Skip to content

bgp_policy

Overview

API to add, delete, get, modify BGP policies- a collection of BGP attributes which can be used to set or modify route attributes for each BGP Peer.

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • bgp_policy : Operations related to bgp_policy

Paths

POST operation for bgp_policy

POST /bgp_policy

Description

Use this operation to add BGP policies

Responses

HTTP Code Description Schema
200 Resource successfully added bgp_policy_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_policy

Get operation for bgp_policy

GET /bgp_policy

Description

Use this operation to get the BGP policies

Responses

HTTP Code Description Schema
200 API Successfully executed bgp_policy_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_policy

PUT operation for bgp_policy

PUT /bgp_policy

Description

Use this operation to modify BGP policies

Parameters

Type Name Schema
Body body
optional
bgp_policy_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added bgp_policy_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_policy

DELETE operation for bgp_policy

DELETE /bgp_policy/{deletePathParam}

Description

Use this operation to delete BGP policies

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_policy_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_policy

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

bgp_policy

Name Schema
bgp_policy_id
optional
bgp_policy_id
name
optional
name
package_name
optional
package_name
policy_attribute
optional
policy_attribute
site_name
optional
site_name

bgp_policy_delete_success_schema

Name Schema
bgp_policy
optional
bgp_policy

bgp_policy

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

bgp_policy_id

Auto-generated ID to uniquely identify BGP Policy

Type : integer

bgp_policy_post_success_schema

Name Schema
bgp_policy
optional
bgp_policy

bgp_policy

Name Description Schema
message
optional
Example : "resource added succesfully" string

bgp_policy_put_success_schema

Name Schema
bgp_policy
optional
bgp_policy

bgp_policy

Name Description Schema
message
optional
Example : "resource modified succesfully" string

bgp_policy_request_schema

Name Schema
bgp_policy
optional
bgp_policy

bgp_policy_response_schema

Type : < bgp_policy_response_schema > array

bgp_policy_response_schema

Name Schema
bgp_policy_id
optional
bgp_policy_id
name
optional
name
package_name
optional
package_name
policy_attribute
optional
policy_attribute
site_name
optional
site_name

name

The name of the BGP Policy.

Type : string

package_name

Config package name using which the site API operation should be performed.

Type : string

policy_attribute

Route Policy Attributes for BGP

Type : < policy_attribute > array

policy_attribute

Name Description Schema
as_prepend_length
optional
Number of times ASN will be prepended to AS_PATH integer
asn
optional
Autonomous system number for which the BGP community is applicable. integer
asn_to_prepend
optional
AS number that will be prepended to AS_PATH integer
attribute
optional
BGP attribute enum (med, as_prepend_length, community_string)
community_string_action
optional
Insert or remove the matching community from a route enum (insert, remove)
community_string_list_name
optional
Select pre-configured BGP community list. string
copy_cost_to_med
optional
Copy the cost from matching routes to MED value. boolean
is_new_format
optional
Use new format(aa:nn) for bgp community. boolean
policy_attribute_id
optional
Auto-generated ID to uniquely identify route policy attributes integer
value
optional
Value for BGP MED attribute/BGP community integer
well_known_option
optional
Select pre-configured BGP community or enter it manually. enum (manual, no_export, no_advertise, community_string_list)

site_name

Site Name

Type : string