Skip to content

intranet_services_wan_links

Overview

API to get, modify wan links for Intranet Services

Version information

Version : v2

URI scheme

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

Tags

  • intranet_services_wan_links : Operations related to intranet_services_wan_links

Paths

POST operation for intranet_services_wan_links

POST /intranet_services_wan_links

Description

Use this operation to enable the intranet service for a particular wan link

Parameters

Type Name Schema
Body body
optional
intranet_services_wan_links_request_schema

Responses

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

  • intranet_services_wan_links

GET /intranet_services_wan_links

Description

Use this operation to get the wan links for Intranet Services. Only enabled wan links are listed

Responses

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

  • intranet_services_wan_links

PUT /intranet_services_wan_links

Description

Use this operation to modify wan links for Intranet Services. This operation can only be used when the wan link is enabled for intranet service

Responses

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

  • intranet_services_wan_links

DELETE /intranet_services_wan_links/{deletePathParam}

Description

Use this operation to disable the intranet service for a particular wan link

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added intranet_services_wan_links_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

  • intranet_services_wan_links

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

access_interface_failover

If enabled, internet/intranet packets with mismatched vlan can still use the service.

Type : boolean

id

Auto-generated ID to uniquely identify the WAN Link

Type : integer

intranet_service_name

Intranet Service Name

Type : string

Name Schema
access_interface_failover
optional
access_interface_failover
id
optional
id
intranet_service_name
optional
intranet_service_name
lan_to_wan_max_delay
optional
lan_to_wan_max_delay
lan_to_wan_tagging
optional
lan_to_wan_tagging
mode
optional
mode
package_name
optional
package_name
site_name
optional
site_name
tunnel_header_size
optional
tunnel_header_size
wan_link_name
optional
wan_link_name
wan_to_lan_grooming
optional
wan_to_lan_grooming
wan_to_lan_matching
optional
wan_to_lan_matching
wan_to_lan_tagging
optional
wan_to_lan_tagging

intranet_services_wan_links_delete_success_schema

Name Schema
intranet_services_wan_links
optional
intranet_services_wan_links

intranet_services_wan_links

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

intranet_services_wan_links_post_success_schema

Name Schema
intranet_services_wan_links
optional
intranet_services_wan_links

intranet_services_wan_links

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

intranet_services_wan_links_put_success_schema

Name Schema
intranet_services_wan_links
optional
intranet_services_wan_links

intranet_services_wan_links

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

intranet_services_wan_links_request_schema

Name Schema
intranet_services_wan_links
optional
intranet_services_wan_links

intranet_services_wan_links_response_schema

Type : < intranet_services_wan_links_response_schema > array

intranet_services_wan_links_response_schema

Name Schema
access_interface_failover
optional
access_interface_failover
id
optional
id
intranet_service_name
optional
intranet_service_name
lan_to_wan_max_delay
optional
lan_to_wan_max_delay
lan_to_wan_tagging
optional
lan_to_wan_tagging
mode
optional
mode
package_name
optional
package_name
site_name
optional
site_name
tunnel_header_size
optional
tunnel_header_size
wan_link_name
optional
wan_link_name
wan_to_lan_grooming
optional
wan_to_lan_grooming
wan_to_lan_matching
optional
wan_to_lan_matching
wan_to_lan_tagging
optional
wan_to_lan_tagging

lan_to_wan_max_delay

The maximum time, in milliseconds, to buffer packets when the WAN Link's bandwidth is exceeded

Type : integer

lan_to_wan_tagging

The DSCP tag to apply to LAN to WAN packets on the Service

Type : enum (any, default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef)

mode

The Service's mode for traffic redundancy or load balancing

Type : enum (primary, secondary, auto)

package_name

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

Type : string

site_name

Site Name

Type : string

tunnel_header_size

The size, in bytes, of the tunnel header, if applicable

Type : integer

wan_link_name

The WAN Link name

Type : string

wan_to_lan_grooming

If enabled, packets will be randomly discarded to prevent WAN to LAN traffic from exceeding the Service's provisioned bandwidth

Type : boolean

wan_to_lan_matching

WAN to LAN packets matching this tag will be assigned to the Service

Type : enum (any, default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef)

wan_to_lan_tagging

The DSCP tag to apply to WAN to LAN packets on the Service

Type : enum (any, default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef)