Modifier

Partager via

Remove-NetworkControllerVirtualGatewayBgpPeer

  • Reference
Module:
NetworkController

Removes a BGP peer.

Syntax

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

Description

The Remove-NetworkControllerVirtualGatewayBgpPeer cmdlet removes the configuration of the BGP peer configuration specified by the ResourceId parameter from a tenant.

Examples

Example 1: Remove a tenant's virtual gateway BGP peer configuration from the Network Controller

PS C:\> Remove-NetworkControllerVirtualGatewayBgpPeer -ConnectionUri "https://networkcontroller" -VirtualGatewayId "Contoso" -BgpRouterName "Contoso_Vnet_Router1" -ResourceId "SiteB_Gre" -Force

This command removes the configuration for BGP peer SiteB_Gre from the Network Controller.

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:3
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:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassInnerException

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

-ResourceId

Specifies the resource ID of the BGP peer to remove.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
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

Outputs

None.