Add-SCVMHostCluster

Add-SCVMHostCluster

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

Syntax

Parameter Set: Default
Add-SCVMHostCluster [-Name] <String> -Credential <VMMCredential> [-AddVMHostJobsListVariable <String> ] [-BaseDiskPaths <String> ] [-ClusterReserve <UInt32]> ] [-Description <String> ] [-EnableLiveMigration <Boolean]> ] [-JobVariable <String> ] [-LiveMigrationMaximum <UInt32]> ] [-LiveStorageMigrationMaximum <UInt32]> ] [-MigrationAuthProtocol <MigrationAuthProtocolType]> ] [-MigrationPerformanceOption <MigrationPerformanceOptionType]> ] [-MigrationSubnet <String[]> ] [-NonTrustedDomainHost] [-PROTipID <Guid]> ] [-Reassociate <Boolean]> ] [-RemoteConnectEnabled <Boolean]> ] [-RemoteConnectPort <UInt32]> ] [-RunAsynchronously] [-UseAnyMigrationSubnet <Boolean]> ] [-VirtualizationManager <VirtualizationManager> ] [-VMHostGroup <HostGroup> ] [-VMMServer <ServerConnection> ] [-VMPaths <String> ] [ <CommonParameters>]

Parameter Set: XenServerHost
Add-SCVMHostCluster [-Name] <String> -Credential <VMMCredential> -XenServerHost [-AddVMHostJobsListVariable <String> ] [-BaseDiskPaths <String> ] [-Certificate <ClientCertificate[]> ] [-ClusterReserve <UInt32]> ] [-Description <String> ] [-EnableLiveMigration <Boolean]> ] [-EnableSecureMode <Boolean> ] [-JobVariable <String> ] [-LiveMigrationMaximum <UInt32]> ] [-LiveStorageMigrationMaximum <UInt32]> ] [-MigrationAuthProtocol <MigrationAuthProtocolType]> ] [-MigrationPerformanceOption <MigrationPerformanceOptionType]> ] [-MigrationSubnet <String[]> ] [-PROTipID <Guid]> ] [-Reassociate <Boolean]> ] [-RemoteConnectEnabled <Boolean]> ] [-RemoteConnectPort <UInt32]> ] [-RunAsynchronously] [-TCPPort <UInt32]> ] [-UseAnyMigrationSubnet <Boolean]> ] [-VirtualizationManager <VirtualizationManager> ] [-VMHostGroup <HostGroup> ] [-VMMServer <ServerConnection> ] [-VMPaths <String> ] [ <CommonParameters>]

Detailed Description

The Add-SCVMHostCluster cmdlet adds an existing Windows Server failover cluster, VMware ESX host cluster or a Citrix XenServer Resource Pool to the 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.

Parameters

-AddVMHostJobsListVariable<String>

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

-BaseDiskPaths<String>

Specifies the paths of base disks.

-Certificate<ClientCertificate[]>

Specifies a security certificate object.

-ClusterReserve<UInt32]>

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.

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

For more information about the PSCredential object, type Get-Help Get-Credential.

For more information about Run As accounts, type Get-Help New-SCRunAsAccount.

-Description<String>

States a description for the specified object.

-EnableLiveMigration<Boolean]>

Indicates whether live migration is enabled on the host.

-EnableSecureMode<Boolean>

Indicates whether VMM communicates with VMware ESX hosts and Citrix XenServer hosts in secure mode. The default value is $True.

-JobVariable<String>

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

-LiveMigrationMaximum<UInt32]>

Specifies the maximum number of simultaneous live migrations.

-LiveStorageMigrationMaximum<UInt32]>

Specifies the maximum number of simultaneous live storage migrations.

-MigrationAuthProtocol<MigrationAuthProtocolType]>

Specifies the authorization protocol used for migration. Valid values are: CredSSP or Kerberos.

-MigrationPerformanceOption<MigrationPerformanceOptionType]>

Specifies the migration performance option type. Valid values are:

-- Standard
-- UseCompression
-- UseSmbTransport

-MigrationSubnet<String[]>

Specifies an array of subnets to use for migration.

-Name<String>

Specifies the name of a VMM object.

-NonTrustedDomainHost

Indicates that the host to be added to VMM belongs to a non-trusted domain.

-PROTipID<Guid]>

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

-Reassociate<Boolean]>

Indicates that this cmdlet reassociates a host currently managed by one VMM server with another VMM server.

-RemoteConnectEnabled<Boolean]>

Indicates whether 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<UInt32]>

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

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

-TCPPort<UInt32]>

Specifies a numeric value that represents a TCP port.

-UseAnyMigrationSubnet<Boolean]>

Indicates whether any subnet can be used for migration.

-VirtualizationManager<VirtualizationManager>

Specifies a virtualization manager object managed by VMM.

-VMHostGroup<HostGroup>

Specifies a virtual machine host group object.

-VMMServer<ServerConnection>

Specifies a VMM server object.

-VMPaths<String>

Specifies a set of default paths, as strings separated by the pipeline operator, on a host where virtual machine files can be stored. Specify paths in the following format:

C:\Folder01|C:\Folder02|C:\Folder03

-XenServerHost

Indicates that the the host to be added to VMM is a Citrix XenServer host.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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

Example 1: Add a failover cluster to VMM

The first command gets the Run As account object named RunAsAccount01, and then 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 to 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.

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

Related topics

Add-SCVirtualizationManager

Find-SCCluster

Get-SCVMHostCluster

Install-SCVMHostCluster

Move-SCVMHostCluster

Read-SCVMHostCluster

Remove-SCVMHostCluster

Restart-SCJob

Set-SCVMHostCluster

Test-SCVMHostCluster

Uninstall-SCVMHostCluster

Get-SCRunAsAccount

Get-SCVMHostGroup