Register-SCVMHost

Associates a VMware ESX host with VMM as a virtual machine host and specifies credentials to manage the host.

Syntax

Register-SCVMHost [-VMHost] <Host> [-Certificate <ClientCertificate>] [-Credential <VMMCredential>]
 [-JobVariable <String>] [-PROTipID <Guid>] [-RunAsynchronously] [-SshPublicKey <ClientSshPublicKey>]
 [-SshPublicKeyFile <String>] [-SshTcpPort <UInt32>] [-TCPPort <UInt32>] [<CommonParameters>]

Description

The Register-SCVMHost cmdlet associates a VMware ESX host with Virtual Machine Manager (VMM) as a virtual machine host and specifies the credentials to use with this ESX host.

Examples

Example 1: Set the credentials for a specific VMware ESX host

PS C:\> $RunAsAccount = Get-SCRunAsAccount -Name "ESX Host Computer Acct"
PS C:\> $ESXHost = Get-SCVMHost -ComputerName "ESXHost02.Contoso.com"
PS C:\> Register-SCVMHost -VMHost $ESXHost -Credential $RunAsAccount

The first command gets the Run As account object named ESX Host Computer Acct and stores the object in the $RunAsAccount variable.

The second command gets the ESX host object named ESXHost02 and stores the object in the $ESXHost variable.

The last command associates the VMware ESX host with VMM as a managed host, and specifies that the Run As account stored in $Credential should be used to access ESXHost02.

Example 2: Set the credentials and certificate for a specific VMware ESX host

PS C:\> $RunAsAccount = Get-SCRunAsAccount -Name "ESX Host Computer Acct"
PS C:\> $ESXHost = Get-SCVMHost -ComputerName "ESXHost03.contoso.com"
PS C:\> $Cert = Get-SCCertificate -ComputerName "ESXHost03.contoso.com"
PS C:\> Register-SCVMHost -VMHost $ESXHost -Credential $RunAsAccount -Certificate $Cert

The first command gets the Run As account object named ESX Host Computer Acct and stores the object in the $RunAsAccount variable. The required credentials for this operation are either a root account (root/<password>) or the account for the VMware delegated administrator defined earlier in VirtualCenter Server for this ESX host.

The second command gets the VMware ESX host object named ESXHost03 and stores the object in the $ESXHost variable.

The third command uses the Get-SCCertificate cmdlet to get the certificate object from ESXHost02 and stores the object in the $Cert variable.

The last command associates this VMware ESX Server with VMM as a managed host and specifies that the credentials used to access ESXHost02 are those stored in $RunAsAccount.

Parameters

-Certificate

Specifies a security certificate object.

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

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

Specifies the public key used by Secure Shell (SSH) communications.

Type:ClientSshPublicKey
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SshPublicKeyFile

Specifies the path to the public key file for establishing a secured SSH channel with the target hosts.

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

Specifies the TCP port number used by the SSH protocol.

Type:UInt32
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TCPPort

Specifies a numeric value that represents a TCP port.

Type:UInt32
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMHost

Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts.

For more information about each type of host, see the Add-SCVMHost cmdlet.

Type:Host
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Outputs

Host

This cmdlet returns a **Host** object.