Delete Bgp Peer

directconnect_delete_bgp_peer

R Documentation

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN

Description

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

You cannot delete the last BGP peer from a virtual interface.

Usage

directconnect_delete_bgp_peer(virtualInterfaceId, asn, asnLong,
  customerAddress, bgpPeerId)

Arguments

virtualInterfaceId	The ID of the virtual interface.
asn	The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
asnLong	The long ASN for the BGP peer to be deleted from a Direct Connect virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
customerAddress	The IP address assigned to the customer interface.
bgpPeerId	The ID of the BGP peer.

Value

A list with the following syntax:

list(
  virtualInterface = list(
    ownerAccount = "string",
    virtualInterfaceId = "string",
    location = "string",
    connectionId = "string",
    virtualInterfaceType = "string",
    virtualInterfaceName = "string",
    vlan = 123,
    asn = 123,
    asnLong = 123,
    amazonSideAsn = 123,
    authKey = "string",
    amazonAddress = "string",
    customerAddress = "string",
    addressFamily = "ipv4"|"ipv6",
    virtualInterfaceState = "confirming"|"verifying"|"pending"|"available"|"down"|"testing"|"deleting"|"deleted"|"rejected"|"unknown",
    customerRouterConfig = "string",
    mtu = 123,
    jumboFrameCapable = TRUE|FALSE,
    virtualGatewayId = "string",
    directConnectGatewayId = "string",
    routeFilterPrefixes = list(
      list(
        cidr = "string"
      )
    ),
    bgpPeers = list(
      list(
        bgpPeerId = "string",
        asn = 123,
        asnLong = 123,
        authKey = "string",
        addressFamily = "ipv4"|"ipv6",
        amazonAddress = "string",
        customerAddress = "string",
        bgpPeerState = "verifying"|"pending"|"available"|"deleting"|"deleted",
        bgpStatus = "up"|"down"|"unknown",
        awsDeviceV2 = "string",
        awsLogicalDeviceId = "string"
      )
    ),
    region = "string",
    awsDeviceV2 = "string",
    awsLogicalDeviceId = "string",
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    siteLinkEnabled = TRUE|FALSE
  )
)

Request syntax

svc$delete_bgp_peer(
  virtualInterfaceId = "string",
  asn = 123,
  asnLong = 123,
  customerAddress = "string",
  bgpPeerId = "string"
)