PowerCLI Reference

Unregister-KeyProvider

Synopsis

This cmdlet unregisters the specified key provider from the workload vCenter Server system. For a trusted key provider, you cannot use it in encryption operations. For a standard key provider, you can remove it from the workload vCenter Server system.

Syntax

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

Related Commands

Online Version
Get-KeyProvider
Register-KeyProvider

Detailed Description

This cmdlet unregisters the specified key provider from the workload vCenter Server system. For a trusted key provider, you cannot use it in encryption operations. For a standard key provider, you can remove it from the workload vCenter Server system.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
KeyProviderKmsCluster[]Specifies the key providers that you want to unregister or remove.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

System.Void

Notes

Examples

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

Unregister-KeyProvider -KeyProvider mykp

Unregisters the key provider mykp from the connected workload vCenter Server system.


Copyright © VMware, Inc. All rights reserved.