Get-KeyManagementServer

NAME 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>]





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

-Address <String[]>

Specifies the IPv4, IPv6, or DNS address of the key management server.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Id <String[]>

Specifies the IDs of the key management servers you want to retrieve.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-KmsCluster <KmsCluster[]>

Specifies the list of the key management server clusters by which you want to filter the results.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Name <String[]>

Specifies the name or alias of the key management server you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? true



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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more KeyManagementServer objects







NOTES









-------------------------- 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 LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... erver.html

Add-KeyManagementServer

Remove-KeyManagementServer

Set-KeyManagementServer