PowerCLI Reference



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


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

Related Commands

Online Version

Detailed Description

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


NameTypeDescriptionRequired?Pipeline InputDefault Value
KeyProviderKmsClusterSpecifies the key provider you want to add to the entities.trueTrue (ByValue)
EntityVIObject[]Specifies the entities to which you want to add a default key provider. Only the Cluster type and the HostAndCluster type support this operation.trueFalse
ConfirmSwitchParameterIf 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.falseFalse
ServerVIServer[]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.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The key provider added to the entities.



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

Copyright © VMware, Inc. All rights reserved.