---
title: "Set-VBRKMSServer"
description: "This cmdlet modifies settings of Key Management System servers (KMS server) added to the Veeam Backup & Replication console. To modify settings, specify new values for the necessary parameters."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrkmsserver.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Working with KMS Servers > Set-VBRKMSServer"
dateModified: "2026-08-19"
---

# Set-VBRKMSServer

## Short Description
Modifies settings of KMS servers.

**Product Edition**: Standard, Enterprise, Enterprise Plus, Veeam Universal License

## Syntax
```
Set-VBRKMSServer -Server <VBRKMSServer> [-Description <String>] [-Port <Int32>]
 [-CACertificate <X509Certificate2>] [-ClientCertificate <X509Certificate2>]
 [-WhatIf] [-Confirm] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies settings of Key Management System servers (KMS server) added to the Veeam Backup & Replication console.

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">CACertificate</span></p>
        </td>
        <td>
          <p>Specifies the KMS server certificate.</p>
        </td>
        <td style="width:10%;">
          <p><code>X509Certificate2</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ClientCertificate</span></p>
        </td>
        <td>
          <p>Specifies the client certificate issued by the KMS administrator for Veeam Backup & Replication.</p><p><strong>Note</strong>: The client certificate must contain a private key and be exportable.</p>
        </td>
        <td style="width:10%;">
          <p><code>X509Certificate2</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Description</span></p>
        </td>
        <td>
          <p>Specifies description of the KMS server.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Port</span></p>
        </td>
        <td>
          <p>Specifies a port number to connect to the KMS server.</p><p>Default: <code>5696</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Server</span></p>
        </td>
        <td>
          <p>Specifies a KMS server which settings you want to modify.</p><p>Accepts the <code>VBRKMSServer</code> object. To get this object, run the <a href="get-vbrkmsserver.md"><code>Get-VBRKMSServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrkmsserver.md"><code>VBRKMSServer</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Confirm</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will display a prompt that asks if you want to continue running the command.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">WhatIf</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
[`VBRKMSServer`](vbrkmsserver.md)

## Examples

::: example
### Modifying KMS Server Settings

This example shows how to modify the port number for the KMS server added to the Veeam Backup & Replication console.

```
$server = Get-VBRKMSServer -Id "8f723f68-82c6-430d-8915-58a0582440a4"
Set-VBRKMSServer -Server $server -Port 5696
```

Perform the following steps:

1. Run the [`Get-VBRKMSServer`](get-vbrkmsserver.md) cmdlet. Specify the `Id` parameter values. Save the result to the `$server` variable.
2. Run the `Set-VBRKMSServer` cmdlet. Set the `$server` variable as the `Server` parameter value. Specify the `Port` parameter value.

:::

## Related Commands

[`Get-VBRKMSServer`](get-vbrkmsserver.md)