Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-IscsiVirtualDiskSnapshot

Set-IscsiVirtualDiskSnapshot

microsoft.iscsi.target.commands.dll

Synopsis

Sets the description for a snapshot.

Syntax

Set-IscsiVirtualDiskSnapshot [-SnapshotId] [-ComputerName] [-Credential] [-Description] [-PassThru] [<CommonParameters>]

Set-IscsiVirtualDiskSnapshot [-ComputerName] [-Credential] [-Description] [-PassThru] [-InputObject] [<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 <SwitchParameter>

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

Input Type

None

Return Type

Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot

Notes

None

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"

Online Version
Dismount-IscsiVirtualDiskSnapshot
Export-IscsiVirtualDiskSnapshot
Get-IscsiVirtualDiskSnapshot
Mount-IscsiVirtualDiskSnapshot
Remove-IscsiVirtualDiskSnapshot