Set-IscsiVirtualDiskSnapshot
Set-IscsiVirtualDiskSnapshot
Sets the description for an iSCSI virtual disk snapshot.
Syntax
Parameter Set: SnapshotId
Set-IscsiVirtualDiskSnapshot [-SnapshotId] <String> [ <CommonParameters>]
Parameter Set: __AllParameterSets
Set-IscsiVirtualDiskSnapshot [-ComputerName <String> ] [-Credential <PSCredential> ] [-Description <String> ] [-PassThru] [ <CommonParameters>]
Parameter Set: InputObject
Set-IscsiVirtualDiskSnapshot -InputObject <IscsiVirtualDiskSnapshot> [ <CommonParameters>]
Detailed Description
The Set-IscsiVirtualDiskSnapshot cmdlet sets the description for a snapshot.
Parameters
-ComputerName<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the credentials when connecting to a remote computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Description<String>
Specifies the description for the iSCSI virtual disk snapshot.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IscsiVirtualDiskSnapshot>
Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SnapshotId<String>
Specifies the identifier (ID) for the snapshot.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot
Examples
EXAMPLE 1
This example sets a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40} to have the description before upgrade.
PS C:\> Set-IscsiVirtualDiskSnasphot –SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -Description "before upgrade"
Related topics
Dismount-IscsiVirtualDiskSnapshot
Export-IscsiVirtualDiskSnapshot