Citrix Virtual Apps and Desktops SDK

Set-ProvVMSnapshot

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Set the values for a snapshot.

Syntax

Set-ProvVMSnapshot
   -ProvisioningSchemeUid <Guid>
   -VMName <String>
   -SnapshotName <String>
   [-DeletionProtection <Boolean>]
   [-UserVisible <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-ProvVMSnapshot
   -ProvisioningSchemeName <String>
   -VMName <String>
   -SnapshotName <String>
   [-DeletionProtection <Boolean>]
   [-UserVisible <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-ProvVMSnapshot
   -SnapshotUid <Guid>
   [-DeletionProtection <Boolean>]
   [-UserVisible <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Changes the configuration for a specific provisioned snapshot.

Examples

EXAMPLE 1

Enables deletion protection for snapshot1.

Set-ProvVMSnapshot -ProvisioningSchemeName MyScheme -VMName machine1 -SnapshotName snapshot1 -DeletionProtection $true
<!--NeedCopy-->

Parameters

-ProvisioningSchemeName

The name of the provisioning scheme the Snapshot is a part of

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

-VMName

The name of the VM

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

-SnapshotName

The name of the snapshot

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

-ProvisioningSchemeUid

The unique identifier for the provisioning scheme the Snapshot is a part of

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

-SnapshotUid

The unique identifier for the snapshot

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

-DeletionProtection

Sets whether the snapshot is deletion protected. see “Remove-ProvVmSnapshot” for more details.

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

-UserVisible

Sets whether the snapshot is visible to users.

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

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Set-ProvVMSnapshot