New-RubrikSnapshot

SYNOPSIS

Takes an on-demand Rubrik snapshot of a protected object

SYNTAX

SLA_Name

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

SLA_Forever

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

SLA_ByID

New-RubrikSnapshot -id <String> [-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.)

EXAMPLES

EXAMPLE 1

Get-RubrikVM 'Server1' | New-RubrikSnapshot -Forever

This will trigger an on-demand backup for any virtual machine named "Server1" that will be retained indefinitely and available under Unmanaged Objects.

EXAMPLE 2

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

Get-RubrikDatabase 'DB1' | New-RubrikSnapshot -ForceFull -SLA 'Silver'

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

EXAMPLE 4

Get-RubrikOracleDB -Id OracleDatabase:::e7d64866-b2ee-494d-9a61-46824ae85dc1 | New-RubrikSnapshot -ForceFull -SLA Bronze

This will trigger an on-demand backup for the Oracle database by its ID, and force the backup to be a full rather than an incremental.

EXAMPLE 5

New-RubrikSnapShot -Id MssqlDatabase:::ee7aead5-6a51-4f0e-9479-1ed1f9e31614 -SLA Gold

This will trigger an on-demand backup by ID, in this example it is the ID of a MSSQL Database

EXAMPLE 6

New-RubrikSnapShot -Id MssqlDatabase:::ee7aead5-6a51-4f0e-9479-1ed1f9e31614 -SLA Gold -SLAPrimaryClusterId 57bbd327-477d-40d8-b1d8-5820b37d88e5

This will trigger an on-demand backup by ID, in this example it is the ID of a MSSQL Database, creating a snapshot in the Gold SLA on the cluster id specified in SLAPrimaryClusterId

PARAMETERS

-id

Rubrik's id of the object

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SLA

The SLA Domain in Rubrik

Type: String
Parameter Sets: SLA_Name
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SLAPrimaryClusterId

The PrimaryClusterId of SLA Domain on Rubrik, defaults to local

Type: String
Parameter Sets: SLA_Name
Aliases:

Required: False
Position: Named
Default value: Local
Accept pipeline input: False
Accept wildcard characters: False

-Forever

The snapshot will be retained indefinitely and available under Unmanaged Objects

Type: SwitchParameter
Parameter Sets: SLA_Forever
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ForceFull

Whether to force a full snapshot or an incremental. Only valid with MSSQL and Oracle Databases.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: forceFullSnapshot

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SLAID

SLA id value

Type: String
Parameter Sets: SLA_ByID
Aliases: effectiveSlaDomainId

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Server

Rubrik server IP or FQDN

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $global:RubrikConnection.server
Accept pipeline input: False
Accept wildcard characters: False

-api

API version

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $global:RubrikConnection.api
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Written by Chris Wahl for community usage Twitter: @ChrisWahl GitHub: chriswahl

https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/new-rubriksnapshot

Last updated