Get-VBOProxy
Short Description
Returns a list of backup proxy servers added to the Veeam Backup for Microsoft 365 infrastructure.
Syntax
This cmdlet provides parameter sets that allow you to:
- Get a backup proxy server by the server DNS name or IP address.
- Get a backup proxy server by the server ID.
- Get a list of backup proxy servers by the specified organization.
Get-VBOProxy [-Organization <VBOOrganization>] [-ExtendedView <switchparameter>] [<CommonParameters>] |
Detailed Description
This cmdlet returns a list of backup proxy servers added to the Veeam Backup for Microsoft 365 backup infrastructure.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
---|---|---|---|---|---|---|
Hostname | Specifies a DNS name or an IP address of the backup proxy server that you want to get. | String | True | Named | False | False |
Id | Specifies an ID of a backup proxy server. The cmdlet will return the backup proxy server with the specified ID. | Guid | True | Named | False | False |
Organization | Specifies a Microsoft organization. The cmdlet will return the backup proxy that is assigned to the specified organization. | Accepts the VBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet. | False | Named | True (ByValue) | False |
ExtendedView | Defines whether the cmdlet will return all parameters of the backup proxy server (if the proxy server is online) or exclude from a list the following parameters:
Default: True | SwitchParameter | False | 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.
Output Object
The cmdlet returns the VBOProxy object that contains a list of backup proxy servers added to the Veeam Backup for Microsoft 365 backup infrastructure.
Examples
Example 1. Getting All Backup Proxy Servers
This command returns all backup proxy servers that are added to Veeam Backup for Microsoft 365 infrastructure. |
Example 2. Getting Backup Proxy Servers by ID
This command returns a backup proxy with the ID d96f55a4-d15d-410b-b0f0-d51d17ccdab6. |
Example 3. Getting Backup Proxy Server by IP
This command returns a backup proxy with the 172.17.53.53 IP address. |
Example 4. Getting Backup Proxy Server by Organization
This example shows how to get a backup proxy associated with the Columbus organization. Perform the following steps:
|
Related Commands