Install-SCVMHostCluster

Module:

VirtualMachineManager

Creates a failover cluster from Hyper-V hosts managed by VMM.

Syntax

Install-SCVMHostCluster
       -VMHost <Host[]>
       -ClusterName <String>
       -Credential <VMMCredential>
       [-ClusterIPAddress <String[]>]
       [-ClusterIPAddressPool <StaticIPAddressPool[]>]
       [-ClusterReserve <Int32>]
       [-Description <String>]
       [-VMMServer <ServerConnection>]
       [-SetQuorumNodeMajority]
       [-SetQuorumDisk <ClientObject>]
       [-SkipValidation]
       [-JobGroup <Guid>]
       [-EnableS2D]
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]

Install-SCVMHostCluster
       -VMHost <Host[]>
       -VMHostCluster <HostCluster>
       -Credential <VMMCredential>
       [-VMMServer <ServerConnection>]
       [-SkipValidation]
       [-JobGroup <Guid>]
       [-EnableS2D]
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]

Install-SCVMHostCluster
       -PhysicalComputerConfig <PhysicalComputerConfig[]>
       -VMHostCluster <HostCluster>
       -Credential <VMMCredential>
       [-VMMServer <ServerConnection>]
       [-SkipValidation]
       [-JobGroup <Guid>]
       [-EnableS2D]
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]

Install-SCVMHostCluster
       -PhysicalComputerConfig <PhysicalComputerConfig[]>
       -ClusterName <String>
       -Credential <VMMCredential>
       [-ClusterIPAddress <String[]>]
       [-ClusterIPAddressPool <StaticIPAddressPool[]>]
       [-ClusterReserve <Int32>]
       [-Description <String>]
       [-VMMServer <ServerConnection>]
       [-SetQuorumNodeMajority]
       [-SkipValidation]
       [-JobGroup <Guid>]
       [-EnableS2D]
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]

Description

Note

A new parameter [-DCBSettings] is included in VMM 2019 UR1 and later. For more information, see Parameters.

The Install-SCVMHostCluster cmdlet creates a failover cluster from Hyper-V hosts managed by Virtual Machine Manager (VMM). Install-SCVMHostCluster can also add a node to an existing cluster.

Examples

Example 1: Create a cluster from managed hosts

PS C:\> $RunAsAcct = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> $HostGroup = Get-SCVMHostGroup -Name "New York"
PS C:\> $Nodes = Get-SCVMHost | where {$_.Name -like "HostClus*" -and $_.VMHostGroup -eq $HostGroup}
PS C:\> Install-SCVMHostCluster -VMHost $Nodes -ClusterName "Cluster01" -Credential $RunAsAcct

The first command gets the Run As account named RunAsAccount01 and stores it in the $RunAsAcct variable.

The second command gets the host group object named New York and stores the object in the $HostGroup variable.

The third command gets the cluster nodes that begin with the name HostClus in the host group stored in $HostGroup. The command then stores the nodes in the $Nodes variable.

The last command creates the cluster and names it Cluster01.

Example 2: Create a hyper converge cluster from managed hosts

PS C:\> $RunAsAcct = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> $HostGroup = Get-SCVMHostGroup -Name "New York"
PS C:\> $Nodes = Get-SCVMHost | where {$_.Name -like "HostClus*" -and $_.VMHostGroup -eq $HostGroup}
PS C:\> Install-SCVMHostCluster -VMHost $Nodes -ClusterName "Cluster01" -Credential $RunAsAcct -EnableS2D

The first command gets the Run As account named RunAsAccount01, and then stores it in the $RunAsAcct variable.

The second command gets the host group object named New York, and then stores it in the $HostGroup variable.

The third command gets the cluster nodes that begin with the name HostClus in the host group stored in $HostGroup. The command stores the nodes in the $Nodes variable.

The last command creates hyper converged cluster and names it Cluster01.

Parameters

-ClusterIPAddress

Specifies one or more IP addresses to use as a cluster IP address.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterIPAddressPool

Specifies a static IP address pool to use as a cluster IP address pool.

Type:	StaticIPAddressPool[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterName

Specifies the name of a cluster.

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

-ClusterReserve

Specifies the number of host failures that a host cluster can sustain before VMM designates the cluster as over-committed. The default value is 1.

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

-Credential

Specifies a credential object or, for some cmdlets, a Run As account object that contains the user name and password of an account that has permission to perform this action. Or, in the case of Restart-SCJob, has permission to complete a restarted task.

For more information about the PSCredential object, type Get-Help Get-Credential. For more information about Run As accounts, type Get-Help New-SCRunAsAccount.

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

-DCBSettings

Specifies the DCB settings configured on the cluster.

Note

This parameter is applicable for VMM 2019 UR1 and later.

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

-Description

Specifies a description for the host cluster.

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

-EnableS2D

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

-JobGroup

Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
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

-PhysicalComputerConfig

Specifies an array of host configuration objects.

For information about host configuration objects, see the New-SCVMHostConfig cmdlet.

Type:	PhysicalComputerConfig[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
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

-SetQuorumDisk

Specifies a disk to use as the quorum disk for the cluster.

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

-SetQuorumNodeMajority

Sets the quorum mode to Node Majority for the cluster.

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

-SkipValidation

Skips cluster validation tests when creating a cluster.

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

-VMHost

Specifies an array of virtual machine host objects.

Type:	Host[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-VMHostCluster

Specifies a VMM host cluster object.

Type:	HostCluster
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:	True
Accept wildcard characters:	False

Outputs

VMHostCluster

This cmdlet returns a VMHostCluster object.

Related Links

• Add-SCVMHostCluster
• Get-SCVMHostCluster
• Move-SCVMHostCluster
• Read-SCVMHostCluster
• Remove-SCVMHostCluster
• Set-SCVMHostCluster
• Test-SCVMHostCluster
• Uninstall-SCVMHostCluster