Get-NetworkControllerVirtualGateway

Gets the configuration of one or more virtual gateways.

Syntax

Get-NetworkControllerVirtualGateway
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

The Get-NetworkControllerVirtualGateway cmdlet gets the virtual gateway configuration for one or more tenants specified by the ResourceId parameter. If you do not specify the ResourceId, this cmdlet gets all virtual gateways for all tenants.

Examples

Example 1: Display all virtual gateway configurations

PS C:\> Get-NetworkControllerVirtualGateway -ConnectionUri "https://networkcontroller"
Tags             : 
ResourceRef      : /VirtualGateways/Contoso
InstanceId       : 49931c9d-8d5e-47a0-8c2c-7b5d597e9bc1
Etag             : W/"b2e94f9d-c589-4c11-84dc-fc2241135352"
ResourceMetadata : 
ResourceId       : Contoso
Properties       : Microsoft.Windows.NetworkController.VirtualGatewayProperties
Tags             : 
ResourceRef      : /VirtualGateways/Woodgrove
InstanceId       : ad2b0c59-7eb4-4851-b0ef-0181376b622c
Etag             : W/"09d07a70-0ae1-4914-9bd5-76d53ff06659"
ResourceMetadata : 
ResourceId       : Woodgrove
Properties       : Microsoft.Windows.NetworkController.VirtualGatewayProperties

This command gets all virtual gateways configured with the Network Controller.

Example 2: Display a specified virtual gateway configuration

PS C:\> Get-NetworkControllerVirtualGateway -ConnectionUri "https://networkcontroller" -ResourceId "Contoso"
Tags             : 
ResourceRef      : /VirtualGateways/Contoso
InstanceId       : 49931c9d-8d5e-47a0-8c2c-7b5d597e9bc1
Etag             : W/"b2e94f9d-c589-4c11-84dc-fc2241135352"
ResourceMetadata : 
ResourceId       : Contoso
Properties       : Microsoft.Windows.NetworkController.VirtualGatewayProperties

This command gets the virtual gateway configuration for the tenant Contoso.

Required Parameters

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Type:Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-CertificateThumbprint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a user credential that has permission to perform this action. The default value is the current user. This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassInnerException
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies an array of resource IDs.

Type:String[]
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

This cmdlet returns objects that contain the following fields.

  • Resource reference URI.
  • Created time of the resource.
  • Instance ID of the resource.
  • Resource metadata.
  • Resource ID.
  • Properties of the resource (a virtual gateway/tenant gateway):
    • Reference to the virtual network IP subnet used for routing between gateway and virtual network.
    • Array of network connections configured in the virtual gateway.
    • Routing type configured for CA space routing.
    • Array of CA space BGP routers configured in the virtual gateway and their configurations.
    • Array of BGP routing policy maps configured for the tenant.
    • Array of references to gateway pools where the virtual gateway is configured.