Get-VBRDefaultGatewayConfiguration

In this article

    Short Description

    Returns configuration of default gateways.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    This cmdlet provides two parameter sets.

    • For looking for default gateways of all cloud service providers:

    Get-VBRDefaultGatewayConfiguration  [<CommonParameters>]

    • For looking for default gateways of a selected cloud service provider:

    Get-VBRDefaultGatewayConfiguration [-CloudProvider <VBRCloudProvider[]>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns configuration information on service provider default gateways. You can get information about all gateways of all service providers, or look for a selected service provider. Use an appropriate parameter set for each case.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CloudProvider

    Specifies the array of cloud providers. The cmdlet will return the default gateways of these cloud providers.

    Accepts VBRCloudProvider type.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    <CommonParameters>

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

    Return Type

    VBRDefaultGatewayConfiguration[]

    Example 1

    This command looks for configuration of default gateways of all cloud providers.

    Get-VBRDefaultGatewayConfiguration

    Example 2

    This example shows how to look for configuration of default gateway of the selected cloud provider.

    1. Run Get-VBRCloudProvider to get the cloud service provider. Save the result to the $cloudprovider variable.
    2. Run Get-VBRDefaultGatewayConfiguration to get the configuration of default gateways of a selected cloud provider. Use the saved variable.

    $cloudprovider = Get-VBRCloudprovider -Name "Cloud provider01"

    Get-VBRDefaultGatewayConfiguration -CloudProvider $cloudprovider

    Related Commands

    Get-VBRCloudProvider

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.