ospf_export_filters¶

Overview¶

API to add, delete, get, modify OSPF Export Filters

Version information¶

Version : v2

URI scheme¶

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

Tags¶

ospf_export_filters : Operations related to ospf_export_filters

Paths¶

POST operation for ospf_export_filters¶

POST /ospf_export_filters

Description¶

Use this operation to add OSPF Export Filters

Responses¶

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

Produces¶

application/json

Tags¶

ospf_export_filters

Get operation for ospf_export_filters¶

GET /ospf_export_filters

Description¶

Use this operation to get the OSPF Export Filters

Responses¶

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

ospf_export_filters

PUT operation for ospf_export_filters¶

PUT /ospf_export_filters

Description¶

Use this operation to modify OSPF Export Filters

Parameters¶

Type	Name	Schema
Body	body optional	ospf_export_filters_request_schema

Responses¶

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

Consumes¶

application/json

Produces¶

application/json

Tags¶

ospf_export_filters

DELETE operation for ospf_export_filters¶

DELETE /ospf_export_filters/{deletePathParam}

Description¶

Use this operation to delete OSPF 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	ospf_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¶

ospf_export_filters

Definitions¶

ErrorSchema¶

Name	Schema
errorcode optional	integer
errormessage optional	string

cost¶

The cost used to match routes

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 (type_1, type_5)

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 OSPF Export Filters

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 with prefix, describing a route's destination

Type : string

network_object_name¶

The Network Object describing a route's network

Type : string

order¶

The Order in which filters are prioritized. Once filters are applied, they are automatically sorted by Order.

Type : integer