PowerCLI Reference

Get-KmsCluster

Synopsis

This cmdlet retrieves all key management server clusters from the vCenter Server system.

Syntax

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

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

Related Commands

Online Version
Set-KmsCluster

Detailed Description

This cmdlet retrieves all key management server clusters from the vCenter Server system.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the name of the key management server clusters you want to retrieve.	false	False
Id	String[]	Specifies the IDs of the key management server clusters 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 KmsCluster objects

Notes

Examples

-------------------------- Example 1 --------------------------

Get-KmsCluster -Server $myServer

Retrieves all key management server clusters from the $myServer vCenter Server system.

-------------------------- Example 2 --------------------------

Get-KmsCluster -Name 'ThalesCluster'

Retrieves a key management server cluster named 'ThalesCluster'.