Protect-RubrikNutanixVM

SYNOPSIS

Connects to Rubrik and assigns an SLA to a virtual machine

SYNTAX

None (Default)

Protect-RubrikNutanixVM -id <String> [-SLAID <String>] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SLA_Explicit

Protect-RubrikNutanixVM -id <String> [-SLA <String>] [-SLAID <String>] [-Server <String>] [-api <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SLA_Inherit

Protect-RubrikNutanixVM -id <String> [-Inherit] [-SLAID <String>] [-Server <String>] [-api <String>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

SLA_Unprotected

Protect-RubrikNutanixVM -id <String> [-DoNotProtect] [-ExistingSnapshotRetention <String>] [-SLAID <String>]
 [-Server <String>] [-api <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Protect-RubrikNutanixVM cmdlet will update a virtual machine's SLA Domain assignment within the Rubrik cluster. The SLA Domain contains all policy-driven values needed to protect workloads. Note that this function requires the virtual machine ID value, not the name of the virtual machine, since virtual machine names are not unique across clusters. It is suggested that you first use Get-RubrikNutanixVM to narrow down the one or more virtual machine to protect, and then pipe the results to Protect-RubrikVM. You will be asked to confirm each virtual machine you wish to protect, or you can use -Confirm:$False to skip confirmation checks.

EXAMPLES

EXAMPLE 1

Get-RubrikNutanixVM "VM1" | Protect-RubrikNutanixVM -SLA 'Gold'

This will assign the Gold SLA Domain to any virtual machine named "VM1"

EXAMPLE 2

Get-RubrikNutanixVM "VM1" | Protect-RubrikNutanixVM -DoNotProtect -ExistingSnapshotRetention KeepForever

This will unprotect the Nutanix VM VM1 while keeping existing snapshots forever

EXAMPLE 3

Get-RubrikNutanixVM "VM1" -SLA Silver | Protect-RubrikNutanixVM -SLA 'Gold' -Confirm:$False

This will assign the Gold SLA Domain to any virtual machine named "VM1" that is currently assigned to the Silver SLA Domain without asking for confirmation

PARAMETERS

-id

Virtual machine ID

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_Explicit
Aliases:

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

-Inherit

Inherits the SLA Domain assignment from a parent object

Type: SwitchParameter
Parameter Sets: SLA_Inherit
Aliases:

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

-DoNotProtect

Removes the SLA Domain assignment

Type: SwitchParameter
Parameter Sets: SLA_Unprotected
Aliases:

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

-ExistingSnapshotRetention

Determine the retention settings for the already existing snapshots

Type: String
Parameter Sets: SLA_Unprotected
Aliases:

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

-SLAID

SLA id value

Type: String
Parameter Sets: (All)
Aliases: configuredSlaDomainId

Required: False
Position: Named
Default value: (Test-RubrikSLA -SLA $SLA -DoNotProtect $DoNotProtect -Inherit $Inherit -Mandatory:$true)
Accept pipeline input: False
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 Mike Fal for community usage Twitter: @Mike_Fal GitHub: MikeFal

https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/protect-rubriknutanixvm

Last updated