Install-SCVMHostCluster

Applies To: System Center 2012 - Virtual Machine Manager

Install-SCVMHostCluster

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

Syntax

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

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

Detailed Description

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

For more information about Install-SCVMHostCluster, type: "Get-Help Install-SCVMHostCluster -online".

Parameters

-ClusterIPAddress<String[]>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClusterIPAddressPool<StaticIPAddressPool[]>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClusterName<String>

Specifies the name of a cluster.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClusterReserve<Int32>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<VMMCredential>

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".

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

States a description for the specified object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobGroup<Guid>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SetQuorumDisk<ClientObject>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SetQuorumNodeMajority

Sets the quorum mode to Node Majority for the cluster.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SkipValidation

Skips cluster validation tests when creating a cluster.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMHost<Host[]>

Specifies an array of virtual machine host objects.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMHostCluster<HostCluster>

Specifies a VMM host cluster object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • VMHostCluster

Examples

1: Create a cluster from managed hosts.

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

The second command gets all host objects whose name contains "myclus" from the New York host group (stored in $HostGroup), and then stores the host objects in the $Nodes variable.

The third command gets all unassigned LUNs from the storage pool associated with the host group stored in $HostGroup (New York).

The fourth command creates a GUID and stores it in the $JobID variable.

The fifth command assigns the LUNs stored in $Luns to the nodes that are to be clustered. The JobGroup parameter will delay running this command until the last command containing the JobGroup parameter runs.

The last command creates the cluster and names it Cluster01. Using the JobGroup parameter assigns the LUNs just propr to creating the cluster.

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

Add-SCVMHostCluster

Get-SCVMHostCluster

Move-SCVMHostCluster

Read-SCVMHostCluster

Remove-SCVMHostCluster

Set-SCVMHostCluster

Test-SCVMHostCluster

Uninstall-SCVMHostCluster