PowerCLI Reference

Register-KeyProvider

Synopsis

This cmdlet registers a trusted key provider in the workload vCenter Server system which you can use for encryption operations.

Syntax

Register-KeyProvider [-KeyProvider] <KmsCluster[]> [-Confirm] [-Server <VIServer[]>] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Unregister-KeyProvider

Detailed Description

This cmdlet registers a trusted key provider in the workload vCenter Server system which you can use for encryption operations.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
KeyProviderKmsCluster[]Specifies the key provider that you want to register. If the given key provider's type is KeyProvider, the cmdlet fails.trueTrue (ByValue)
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

VMware.VimAutomation.ViCore.Types.V1.Security.KeyProvider

Notes

Examples

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

$kp = Get-KeyProvider | Where-Object {$_.Type -eq 'TrustedKeyProvider'}
Register-KeyProvider -KeyProvider $kp

Registers all trusted key providers in the connected workload vCenter Server system.


Copyright © VMware, Inc. All rights reserved.