Add-SCVMHostCluster

Adds a Windows Server failover cluster, VMware ESX host cluster or Citrix XenServer resource pool to VMM.

Description

The Add-SCVMHostCluster cmdlet adds an existing Windows Server failover cluster, VMware ESX host cluster or a Citrix XenServer Resource Pool to the System Center Virtual Machine Manager (VMM) database so that VMM can manage the host cluster. 

Before you can use the Add-SCVMHostCluster cmdlet to add a Windows Server cluster to VMM, you must use the Failover Cluster Management tool to create and configure the host cluster. To create a host cluster by using VMM, use the Install-SCVMHostCluster cmdlet.

Before you can use the Add-SCVMHostCluster cmdlet to add a Citrix XenServer resource pool to VMM, you must use Citrix XenCenter to create and configure the resource pool.

Prior to using Add-SCVMHostCluster to add ESX host clusters, you must use the Add-SCVirtualizationManager cmdlet to add a VMware vCenter Server to your VMM environment and import its data. After you add the vCenter Server to VMM, you can add and manage VMware ESX clusters using VMM.

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

Parameters

Name

Required? true
Accept Pipeline Input? false
Position? 0 
Specifies the name of a VMM object.

Credential

Required? true
Accept Pipeline Input? false
Position? named 
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".

AddVMHostJobsListVariable

Required? false
Accept Pipeline Input? false
Position? named 
Returns an array of job variable objects for jobs that are created for each node when hosts in a host cluster are added to VMM. VMM uses these job variables to track the progress of each job individually.

ClusterReserve

Required? false
Accept Pipeline Input? false
Position? named 
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.

Description

Required? false
Accept Pipeline Input? false
Position? named 
States a description for the specified object.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

NonTrustedDomainHost

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the host to be added to VMM belongs to a non-trusted domain.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Reassociate

Required? false
Accept Pipeline Input? false
Position? named 
Reassociates a host currently managed by one VMM server with another VMM server.

RemoteConnectEnabled

Required? false
Accept Pipeline Input? false
Position? named 
Enables, when set to $True, a connection on a host server that lets users connect to their virtual machines remotely. This parameter only applies to virtual machines on Hyper-V hosts. It is not applicable to virtual machines on VMware ESX hosts or Citrix XenServer hosts.

RemoteConnectPort

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a default value for the TCP port to use when a remote user connects to a virtual machine. Typically, the default port for a Hyper-V host is 2179. This parameter does not apply to VMware ESX hosts or Citrix XenServer hosts.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VirtualizationManager

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a virtualization manager object managed by VMM.

VMHostGroup

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a virtual machine host group object.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

VMPaths

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a set of default paths (as strings separated by the pipeline operator) on a host where virtual machine files can be stored.

Example format: -VMPaths "C:\Folder1|C:\Folder2|C:\Folder3"

Name

Required? true
Accept Pipeline Input? false
Position? 0 
Specifies the name of a VMM object.

Credential

Required? true
Accept Pipeline Input? false
Position? named 
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".

XenServerHost

Required? true
Accept Pipeline Input? false
Position? named 
Indicates that the specified host is a Citrix XenServer host.

AddVMHostJobsListVariable

Required? false
Accept Pipeline Input? false
Position? named 
Returns an array of job variable objects for jobs that are created for each node when hosts in a host cluster are added to VMM. VMM uses these job variables to track the progress of each job individually.

Certificate

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a security certificate object.

ClusterReserve

Required? false
Accept Pipeline Input? false
Position? named 
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.

Description

Required? false
Accept Pipeline Input? false
Position? named 
States a description for the specified object.

EnableSecureMode

Required? false
Accept Pipeline Input? false
Position? named 
Indicates whether VMM communicates with VMware ESX hosts and Citrix XenServer hosts in secure mode. The default value is $True.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Reassociate

Required? false
Accept Pipeline Input? false
Position? named 
Reassociates a host currently managed by one VMM server with another VMM server.

RemoteConnectEnabled

Required? false
Accept Pipeline Input? false
Position? named 
Enables, when set to $True, a connection on a host server that lets users connect to their virtual machines remotely. This parameter only applies to virtual machines on Hyper-V hosts. It is not applicable to virtual machines on VMware ESX hosts or Citrix XenServer hosts.

RemoteConnectPort

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a default value for the TCP port to use when a remote user connects to a virtual machine. Typically, the default port for a Hyper-V host is 2179. This parameter does not apply to VMware ESX hosts or Citrix XenServer hosts.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

TCPPort

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a numeric value that represents a TCP port.

VirtualizationManager

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a virtualization manager object managed by VMM.

VMHostGroup

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a virtual machine host group object.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

VMPaths

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a set of default paths (as strings separated by the pipeline operator) on a host where virtual machine files can be stored.

Example format: -VMPaths "C:\Folder1|C:\Folder2|C:\Folder3"

Examples

1: Add a failover cluster to VMM. 
PS C:\> $Credential = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> $VMHostGroup = Get-SCVMHostGroup | where {$_.Path -eq "All Hosts"}
PS C:\> Add-SCVMHostCluster -Name "VMHostCluster01.Contoso.com" -VMHostGroup $VMHostGroup -RemoteConnectEnabled $True -RemoteConnectPort 5900 -Credential $Credential

The first command gets the Run As account object named RunAsAccount01 and stores the object in the $Credential variable. The Run As account used for this operation must be a domain account with administrator rights on all the nodes of the failover cluster that you want to add.

The second command gets the host group object "All Hosts". This is the host group that will be the container for the nodes in this host cluster.

The last command adds the failover cluster VMHostCluster01 to the VMM database, specifies "All Hosts" as the host group, enables remote connections, and specifies that TCP port 5900 will be used for remote connections to each node of the cluster. As the last command is processed, variable $Credential provides the stored Run As account to Add-SCVMHostCluster.

See Also