Avi NetworkProfile Object API
CLI ``` - configure networkprofile - show networkprofile ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /networkprofilepost /networkprofiledelete /networkprofile/{uuid}get /networkprofile/{uuid}patch /networkprofile/{uuid}put /networkprofile/{uuid}get /networkprofile/{uuid}/runtime/internal/
(networkprofileGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"connection_mirror" : true,
"profile" : {
"tcp_proxy_profile" : {
"nagles_algorithm" : true,
"ip_dscp" : 123,
"keepalive_in_halfclose_state" : true,
"time_wait_delay" : 123,
"idle_connection_timeout" : 123,
"min_rexmt_timeout" : 123,
"automatic" : true,
"max_retransmissions" : 123,
"aggressive_congestion_avoidance" : true,
"idle_connection_type" : "aeiou",
"reorder_threshold" : 123,
"reassembly_queue_size" : 123,
"cc_algo" : "aeiou",
"receive_window" : 123,
"auto_window_growth" : true,
"max_syn_retransmissions" : 123,
"ignore_time_wait" : true,
"max_segment_size" : 123,
"congestion_recovery_scaling_factor" : 123,
"use_interface_mtu" : true,
"slow_start_scaling_factor" : 123
},
"udp_fast_path_profile" : {
"per_pkt_loadbalance" : true,
"dsr_profile" : "",
"snat" : true,
"session_idle_timeout" : 123
},
"sctp_proxy_profile" : {
"max_retransmissions_init_chunks" : 123,
"receive_window" : 123,
"number_of_streams" : 123,
"reset_timeout" : 123,
"idle_timeout" : 123,
"max_retransmissions_association" : 123,
"heartbeat_interval" : 123,
"cookie_expiration_timeout" : 123
},
"tcp_fast_path_profile" : {
"dsr_profile" : {
"dsr_encap_type" : "aeiou",
"dsr_type" : "aeiou"
},
"session_idle_timeout" : 123,
"enable_syn_protection" : true
},
"type" : "aeiou",
"sctp_fast_path_profile" : {
"idle_timeout" : 123,
"enable_init_chunk_protection" : true
},
"udp_proxy_profile" : {
"session_idle_timeout" : 123
}
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkProfileApiResponse
401
log in failed
(networkprofilePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NetworkProfile object creation
Return type
Example data
Content-Type: application/json
{
"connection_mirror" : true,
"profile" : {
"tcp_proxy_profile" : {
"nagles_algorithm" : true,
"ip_dscp" : 123,
"keepalive_in_halfclose_state" : true,
"time_wait_delay" : 123,
"idle_connection_timeout" : 123,
"min_rexmt_timeout" : 123,
"automatic" : true,
"max_retransmissions" : 123,
"aggressive_congestion_avoidance" : true,
"idle_connection_type" : "aeiou",
"reorder_threshold" : 123,
"reassembly_queue_size" : 123,
"cc_algo" : "aeiou",
"receive_window" : 123,
"auto_window_growth" : true,
"max_syn_retransmissions" : 123,
"ignore_time_wait" : true,
"max_segment_size" : 123,
"congestion_recovery_scaling_factor" : 123,
"use_interface_mtu" : true,
"slow_start_scaling_factor" : 123
},
"udp_fast_path_profile" : {
"per_pkt_loadbalance" : true,
"dsr_profile" : "",
"snat" : true,
"session_idle_timeout" : 123
},
"sctp_proxy_profile" : {
"max_retransmissions_init_chunks" : 123,
"receive_window" : 123,
"number_of_streams" : 123,
"reset_timeout" : 123,
"idle_timeout" : 123,
"max_retransmissions_association" : 123,
"heartbeat_interval" : 123,
"cookie_expiration_timeout" : 123
},
"tcp_fast_path_profile" : {
"dsr_profile" : {
"dsr_encap_type" : "aeiou",
"dsr_type" : "aeiou"
},
"session_idle_timeout" : 123,
"enable_syn_protection" : true
},
"type" : "aeiou",
"sctp_fast_path_profile" : {
"idle_timeout" : 123,
"enable_init_chunk_protection" : true
},
"udp_proxy_profile" : {
"session_idle_timeout" : 123
}
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkProfile
401
log in failed
Up
delete /networkprofile/{uuid}
(networkprofileUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /networkprofile/{uuid}
(networkprofileUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"connection_mirror" : true,
"profile" : {
"tcp_proxy_profile" : {
"nagles_algorithm" : true,
"ip_dscp" : 123,
"keepalive_in_halfclose_state" : true,
"time_wait_delay" : 123,
"idle_connection_timeout" : 123,
"min_rexmt_timeout" : 123,
"automatic" : true,
"max_retransmissions" : 123,
"aggressive_congestion_avoidance" : true,
"idle_connection_type" : "aeiou",
"reorder_threshold" : 123,
"reassembly_queue_size" : 123,
"cc_algo" : "aeiou",
"receive_window" : 123,
"auto_window_growth" : true,
"max_syn_retransmissions" : 123,
"ignore_time_wait" : true,
"max_segment_size" : 123,
"congestion_recovery_scaling_factor" : 123,
"use_interface_mtu" : true,
"slow_start_scaling_factor" : 123
},
"udp_fast_path_profile" : {
"per_pkt_loadbalance" : true,
"dsr_profile" : "",
"snat" : true,
"session_idle_timeout" : 123
},
"sctp_proxy_profile" : {
"max_retransmissions_init_chunks" : 123,
"receive_window" : 123,
"number_of_streams" : 123,
"reset_timeout" : 123,
"idle_timeout" : 123,
"max_retransmissions_association" : 123,
"heartbeat_interval" : 123,
"cookie_expiration_timeout" : 123
},
"tcp_fast_path_profile" : {
"dsr_profile" : {
"dsr_encap_type" : "aeiou",
"dsr_type" : "aeiou"
},
"session_idle_timeout" : 123,
"enable_syn_protection" : true
},
"type" : "aeiou",
"sctp_fast_path_profile" : {
"idle_timeout" : 123,
"enable_init_chunk_protection" : true
},
"udp_proxy_profile" : {
"session_idle_timeout" : 123
}
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkProfile
401
log in failed
Up
patch /networkprofile/{uuid}
(networkprofileUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NetworkProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"connection_mirror" : true,
"profile" : {
"tcp_proxy_profile" : {
"nagles_algorithm" : true,
"ip_dscp" : 123,
"keepalive_in_halfclose_state" : true,
"time_wait_delay" : 123,
"idle_connection_timeout" : 123,
"min_rexmt_timeout" : 123,
"automatic" : true,
"max_retransmissions" : 123,
"aggressive_congestion_avoidance" : true,
"idle_connection_type" : "aeiou",
"reorder_threshold" : 123,
"reassembly_queue_size" : 123,
"cc_algo" : "aeiou",
"receive_window" : 123,
"auto_window_growth" : true,
"max_syn_retransmissions" : 123,
"ignore_time_wait" : true,
"max_segment_size" : 123,
"congestion_recovery_scaling_factor" : 123,
"use_interface_mtu" : true,
"slow_start_scaling_factor" : 123
},
"udp_fast_path_profile" : {
"per_pkt_loadbalance" : true,
"dsr_profile" : "",
"snat" : true,
"session_idle_timeout" : 123
},
"sctp_proxy_profile" : {
"max_retransmissions_init_chunks" : 123,
"receive_window" : 123,
"number_of_streams" : 123,
"reset_timeout" : 123,
"idle_timeout" : 123,
"max_retransmissions_association" : 123,
"heartbeat_interval" : 123,
"cookie_expiration_timeout" : 123
},
"tcp_fast_path_profile" : {
"dsr_profile" : {
"dsr_encap_type" : "aeiou",
"dsr_type" : "aeiou"
},
"session_idle_timeout" : 123,
"enable_syn_protection" : true
},
"type" : "aeiou",
"sctp_fast_path_profile" : {
"idle_timeout" : 123,
"enable_init_chunk_protection" : true
},
"udp_proxy_profile" : {
"session_idle_timeout" : 123
}
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkProfile
401
log in failed
Up
put /networkprofile/{uuid}
(networkprofileUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NetworkProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"connection_mirror" : true,
"profile" : {
"tcp_proxy_profile" : {
"nagles_algorithm" : true,
"ip_dscp" : 123,
"keepalive_in_halfclose_state" : true,
"time_wait_delay" : 123,
"idle_connection_timeout" : 123,
"min_rexmt_timeout" : 123,
"automatic" : true,
"max_retransmissions" : 123,
"aggressive_congestion_avoidance" : true,
"idle_connection_type" : "aeiou",
"reorder_threshold" : 123,
"reassembly_queue_size" : 123,
"cc_algo" : "aeiou",
"receive_window" : 123,
"auto_window_growth" : true,
"max_syn_retransmissions" : 123,
"ignore_time_wait" : true,
"max_segment_size" : 123,
"congestion_recovery_scaling_factor" : 123,
"use_interface_mtu" : true,
"slow_start_scaling_factor" : 123
},
"udp_fast_path_profile" : {
"per_pkt_loadbalance" : true,
"dsr_profile" : "",
"snat" : true,
"session_idle_timeout" : 123
},
"sctp_proxy_profile" : {
"max_retransmissions_init_chunks" : 123,
"receive_window" : 123,
"number_of_streams" : 123,
"reset_timeout" : 123,
"idle_timeout" : 123,
"max_retransmissions_association" : 123,
"heartbeat_interval" : 123,
"cookie_expiration_timeout" : 123
},
"tcp_fast_path_profile" : {
"dsr_profile" : {
"dsr_encap_type" : "aeiou",
"dsr_type" : "aeiou"
},
"session_idle_timeout" : 123,
"enable_syn_protection" : true
},
"type" : "aeiou",
"sctp_fast_path_profile" : {
"idle_timeout" : 123,
"enable_init_chunk_protection" : true
},
"udp_proxy_profile" : {
"session_idle_timeout" : 123
}
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkProfile
401
log in failed
Up
get /networkprofile/{uuid}/runtime/internal/
(networkprofileUuidRuntimeInternalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesDsrProfileKeyValueNetworkProfileNetworkProfileApiResponseNetworkProfileUnionRoleFilterMatchLabelSCTPFastPathProfileSCTPProxyProfileTCPFastPathProfileTCPProxyProfileUDPFastPathProfileUDPProxyProfile
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
dsr_encap_type
String Encapsulation type to use when DSR is L3. Enum options - ENCAP_IPINIP, ENCAP_GRE. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dsr_type
String DSR type L2/L3. Enum options - DSR_TYPE_L2, DSR_TYPE_L3. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
connection_mirror (optional)
Boolean When enabled, Avi mirrors all TCP fastpath connections to standby. Applicable only in Legacy HA Mode. Field introduced in 18.1.3,18.2.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic, Enterprise with Cloud Services edition.
description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
name
String The name of the network profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
profile
NetworkProfileUnion Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID of the network profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
sctp_fast_path_profile (optional)
SCTPFastPathProfile Configure SCTP FastPath network profile. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sctp_proxy_profile (optional)
SCTPProxyProfile Configure SCTP Proxy network profile. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tcp_fast_path_profile (optional)
TCPFastPathProfile Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tcp_proxy_profile (optional)
TCPProxyProfile Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
type
String Configure one of either proxy or fast path profiles. Enum options - PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH, PROTOCOL_TYPE_UDP_PROXY, PROTOCOL_TYPE_SCTP_PROXY, PROTOCOL_TYPE_SCTP_FAST_PATH. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- PROTOCOL_TYPE_TCP_FAST_PATH,PROTOCOL_TYPE_UDP_FAST_PATH), Basic edition(Allowed values- PROTOCOL_TYPE_TCP_PROXY,PROTOCOL_TYPE_TCP_FAST_PATH,PROTOCOL_TYPE_UDP_FAST_PATH), Enterprise with Cloud Services edition.
udp_fast_path_profile (optional)
UDPFastPathProfile Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
udp_proxy_profile (optional)
UDPProxyProfile Configure UDP Proxy network profile. Field introduced in 17.2.8, 18.1.3, 18.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enable_init_chunk_protection (optional)
Boolean When enabled, Avi will complete the 4-way handshake with the client before forwarding any packets to the server. This will protect the server from INIT chunks flood and half open connections. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
idle_timeout (optional)
Integer SCTP autoclose timeout. 0 means autoclose deactivated. Allowed values are 0-247483647. Field introduced in 22.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
cookie_expiration_timeout (optional)
Integer SCTP cookie expiration timeout. Allowed values are 60-3600. Field introduced in 22.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
heartbeat_interval (optional)
Integer SCTP heartbeat interval. Allowed values are 30-247483647. Field introduced in 22.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
idle_timeout (optional)
Integer SCTP autoclose timeout. 0 means autoclose deactivated. Allowed values are 0-247483647. Field introduced in 22.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_retransmissions_association (optional)
Integer SCTP maximum retransmissions for association. Allowed values are 1-247483647. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_retransmissions_init_chunks (optional)
Integer SCTP maximum retransmissions for INIT chunks. Allowed values are 1-247483647. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
number_of_streams (optional)
Integer Number of incoming SCTP Streams. Allowed values are 1-65535. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
receive_window (optional)
Integer SCTP send and receive buffer size. Allowed values are 2-65536. Field introduced in 22.1.3. Unit is KB. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
reset_timeout (optional)
Integer SCTP reset timeout. 0 means 5 times RTO max. Allowed values are 0-247483647. Field introduced in 22.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
dsr_profile (optional)
DsrProfile DSR profile information. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enable_syn_protection (optional)
Boolean When enabled, Avi will complete the 3-way handshake with the client before forwarding any packets to the server. This will protect the server from SYN flood and half open SYN connections. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
session_idle_timeout (optional)
Integer The amount of time (in sec) for which a connection needs to be idle before it is eligible to be deleted. Allowed values are 5-14400. Special values are 0 - infinite. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
aggressive_congestion_avoidance (optional)
Boolean Controls the our congestion window to send, normally it's 1 mss, If this option is turned on, we use 10 msses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
auto_window_growth (optional)
Boolean Controls whether the windows are static or supports autogrowth. Maximum that it can grow to is limited to 4MB. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
automatic (optional)
Boolean Dynamically pick the relevant parameters for connections. Allowed in Enterprise edition with any value, Basic edition(Allowed values- true), Essentials, Enterprise with Cloud Services edition.
cc_algo (optional)
String Controls the congestion control algorithm we use. Enum options - CC_ALGO_NEW_RENO, CC_ALGO_CUBIC, CC_ALGO_HTCP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
congestion_recovery_scaling_factor (optional)
Integer Congestion window scaling factor after recovery. Allowed values are 0-8. Field introduced in 17.2.12, 18.1.3, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
idle_connection_timeout (optional)
Integer The duration for keepalive probes or session idle timeout. Max value is 3600 seconds, min is 5. Set to 0 to allow infinite idle time. Allowed values are 5-14400. Special values are 0 - infinite. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
idle_connection_type (optional)
String Controls the behavior of idle connections. Enum options - KEEP_ALIVE, CLOSE_IDLE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ignore_time_wait (optional)
Boolean A new SYN is accepted from the same 4-tuple even if there is already a connection in TIME_WAIT state. This is equivalent of setting Time Wait Delay to 0. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_dscp (optional)
Integer Controls the value of the Differentiated Services Code Point field inserted in the IP header. This has two options Set to a specific value, or Pass Through, which uses the incoming DSCP value. Allowed values are 0-63. Special values are MAX - Passthrough. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
keepalive_in_halfclose_state (optional)
Boolean Controls whether to keep the connection alive with keepalive messages in the TCP half close state. The interval for sending keepalive messages is 30s. If a timeout is already configured in the network profile, this will not override it. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
max_retransmissions (optional)
Integer The number of attempts at retransmit before closing the connection. Allowed values are 3-8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_segment_size (optional)
Integer Maximum TCP segment size. Allowed values are 512-9000. Special values are 0 - Use Interface MTU. Unit is BYTES. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_syn_retransmissions (optional)
Integer The maximum number of attempts at retransmitting a SYN packet before giving up. Allowed values are 3-8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
min_rexmt_timeout (optional)
Integer The minimum wait time (in millisec) to retransmit packet. Allowed values are 50-5000. Field introduced in 17.2.8. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
nagles_algorithm (optional)
Boolean Consolidates small data packets to send clients fewer but larger packets. Adversely affects real time protocols such as telnet or SSH. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reassembly_queue_size (optional)
Integer Maximum number of TCP segments that can be queued for reassembly. Configuring this to 0 disables the feature and provides unlimited queuing. Field introduced in 17.2.13, 18.1.4, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
receive_window (optional)
Integer Size of the receive window. Allowed values are 2-65536. Unit is KB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
reorder_threshold (optional)
Integer Controls the number of duplicate acks required to trigger retransmission. Setting a higher value reduces retransmission caused by packet reordering. A larger value is recommended in public cloud environments where packet reordering is quite common. The default value is 8 in public cloud platforms (AWS, Azure, GCP), and 3 in other environments. Allowed values are 1-100. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
slow_start_scaling_factor (optional)
Integer Congestion window scaling factor during slow start. Allowed values are 0-8. Field introduced in 17.2.12, 18.1.3, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
time_wait_delay (optional)
Integer The time (in millisec) to wait before closing a connection in the TIME_WAIT state. Allowed values are 500-2000. Special values are 0 - immediate. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
use_interface_mtu (optional)
Boolean Use the interface MTU to calculate the TCP max segment size. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dsr_profile (optional)
DsrProfile DSR profile information. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
per_pkt_loadbalance (optional)
Boolean When enabled, every UDP packet is considered a new transaction and may be load balanced to a different server. When disabled, packets from the same client source IP and port are sent to the same server. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
session_idle_timeout (optional)
Integer The amount of time (in sec) for which a flow needs to be idle before it is deleted. Allowed values are 2-3600. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
snat (optional)
Boolean When disabled, Source NAT will not be performed for all client UDP packets. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
session_idle_timeout (optional)
Integer The amount of time (in sec) for which a flow needs to be idle before it is deleted. Allowed values are 2-3600. Field introduced in 17.2.8, 18.1.3, 18.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32