Add-SCVirtualizationManager
Add-SCVirtualizationManager
Adds a VMware vCenter Server to VMM.
Syntax
Parameter Set: Default
Add-SCVirtualizationManager [-ComputerName] <String> -Credential <VMMCredential> [-Certificate <ClientCertificate> ] [-Description <String> ] [-EnableSecureMode <Boolean> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-TCPPort <UInt32> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Add-SCVirtualizationManager cmdlet adds a VMware vCenter Server to your Virtual Machine Manager (VMM) environment so that VMM can connect to the vCenter Server and import its data. After you add the vCenter Server to VMM, you need to add the VMware ESX hosts associated with the vCenter Server before VMM can manage the virtual machines deployed on those hosts.
The default port used to connect to a VMware VirtualCenter Server computer is TCP port 443.
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 |
-ComputerName<String>
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are: FQDN, IPv4 or IPv6 address, or NetBIOS name.
NOTE: See the examples for a specific cmdlet to determine how that cmdlet specifies the computer name.
Aliases |
none |
Required? |
true |
Position? |
1 |
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? |
True (ByValue) |
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 |
-EnableSecureMode<Boolean>
Indicates whether VMM communicates with VMware ESX hosts and Citrix XenServer hosts in secure mode. The default value is $True.
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 |
-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 |
-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 (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.
- VirtualizationManager
Examples
1: Add a VMware vCenter Server to VMM.
The first command gets the Run As account object named RunAsAccount03 and stores the object in the $RunAsAccount variable. The required credentials for this operation are either a local Administrator account or a domain account with administrator rights on the vCenter Server that you want to add as a virtualization manager to VMM.
The second command obtains the security certificate from vCenterrServer01 and stores it in the $Cert variable.
The last command adds the virtualization manager object named vCenterServer01 to the VMM database, imports the security certificate object, and specifies that VMM will use TCP port 443 (the default port) to connect to that server. As the last command is processed, $Credential provides your Run As credentials to Add-SCVirtualizationManager.
PS C:\> $RunAsAccount = Get-SCRunAsAccount -Name "RunAsAccount03"
PS C:\> $Cert = Get-SCCertificate -Computername "vCenterServer01.Contoso.com"
PS C:\> Add-SCVirtualizationManager -ComputerName "vCenterServer01.Contoso.com" -Certificate $Cert -TCPPort 443 -Credential $RunAsAccount
2: Add multiple VMware vCenter Servers to VMM.
The first command gets the Run As account object named RunAsAccount03 and stores the object in the $RunAsAccount variable. The required credentials for this operation are either a local Administrator account or a domain account with administrator rights on the vCenter Server that you want to add as a virtualization manager to VMM.
The second command stores the strings "vCenterServer01.Contoso.com" and "vCenterServer02.Contoso.com", which are the names of two VMware vCenter Servers, in the $Servers variable.
The last command adds the two servers to VMM and specifies that VMM will import the security certificates and use TCP port 443 (the default port) to connect to the virtualization manager service on vCenterServer01 and vCenterServer02. As this command is processed, $Credential provides your Run As credentials to Add-SCVirtualizationManager.
For more information about the standard Windows PowerShell foreach loop statement, type: Get-Help about_ForEach.
PS C:\> $Credential = Get-SCRunAsAccount -Name "RunAsAccount03"
PS C:\> $Servers = "vCenterServer01.Contoso.com", "vCenterServer02.Contoso.com"
PS C:\> ForEach ($Server in $Servers) {$Cert = Get-SCCertificate -Computername $Server; Add-SCVirtualizationManager -ComputerName $Server -Certificate $Cert -TCPPort 443 -Credential $Credential}