PowerCLI Reference

New-TrustAuthorityKeyProvider

Synopsis

This cmdlet creates a new Trust Authority key provider in the Trust Authority vCenter Server system.

Syntax

New-TrustAuthorityKeyProvider [-TrustAuthorityCluster] <TrustAuthorityCluster> [-Name] <String> [-Confirm] [-ConnectionTimeOutSeconds <Int64>] [-Description <String>] -KmipServerAddress <String> [-KmipServerName <String>] [-KmipServerPassword <SecureString>] [-KmipServerPort <Int32>] [-KmipServerUsername <String>] -MasterKeyId <String> [-ProxyAddress <String>] [-ProxyPort <Int32>] [-Server <VIServer[]>] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-TrustAuthorityKeyProvider
Set-TrustAuthorityKeyProvider
Remove-TrustAuthorityKeyProvider

Detailed Description

This cmdlet creates a new Trust Authority key provider in the Trust Authority vCenter Server system.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
TrustAuthorityClusterTrustAuthorityClusterSpecifies the Trust Authority cluster in which you want to create the Trust Authority key provider.trueTrue (ByValue)
NameStringSpecifies the name of the Trust Authority key provider.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
ConnectionTimeOutSecondsInt64Specifies the timeout in seconds for the connection between the Trust Authority key provider and the KMIP servers.falseFalse
DescriptionStringSpecifies the description of the Trust Authority key provider.falseFalse
KmipServerAddressStringSpecifies the first KMIP server address in the Trust Authority key provider.trueFalse
KmipServerNameStringSpecifies the name of the first KMIP server in the Trust Authority key provider.falseFalse
KmipServerPasswordSecureStringSpecifies the password of the first KMIP server in the Trust Authority key provider.falseFalse
KmipServerPortInt32Specifies the port number of the first KMIP server in the Trust Authority key provider.falseFalse
KmipServerUsernameStringSpecifies the user name of the first KMIP server in the Trust Authority key provider.falseFalse
MasterKeyIdStringSpecifies the master key ID of the Trust Authority key provider that you want to generate by the KMIP servers.trueFalse
ProxyAddressStringSpecifies the proxy address of the Trust Authority key provider that you want to use to connect to the KMIP servers.falseFalse
ProxyPortInt32Specifies the proxy port number of the Trust Authority key provider that you use to connect to the KMIP servers. It works with the ProxyAddress parameter.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.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider

Notes

Examples

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

New-TrustAuthorityKeyProvider -TrustAuthorityCluster mycluster -Name mykp -MasterKeyId 1 -KmipServerAddress 1.1.1.1

Creates a new Trust Authority key provider in the Trust Authority cluster mycluster with the mykp and masterkeyId 1 names for all the Key Management Interoperability Protocol (KMIP) servers in this key provider. Adds KMIP server with the 1.1.1.1 address to the key provider.


Copyright © VMware, Inc. All rights reserved.