Skip to main content
REST API reference

Create a new BGP peer group for VIP

PDFs

POST /network/ip/bgp/peer-groups

Introduced In: 9.7

Creates a new BGP peer group for VIP. Multipath-routing is turned on cluster-wide automatically if the peer group being created results in multiple paths being available for an existing or future VIP interface.

Required properties

  • name - Name of the peer-group to create.

  • ipspace.name or ipspace.uuid or local.port

    • Required with local.interface.name or local.ip.address to identify a local interface

    • Optional when local.interface.uuid is specified

  • local.interface.uuid or local.interface.name or local.ip.address

    • Required when specifying an existing local interface.

  • local.ip and local.port

    • Required to create a new local interface.

  • peer.address - IP address of the peer router

Default property values

If not specified in POST, the following default property values are assigned:

  • is_next_hop - false

  • peer.md5_enabled - false

  • network bgp peer-group create

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

ipspace

ipspace

Either the UUID or name is supplied on input.

local

local

Information describing the local interface that is being used to peer with a router using BGP. On a POST operation, an existing BGP interface is used by specifying the interface, or create a new one by specifying the port and IP address.

name

string

Name of the peer group

peer

peer

Information describing the router to peer with

state

string

State of the peer group

uuid

string

UUID of the peer group
Example request 
{
  "ipspace": {
    "name": "Default",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "local": {
    "interface": {
      "name": "lif1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "ip": {
      "address": "10.10.10.7",
      "netmask": "24"
    },
    "port": {
      "name": "e1b",
      "node": {
        "name": "node1"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  },
  "name": "bgpv4peer",
  "peer": {
    "address": "10.10.10.7",
    "md5_enabled": 1,
    "md5_secret": "SECRET_WORD"
  },
  "state": "string",
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1376963

Duplicate IP address is specified.

1966133

Since masking an address with a netmask represents an entire IP subnet, the masked and unmasked IP addresses cannot be the same.

1966267

IPv6 addresses must have a prefix length of 64.

1966269

IPv4 addresses must have a netmask length between 1 and 32.

1967082

IPspace name and UUID must match if both are given.

1967155

The specified local.port.name does not match the location.port.name for the specified local.interface.

1967156

The specified local.port.node.name does not match the location.port.node.name for the specified local.interface.

1967157

The specified local.port.uuid does not match the location.port.uuid for the specified local.interface.

1967158

The specified local.interface.name does not exist in the associated IPspace. local.ip.address and local.ip.netmask are required to create a new LIF.

1967159

local.interface does not support management-bgp service.

1967160

The specified local.interface.name does not match the specified interface name of local.interface.uuid.

1967161

The specified local.interface.uuid does not exist in the specified IPspace.

1967162

Either local.interface or local.ip and local.port are required to specify a local LIF.

1967163

The specified local.port.name does not match the specified port name of local.port.uuid.

1967164

The specified local.port.node.name does not match the specified node name of local.port.uuid.

1967165

The specified local.port does not exist.

1967166

ipspace.uuid or ipspace.name must be provided with local.interface.name together to identify a LIF.

1967167

Internal error. Failed to update BGP configuration for node. Retry the command, if necessary.

1967168

Internal error. Failed to create a VIP port for IPspace on node. Retry the command, if necessary.

1967169

Internal error. BGP configuration changed during the operation. Retry the command, if necessary.

1967170

Internal error. VIP port configuration changed during the operation. Retry the command, if necessary.

1967171

Internal error. Fail to access or update BGP peer group. Retry the command, if necessary.

1967172

Peer group could not be updated because IPspace does not exist. Retry the command, if necessary.

1967173

The specified local.ip.address does not match the address for the specified local.interface.

1967174

The specified local.ip.netmask does not match the netmask for the specified local.interface.

1967176

The specified local.interface.name does not exist in the associated IPspace. local.port.name, local.port.node.name, or local.port.uuid is required to create a new LIF.

1967177

Internal error. Failed to access the local interface. Retry the command, if necessary.

1967178

The IPv6 address specified with local.ip.address is not supported because it is link-local, multicast, v4-compatible, v4-mapped, loopback or "::".

1967179

The IPv4 address specified with local.ip.address is not supported because it is multicast, loopback or 0.0.0.0.

1967187

Configuring 4 bytes peer.asn requires an effective cluster version of 9.9.1 or later.

1967188

Configuring peer address as a next hop requires an effective cluster version of 9.9.1 or later.

1967189

The parameter peer.asn can't be zero.

1967192

Configuring peer.md5_enabled requires an effective cluster version of 9.16.1 or later.

1967193

Configuring peer.md5_enabled requires the peer.md5_secret parameter.

1967194

Configuring peer.md5_secret requires that peer.md5_enabled is set to true.

53281985

Internal error. Failed to update BGP peer group because BGP LIF moved during the operation. Wait a few minutes and try the command again.

53282006

BGP peer group could not be updated to use a peer address because the value provided is not a valid peer address. If necessary, try the command again with a routable host address.

53282007

BGP peer group could not be updated to use a peer address because the address represents a different address family to the address of the associated BGP LIF. If necessary, try the command again with a matching address family.

53282018

Failed to create BGP peer group because an existing peer group has already established a BGP session between LIF and peer address. If necessary, try the command again with a different BGP LIF or a different peer address.

53282021

IPsec must be enabled to use TCP MD5 in BGP sessions with a BGP peer-group.

53282024

peer.md5_secret should be 1-80 bytes.

53282025

peer.md5_secret should have an even length.

53282026

The hex format of peer.md5_secret should have only hex string starting with '0x'.

53282027

peer.md5_secret should be 1-79 characters.

53282028

peer.md5_secret supports only printable ASCII characters such as numbers, alphabets, or special characters.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

_links

ipspace

Either the UUID or name is supplied on input.

Name Type Description

name

string

IPspace name

uuid

string

IPspace UUID

ip

IP information

interface

A network interface. Either UUID or name may be supplied on input.

Name Type Description

ip

ip

IP information

name

string

The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the interface.

ip

IP information to create a new interface.

Name Type Description

address

string

IPv4 or IPv6 address

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always the netmask length.

node

Name Type Description

name

string

Name of node on which the port is located.

port

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

Name Type Description

name

string

node

node

uuid

string

local

Information describing the local interface that is being used to peer with a router using BGP. On a POST operation, an existing BGP interface is used by specifying the interface, or create a new one by specifying the port and IP address.

Name Type Description

interface

interface

A network interface. Either UUID or name may be supplied on input.

ip

ip

IP information to create a new interface.

port

port

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

peer

Information describing the router to peer with

Name Type Description

address

string

Peer router address

asn

integer

Autonomous system number of peer

is_next_hop

boolean

Use peer address as next hop.

md5_enabled

boolean

Enable or disable TCP MD5 signatures per RFC 2385.

md5_secret

string

The shared TCP MD5 secret key. This can either be given as a password or hexadecimal key.

bgp_peer_group

A BGP peer group between a local network interface and a router, for the purpose of announcing VIP interface locations for SVMs in this IPspace.

Name Type Description

ipspace

ipspace

Either the UUID or name is supplied on input.

local

local

Information describing the local interface that is being used to peer with a router using BGP. On a POST operation, an existing BGP interface is used by specifying the interface, or create a new one by specifying the port and IP address.

name

string

Name of the peer group

peer

peer

Information describing the router to peer with

state

string

State of the peer group

uuid

string

UUID of the peer group

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.