wan_links
wan_links
Configuration Editor for API to add, modify, delete, and get configuration for WAN links resource.
Read/write properties
lan_2_wan_physical_rate <Integer>
LAN to WAN Physical rate in Kbps.
access_interfaces <access_interface[]>
List of Access Interfaces associated with the wan links group..
public_ip <String>
Public IP Address of WAN Links.
wan_2_lan_permitted_rate <Integer>
WAN to LAN Permitted rate in Kbps.
lan_2_wan_permitted_rate <Integer>
LAN to WAN Permitted rate in Kbps.
package_name <String>
Config package name using which the wan_links API operation should be performed.. Minimum length = 1 Maximum length = 141
access_type <String>
The type of network connected to the WAN link. Possible values = [public_internet,private_intranet,private_mpls]
mpls_queues <mpls_queue_obj[]>
List of MPLS Queues associated with the wan links group..
wan_2_lan_physical_rate <Integer>
WAN to LAN Physical rate in Kbps.
wan_link_name <String>
WAN Link name. Minimum length = 1 Maximum length = 42
enable_public_ip_learning <Boolean>
Enable public IP learning.
site_name <String>
Site Name. Minimum length = 1 Maximum length = 42
wan_link_template_name <String>
WAN Link template name.
Read only properties
Operations
[add]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/wan_links
Description: Use this operation to add wan links
HTTP Method: POST
Request Payload: JSON
{"wan_links": { "lan_2_wan_physical_rate":<Integer_value> , "access_interfaces":[{ "virtual_ip_addr":<String_value> , "gw_ip_addr":<String_value> , "virtual_interface_name":<String_value> }] , "public_ip":<String_value> , "wan_2_lan_permitted_rate":<Integer_value> , "lan_2_wan_permitted_rate":<Integer_value> , "package_name":<String_value> , "access_type":<String_value> , "mpls_queues":[{ "wan_2_lan_permitted_rate_kbps":<Integer_value> , "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }] , "wan_2_lan_physical_rate":<Integer_value> , "wan_link_name":<String_value> , "enable_public_ip_learning":<Boolean_value> , "site_name":<String_value> , "wan_link_template_name":<String_value> }}
Response Payload: JSON
{ "wan_links":{ "lan_2_wan_physical_rate":<Integer_value>
, "access_interfaces":[{ "virtual_ip_addr":<String_value> , "gw_ip_addr":<String_value> , "virtual_interface_name":<String_value> }], "public_ip":<String_value> , "wan_2_lan_permitted_rate":<Integer_value> , "lan_2_wan_permitted_rate":<Integer_value> , "package_name":<String_value> , "access_type":<String_value> , "mpls_queues":[{ "wan_2_lan_permitted_rate_kbps":<Integer_value> , "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }], "wan_2_lan_physical_rate":<Integer_value> , "wan_link_name":<String_value> , "enable_public_ip_learning":<Boolean_value> , "site_name":<String_value> , "wan_link_template_name":<String_value> }]}
[delete]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/wan_links/site_name=<String>,wan_link_name=<String>,package_name=<String>
Description: Use this operation to delete a wan link
HTTP Method: DELETE
Response Payload: JSON
{ "errorcode": 0, "message": "Done", "severity": <String;_value> }
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/wan_links/package_name=<package_name>
Description: Use this operation to get the list of wan links
HTTP Method: GET
Response Payload: JSON
{"wan_links":[{ "lan_2_wan_physical_rate":<Integer_value>
, "access_interfaces":[{ "virtual_ip_addr":<String_value> , "gw_ip_addr":<String_value> , "virtual_interface_name":<String_value> }], "public_ip":<String_value> , "wan_2_lan_permitted_rate":<Integer_value> , "lan_2_wan_permitted_rate":<Integer_value> , "package_name":<String_value> , "access_type":<String_value> , "mpls_queues":[{ "wan_2_lan_permitted_rate_kbps":<Integer_value> , "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }], "wan_2_lan_physical_rate":<Integer_value> , "wan_link_name":<String_value> , "enable_public_ip_learning":<Boolean_value> , "site_name":<String_value> , "wan_link_template_name":<String_value> }]}
[modify]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/wan_links
Description: Use this operation to modify a wan link
HTTP Method: PUT
Request Payload: JSON
{"wan_links":{ "lan_2_wan_physical_rate":<Integer_value> , "access_interfaces":[{ "virtual_ip_addr":<String_value> , "gw_ip_addr":<String_value> , "virtual_interface_name":<String_value> }] , "public_ip":<String_value> , "wan_2_lan_permitted_rate":<Integer_value> , "lan_2_wan_permitted_rate":<Integer_value> , "package_name":<String_value> , "access_type":<String_value> , "mpls_queues":[{ "wan_2_lan_permitted_rate_kbps":<Integer_value> , "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }] , "wan_2_lan_physical_rate":<Integer_value> , "wan_link_name":<String_value> , "enable_public_ip_learning":<Boolean_value> , "site_name":<String_value> , "wan_link_template_name":<String_value> }}
Response Payload: JSON
{ "wan_links":[{ "lan_2_wan_physical_rate":<Integer_value>
, "access_interfaces":[{ "virtual_ip_addr":<String_value> , "gw_ip_addr":<String_value> , "virtual_interface_name":<String_value> }], "public_ip":<String_value> , "wan_2_lan_permitted_rate":<Integer_value> , "lan_2_wan_permitted_rate":<Integer_value> , "package_name":<String_value> , "access_type":<String_value> , "mpls_queues":[{ "wan_2_lan_permitted_rate_kbps":<Integer_value> , "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }], "wan_2_lan_physical_rate":<Integer_value> , "wan_link_name":<String_value> , "enable_public_ip_learning":<Boolean_value> , "site_name":<String_value> , "wan_link_template_name":<String_value> }]}