Get-SCCustomPlacementRule
Get-SCCustomPlacementRule
Gets the custom placement rules for a placement configuration.
Syntax
Parameter Set: FromPlacementConfiguration
Get-SCCustomPlacementRule -PlacementConfiguration <PlacementConfigurationSettings> [-VMMServer <ServerConnection> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Get-SCCustomPlacementRule cmdlet gets the custom placement rules that have been added to the placement configuration for a host group.
Parameters
-PlacementConfiguration<PlacementConfigurationSettings>
Specifies a placement configuration object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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.
- CustomPlacementRule
Examples
Example 1: Get all of the custom placement rules for a specified host group
The first command gets the host group object named HostGroup01, and then stores the object in the $HostGroup variable.
The second command gets the placement configuration object for the host group stored in $HostGroup, and then stores the object in the $PlacementConfig variable.
The third command gets all custom placement rule objects for the placement configuration stored in $PlacementConfig, and then stores the objects in the $CustomPlacementRule variable.
The last command displays information about the custom placement rules stored in $CustomPlacementRule.
PS C:\> $HostGroup = Get-SCVMHostGroup -Name "HostGroup01"
PS C:\> $PlacementConfig = Get-SCPlacementConfiguration -VMHostGroup $HostGroup
PS C:\> $CustomPlacementRule = Get-SCCustomPlacementRule -PlacementConfiguration $PlacementConfig
PS C:\> $CustomPlacementRule