Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Get-VBRCloudServer

Short Description

Returns cloud hosts available by your cloud resources.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides three parameter sets.

  • For looking for hosts by host name:

Get-VBRCloudServer [-Name <string[]>]  [<CommonParameters>]

  • For looking for hosts of a selected cloud service provider:

Get-VBRCloudServer [-CloudProvider <VBRCloudProvider[]>] [-Name <string[]>]  [<CommonParameters>]

  • For looking for hosts by host ID:

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

Detailed Description

This cmdlet returns cloud hosts that are allocated to you by your cloud resources.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the array of the host names you want to get.

False

Named

False

False

CloudProvider

Specifies the array of the  cloud providers. The cmdlet will return the hosts that are provided to you by these providers.

Accepts VBRCloudProvider type.

False

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

Id

Specifies the array of the IDs of the host you want to get. The cmdlet will return the hosts with these IDs.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRCloudServer

Example 1

This command returns cloud server named "Hyper-V Silver".

PS C:\PS> Get-VBRCloudServer -Name "Hyper-V Silver"

Example 2

This example shows how to return cloud servers of the server provider with the 104.45.95.227 IP address.

  1. Run Get-VBRCloudProvider to get the cloud provider and save the result to the $cloudProvider variable.
  2. Run Get-VBRCloudServer using the saves variable.

PS C:\PS> $cloudProvider = Get-VBRCloudProvider -Name "104.45.95.227"

PS C:\PS> Get-VBRCloudServer -CloudProvider $cloudProvider

Related Commands

Get-VBRCloudProvider

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation