New-NetworkControllerVirtualGatewayBgpPeer

  • Reference
Module:
NetworkController

Creates a BGP peer.

Syntax

New-NetworkControllerVirtualGatewayBgpPeer
   [-VirtualGatewayId] <String>
   [-BgpRouterName] <String>
   [-ResourceId] <String>
   [-Properties] <VGwBgpPeerProperties>
   [[-ResourceMetadata] <ResourceMetadata>]
   [[-Etag] <String>]
   [-Force]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-NetworkControllerVirtualGatewayBgpPeer cmdlet adds the configuration for a new Border Gateway Protocol (BGP) peer for the specified tenant to the Network Controller. If the BGP peer configuration already exists in the Network Controller for the tenant, this cmdlet overwrites and replaces the older configuration.

Examples

Example 1: Add a new virtual gateway BGP peer configuration to the Network Controller

PS C:\> $uri = "https://networkcontroller"

# Create a new object for tenant BGP peer
PS C:\> $bgpPeerProperties = New-Object Microsoft.Windows.NetworkController.VGwBgpPeerProperties 

# Update the BGP peer properties
PS C:\> $bgpPeerProperties.PeerIpAddress = "14.1.10.1" 
PS C:\> $bgpPeerProperties.AsNumber = 64521 
PS C:\> $bgpPeerProperties.ExtAsNumber = "0.64521" 

# Add the new BGP peer for tenant
PS C:\> New-NetworkControllerVirtualGatewayBgpPeer -ConnectionUri $uri -VirtualGatewayId Contoso -BgpRouterName "Contoso_Vnet_BgpRouter2" -ResourceId "Contoso_IPSec_Peer" -Properties $bgpPeerProperties -Force

This set of cmdlets adds a new BGP peer to the BGP router Contoso_Vnet_BgpRouter1 for the tenant Contoso.

Parameters

-BgpRouterName

Specifies the name of a BGP router.

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

-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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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

-Etag

Specifies the entity tag (ETag) of the resource. An ETag is an HTTP response header returned by an HTTP-compliant web server. An ETag is used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.

Type:String
Position:7
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:8
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

-Properties

Specifies the BGP peer properties.

Type:VGwBgpPeerProperties
Position:4
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Specifies the resource ID of the BGP peer.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceMetadata

Specifies metadata information for the client, such as the tenant ID, group ID, and resource name.

Type:ResourceMetadata
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualGatewayId

Specifies the ID of a virtual gateway.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

String

Microsoft.Windows.NetworkController.VGwBgpPeerProperties

Outputs

Object

This cmdlet outputs the following information:

  • Resource reference URI.
  • Created time of the resource.
  • Instance ID of the resource.
  • Resource metadata.
  • Resource ID.
  • Properties of the resource:

"{

""PeerIP"" : """",

""PeerASNumber"": """",

""PeerExtASNumber"": """",

""PolicyMapIn"": @{""ResourceRef"": ""\<string\>"" },

""PolicyMapOut"": @{""ResourceRef"": ""\<string\>"" }

}"