Set-SCPlacementConfiguration

Sets the placement configuration settings for a host group.

Description

The Set-SCPlacementConfiguration cmdlet sets the placement configuration settings for a host group. To update settings for a host group, that host group must not be inheriting its settings from a parent host group.

For more information about Set-SCPlacementConfiguration, type: "Get-Help Set-SCPlacementConfiguration -online".

Parameters

Favor

Required? true
Accept Pipeline Input? false
Position? named 
Indicates that the placement process will select a host even if the host does not meet all requirements; no warning message is displayed to the user.

PlacementConfiguration

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a placement configuration object.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

DVDDriveRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have the number of physical DVD drives required by a virtual machine for placement. If a specific DVD drive letter has been configured on the virtual machine, the host must have a DVD drive that uses that same drive letter.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

LoadBalancerRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have access to a load balancer for placement.

NetworkRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have virtual switches that connect to each of the logical networks required by a virtual machine for placement.

PassthroughDiskRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that a destination host must support passthrough disks for placement.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VMMServer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a VMM server object.

VMQueueAvailability

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that a destination host must support network optimizations for placement.

Inherit

Required? true
Accept Pipeline Input? false
Position? named 
Indicates whether settings are inherited from the parent host group.

PlacementConfiguration

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a placement configuration object.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VMMServer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a VMM server object.

MustMeet

Required? true
Accept Pipeline Input? false
Position? named 
Indicates that the placement process will not select a host if the host does not meet the requirements.

PlacementConfiguration

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a placement configuration object.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

DVDDriveRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have the number of physical DVD drives required by a virtual machine for placement. If a specific DVD drive letter has been configured on the virtual machine, the host must have a DVD drive that uses that same drive letter.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

LoadBalancerRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have access to a load balancer for placement.

NetworkRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have virtual switches that connect to each of the logical networks required by a virtual machine for placement.

PassthroughDiskRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that a destination host must support passthrough disks for placement.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VMMServer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a VMM server object.

VMQueueAvailability

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that a destination host must support network optimizations for placement.

Off

Required? true
Accept Pipeline Input? false
Position? named 
Indicates that a placement check is turned off, therefore placement will not consider that metric when determining whether the destination host meets placement metrics.

PlacementConfiguration

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a placement configuration object.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

DVDDriveRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have the number of physical DVD drives required by a virtual machine for placement. If a specific DVD drive letter has been configured on the virtual machine, the host must have a DVD drive that uses that same drive letter.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

LoadBalancerRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have access to a load balancer for placement.

NetworkRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have virtual switches that connect to each of the logical networks required by a virtual machine for placement.

PassthroughDiskRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that a destination host must support passthrough disks for placement.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VMMServer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a VMM server object.

VMQueueAvailability

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that a destination host must support network optimizations for placement.

PlacementConfiguration

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a placement configuration object.

ShouldMeet

Required? true
Accept Pipeline Input? false
Position? named 
Indicates that the placement process will select a host even if the host does not meet all requirements; a warning message is displayed to the user.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

DVDDriveRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have the number of physical DVD drives required by a virtual machine for placement. If a specific DVD drive letter has been configured on the virtual machine, the host must have a DVD drive that uses that same drive letter.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

LoadBalancerRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have access to a load balancer for placement.

NetworkRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the destination host must have virtual switches that connect to each of the logical networks required by a virtual machine for placement.

PassthroughDiskRequirement

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that a destination host must support passthrough disks for placement.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VMMServer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a VMM server object.

VMQueueAvailability

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that a destination host must support network optimizations for placement.

Examples

1: Set the placement settings which must be met by a host group. 
PS C:\> $HostGroup = Get-SCVMHostGroup "HostGroup01"
PS C:\> $PlacementConfig = Get-SCPlacementConfiguration -VMHostGroup $HostGroup
PS C:\> Set-SCPlacementConfiguration -PlacementConfiguration $PlacementConfig -MustMeet -ClusterReserveRequirement -HighAvailabilityRequirement -IPAddressAvailabilityRequirement

The first command gets the host group object named HostGroup01 and stores the object in the $HostGroup variable.

The second command gets the placement configuration object for the host group stored in $HostGroup and stores the object in the $PlacementConfig variable.

The last command updates the settings for the placement configuration stored in $PlacementConfig.
2: Reset the placement settings for a host group to inherit from the parent host group. 
PS C:\> $HostGroup = Get-SCVMHostGroup "HostGroup01"
PS C:\> $PlacementConfig = Get-SCPlacementConfiguration -VMHostGroup $HostGroup
PS C:\> Set-SCPlacementConfiguration -PlacementConfiguration $PlacementConfig -Inherit $True

The first command gets the host group object named HostGroup01 and stores the object in the $HostGroup variable.

The second command gets the placement configuration object for the host group stored in $HostGroup and stores the object in the $PlacementConfig variable.

The last command sets the placement configuration stored in $PlacementConfig to inherit its placement settings from its parent host group.
3: Turn off placement settings for a host group. 
PS C:\> $HostGroup = Get-SCVMHostGroup "HostGroup01"
PS C:\> $PlacementConfig = Get-SCPlacementConfiguration -VMHostGroup $HostGroup
PS C:\> Set-SCPlacementConfiguration -PlacementConfiguration $PlacementConfig -Off -ClusterReserveRequirement -HighAvailabilityRequirement -IPAddressAvailabilityRequirement

The first command gets the host group object named HostGroup01 and stores the object in the $HostGroup variable.

The second command gets the placement configuration object for the host group stored in $HostGroup and stores the object in the $PlacementConfig variable.

The last command turns off the specified placement settings for the placement configuration stored in $PlacementConfig.

See Also