Get-VBRKMSServer

Short Description

Returns KMS servers added to the Veeam Backup & Replication console.

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

Syntax

This cmdlet provides the following parameter sets:

  • Name (Default)

    Get-VBRKMSServer [-Name <String[]>] [<CommonParameters>]

  • Id

    Get-VBRKMSServer -Id <Guid[]> [<CommonParameters>]

Detailed Description

This cmdlet returns a Key Management System server (KMS server) added to the Veeam Backup & Replication console.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Id

Specifies an array of IDs for KMS servers. The cmdlet will return KMS servers with these IDs.

Guid[]

True

Named

True (ByPropertyName, ByValue)

Name

Specifies an array of names for KMS servers. The cmdlet will return KMS servers with these names.

String[]

False

Named

True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRKMSServer

Examples

Get-VBRKMSServerExample 1. Getting KMS Server by ID

This command returns the 8f723f68-82c6-430d-8915-58a0582440a4 and 8f723f68-82c6-430d-8915-58a0582440a4 KMS servers.

Get-VBRKMSServer -Id "8f723f68-82c6-430d-8915-58a0582440a4" , "8f723f68-82c6-430d-8915-58a0582440a4"

Get-VBRKMSServerExample 2. Getting KMS Server by Name

This command returns the thales.tech.local KMS server.

Get-VBRKMSServer -Name "thales.tech.local"

Page updated 2026-08-19

Page content applies to build 13.1.1.18