Skip to content

global_network_settings

Overview

API to get, modify global Network Settings.

Version information

Version : v2

URI scheme

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

Tags

  • global_network_settings : Operations related to global_network_settings

Paths

Get operation for global_network_settings

GET /global_network_settings

Description

Use this operation to get the current values of Global Network settings

Responses

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

  • global_network_settings

PUT operation for global_network_settings

PUT /global_network_settings

Description

Use this operation to modify the current values of Global Network settings

Parameters

Type Name Schema
Body body
optional
global_network_settings_request_schema

Responses

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

  • global_network_settings

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

default_connection_state_tracking

Set to true to enable bidirectional connection state tracking for TCP, UDP and ICMP flows that do not match a filter policy or NAT rule. Asymmetric flows will be blocked when this is enabled even when there are no Firewall policies defined. The settings may be defined at the site level which will override the global setting. If there is the possibility of asymmetric flows at a site, the recommendation is to enable this at a site or policy level and not globally.

Type : boolean

default_firewall_action

The action for packets the do not match a policy. This policy may be overridden at an Appliance.

Type : enum (allow, drop)

denied_timeout

The time, in seconds, to wait for new packets before closing Denied Connections.

Type : integer

enable_encryption_key_rotation

Set to true to enable encryption key rotation. If enabled, Encryption Keys are rotated at intervals of 10-15 minutes

Type : boolean

enable_extended_packet_authentication_trailer

Set to true to enable extended packet authentication trailer. If enabled, an authentication code is appended to the contents of encrypted traffic to verify the message is delivered unaltered

Type : boolean

enable_extended_packet_encryption_header

Set to true to enable extended packet encryption header. If enabled, a 16 byte encrypted counter is prepended to encrypted traffic to serve as an Initialization Vector and randomize packet encryption

Type : boolean

enable_fips_mode

Set to true to enable FIPS mode. If enabled, a strict FIPS compliance checking is enforced to meet requirements for all sites

Type : boolean

extended_packet_authentication_trailer_type

The type of trailer used to validate packet contents

Type : enum (32-Bit Checksum, SHA-256)

generic_idle_timeout

The time, in seconds, to wait for new packets before closing an active generic session.

Type : integer

generic_initial_timeout

The time, in seconds, to wait for new packets before closing a generic session that has not seen traffic in both directions.

Type : integer

global_network_settings

Name Schema
default_connection_state_tracking
optional
default_connection_state_tracking
default_firewall_action
optional
default_firewall_action
denied_timeout
optional
denied_timeout
enable_encryption_key_rotation
optional
enable_encryption_key_rotation
enable_extended_packet_authentication_trailer
optional
enable_extended_packet_authentication_trailer
enable_extended_packet_encryption_header
optional
enable_extended_packet_encryption_header
enable_fips_mode
optional
enable_fips_mode
extended_packet_authentication_trailer_type
optional
extended_packet_authentication_trailer_type
generic_idle_timeout
optional
generic_idle_timeout
generic_initial_timeout
optional
generic_initial_timeout
global_policy_template
optional
global_policy_template
icmp_idle_timeout
optional
icmp_idle_timeout
icmp_initial_timeout
optional
icmp_initial_timeout
network_encryption_mode
optional
network_encryption_mode
on_demand_bandwidth_limit_percent
optional
on_demand_bandwidth_limit_percent
package_name
optional
package_name
tcp_closed_timeout
optional
tcp_closed_timeout
tcp_closing_timeout
optional
tcp_closing_timeout
tcp_idle_timeout
optional
tcp_idle_timeout
tcp_initial_timeout
optional
tcp_initial_timeout
tcp_time_wait_timeout
optional
tcp_time_wait_timeout
udp_idle_timeout
optional
udp_idle_timeout
udp_initial_timeout
optional
udp_initial_timeout

global_network_settings_delete_success_schema

Name Schema
global_network_settings
optional
global_network_settings

global_network_settings

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

global_network_settings_post_success_schema

Name Schema
global_network_settings
optional
global_network_settings

global_network_settings

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

global_network_settings_put_success_schema

Name Schema
global_network_settings
optional
global_network_settings

global_network_settings

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

global_network_settings_request_schema

Name Schema
global_network_settings
optional
global_network_settings

global_network_settings_response_schema

Type : < global_network_settings_response_schema > array

global_network_settings_response_schema

Name Schema
default_connection_state_tracking
optional
default_connection_state_tracking
default_firewall_action
optional
default_firewall_action
denied_timeout
optional
denied_timeout
enable_encryption_key_rotation
optional
enable_encryption_key_rotation
enable_extended_packet_authentication_trailer
optional
enable_extended_packet_authentication_trailer
enable_extended_packet_encryption_header
optional
enable_extended_packet_encryption_header
enable_fips_mode
optional
enable_fips_mode
extended_packet_authentication_trailer_type
optional
extended_packet_authentication_trailer_type
generic_idle_timeout
optional
generic_idle_timeout
generic_initial_timeout
optional
generic_initial_timeout
global_policy_template
optional
global_policy_template
icmp_idle_timeout
optional
icmp_idle_timeout
icmp_initial_timeout
optional
icmp_initial_timeout
network_encryption_mode
optional
network_encryption_mode
on_demand_bandwidth_limit_percent
optional
on_demand_bandwidth_limit_percent
package_name
optional
package_name
tcp_closed_timeout
optional
tcp_closed_timeout
tcp_closing_timeout
optional
tcp_closing_timeout
tcp_idle_timeout
optional
tcp_idle_timeout
tcp_initial_timeout
optional
tcp_initial_timeout
tcp_time_wait_timeout
optional
tcp_time_wait_timeout
udp_idle_timeout
optional
udp_idle_timeout
udp_initial_timeout
optional
udp_initial_timeout

global_policy_template

A Firewall Policy template to be applied to all Appliances in the Citrix SD-WAN Network

Type : string

icmp_idle_timeout

The time, in seconds, to wait for new packets before closing an active ICMP session.

Type : integer

icmp_initial_timeout

The time, in seconds, to wait for new packets before closing an ICMP session that has not seen traffic in both directions.

Type : integer

network_encryption_mode

The encryption algorithm used for encrypted Paths

Type : enum (AES 128-Bit, AES 256-Bit)

on_demand_bandwidth_limit_percent

Default maximum total WAN-to-LAN bandwidth, as a percentage of bandwidth provided by non-standby WAN links in the Virtual Path (%).

Type : integer

package_name

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

Type : string

tcp_closed_timeout

The time, in seconds, to wait for new packets before closing an aborted TCP session.

Type : integer

tcp_closing_timeout

The time, in seconds, to wait for new packets before closing a TCP session after a request to terminate.

Type : integer

tcp_idle_timeout

The time, in seconds, to wait for new packets before closing an active TCP session.

Type : integer

tcp_initial_timeout

The time, in seconds, to wait for new packets before closing a TCP session that has not completed a handshake.

Type : integer

tcp_time_wait_timeout

The time, in seconds, to wait for new packets before closing a terminated TCP session.

Type : integer

udp_idle_timeout

The time, in seconds, to wait for new packets before closing an active UDP session.

Type : integer

udp_initial_timeout

The time, in seconds, to wait for new packets before closing a UDP session that has not seen traffic in both directions.

Type : integer