Get-KeyManagementServer
This cmdlet retrieves the key management servers registered on the vCenter Server system and can filter the result by name, key provider, key management server address, and ID.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | KeyProvider | KeyProvider[] | 1 |
|
Specifies the list of the key providers by which you want to filter the results. |
| optional | Name | String[] | named |
|
Specifies the name or alias of the key management server you want to retrieve. |
| 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 the Connect-VIServer cmdlet. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Address | String[] | named |
|
Specifies the IPv4, IPv6, or DNS address of the key management server. |
| 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 the Connect-VIServer cmdlet. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | String[] | named |
|
Specifies the IDs of the key management servers you want to retrieve. |
| 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 the Connect-VIServer cmdlet. |
Output
VMware.VimAutomation.Storage.Types.V1.Encryption.KeyManagementServerExamples
Example 1
Get-KeyManagementServer -Server $myServer
Retrieves all key management servers on the $myServer vCenter Server system.
Example 2
Get-KeyManagementServer -Name 'KMS'
Retrieves a key management server named 'KMS'.
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.