PowerCLI Reference

Add-EntityDefaultKeyProvider

This cmdlet adds a key provider to entities as default key provider.

Syntax

Add-EntityDefaultKeyProvider [-KeyProvider] <KmsCluster> [-Entity] <VIObject[]> [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet adds a key provider to entities as default key provider.

Parameters

Name	Type	Description	Required?	Pipeline Input
KeyProvider	KmsCluster	Specifies the key provider you want to add to the entities.	true	True (ByValue)
Entity	VIObject[]	Specifies the entities to which you want to add a default key provider. Only the Cluster type and the HostAndCluster type support this operation.	true	False
Confirm	SwitchParameter	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	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 the Connect-VIServer cmdlet.	false	False
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	False

Return Type

The key provider added to the entities.

Notes

Examples

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

$cluster  = Get-Cluster -name "MyCluster"
Add-EntityDefaultKeyProvider -KeyProvider (Get-KeyProvider)[0] -Entity $cluster

Adds the first key provider to entity "MyCluster" as default key provider.