Share via

Update-SCVMConfiguration

Module:
VirtualMachineManager Module

Updates the properties of a VMM virtual machine configuration object.

Syntax

FromVMConfig (Default) 

Update-SCVMConfiguration
    [-VMConfiguration] <BaseVMConfiguration>
    [-ValidateOnly <Boolean>]
    [-VMName <String>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

FromVMConfigList 

Update-SCVMConfiguration

    -VMConfigurationList <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.BaseVMConfiguration]>
    [-ValidateOnly <Boolean>]
    [-VMName <String>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

Description

The Update-SCVMConfiguration cmdlet updates the properties of a Virtual Machine Manager (VMM) virtual machine configuration object.

Examples

Example 1: Update an existing virtual machine configuration

PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $VMConfig = Get-SCVMConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> Update-SCVMConfiguration -VMConfiguration $VMConfig[0] -ValidateOnly $True

The first command gets the service configuration object named Service01 from the VMM library and stores the object in the $ServiceConfig variable.

The second command gets the virtual machine configuration object for the service configuration stored in $ServiceConfig and 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.

Parameters

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OnBehalfOfUser

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OnBehalfOfUserRole

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

Parameter properties

Type:UserRole
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunAsynchronously

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ValidateOnly

Indicates whether validation of the placement is performed, but placement is not actually performed.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMConfiguration

Specifies a virtual machine configuration object.

Parameter properties

Type:BaseVMConfiguration
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FromVMConfig
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMConfigurationList

Specifies a list of configuration objects.

Parameter properties

Type:

System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.BaseVMConfiguration]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FromVMConfigList
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMName

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

ComputerConfig

This cmdlet returns a ComputerConfig object.

Notes

  • Requires a VMM virtual machine configuration object, which can be obtained by using the Get-SCVMConfiguration cmdlet.