Set-KeyManagementServer

NAME Set-KeyManagementServer



SYNOPSIS

This cmdlet configures the settings of the key management server.





SYNTAX

Set-KeyManagementServer [-KeyManagementServer] <KeyManagementServer[]> [-Address <String>] [-Credential

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

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





DESCRIPTION

This cmdlet configures the settings of the key management server.





PARAMETERS

-Address <String>

Specifies the new address of the key management server.



Required? false

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



-KeyManagementServer <KeyManagementServer[]>

Specifies the key management servers you want to configure.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Password <SecureString>

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

Protocol server. If you want to unset the password, set the value to an empty string.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Port <Int32>

Specifies the new port number of the key management server.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProxyAddress <String>

Specifies the new address of the proxy server. If you want to unset the address, set the value to an empty

string.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProxyPort <Int32>

Specifies the new port number of the proxy server. If you want to unset the port number, set the value to -1.



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? false



-TrustKeyManagementServer <Boolean>

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

the key management server is not supported.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Username <String>

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

Protocol server. If you want to unset the user name, set the value to an empty string.



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 list of modified KeyManagementServer objects







NOTES









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



Set-KeyManagementServer -KeyManagementServer $kms -Address $newKmsAddress -Port $newKmsPort



Updates the $kms key management server with $newKmsAddress as the new key management server address and

$newKmsPort as the new key management server port.

-------------------------- Example 2 --------------------------



Set-KeyManagementServer -KeyManagementServer $kms -Name 'NewName'



Renames the $kms key management server to 'NewName'.



RELATED LINKS

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

Add-KeyManagementServer

Get-KeyManagementServer

Remove-KeyManagementServer