Get-SCPlacementConfiguration

  • Reference
Module:
VirtualMachineManager

Gets the placement configuration settings for a host group.

Syntax

Get-SCPlacementConfiguration
   -VMHostGroup <HostGroup>
   [-VMMServer <ServerConnection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-SCPlacementConfiguration cmdlet gets the placement configuration settings that have been configured for a host group.

Examples

Example 1: Get the placement configuration for a host group

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

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 last command displays the placement configuration settings for the placement configuration stored in $PlacementConfig 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

-VMHostGroup

Specifies a virtual machine host group object or an array of host group objects.

Type:HostGroup
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:True
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

PlacementConfiguration

This cmdlet returns a PlacementConfiguration object.