Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Set-IscsiVirtualDiskSnapshot

Brian Lich|Last Updated: 3/30/2017

SYNOPSIS

Sets the description for a snapshot.

SYNTAX

SnapshotId (Default)

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

InputObject

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-IscsiVirtualDiskSnasphot -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
Parameter Sets: (All)
Aliases: 

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

-Credential

Specifies the credentials when connecting to a remote computer.

Type: PSCredential
Parameter Sets: (All)
Aliases: 

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

-Description

Specifies the description for the iSCSI virtual disk snapshot.

Type: String
Parameter Sets: (All)
Aliases: 

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

-InputObject

Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline.

Type: IscsiVirtualDiskSnapshot
Parameter Sets: InputObject
Aliases: 

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-SnapshotId

Specifies the identifier (ID) for the snapshot.

Type: String
Parameter Sets: SnapshotId
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

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

OUTPUTS

Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot

NOTES

Dismount-IscsiVirtualDiskSnapshot

Export-IscsiVirtualDiskSnapshot

Get-IscsiVirtualDiskSnapshot

Mount-IscsiVirtualDiskSnapshot

Remove-IscsiVirtualDiskSnapshot

© 2017 Microsoft