PowerCLI Reference

Add-KeyProviderServiceInfo

Synopsis

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 [-ServiceAddress] <String> [-Confirm] [-FilePath <String>] [-Server <VIServer[]>] -ServiceGroup <String> [-ServicePort <Int32>] -TAClusterId <String> [-TrustedCA <X509Chain>] [-WhatIf] [<CommonParameters>]

Add-KeyProviderServiceInfo [-KeyProviderService] <TrustAuthorityKeyProviderService[]> [-Confirm] [-Server <VIServer[]>] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Remove-KeyProviderServiceInfo
Add-TrustedClusterKeyProviderServiceInfo
Remove-TrustedClusterKeyProviderServiceInfo
Get-TrustAuthorityKeyProviderService

Detailed Description

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.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
KeyProviderServiceTrustAuthorityKeyProviderService[]Specifies the Trust Authority key provider services that you want to retrieve from the Trust Authority System.trueTrue (ByValue)
ServiceAddressStringSpecifies the service address which you want to retrieve from the service address in the Trust Authority key provider service in the Trust Authority system.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
FilePathStringSpecifies 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.
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-CIServer cmdlet.falseFalse
ServiceGroupStringSpecifies the service group which you want to retrieve from the service group in the Trust Authority key provider service in the Trust Authority system.trueFalse
ServicePortInt32Specifies 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.falseFalse
TAClusterIdStringSpecifies 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.trueFalse
TrustedCAX509ChainSpecifies 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.
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.Security.Types.V1.TrustedInfrastructure.KeyProviderServiceInfo

Notes

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.


Copyright © VMware, Inc. All rights reserved.