Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Set-VMHostCluster

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Configures a virtual machine host cluster.

SYNTAX

ClusterName (Default)

Set-VMHostCluster [-ClusterName] <String[]> [[-Credential] <PSCredential[]>] [-SharedStoragePath <String>]
 [-Passthru] [<CommonParameters>]

CimSession

Set-VMHostCluster [-CimSession] <CimSession[]> [-SharedStoragePath <String>] [-Passthru] [<CommonParameters>]

InputObject

Set-VMHostCluster [-InputObject] <VMHostCluster[]> [-SharedStoragePath <String>] [-Passthru]
 [<CommonParameters>]

DESCRIPTION

The Set-VMHostCluster cmdlet configures a virtual machine host cluster.

EXAMPLES

Example 1: Configure a virtual machine host cluster

PS C:\> Set-VMHostCluster -ClusterName "ContosoCluster" -SharedStoragePath "D:\ClusterStorage\cluster01"

This command configures the shared storage path for the cluster named ContosoCluster.

PARAMETERS

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: CimSession
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ClusterName

Specifies an array of names of the virtual machine host clusters that this cmdlet configures.

Type: String[]
Parameter Sets: ClusterName
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type: PSCredential[]
Parameter Sets: ClusterName
Aliases: 

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

-InputObject

Specifies an array of virtual machine host clusters that this cmdlet configures. To obtain a VMHostCluster object, use the Get-VMHostCluster cmdlet.

Type: VMHostCluster[]
Parameter Sets: InputObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Passthru

Indicates that this cmdlet returns the Microsoft.HyperV.PowerShell.VMHostCluster object that it configures.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-SharedStoragePath

Specifies the location of the shared storage for the virtual machine host cluster.

Type: String
Parameter Sets: (All)
Aliases: 

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

CommonParameters

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

INPUTS

OUTPUTS

Microsoft.HyperV.PowerShell.VMHostCluster

This cmdlet returns a VMHostCluster object, if you specify the Passthru parameter.

NOTES

Get-VMHostCluster

© 2017 Microsoft