Set-KeyManagementServer Command | Vmware PowerCLI Reference

Set-KeyManagementServer

This cmdlet configures the settings of the key management server.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
 KeyManagementServer KeyManagementServer[] named
  • pipeline
  • wildcards
 Specifies the key management servers you want to configure.
optional Address String named
Specifies the new address of the key management server.
optional Credential PSCredential named
Specifies a PSCredential object that contains credentials for authenticating with the key management server.
optional Password SecureString named
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.
optional Port Int32 named
Specifies the new port number of the key management server.
optional ProxyAddress String named
Specifies the new address of the proxy server. If you want to unset the address, set the value to an empty string.
optional ProxyPort Int32 named
Specifies the new port number of the proxy server. If you want to unset the port number, set the value to -1.
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
optional TrustKeyManagementServer Boolean named
Indicates whether the vCenter Server system can trust the key management server certificate. Revoking trust of the key management server is not supported.
optional Username String named
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.

Output

VMware.VimAutomation.Storage.Types.V1.Encryption.KeyManagementServer

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

Related Commands

KeyManagementServer

This cmdlet adds a key management server to a vCenter Server system.

This cmdlet retrieves the key management servers registered on the vCenter Server system.

This cmdlet removes the specified key management servers from the vCenter Server systems.

This cmdlet configures the settings of the key management server.

KeyProvider

This cmdlet exports a specified key provider configuration to a specified file. You can use only the NativeKeyProvider type for the KeyProvider parameter.

This cmdlet imports a key provider from a specified configuration file.

This cmdlet registers a trusted key provider in the workload vCenter Server system which you can use for encryption operations.

This cmdlet unregisters the specified key provider from the workload vCenter Server system. For a trusted key provider, you cannot use it in encryption operations. For a standard key provider, you can remove it from the workload vCenter Server system.

This cmdlet retrieves all key providers from the vCenter Server system.

This cmdlet modifies the settings of the specified key provider.

KeyProviderServiceInfo

This cmdlet adds key provider service information, which comes from the Trust Authority key provider service running in the Trust Authority system or its detailed information in the workload vCenter Server system.

This cmdlet retrieves the key provider services information configured in the workload vCenter Server system.

This cmdlet removes the specified key provider services information from the workload vCenter Server system.