Skip to main content
A newer release of this product is available.

Retrieve all BGP peer group details for VIP

Contributors
PDFs

GET /network/ip/bgp/peer-groups

Introduced In: 9.7

Retrieves the details of all BGP peer groups for VIP.

  • network bgp peer-group show

Parameters

Name Type In Required Description

ipspace.uuid

string

query

False

Filter by ipspace.uuid

ipspace.name

string

query

False

Filter by ipspace.name

state

string

query

False

Filter by state

peer.address

string

query

False

Filter by peer.address

peer.asn

integer

query

False

Filter by peer.asn

peer.is_next_hop

boolean

query

False

Filter by peer.is_next_hop

  • Introduced in: 9.9

uuid

string

query

False

Filter by uuid

local.port.name

string

query

False

Filter by local.port.name

local.port.uuid

string

query

False

Filter by local.port.uuid

local.port.node.name

string

query

False

Filter by local.port.node.name

local.interface.ip.address

string

query

False

Filter by local.interface.ip.address

local.interface.name

string

query

False

Filter by local.interface.name

local.interface.uuid

string

query

False

Filter by local.interface.uuid

name

string

query

False

Filter by name

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

records

array[bgp_peer_group]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": "1",
  "records": {
    "ipspace": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "exchange",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "local": {
      "interface": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "ip": {
          "address": "10.10.10.7"
        },
        "name": "lif1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "ip": {
        "address": "10.10.10.7",
        "netmask": "24"
      },
      "port": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "e1b",
        "node": {
          "name": "node1"
        },
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    },
    "name": "bgpv4peer",
    "peer": {
      "address": "10.10.10.7"
    },
    "state": "up",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  }
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

ipspace

Either the UUID or name is supplied on input.

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

interface

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface.

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 netmask length.

node

Name Type Description

name

string

Name of node on which the port is located.

port

Name Type Description

_links

_links

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

ip

ip

IP information to create a new interface.

port

port

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.

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

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.