Set-VMHostCluster

Configures a virtual machine host cluster.

Syntax

Set-VMHostCluster
   [-ClusterName] <String[]>
   [[-Credential] <PSCredential[]>]
   [-SharedStoragePath <String>]
   [-Passthru]
   [<CommonParameters>]
Set-VMHostCluster
   [-CimSession] <CimSession[]>
   [-SharedStoragePath <String>]
   [-Passthru]
   [<CommonParameters>]
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.

Required 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[]
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[]
Position:0
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[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-Credential

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

Type:PSCredential[]
Position:1
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
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.HyperV.PowerShell.VMHostCluster

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