Add-KeyProviderServiceInfo Command | Vmware PowerCLI Reference

Add-KeyProviderServiceInfo

This cmdlet adds key provider service information, which comes from the Trust Authority key provider service running in the Trust Authority system or its detailed information in the workload vCenter Server system.

Syntax

Add-KeyProviderServiceInfo
-KeyProviderService < TrustAuthorityKeyProviderService[] >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 KeyProviderService TrustAuthorityKeyProviderService[] named
  • pipeline
 Specifies the Trust Authority key provider services that you want to retrieve from the Trust Authority System.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-CIServer cmdlet.
Add-KeyProviderServiceInfo
-ServiceAddress < String >
-ServiceGroup < String >
-TAClusterId < String >
[-FilePath < String > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-ServicePort < Int32 > ]
[-TrustedCA < X509Chain > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 ServiceAddress String named
Specifies the service address which you want to retrieve from the service address in the Trust Authority key provider service in the Trust Authority system.
required
 ServiceGroup String named
Specifies the service group which you want to retrieve from the service group in the Trust Authority key provider service in the Trust Authority system.
required
 TAClusterId String named
Specifies the Trust Authority cluster ID which you want to retrieve from the Trust Authority cluster ID in the running Trust Authority key provider service in the Trust Authority system.
optional FilePath String named
Specifies a file that stores the X509Chain data that you want to use to connect to the Trust Authority key provider service. Either this parameter or the TrustedCA should be specified.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-CIServer cmdlet.
optional ServicePort Int32 named
Specifies the number of the service port which you want to retrieve from the service port in the Trust Authority key provider service in the Trust Authority system.
optional TrustedCA X509Chain named
Specifies the Trusted Certificate Authority that you want to retrieve from the Trusted Certificate Authority in the running Trust Authority key provider service in the Trust Authority system. Either this parameter or the FilePath should be specified.

Output

VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.KeyProviderServiceInfo

Examples

Example 1 

$kmxService = Get-TrustAuthorityKeyProviderService -Server trustAuthoritySystem
Add-KeyProviderServiceInfo -KeyProviderService $kmxService -Server workloadSystem

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.

Example 2 

$kmxService = Get-TrustAuthorityKeyProviderService -Server trustAuthoritySystem | select -First 1
Add-AttestationServiceInfo -ServiceAddress $kmxService.ServiceAddress -ServiceGroup $kmxService.ServiceGroup -TAClusterId $kmxService.TrustAuthorityClusterId -TrustedCA $kmxService.TrustedCA -ServicePort $kmxService.ServicePort -Server workloadSystem

Adds the key provider service information to the workload vCenter Server system by specifying detailed information of the Trust Authority key provider service that runs in the Trust Authority system.

Related Commands

KeyManagementServer

This cmdlet adds a key management server to a vCenter Server system.

This cmdlet retrieves the key management servers registered on the vCenter Server system.

This cmdlet removes the specified key management servers from the vCenter Server systems.

This cmdlet configures the settings of the key management server.

KeyProvider

This cmdlet exports a specified key provider configuration to a specified file. You can use only the NativeKeyProvider type for the KeyProvider parameter.

This cmdlet imports a key provider from a specified configuration file.

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

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.

This cmdlet retrieves all key providers from the vCenter Server system.

This cmdlet modifies the settings of the specified key provider.

KeyProviderServiceInfo

This cmdlet adds key provider service information, which comes from the Trust Authority key provider service running in the Trust Authority system or its detailed information in the workload vCenter Server system.

This cmdlet retrieves the key provider services information configured in the workload vCenter Server system.

This cmdlet removes the specified key provider services information from the workload vCenter Server system.