Skip to content

virtual_path_default_set_rules

Overview

API to modify, get Virtual Path Default Set Rules

Version information

Version : v2

URI scheme

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

Tags

  • virtual_path_default_set_rules : Operations related to virtual_path_default_set_rules

Paths

POST operation for virtual_path_default_set_rules

POST /virtual_path_default_set_rules

Description

Use this operation to add Virtual Path Default Set Rules

Responses

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

  • virtual_path_default_set_rules

Get operation for virtual_path_default_set_rules

GET /virtual_path_default_set_rules

Description

Use this operation to get the Virtual Path Default Set Rules

Responses

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

  • virtual_path_default_set_rules

PUT operation for virtual_path_default_set_rules

PUT /virtual_path_default_set_rules

Description

Use this operation to modify Virtual Path Default Set Rules

Parameters

Type Name Schema
Body body
optional
virtual_path_default_set_rules_request_schema

Responses

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

  • virtual_path_default_set_rules

DELETE operation for virtual_path_default_set_rules

DELETE /virtual_path_default_set_rules/{deletePathParam}

Description

Use this operation to delete Virtual Path Default Set Rules

Parameters

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

Responses

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

  • virtual_path_default_set_rules

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID to uniquely identify Virtual Path Default Set Rules

Type : integer

match_properties

Rule match properties

Name Description Schema
destination_ip_address
optional
The Destination IP Address and subnet mask that this rule will match. Give IP Address with subnet string
destination_port
optional
If set, the Destination Port or Port range (eg: 2345-2457) that this rule will match. string
dscp
optional
The DSCP tag in the IP header that this rule will match.
Default : "any"
enum (any, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef)
protocol
optional
The Protocol Name that this filter will match.
Default : "ANY"
enum (FTP, SMTP, POP3, IMAP, HTTP, TELNET, ICMP, HTTPS, ALTHTTP, SSH, DNS, NTP, SNMP, SNMPTRAP, RPC, RDP, IPSEC, SIP, ICACGPUDP, ICAUDP, ICACGP, ICA, IPERF, CIFS, LDAP, NETBIOS, RTP, RTCP, DHCP, NFS, GRE, TCP, UDP, Number, ANY)
protocol_num
optional
The Protocol Number that this filter will match. integer
rebind_flow_on_change
optional
If enabled, flows which are otherwise identical in terms of match criteria will be treated as separate if their DSCP fields differ. boolean
routing_domain
optional
routing domain string
source_ip_address
optional
The Source IP Address and subnet mask that this rule will match. Give IP Address with subnet string
source_port
optional
If set, the Source or Destination Port or Port range (eg: 2345-2457) that this rule will match. string
vlan_id
optional
The Ethernet VLAN tag that this rule will match. integer

order

The order/precedence in which Rules are applied (automatically redistributed)

Type : integer

package_name

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

Type : string

rule_properties

Rule properties

Name Description Schema
enable_gre
optional
If enabled, header compression will be used for GRE packets boolean
enable_ip_tcp_udp_compression
optional
If enabled, header compression will be used for IP, TCP and UDP packets boolean
enable_packet_aggregation
optional
If enabled, small packets on this flow will be aggregated together into larger packets boolean
enable_passive_ftp_detection
optional
If enabled, processing decisions will be based upon user data. The rule will learn the port used for the FTP data transfer and apply the rule properties to the learned port boolean
enable_tcp_termination
optional
If enabled, flows matching this rule will be sent using reliable service to the remote appliance and any packets lost will be retransmitted boolean
lan_to_wan_class_id
optional
The Class that is to service traffic flows that match this Rule. The default is Class 9 string
lan_to_wan_drop_depth
optional
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted integer
lan_to_wan_drop_limit
optional
The maximum amount of estimated time that packets smaller than the Large Packet Size will have to wait in the class scheduler. If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes. integer
lan_to_wan_duplicate_packets_disable_depth
optional
The queue depth of the class scheduler at which point duplicate packets will not be generated integer
lan_to_wan_duplicate_packets_disable_limit
optional
The amount of time a packet may wait in the queue before duplication is not performed, which prevents duplicate packets from consuming bandwidth when bandwidth is limited integer
lan_to_wan_enable_red
optional
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected. boolean
lan_to_wan_large_packet_size
optional
Packets destined for this class which are larger than or equal to this size will follow large packet drop policy. Packets which are smaller than this size will follow small packet drop policy. If this size is set to 0, all packets will be treated as small packets. integer
lan_to_wan_large_packets_drop_depth
optional
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted. integer
lan_to_wan_large_packets_drop_limit
optional
The maximum amount of estimated time that packets larger than or equal to the Large Packet Size will have to wait in the class scheduler. If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes. integer
lan_to_wan_reassign_class_id
optional
The Class to which flows will be reassigned if the size specified is exceeded. If the default option is selected, packets will not be assigned to an alternate class based on packet size, and will continue to be mapped to the class specified in the General section. string
lan_to_wan_reassign_drop_depth
optional
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted integer
lan_to_wan_reassign_drop_limit
optional
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes. integer
lan_to_wan_reassign_duplicate_packets_disable_depth
optional
The queue depth of the class scheduler at which point duplicate packets will not be generated. integer
lan_to_wan_reassign_duplicate_packets_disable_limit
optional
Designates the amount of time a packet may wait in the queue before duplication is not performed, which prevents duplicate packets from consuming bandwidth when bandwidth is limited. integer
lan_to_wan_reassign_enable_red
optional
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected. boolean
lan_to_wan_reassign_large_packet_size
optional
Packets destined for this class which are larger than or equal to this size will follow large packet drop policy. Packets which are smaller than this size will follow small packet drop policy. If this size is set to 0, all packets will be treated as small packets. integer
lan_to_wan_reassign_large_packets_drop_depth
optional
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted. integer
lan_to_wan_reassign_large_packets_drop_limit
optional
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes. integer
lan_to_wan_reassign_size
optional
After a flow is established, if a packet that exceeds this size is detected on the LAN to WAN, then the flow will be moved to the class indicated integer
lan_to_wan_tcp_standalone_ack_class_id
optional
The Class that will be used for standalone TCP ACKs. This has no effect on packets that are piggyback ACKs with payload. If the default option is selected, TCP Standalone ACKs will continue to be mapped to the class specified in the General section. string
lan_to_wan_tcp_standalone_ack_drop_depth
optional
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted integer
lan_to_wan_tcp_standalone_ack_drop_limit
optional
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes. integer
lan_to_wan_tcp_standalone_ack_large_packet_size
optional
Packets destined for this class which are larger than or equal to this size will follow large packet drop policy. Packets which are smaller than this size will follow small packet drop policy. If this size is set to 0, all packets will be treated as small packets. integer
lan_to_wan_tcp_standalone_ack_large_packets_drop_depth
optional
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted integer
lan_to_wan_tcp_standalone_ack_large_packets_drop_limit
optional
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes. integer
override_service
optional
The destination service that flows should go to boolean
persistent_impedance
optional
Use the same path until wait time on the path is longer than the configured value integer
retransmit_lost_packets
optional
If enabled, flows matching this rule will be sent using reliable service to the remote appliance and any packets lost will be retransmitted boolean
rule_group_name
optional
A name given to a rule that will allow rule statistics to be summed in groups when they are displayed. All rule statistics for rules with the same Rule Group Name can be viewed together. string
track_performance
optional
If enabled, performance of a rule over time will be recorded in a session DB, including loss, latency, jitter and bandwidth used. boolean
transmit_mode
optional
The method of transmitting and receiving packets enum (load_balance_paths, persistent_paths, duplicate_paths, override_service)
wan_to_lan_discard_late_resequence_packets
optional
After a packets sequence timer has expired for a dependent packet, and the packets were permitted to the LAN: If a late packet arrives at WAN to LAN, this property defines what is to be done with it. Enable this checkbox to discard, disable this checkbox to forward. boolean
wan_to_lan_dscp_tag
optional
The DSCP tag that will be applied to packets that match this rule on WAN to LAN, before they are sent to the LAN
Default : "any"
enum (any, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef)
wan_to_lan_enable_packet_resequencing
optional
If enabled, traffic flows that match this rule should be tagged for sequence order, and the packets should be reordered (if necessary) at the WAN to LAN appliance. boolean
wan_to_lan_hold_time
optional
The maximum delay that a packet may be held awaiting re-sequence. When the timer expires the packet will be sent to the LAN without waiting any further for the pre-requisite sequence numbers.
DEFAULTS: If this rule has a transmit mode of duplicate paths, the default hold time is 80ms. Otherwise, the default is 900ms for TCP rules and 250ms for NON TCP rules.
integer

virtual_path_default_set_name

Virtual path Default Set name using which the API operation should be performed.

Type : string

virtual_path_default_set_rules

Name Schema
id
optional
id
match_properties
optional
match_properties
order
optional
order
package_name
optional
package_name
rule_properties
optional
rule_properties
virtual_path_default_set_name
optional
virtual_path_default_set_name

virtual_path_default_set_rules_delete_success_schema

Name Schema
virtual_path_default_set_rules
optional
virtual_path_default_set_rules

virtual_path_default_set_rules

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

virtual_path_default_set_rules_post_success_schema

Name Schema
virtual_path_default_set_rules
optional
virtual_path_default_set_rules

virtual_path_default_set_rules

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

virtual_path_default_set_rules_put_success_schema

Name Schema
virtual_path_default_set_rules
optional
virtual_path_default_set_rules

virtual_path_default_set_rules

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

virtual_path_default_set_rules_request_schema

Name Schema
virtual_path_default_set_rules
optional
virtual_path_default_set_rules

virtual_path_default_set_rules_response_schema

Type : < virtual_path_default_set_rules_response_schema > array

virtual_path_default_set_rules_response_schema

Name Schema
id
optional
id
match_properties
optional
match_properties
order
optional
order
package_name
optional
package_name
rule_properties
optional
rule_properties
virtual_path_default_set_name
optional
virtual_path_default_set_name