Set-IscsiVirtualDiskSnapshot
Sets the description for a snapshot.
Syntax
Set-IscsiVirtualDiskSnapshot
[-SnapshotId] <String>
[-Description <String>]
[-PassThru]
[-ComputerName <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Set-IscsiVirtualDiskSnapshot
-InputObject <IscsiVirtualDiskSnapshot>
[-Description <String>]
[-PassThru]
[-ComputerName <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Description
The Set-IscsiVirtualDiskSnapshot cmdlet sets the description for a snapshot.
Examples
Example 1: Modify a snapshot description
PS C:\> Set-IscsiVirtualDiskSnapshot -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -Description "before upgrade"This example sets a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40} to have the description before upgrade.
Parameters
-ComputerName
Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer.
Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Credential
Specifies the credentials when connecting to a remote computer.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Description
Specifies the description for the iSCSI virtual disk snapshot.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline.
| Type: | IscsiVirtualDiskSnapshot |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SnapshotId
Specifies the identifier (ID) for the snapshot.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
None
Outputs
Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot