PowerCLI Reference

Set-KeyManagementServer

Synopsis

This cmdlet configures the settings of the key management server.

Syntax

Set-KeyManagementServer [-KeyManagementServer] <KeyManagementServer[]> [-Address <String>] [-Port <Int32>] [-TrustKeyManagementServer <Boolean>] [-ProxyAddress <String>] [-ProxyPort <Int32>] [-Username <String>] [-Password <SecureString>] [-Credential <PSCredential>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Add-KeyManagementServer
Get-KeyManagementServer
Remove-KeyManagementServer

Detailed Description

This cmdlet configures the settings of the key management server.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
KeyManagementServerKeyManagementServer[]Specifies the key management servers you want to configure.truetrue (ByValue)
AddressStringSpecifies the new address of the key management server.falsefalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse
CredentialPSCredentialSpecifies a PSCredential object that contains credentials for authenticating with the key management server.falsefalse
PasswordSecureStringSpecifies the new password you want to use for authenticating with the Key Management Interoperability Protocol server. If you want to unset the password, set the value to an empty string.falsefalse
PortInt32Specifies the new port number of the key management server.falsefalse
ProxyAddressStringSpecifies the new address of the proxy server. If you want to unset the address, set the value to an empty string.falsefalse
ProxyPortInt32Specifies the new port number of the proxy server. If you want to unset the port number, set the value to -1.falsefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
TrustKeyManagementServerBooleanIndicates whether the vCenter Server system can trust the key management server certificate. Revoking trust of the key management server is not supported.falsefalse
UsernameStringSpecifies the new user name you want to use for authenticating with the Key Management Interoperability Protocol server. If you want to unset the user name, set the value to an empty string.falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

The list of modified KeyManagementServer objects

Notes

Examples

-------------- Example 1 --------------

Set-KeyManagementServer -KeyManagementServer $kms -Address $newKmsAddress -Port $newKmsPort

Updates the $kms key management server with $newKmsAddress as the new key management server address and $newKmsPort as the new key management server port.

-------------- Example 2 --------------

Set-KeyManagementServer -KeyManagementServer $kms -Name 'NewName'

Renames the $kms key management server to 'NewName'.


Copyright © VMware, Inc. All rights reserved.