This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRCloudGateway

In this article

    Short Description

    Returns cloud gateways.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Requires a cloud provider license.

    Syntax

    Get-VBRCloudGateway [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    -OR-

    Get-VBRCloudGateway [-Id <Guid[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    -OR-

    Get-VBRCloudGateway [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns existing cloud gateways.

    You can get the list of all existing cloud gateways or search for instances directly by name or ID. This cmdlet provides syntax for three scenarios accordingly.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Id

    Specifies the array of IDs of the VBRCloudGateway object you want to get.

    Accepts GUID or string type.

    False

    Named

    True (by Value
    FromPipeline, ValueFromPipeline
    ByPropertyName)

    False

    Name

    Specifies the array of the  cloud gateway names you want to get or search conditions.

    False

    Named

    True (by Value
    FromPipeline, ValueFromPipeline
    ByPropertyName)

    True

    <CommonParameters>

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

    Related Commands

    None

    Return Type

    VBRCloudGateway[]

    Example 1

    This command returns all cloud gateways configured in Veeam Backup & Replication.

    PS C:\PS> Get-VBRCloudGateway

    Example 2

    This command gets the cloud gateway by name.

    PS C:\PS> Get-VBRCloudGateway -Name "Cloud gateway"