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

[[-KeyProvider]  <KmsCluster[]>]
[-Name  <String[]>]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
KeyProvider
KmsCluster[] 1
  • wildcards
  • pipeline
  • Specifies the list of the key providers by which you want to filter the results.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the name or alias of the key management server you want to retrieve.
    optional
    Server
    VIServer[] named
  • wildcards
  • 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.

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

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

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

    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
  • wildcards
  • 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.KeyManagementServer

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

    Related Commands

    Feedback

    Was this page helpful?