Get-VBRKMSServer

Short Description

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

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get KMS servers by the KMS server ID.

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

  • Get KMS servers by the KMS server name.

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

Detailed Description

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

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

Example 1. Getting KMS Server by ID

Example 2. Getting KMS Server by Name

Page updated 8/14/2024

Page content applies to build 12.3.2.3617