Syntax
Set-KeyManagementServer [-KeyManagementServer] <KeyManagementServer[]> [-Address <String>] [-Credential <PSCredential>] [-Password <SecureString>] [-Port <Int32>] [-ProxyAddress <String>] [-ProxyPort <Int32>] [-Server <VIServer[]>] [-TrustKeyManagementServer <Boolean>] [-Username <String>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet configures the settings of the key management server.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| KeyManagementServer | KeyManagementServer[] | Specifies the key management servers you want to configure. | true | True (ByValue) | |
| Address | String | Specifies the new address of the key management server. | false | False | |
| Confirm | SwitchParameter | If 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. | false | False | |
| Credential | PSCredential | Specifies a PSCredential object that contains credentials for authenticating with the key management server. | false | False | |
| Password | SecureString | Specifies 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. | false | False | |
| Port | Int32 | Specifies the new port number of the key management server. | false | False | |
| ProxyAddress | String | Specifies the new address of the proxy server. If you want to unset the address, set the value to an empty string. | false | False | |
| ProxyPort | Int32 | Specifies the new port number of the proxy server. If you want to unset the port number, set the value to -1. | false | False | |
| Server | VIServer[] | 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. | false | False | |
| TrustKeyManagementServer | Boolean | Indicates whether the vCenter Server system can trust the key management server certificate. Revoking trust of the key management server is not supported. | false | False | |
| Username | String | Specifies 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. | false | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
The list of modified KeyManagementServer objectsNotes
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'.