Modifier

Partager via

Get-NetworkControllerVirtualGatewayBgpRouter

  • Reference
Module:
NetworkController

Gets a BGP router.

Syntax

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

Description

The Get-NetworkControllerVirtualGatewayBgpRouter cmdlet gets the configuration of the Border Gateway Protocol (BGP) router(s) specified by the ResourceId parameter. If you do not specify the ResourceId, this cmdlet gets all BGP routers for the tenant.

Examples

Example 1: Display all BGP router configurations for the tenant virtual gateway

PS C:\> Get-NetworkControllerVirtualGatewayBgpRouter -ConnectionUri https://networkcontroller -VirtualGatewayId "Contoso"
ResourceMetadata :
ResourceRef      : /VirtualGateways/Contoso/BgpRouters/Contoso_Vnet_Router1
InstanceId       : a3e78792-f17a-4179-85b2-f04d9ef332d1
Etag             : W/"b2e94f9d-c589-4c11-84dc-fc2241135352"
ResourceId       : Contoso_Vnet_Router1
Properties       : Microsoft.Windows.NetworkController.VGwBgpRouterProperties
ResourceMetadata :
ResourceRef      : /VirtualGateways/Contoso/BgpRouters/Contoso_Vnet_Router2
InstanceId       : 3a15667d-af0c-4092-a8b5-2e66131815a8
Etag             : W/"143d70dc-1bec-4171-88b1-c6957e2b7aad"
ResourceId       : Contoso_Vnet_Router2
Properties       : Microsoft.Windows.NetworkController.VGwBgpRouterProperties

This command retrieves all the BGP routers for the virtual gateway Contoso configured with the Network Controller.

Example 2: Display a specified BGP router configuration for the tenant virtual gateway

PS C:\> Get-NetworkControllerVirtualGatewayBgpPeer -ConnectionUri "https://networkcontroller" -VirtualGatewayId "Contoso" -ResourceId "Contoso_Vnet_Router1"
ResourceMetadata :
ResourceRef      : /VirtualGateways/Contoso/BgpRouters/Contoso_Vnet_Router1
InstanceId       : a3e78792-f17a-4179-85b2-f04d9ef332d1
Etag             : W/"b2e94f9d-c589-4c11-84dc-fc2241135352"
ResourceId       : Contoso_Vnet_Router1
Properties       : Microsoft.Windows.NetworkController.VGwBgpRouterProperties

This command retrieves the tenant BGP router Contoso_Vnet_Router1.

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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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
Required:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassInnerException

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.

The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.

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

-ResourceId

Specifies an array of resource IDs of BGP routers.

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

-VirtualGatewayId

Specifies an array of virtual gateway IDs.

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

Inputs

String[]

Outputs

Object

This cmdlet returns object(s) 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/tenant gateway's BGP router):
    • Provisioning state.
    • BGP router identifier.
    • BGP router's local IP address(es).
    • BGP router's extended AS number.
    • Router connection state.
    • Whether the BGP peer is automatically generated.
    • Array of BGP peers configured on this router.