Add-KeyManagementServer

NAME Add-KeyManagementServer



SYNOPSIS

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





SYNTAX

Add-KeyManagementServer [-Name] <String> [-KmsCluster] <String> -Address <String> [-Credential <PSCredential>]

[-Password <SecureString>] -Port <Int32> [-ProxyAddress <String>] [-ProxyPort <Int32>] [-Server <VIServer[]>]

-TrustKeyManagementServer <Boolean> [-Username <String>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-Address <String>

Specifies the address of the Key Management Interoperability Protocol server.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Specifies a PSCredential object that contains credentials for authenticating with the key management server.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-KmsCluster <String>

Specifies the key management server cluster to which you want to add the key management server. This parameter

also accepts objects of type KmsCluster through an ArgumentTransformationAttribute object.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the Key Management Interoperability Protocol server you want to add.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Password <SecureString>

Specifies the password you want to use for authenticating with the Key Management Interoperability Protocol

server.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Port <Int32>

Specifies the port number of the Key Management Interoperability Protocol server.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProxyAddress <String>

Specifies the address of the proxy server.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProxyPort <Int32>

Specifies the port number of the proxy server.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Server <VIServer[]>

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 Connect-VIServer.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-TrustKeyManagementServer <Boolean>

Indicates whether the vCenter Server system can trust the key management server certificate.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Username <String>

Specifies the user name you want to use for authenticating with the Key Management Interoperability Protocol

server.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

If 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.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

The newly added KeyManagementServer object







NOTES









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



Add-KeyManagementServer -Name 'KMS' -KmsCluster 'KmsCluster' -Address $kmsAddress -Port $kmsPort -ProxyAddress

$proxyAddress -ProxyPort $proxyPort -TrustKeyManagementServer $true



Adds the key management server named 'KMS' to the 'KmsCuster' cluster that runs at the $kmsAddress address,

$kmsPort port, and trusts the key management server certificate.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... erver.html

Get-KeyManagementServer

Remove-KeyManagementServer

Set-KeyManagementServer