Export (0) Print
Expand All

Set-IscsiVirtualDiskSnapshot

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Set-IscsiVirtualDiskSnapshot

Sets the description for a snapshot.

Syntax

Parameter Set: SnapshotId
Set-IscsiVirtualDiskSnapshot [-SnapshotId] <String> [-ComputerName <String> ] [-Description <String> ] [-PassThru] [ <CommonParameters>]

Parameter Set: InputObject
Set-IscsiVirtualDiskSnapshot -InputObject <IscsiVirtualDiskSnapshot> [-ComputerName <String> ] [-Description <String> ] [-PassThru] [ <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

-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

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output.
To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.


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 (http://go.microsoft.com/fwlink/p/?LinkID=113216).

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"

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft