Get-VBOServerComponents

Short Description

Returns components of the Veeam Backup for Microsoft 365 server.

Syntax

Get-VBOServerComponents [-Name <string>] [-Id <guid>] [<CommonParameters>]

Detailed Description

This cmdlet returns the specified components of the Veeam Backup for Microsoft 365 server.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Name

Specifies a name of the Veeam Backup for Microsoft 365 server component. The cmdlet will return the server component with the specified name. You can get a collection of components of the following types:

  • Proxy
  • Controller
  • Console
  • PowerShell

Note: This parameter is case-sensitive.

String

False

Named

False

False

Id

Specifies an ID of the Veeam Backup for Microsoft 365 server component. The cmdlet will return component with the specified ID.

Guid

True

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Get-VBOServerComponentsExample 1. Getting All Server Components

This command gets all server components connected to the Veeam Backup for Microsoft 365 console. The cmdlet output will provide the following details on server components: Id, Name, ServerName, IsOnline and ExtendedLoggingEnabled.

Get-VBOServerComponents

Id                     : 1c426a3c-aad7-4a26-ad74-0c36e7f8feb4

Name                   : Proxy

ServerName             : ProxyServer01

IsOnline               : True

ExtendedLoggingEnabled : False

 

Id                     : e9454a9e-d0b1-43cf-947e-53631fe49bbd

Name                   : Proxy

ServerName             : ProxyServer02

IsOnline               : True

ExtendedLoggingEnabled : False

 

Id                     : adc79622-7ff2-4055-bc9f-7ae8ebcd87ef

Name                   : Server, PowerShell

ServerName             : BackupServer

IsOnline               : True

ExtendedLoggingEnabled : False

Get-VBOServerComponentsExample 2. Getting Backup Proxy Components

This command gets all backup proxy servers connected to the Veeam Backup for Microsoft 365 console. The cmdlet output will provide the following details on backup proxy servers: Id, Name, ServerName, IsOnline and ExtendedLoggingEnabled.

Get-VBOServerComponents -Name "Proxy"

Id                     : 1c426a3c-aad7-4a26-ad74-0c36e7f8feb4

Name                   : Proxy

ServerName             : ProxyServer01

IsOnline               : True

ExtendedLoggingEnabled : False

 

Id                     : e9454a9e-d0b1-43cf-947e-53631fe49bbd

Name                   : Proxy

ServerName             : ProxyServer02

IsOnline               : True

ExtendedLoggingEnabled : False