Set-SCVMShieldingData

Modifies a VMShieldingData object.

Syntax

Set-SCVMShieldingData
   [-VMShieldingData] <KeyFile>
   [-VMMServer <ServerConnection>]
   [-Description <String>]
   [-Name <String>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Set-SCVMShieldingData cmdlet modifies a VMShieldingData object in Virtual Machine Manager (VMM). The properties you can modify are Name and Description.

Examples

Example 1: Set the name of a shielding data object

PS C:\> $TestVMShieldingData = New-SCVMShieldingData -Name "ShieldingData01" -Description "Test" -VMShieldingDataPath "C:\virtual\SD.pdk"
PS C:\> Set-SCVMShieldingData -VMShieldingData $TestVMShieldingData -Name "NewShieldingData01"

The first command creates a shielding data object named ShieldingData01, and then stores it in the $TestVMShieldingData variable.

The second command sets the name of the object in $TestVMShieldingData to NewShieldingData01.

Parameters

-Description

Specifies a description for the VMShieldingData object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-JobVariable

Specifies the name of a variable in which job progress is tracked and stored.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the VMShieldingData object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Type:UserRole
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-VMShieldingData

Specifies the VMShieldingData object to modify.

Type:KeyFile
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

Outputs

VMShieldingData

This cmdlet returns the updated VMShieldingData object.