Get-VMToClusterMapping

Synopsis

Returns a list of all virtual machines that are running on a cluster.

Syntax

Get-VMToClusterMapping [-server] <String> [-user] <String> [-pass] <String> [-cluster] <String[]> [-folder] <String> [-silence] [[-powerstate] <String>] [<CommonParameters>]

Description

The Get-VMToClusterMapping cmdlet returns a list of all virtual machines that are running on a specified cluster.

Examples

Example 1

Get-VMToClusterMapping -server $server -user $user -pass $pass -cluster $cluster -folder "VCLS"

This example returns all virtual machines in folder VCLS on a cluster $cluster.

Example 2

Get-VMToClusterMapping -server $server -user $user -pass $pass -cluster $cluster -folder "VCLS" -powerstate "poweredon"

This example returns only the powered-on virtual machines in folder VCLS on a cluster $cluster.

Parameters

-server

The FQDN of the vCenter Server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-user

The username to authenticate to vCenter Server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-pass

The password to authenticate to vCenter Server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-cluster

The name of the cluster.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-folder

The name of the folder to search for virtual machines.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-silence

The switch to supress selected log messages.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-powerstate

The powerstate of the virtual machines. The values can be one amongst ("poweredon","poweredoff").

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.