Update-SCVMConfiguration
Update-SCVMConfiguration
Updates the properties of a VMM virtual machine configuration object.
Syntax
Parameter Set: Default
Update-SCVMConfiguration [-VMConfiguration] <BaseVMConfiguration> [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-ValidateOnly <Boolean> ] [-VMName <String> ] [ <CommonParameters>]
Detailed Description
The Update-SCVMConfiguration cmdlet updates the properties of a Virtual Machine Manager (VMM) virtual machine configuration object.
Parameters
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUser<System.String>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ValidateOnly<Boolean>
Indicates that validation of the placement is performed, but placement will not actually be performed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMConfiguration<BaseVMConfiguration>
Specifies a virtual machine configuration object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String>
Specifies the name of a virtual machine to be placed on a physical host server. Use this parameter to verify that another virtual machine with the same name is not already deployed on that host.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
- ComputerConfig
Notes
- This command requires a VMM virtual machine configuration object, which can be obtained by using the Get-SCVMConfiguration cmdlet.
Examples
Example Example 1: Update an existing virtual machine configuration.
The first command gets the service configuration object named Service01 from the VMM library, and then stores the object in the $ServiceConfig variable.
The second command gets the virtual machine configuration object for the service configuration stored in $ServiceConfig, and then stores the virtual machine configuration object in $VMConfig.
The last command sets the ValidateOnly property to $True for the first configuration object stored in $VMConfig.
PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $VMConfig = Get-SCVMConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> Update-SCVMConfiguration -VMConfiguration $VMConfig[0] -ValidateOnly $True