Export (0) Print
Expand All
Expand Minimize

Register-SCVMHost

Updated: April 29, 2014

Applies To: System Center 2012 R2 Virtual Machine Manager

Register-SCVMHost

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

Syntax

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




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

Parameters

-Certificate<ClientCertificate>

Specifies a security certificate object.


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?

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

-SshPublicKey<ClientSshPublicKey>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SshPublicKeyFile<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SshTcpPort<UInt32>

Specifies the TCP port number used by the Secure Shell (SSH) protocol.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TCPPort<UInt32>

Specifies a numeric value that represents a TCP port.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMHost<Host>

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, type Get-Help Add-SCVMHost -detailed. See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.


Aliases

none

Required?

true

Position?

1

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.

  • Host

Examples

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

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

The second command gets the ESX host object named ESXHost02, and then 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.


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

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

The first command gets the Run As account object named ESX Host Computer Acct, and then 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 then stores the object in the $ESXHost variable.

The third command uses the Get-SCCertificate cmdlet to get the certificate object from ESXHost02, and then 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.


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

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft