Key Category | Vmware PowerCLI Reference

Key Category

Cmdlets are usually implemented around resource operations. The four basic operations are CREATE, READ, UPDATE and DELETE. This set of operations is known as CRUD. Most of the cmdlets support CRUD which are respectively cmdlets that start with the New/Get/Set/Remove cmdlet verbs but they also may have additional operations

Step 1: Retrieve a object by running a Get command

You can READ objects by using Get-KeyProviderServiceInfo cmdlet. See example below:

# Retrieves a list of the available key provider service information configured in the workload vCenter Server system.


Step 2 : Run commands from the CRUD group

You can UPDATE objects by using Add-KeyProviderServiceInfo cmdlet. See example below:

# Adds the key provider service information to the workload vCenter Server system by specifying the TrustAuthorityKeyProviderService objects that you want to retrieve from the Trust Authority system.

$kmxService = Get-TrustAuthorityKeyProviderService -Server trustAuthoritySystem Add-KeyProviderServiceInfo -KeyProviderService $kmxService -Server workloadSystem
You can REMOVE objects by using Remove-KeyProviderServiceInfo cmdlet. See example below:

# Removes the key provider services information configured in the connected workload vCenter Server system.

$kmxd = Get-KeyProviderServiceInfo Remove-KeyProviderServiceInfo -KeyProviderServiceInfo $kmxd

Step 3: Explore More Related Commands:

Export-KeyProvider This cmdlet exports a specified key provider configuration to a specified file. You can use only the NativeKeyProvider type for the KeyProvider parameter.
Import-KeyProvider This cmdlet imports a key provider from a specified configuration file.
Register-KeyProvider This cmdlet registers a trusted key provider in the workload vCenter Server system which you can use for encryption operations.
Unregister-KeyProvider 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.
Add-KeyManagementServer This cmdlet adds a key management server to a vCenter Server system.
Get-KeyManagementServer This cmdlet retrieves the key management servers registered on the vCenter Server system.
Get-KeyProvider This cmdlet retrieves all key providers from the vCenter Server system.
Remove-KeyManagementServer This cmdlet removes the specified key management servers from the vCenter Server systems.
Set-KeyManagementServer This cmdlet configures the settings of the key management server.
Set-KeyProvider This cmdlet modifies the settings of the specified key provider.