PowerCLI Reference

Get-KeyManagementServer

Synopsis

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

Syntax

Get-KeyManagementServer -Address <String[]> [-Server <VIServer[]>] [<CommonParameters>]

Get-KeyManagementServer -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]

Get-KeyManagementServer [[-Name] <String[]>] [[-KmsCluster] <KmsCluster[]>] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online Version
Add-KeyManagementServer
Remove-KeyManagementServer
Set-KeyManagementServer

Detailed Description

This cmdlet retrieves the key management servers registered on the vCenter Server system and can filter the result by name, key management server cluster, key management server address, and ID.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the name or alias of the key management server you want to retrieve.	false	False
KmsCluster	KmsCluster[]	Specifies the list of the key management server clusters by which you want to filter the results.	false	True (ByValue)
Address	String[]	Specifies the IPv4, IPv6, or DNS address of the key management server.	true	False
Id	String[]	Specifies the IDs of the key management servers you want to retrieve.	true	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

Return Type

Zero or more KeyManagementServer objects

Notes

Examples

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