Add-SCCustomPlacementRule
Adds a custom placement rule to the placement configuration for a host group.
Syntax
Add-SCCustomPlacementRule
-PlacementConfiguration <PlacementConfigurationSettings>
-CustomPropertyName <String>
[-ShouldMatch]
[-VMMServer <ServerConnection>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-SCCustomPlacementRule
-PlacementConfiguration <PlacementConfigurationSettings>
-CustomPropertyName <String>
[-ShouldNotMatch]
[-VMMServer <ServerConnection>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-SCCustomPlacementRule
-PlacementConfiguration <PlacementConfigurationSettings>
-CustomPropertyName <String>
[-MustMatch]
[-VMMServer <ServerConnection>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-SCCustomPlacementRule
-PlacementConfiguration <PlacementConfigurationSettings>
-CustomPropertyName <String>
[-MustNotMatch]
[-VMMServer <ServerConnection>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Add-SCCustomPlacementRule cmdlet adds a custom placement rule to the placement configuration for a host group.
Examples
Example 1: Add a new custom placement rule to a placement configuration for a host group
PS C:\> $HostGroup = Get-SCVMHostGroup "HostGroup01"
PS C:\> $PlacementConfig = Get-SCPlacementConfiguration -VMHostGroup $HostGroup
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Add-SCCustomPlacementRule -PlacementConfiguration $PlacementConfig -MustMatch -CustomProperty $CustomPropThe 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 the custom property object named Cost Center and stores the object in the $CustomProp variable.
The last command adds a custom placement rule to the placement configuration stored in $PlacementConfig.
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 |
-CustomPropertyName
Specifies the name for a custom property.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MustMatch
Indicates that the property value of the virtual machine must match the host.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MustNotMatch
Indicates that the property value of the virtual machine must not match the host.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ShouldMatch
Indicates that the property value of the virtual machine should match the host.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ShouldNotMatch
Indicates that the property value of the virtual machine should not match the host.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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.