bgp_import_filters¶
Overview¶
API to add, delete, get, modify BGP Import Filters. To set any property value to wildcard, use *.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- bgp_import_filters : Operations related to bgp_import_filters
Paths¶
POST operation for bgp_import_filters¶
POST /bgp_import_filters
Description¶
Use this operation to add BGP Import Filters
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | bgp_import_filters_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_import_filters
Get operation for bgp_import_filters¶
GET /bgp_import_filters
Description¶
Use this operation to get the BGP Import Filters
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | bgp_import_filters_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_import_filters
PUT operation for bgp_import_filters¶
PUT /bgp_import_filters
Description¶
Use this operation to modify BGP Import Filters
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
bgp_import_filters_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | bgp_import_filters_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_import_filters
DELETE operation for bgp_import_filters¶
DELETE /bgp_import_filters/{deletePathParam}
Description¶
Use this operation to delete BGP Import Filters
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_import_filters_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_import_filters
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
bgp_import_filters¶
| Name | Schema |
|---|---|
| cost optional |
cost |
| cost_match_type optional |
cost_match_type |
| destination_ip_address optional |
destination_ip_address |
| destination_network_object_name optional |
destination_network_object_name |
| eligibility_based_on_gateway optional |
eligibility_based_on_gateway |
| eligibility_based_on_path optional |
eligibility_based_on_path |
| enabled optional |
enabled |
| export_route_to_appliance optional |
export_route_to_appliance |
| id optional |
id |
| include optional |
include |
| next_hop optional |
next_hop |
| order optional |
order |
| package_name optional |
package_name |
| path optional |
path |
| prefix optional |
prefix |
| prefix_match_type optional |
prefix_match_type |
| protocol optional |
protocol |
| route_tag optional |
route_tag |
| routing_domain optional |
routing_domain |
| sdwan_cost optional |
sdwan_cost |
| service_name optional |
service_name |
| service_type optional |
service_type |
| site_name optional |
site_name |
| source_router_ip_address optional |
source_router_ip_address |
| use_ospf_route_cost optional |
use_ospf_route_cost |
bgp_import_filters_delete_success_schema¶
| Name | Schema |
|---|---|
| bgp_import_filters optional |
bgp_import_filters |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
bgp_import_filters_post_success_schema¶
| Name | Schema |
|---|---|
| bgp_import_filters optional |
bgp_import_filters |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
bgp_import_filters_put_success_schema¶
| Name | Schema |
|---|---|
| bgp_import_filters optional |
bgp_import_filters |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
bgp_import_filters_request_schema¶
| Name | Schema |
|---|---|
| bgp_import_filters optional |
bgp_import_filters |
bgp_import_filters_response_schema¶
Type : < bgp_import_filters_response_schema > array
bgp_import_filters_response_schema
| Name | Schema |
|---|---|
| cost optional |
cost |
| cost_match_type optional |
cost_match_type |
| destination_ip_address optional |
destination_ip_address |
| destination_network_object_name optional |
destination_network_object_name |
| eligibility_based_on_gateway optional |
eligibility_based_on_gateway |
| eligibility_based_on_path optional |
eligibility_based_on_path |
| enabled optional |
enabled |
| export_route_to_appliance optional |
export_route_to_appliance |
| id optional |
id |
| include optional |
include |
| is_auto optional |
is_auto |
| next_hop optional |
next_hop |
| order optional |
order |
| package_name optional |
package_name |
| path optional |
path |
| prefix optional |
prefix |
| prefix_match_type optional |
prefix_match_type |
| protocol optional |
protocol |
| route_tag optional |
route_tag |
| routing_domain optional |
routing_domain |
| sdwan_cost optional |
sdwan_cost |
| service_name optional |
service_name |
| service_type optional |
service_type |
| site_name optional |
site_name |
| source_router_ip_address optional |
source_router_ip_address |
| use_ospf_route_cost optional |
use_ospf_route_cost |
cost¶
The route cost
Type : string
cost_match_type¶
Choose a method to match the route’s cost from the list of predicates (eq, lt, le, gt, or ge)
Type : enum (eq, lt, le, gt, ge)
destination_ip_address¶
The IP address describing a route's destination
Type : string
destination_network_object_name¶
The Network Object describing a route's destination. To set it to manual, pass manual as the value. To use an existing network object, pass its name
Type : string
eligibility_based_on_gateway¶
Set to true to ensure that traffic is not sent to matching routes if the Gateway is unreachable.
Type : boolean
eligibility_based_on_path¶
Set to true to allow eligibility based on path
Type : boolean
enabled¶
Set to true to Enable the filter. A filter that is not enabled has no effect.
Type : boolean
export_route_to_appliance¶
Set to true to export matching routes to Citrix Appliances at other Sites. This functionality is enabled by default and only applies for the following Service Types: Local, LAN GRE Tunnel.
Type : boolean
id¶
Auto-generated ID to uniquely identify BGP Import Filter
Type : integer
include¶
Set to true to include routes that match this filter. Otherwise matching routes are ignored.
Type : boolean
is_auto¶
to indicate that this is auto-generated
Type : boolean
next_hop¶
The IP address of the next hop
Type : string
order¶
The Order in which filters are prioritized. Once filters are applied, they are automatically sorted by Order.
Type : integer
package_name¶
Config package name using which the site API operation should be performed.
Type : string
path¶
Path from which to determine Route eligibility
Type : string
prefix¶
The prefix used to match route's prefix
Type : string
prefix_match_type¶
The method used to match a route's prefix
Type : enum (eq, lt, le, gt, ge)
protocol¶
Choose the protocol to learn routes from.
Type : enum (any, ospf, bgp)
route_tag¶
Enter the route tag that this filter will match or leave blank in order to not specify a route tag.
Type : string
routing_domain¶
Choose one of the configured Routing Domains. Leave blank or any for Any Routing Domain
Type : string
sdwan_cost¶
Enter the cost will be applied to the matched routes when importing into Citrix Appliance route table(the default is 6).
Type : string
service_name¶
The name of the service that matching routes will use.
Type : string
service_type¶
The service type
Type : enum (local, internet, intranet, gre_tunnel, passthrough)
site_name¶
Site Name
Type : string
source_router_ip_address¶
Enter the IP address of the Source Router, valid for BGP only.
Type : string
use_ospf_route_cost¶
Enable this option for OSPF routes to prevent overriding OSPF cost with SD-WAN cost
Type : boolean