New Commands

This page contains details on New commands.

New-RubrikDatabaseMount

NAME
New-RubrikDatabaseMount
SYNOPSIS
Create a new Live Mount from a protected database
SYNTAX

New-RubrikDatabaseMount -id <String> [-TargetInstanceId <String>] [-MountedDatabaseName <String>] [-TimestampMs <Int64>] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

New-RubrikDatabaseMount -id <String> [-TargetInstanceId <String>] [-MountedDatabaseName <String>] [-RecoveryDateTime <DateTime>] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION
The New-RubrikDatabaseMount cmdlet is used to create a Live Mount (clone) of a protected database and run it in an existing database environment.
PARAMETERS
-id <String>
Rubrik id of the database
-TargetInstanceId <String>
ID of Instance to use for the mount
-MountedDatabaseName <String>
Name of the mounted database
-TimestampMs <Int64>
Recovery Point desired in the form of Epoch with Milliseconds
-RecoveryDateTime <DateTime>
Recovery Point desired in the form of DateTime value
-Server <String>
Rubrik server IP or FQDN
-api <String>
API version

-WhatIf [<SwitchParameter>]

-Confirm [<SwitchParameter>]

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

————————– EXAMPLE 1 ————————–

PS C:>New-RubrikDatabaseMount -id $db.id -targetInstanceId $db.instanceId -mountedDatabaseName ‘BAR-LM’ -recoveryDateTime (Get-date (Get-RubrikDatabase -id $db.id).latestRecoveryPoint)

Creates a new database mount named BAR on the same instance as the source database, using the most recent recovery time for the database.

$db=Get-RubrikDatabase -HostName FOO -Instance MSSQLSERVER -Database BAR

REMARKS
To see the examples, type: “get-help New-RubrikDatabaseMount -examples”. For more information, type: “get-help New-RubrikDatabaseMount -detailed”. For technical information, type: “get-help New-RubrikDatabaseMount -full”. For online help, type: “get-help New-RubrikDatabaseMount -online”

New-RubrikHost

NAME
New-RubrikHost
SYNOPSIS
Registers a host with a Rubrik cluster.
SYNTAX
New-RubrikHost [-Name] <String> [[-HasAgent] <Boolean>] [[-Server] <String>] [[-api] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-RubrikHost cmdlet is used to register a host with the Rubrik cluster. This could be a host leveraging the Rubrik Backup Service or directly as with the case of NAS shares.
PARAMETERS
-Name <String>
The IPv4 address of the host or the resolvable hostname of the host
-HasAgent <Boolean>
Set to $false to register a host that will be accessed through network shares
-Server <String>
Rubrik server IP or FQDN
-api <String>
API version

-WhatIf [<SwitchParameter>]

-Confirm [<SwitchParameter>]

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

————————– EXAMPLE 1 ————————–

PS C:>New-RubrikHost -Name ‘Server1.example.com’

This will register a host that resolves to the name “Server1.example.com”

————————– EXAMPLE 2 ————————–

PS C:>New-RubrikHost -Name ‘NAS.example.com’ -HasAgent $false

This will register a host that resolves to the name “NAS.example.com” without using the Rubrik Backup Service In this case, the example host is a NAS share.

REMARKS
To see the examples, type: “get-help New-RubrikHost -examples”. For more information, type: “get-help New-RubrikHost -detailed”. For technical information, type: “get-help New-RubrikHost -full”. For online help, type: “get-help New-RubrikHost -online”

New-RubrikMount

NAME
New-RubrikMount
SYNOPSIS
Create a new Live Mount from a protected VM
SYNTAX
New-RubrikMount [-id] <String> [[-HostID] <String>] [[-MountName] <String>] [[-DatastoreName] <String>] [[-DisableNetwork] <Boolean>] [-RemoveNetworkDevices] [-PowerOn] [[-Server] <String>] [[-api] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-RubrikMount cmdlet is used to create a Live Mount (clone) of a protected VM and run it in an existing vSphere environment.
PARAMETERS
-id <String>
Rubrik id of the snapshot
-HostID <String>
ID of host for the mount to use
-MountName <String>
Name of the mounted VM
-DatastoreName <String>
Name of the data store to use/create on the host
-DisableNetwork <Boolean>
Whether the network should be disabled on mount.This should be set true to avoid ip conflict in case of static IPs.
-RemoveNetworkDevices [<SwitchParameter>]
Whether the network devices should be removed on mount.
-PowerOn [<SwitchParameter>]
Whether the VM should be powered on after mount.
-Server <String>
Rubrik server IP or FQDN
-api <String>
API version

-WhatIf [<SwitchParameter>]

-Confirm [<SwitchParameter>]

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

————————– EXAMPLE 1 ————————–

PS C:>New-RubrikMount -id ‘11111111-2222-3333-4444-555555555555’

This will create a new mount based on snapshot id “11111111-2222-3333-4444-555555555555” The original virtual machine’s name will be used along with a date and index number suffix The virtual machine will NOT be powered on upon completion of the mount operation

————————– EXAMPLE 2 ————————–

PS C:>New-RubrikMount -id ‘11111111-2222-3333-4444-555555555555’ -MountName ‘Mount1’ -PowerOn -RemoveNetworkDevices

This will create a new mount based on snapshot id “11111111-2222-3333-4444-555555555555” and name the mounted virtual machine “Mount1” The virtual machine will be powered on upon completion of the mount operation but without any virtual network adapters

————————– EXAMPLE 3 ————————–

PS C:>Get-RubrikVM ‘Server1’ | Get-RubrikSnapshot -Date ‘03/01/2017 01:00’ | New-RubrikMount -MountName ‘Mount1’ -DisableNetwork

This will create a new mount based on the closet snapshot found on March 1st, 2017 @ 01:00 AM and name the mounted virtual machine “Mount1” The virtual machine will NOT be powered on upon completion of the mount operation

REMARKS
To see the examples, type: “get-help New-RubrikMount -examples”. For more information, type: “get-help New-RubrikMount -detailed”. For technical information, type: “get-help New-RubrikMount -full”. For online help, type: “get-help New-RubrikMount -online”

New-RubrikSLA

NAME
New-RubrikSLA
SYNOPSIS
Creates a new Rubrik SLA Domain
SYNTAX
New-RubrikSLA [-Name] <String> [[-HourlyFrequency] <Int32>] [[-HourlyRetention] <Int32>] [[-DailyFrequency] <Int32>] [[-DailyRetention] <Int32>] [[-MonthlyFrequency] <Int32>] [[-MonthlyRetention] <Int32>] [[-YearlyFrequency] <Int32>] [[-YearlyRetention] <Int32>] [[-Server] <String>] [[-api] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-RubrikSLA cmdlet will build a new SLA Domain to provide policy-driven control over protected objects within the Rubrik fabric.
PARAMETERS
-Name <String>
SLA Domain Name
-HourlyFrequency <Int32>
Hourly frequency to take backups
-HourlyRetention <Int32>
Number of hours to retain the hourly backups
-DailyFrequency <Int32>
Daily frequency to take backups
-DailyRetention <Int32>
Number of days to retain the daily backups
-MonthlyFrequency <Int32>
Monthly frequency to take backups
-MonthlyRetention <Int32>
Number of months to retain the monthly backups
-YearlyFrequency <Int32>
Yearly frequency to take backups
-YearlyRetention <Int32>
Number of years to retain the yearly backups
-Server <String>
Rubrik server IP or FQDN
-api <String>
API version

-WhatIf [<SwitchParameter>]

-Confirm [<SwitchParameter>]

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

————————– EXAMPLE 1 ————————–

PS C:>New-RubrikSLA -SLA ‘Test1’ -HourlyFrequency 4 -HourlyRetention 24

This will create an SLA Domain named “Test1” that will take a backup every 4 hours and keep those hourly backups for 24 hours.

————————– EXAMPLE 2 ————————–

PS C:>New-RubrikSLA -SLA ‘Test1’ -HourlyFrequency 4 -HourlyRetention 24 -DailyFrequency 1 -DailyRetention 30

This will create an SLA Domain named “Test1” that will take a backup every 4 hours and keep those hourly backups for 24 hours while also keeping one backup per day for 30 days.

REMARKS
To see the examples, type: “get-help New-RubrikSLA -examples”. For more information, type: “get-help New-RubrikSLA -detailed”. For technical information, type: “get-help New-RubrikSLA -full”. For online help, type: “get-help New-RubrikSLA -online”

New-RubrikSnapshot

NAME
New-RubrikSnapshot
SYNOPSIS
Takes an on-demand Rubrik snapshot of a protected object
SYNTAX

New-RubrikSnapshot -id <String> [-SLA <String>] [-ForceFull] [-SLAID <String>] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

New-RubrikSnapshot -id <String> [-DoNotProtect] [-ForceFull] [-SLAID <String>] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

New-RubrikSnapshot -id <String> [-Inherit] [-ForceFull] [-SLAID <String>] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION
The New-RubrikSnapshot cmdlet will trigger an on-demand snapshot for a specific object (virtual machine, database, fileset, etc.)
PARAMETERS
-id <String>
Rubrik’s id of the object
-SLA <String>
The SLA Domain in Rubrik
-DoNotProtect [<SwitchParameter>]
Removes the SLA Domain assignment
-Inherit [<SwitchParameter>]
Inherits the SLA Domain assignment from a parent object
-ForceFull [<SwitchParameter>]
Whether to force a full snapshot or an incremental. Only valid with MSSQL Databases.
-SLAID <String>
SLA id value
-Server <String>
Rubrik server IP or FQDN
-api <String>
API version

-WhatIf [<SwitchParameter>]

-Confirm [<SwitchParameter>]

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

————————– EXAMPLE 1 ————————–

PS C:>Get-RubrikVM ‘Server1’ | New-RubrikSnapshot

This will trigger an on-demand backup for any virtual machine named “Server1”

————————– EXAMPLE 2 ————————–

PS C:>Get-RubrikFileset ‘C_Drive’ | New-RubrikSnapshot -SLA ‘Gold’

This will trigger an on-demand backup for any fileset named “C_Drive” using the “Gold” SLA Domain

————————– EXAMPLE 3 ————————–

PS C:>Get-RubrikDatabase ‘DB1’ | New-RubrikSnapshot -ForceFull

This will trigger an on-demand backup for any database named “DB1” and force the backup to be a full rather than an incremental.

REMARKS
To see the examples, type: “get-help New-RubrikSnapshot -examples”. For more information, type: “get-help New-RubrikSnapshot -detailed”. For technical information, type: “get-help New-RubrikSnapshot -full”. For online help, type: “get-help New-RubrikSnapshot -online”