Update a BGP peer group for VIP
Suggest changes
PDFs
PATCH /network/ip/bgp/peer-groups/{uuid}
Introduced In: 9.7
Updates a BGP peer group for VIP.
Related ONTAP commands
-
network bgp peer-group modify -
network bgp peer-group rename
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
uuid |
string |
path |
True |
UUID of the peer group |
Request Body
| Name | Type | Description |
|---|---|---|
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 |
Information describing the router to peer with |
|
state |
string |
State of the peer group |
uuid |
string |
UUID of the peer group |
Example request
{
"name": "bgpv4peer",
"peer": {
"address": "10.10.10.7"
},
"state": "string",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
1967171 |
Internal error. Fail to access or update BGP peer group. Retry the command, if necessary. |
1967188 |
Configuring peer address as a next hop requires an effective cluster version of 9.9.1 or later. |
53281998 |
Failed to rename the BGP peer group because that name is already assigned to a different peer group in the IPspace. |
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. |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
ipspace
Either the UUID or name is supplied on input.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
IPspace name |
uuid |
string |
IPspace UUID |
ip
IP information
interface
| Name | Type | Description |
|---|---|---|
_links |
||
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 netmask length. |
node
| Name | Type | Description |
|---|---|---|
name |
string |
Name of node on which the port is located. |
port
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
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.
peer
Information describing the router to peer with
| Name | Type | Description |
|---|---|---|
address |
string |
Peer router address |
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 |
|---|---|---|
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 |
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. |