Skip to content

bgp_export_filters

Overview

API to add, delete, get, modify BGP Export 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_export_filters : Operations related to bgp_export_filters

Paths

POST operation for bgp_export_filters

POST /bgp_export_filters

Description

Use this operation to add BGP Export Filters

Parameters

Type Name Schema
Body body
optional
bgp_export_filters_request_schema

Responses

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

Consumes

  • application/json

Produces

  • application/json

Tags

  • bgp_export_filters

Get operation for bgp_export_filters

GET /bgp_export_filters

Description

Use this operation to get the BGP Export Filters

Responses

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

PUT operation for bgp_export_filters

PUT /bgp_export_filters

Description

Use this operation to modify BGP Export Filters

Responses

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

Produces

  • application/json

Tags

  • bgp_export_filters

DELETE operation for bgp_export_filters

DELETE /bgp_export_filters/{deletePathParam}

Description

Use this operation to delete BGP Export 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_export_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_export_filters

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

bgp_export_filters

Name Schema
cost
optional
cost
cost_match_type
optional
cost_match_type
enabled
optional
enabled
export_ospf_route_type
optional
export_ospf_route_type
export_ospf_route_weight
optional
export_ospf_route_weight
gateway_ip_address
optional
gateway_ip_address
id
optional
id
include
optional
include
network_ip_address
optional
network_ip_address
network_object_name
optional
network_object_name
order
optional
order
package_name
optional
package_name
prefix
optional
prefix
prefix_match_type
optional
prefix_match_type
routing_domain
optional
routing_domain
service_type
optional
service_type
site_name
optional
site_name
site_or_service_name
optional
site_or_service_name

bgp_export_filters_delete_success_schema

Name Schema
bgp_export_filters
optional
bgp_export_filters

bgp_export_filters

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

bgp_export_filters_post_success_schema

Name Schema
bgp_export_filters
optional
bgp_export_filters

bgp_export_filters

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

bgp_export_filters_put_success_schema

Name Schema
bgp_export_filters
optional
bgp_export_filters

bgp_export_filters

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

bgp_export_filters_request_schema

Name Schema
bgp_export_filters
optional
bgp_export_filters

bgp_export_filters_response_schema

Type : < bgp_export_filters_response_schema > array

bgp_export_filters_response_schema

Name Schema
cost
optional
cost
cost_match_type
optional
cost_match_type
enabled
optional
enabled
export_ospf_route_type
optional
export_ospf_route_type
export_ospf_route_weight
optional
export_ospf_route_weight
gateway_ip_address
optional
gateway_ip_address
id
optional
id
include
optional
include
is_auto
optional
is_auto
network_ip_address
optional
network_ip_address
network_object_name
optional
network_object_name
order
optional
order
package_name
optional
package_name
prefix
optional
prefix
prefix_match_type
optional
prefix_match_type
routing_domain
optional
routing_domain
service_type
optional
service_type
site_name
optional
site_name
site_or_service_name
optional
site_or_service_name

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)

enabled

Set to true to Enable the filter. A filter that is not enabled has no effect.

Type : boolean

export_ospf_route_type

Advertise the NetScaler SD-WAN route to OSPF neighbors as type 1 Intra-area route or type 5 External route. Default route is always advertised as type-5 External route to normal areas and type-3 summary route to stub areas.

Type : enum (type1_intra_area, type5_as_external)

export_ospf_route_weight

When export NetScaler SD-WAN routes to OSPF, add the weight to each route's NetScaler SD-WAN cost as total cost.

Type : integer

gateway_ip_address

The IP address of the gateway

Type : string

id

Auto-generated ID to uniquely identify BGP Export 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

network_ip_address

The IP address describing a route's destination

Type : string

network_object_name

The Network Object describing a route's network. To set it to manual, pass manual as the value. To use an existing network object, pass its name

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 API operation should be performed.

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)

routing_domain

Choose one of the configured Routing Domains. Leave blank or any for Any Routing Domain

Type : string

service_type

The service type

Type : enum (local, internet, intranet, gre_tunnel, virtual_path, lan_ipsec_tunnel, ip_host)

site_name

Site for which the feature is being configured

Type : string

site_or_service_name

The name of the Service or Site (for Virtual Paths)

Type : string