Get-SCCustomPlacementRule

Reference

Module:: VirtualMachineManager

Gets the custom placment rules for a placement configuration.

Syntax

Get-SCCustomPlacementRule
   -PlacementConfiguration <PlacementConfigurationSettings>
   [-VMMServer <ServerConnection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-SCCustomPlacementRule cmdlet gets the customm placement rules that have been added to the placement configuration for a host group.

Examples

Example 1: Get all of the custom placement rules for a specified host group

PS C:\> $HostGroup = Get-SCVMHostGroup "HostGroup01"
PS C:\> $PlacementConfig = Get-SCPlacementConfiguration -VMHostGroup $HostGroup
PS C:\> $CustomPlacementRule = Get-SCCustomPlacementRule -PlacementConfiguration $PlacementConfig
PS C:\> $CustomPlacementRule

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 places the object in the $PlacementConfig variable.

The third command gets all custom placement rule objects for the placement configuration stored in $PlacementConfig and stores the objects in the $CustomPlacementRule variable.

The last command displays information about the custom placement rules stored in $CustomPlacementRule for the user.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PlacementConfiguration

Specifies a placement configuration object.

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

-VMMServer

Specifies a VMM server object.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

CustomPlacementRule

This cmdlet returns a CustomPlacementRule object.