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.
  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  • If you enter a 4-byte ASN for the asn parameter, the API returns an error.
  • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

• 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.

  Note the following limitations when using asnLong:

  • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  • asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte.
  • When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647.
  • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.
  • 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,
    prefixPoolAllocatedCountIpv4 = 123,
    prefixPoolAllocatedCountIpv6 = 123,
    rateLimit = "string"
  )
)

Request syntax¶

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