Set-SCVirtualizationManager
Set-SCVirtualizationManager
Changes the properties of a VMware vCenter Server that is managed by VMM.
Syntax
Parameter Set: Default
Set-SCVirtualizationManager [-VirtualizationManager] <VirtualizationManager> [-Certificate <ClientCertificate> ] [-Credential <VMMCredential> ] [-EnableSecureMode <Boolean> ] [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-TCPPort <UInt32]> ] [ <CommonParameters>]
Detailed Description
The Set-SCVirtualizationManager cmdlet changes one or more properties of a VMware vCenter Server that is managed by Virtual Machine Manager (VMM). A vCenter Server manages VMware ESX hosts and VMware-based virtual machines.
Properties that you can change include settings for the TCP port that is used to connect to the vCenter Server, credentials that are used to access the vCenter Server, and updating a vCenter Server security certificate.
If a security certificate for a vCenter Server expires or a self-signed certificate is replaced by a certificate from a third-party Certification Authority (CA), you must update both the vCenter Server and VMM:
-- First, replace the current vCenter certificate with the new certificate in vCenter. Refer to the VMware documentation for instructions.
-- Next, update the certificate in VMM by importing the new certificate into VMM. See example 3 for this cmdlet.
For more information about including a VMware vCenter Server as a virtualization manager in a Virtual Machine Manager environment, type Get-Help Add-SCVirtualizationManager -detailed.
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.
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 |
-EnableSecureMode<Boolean>
Indicates whether VMM communicates with VMware ESX hosts and Citrix XenServer hosts in secure mode. The default value is $True.
Aliases |
SecureMode |
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 Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit 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 |
-VirtualizationManager<VirtualizationManager>
Specifies a virtualization manager object managed by VMM.
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 (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
Notes
- This command requires a VMM virtualization manager object. To obtain one, use the Get-SCVirtualizationManager cmdlet.
Examples
Example 1: Specify new credentials for a virtualization manager
The first command gets the virtualization manager object named VirtMgrServer01 from the VMM database, and then stores the object in the $VirtManager variable.
The second command gets the Run As account named Host Computer Account 04, and then stores the account in the $Credential variable.
The last command changes the stored credentials for VirtMgrServer01 that are used when VMM connects to the external service.
PS C:\> $VirtManager = Get-SCVirtualizationManager -ComputerName "VirtMgrServer01.Contoso.com"
PS C:\> $Credential = Get-SCRunAsAccount -Name "RunAsAccount04"
PS C:\> Set-SCVirtualizationManager -VirtualizationManager $VirtManager -Credential $Credential