bgp_neighbor¶
Overview¶
API to add, delete, get, modify BGP neighbours - All of the configured BGP peer routers that are scrutinized to find the shortest paths for data. All of the neighbors must be part of the same Autonomous System.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- bgp_neighbor : Operations related to bgp_neighbor
Paths¶
POST operation for bgp_neighbor¶
POST /bgp_neighbor
Description¶
Use this operation to add BGP neighbours
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | bgp_neighbor_post_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- bgp_neighbor
Get operation for bgp_neighbor¶
GET /bgp_neighbor
Description¶
Use this operation to get BGP neighbours
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | bgp_neighbor_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- bgp_neighbor
PUT operation for bgp_neighbor¶
PUT /bgp_neighbor
Description¶
Use this operation to modify BGP neighbours
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
bgp_neighbor_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | bgp_neighbor_put_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- bgp_neighbor
DELETE operation for bgp_neighbor¶
DELETE /bgp_neighbor/{deletePathParam}
Description¶
Use this operation to delete BGP neighbours
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | bgp_neighbor_delete_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- bgp_neighbor
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
bgp_neighbor¶
| Name | Schema |
|---|---|
| bgp_neighbor_policy optional |
bgp_neighbor_policy |
| bgp_neighbor_properties optional |
bgp_neighbor_properties |
| id optional |
id |
| package_name optional |
package_name |
| site_name optional |
site_name |
bgp_neighbor_delete_success_schema¶
| Name | Schema |
|---|---|
| bgp_neighbor optional |
bgp_neighbor |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
bgp_neighbor_policy¶
BGP neighbour policies
Type : < bgp_neighbor_policy > array
| Name | Description | Schema |
|---|---|---|
| as_path optional |
The AS Path of the BGP Route | string |
| bgp_policy optional |
Choose a configured BGP policy to apply against the matching routes or select default Accept or policies to either accept or reject all matching routes. | string |
| community_string_asn optional |
The ASN for which the BGP Community was configured. | integer |
| community_string_list_name optional |
BGP community string list | string |
| community_string_value optional |
The Value of the BGP Community that we are using for matching route(s) | integer |
| direction optional |
Choose the direction in which the BGP policy is applied | enum (in, out) |
| id optional |
Auto-generated ID to uniquely identify the policy | integer |
| network_ip_address optional |
IP address with subnet | string |
| network_object_name optional |
The Network Object that describes the route's destination for matching | string |
| order optional |
The Order in which policies are prioritized. Once policies are applied, they are automatically sorted by Order. | integer |
bgp_neighbor_post_success_schema¶
| Name | Schema |
|---|---|
| bgp_neighbor optional |
bgp_neighbor |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
bgp_neighbor_properties¶
BGP neighbour properties
| Name | Description | Schema |
|---|---|---|
| hold_time optional |
Enter the Hold Time, in seconds, to wait before declaring a neighbor down (the default is 180). | integer |
| id optional |
Auto-generated ID to uniquely identify the property | integer |
| igp_metric optional |
To enable the comparison of internal distances to calculate the best route. | boolean |
| local_preference optional |
Enter the Local Preference value which is used for selecting from multiple BGP routes (the default is 100). | integer |
| multihop optional |
Set to true if the neighbour is a few hops away. The default multihop count is 255. This is by default selected, but if the neighbour is directly connected, it can be set to false | boolean |
| neighbor_as optional |
Enter the Local Autonomous System number to learn routes from and advertise routes to. This must match what is configured on the neighboring routers. | integer |
| neighbor_ip_address optional |
IP address of the BGP neighbour router | string |
| password optional |
Enter a password for MD5 authentication of BGP sessions (authentication is not required). | string |
| routing_domain optional read-only |
Routing domain | string |
| virtual_interface_name optional |
The Virtual Interface | string |
bgp_neighbor_put_success_schema¶
| Name | Schema |
|---|---|
| bgp_neighbor optional |
bgp_neighbor |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
bgp_neighbor_request_schema¶
| Name | Schema |
|---|---|
| bgp_neighbor optional |
bgp_neighbor |
bgp_neighbor_response_schema¶
Type : < bgp_neighbor_response_schema > array
| Name | Schema |
|---|---|
| bgp_neighbor_policy optional |
bgp_neighbor_policy |
| bgp_neighbor_properties optional |
bgp_neighbor_properties |
| id optional |
id |
| package_name optional |
package_name |
| site_name optional |
site_name |
id¶
Auto-generated ID to uniquely identify BGP Neighbour
Type : integer
package_name¶
Config package name using which the site API operation should be performed.
Type : string
site_name¶
Site Name
Type : string