Install-SCVMHostCluster

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

Syntax

CreateCluster

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>]

AddNodes

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

AddNodesFromBareMetal

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

CreateClusterFromBareMetal

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

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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateCluster
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateClusterFromBareMetal
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClusterIPAddressPool

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

Parameter properties

Type:

StaticIPAddressPool[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateCluster
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateClusterFromBareMetal
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClusterName

Specifies the name of a cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateCluster
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateClusterFromBareMetal
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateCluster
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateClusterFromBareMetal
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:VMMCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DCBSettings

Specifies the DCB settings configured on the cluster.

Parameter properties

Type:DCBSettings
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AddNodes
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateCluster
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the host cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateCluster
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateClusterFromBareMetal
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableS2D

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PhysicalComputerConfig

Specifies an array of host configuration objects.

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

Parameter properties

Type:

PhysicalComputerConfig[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AddNodesFromBareMetal
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateClusterFromBareMetal
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetQuorumDisk

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

Parameter properties

Type:ClientObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateCluster
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetQuorumNodeMajority

Sets the quorum mode to Node Majority for the cluster.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateCluster
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateClusterFromBareMetal
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SkipValidation

Skips cluster validation tests when creating a cluster.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMHost

Specifies an array of virtual machine host objects.

Parameter properties

Type:

Host[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateCluster
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AddNodes
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMHostCluster

Specifies a VMM host cluster object.

Parameter properties

Type:HostCluster
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AddNodes
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AddNodesFromBareMetal
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMMServer

Specifies a VMM server object.

Parameter properties

Type:ServerConnection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Outputs

VMHostCluster

This cmdlet returns a VMHostCluster object.