NetworkProfile

Description

API


    POST /api/networkprofile
    PUT /api/networkprofile/&ltkey>
    DELETE /api/networkprofile/&ltkey>
    GET /api/networkprofile
    GET /api/networkprofile/&ltkey>

CLI


    configure networkprofile &ltkey>
    show networkprofile &ltkey>

Data

NetworkProfile

uuid

Type
string
Category
required
Description
UUID of the network profile.

name

Type
string
Category
required
Description
The name of the network profile.

profile

Type
NetworkProfileUnion
Category
required
Description

description

Type
string
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
required
Description

NetworkProfileUnion

type

Type
enum
Category
required
Description
Configure one of either proxy or fast path profiles.
Default
PROTOCOL_TYPE_TCP_PROXY
Choices
PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_UDP_FAST_PATH

tcp_proxy_profile

Type
TCPProxyProfile
Category
optional
Description

tcp_fast_path_profile

Type
TCPFastPathProfile
Category
optional
Description

udp_fast_path_profile

Type
UDPFastPathProfile
Category
optional
Description

TCPProxyProfile

automatic

Type
bool
Category
optional
Description
Dynamically pick the relevant parameters for connections.
Default
True

idle_connection_type

Type
enum
Category
optional
Description
Controls the behavior of idle connections.
Default
KEEP_ALIVE
Choices
KEEP_ALIVE, CLOSE_IDLE

idle_connection_timeout

Type
int32
Category
optional
Description
The duration for keepalive probes or session idle timeout. Max value is 1800 seconds, min is 60. Set to 0 to allow infinite idle time.
Default
600

ignore_time_wait

Type
bool
Category
optional
Description
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
Default
False

time_wait_delay

Type
int32
Category
optional
Description
The time (in millisec) to wait before closing a connection in the TIME_WAIT state.
Default
2000

max_retransmissions

Type
int32
Category
optional
Description
The number of attempts at retransmit before closing the connection.
Default
8

max_syn_retransmissions

Type
int32
Category
optional
Description
The maximum number of attempts at retransmitting a SYN packet before giving up.
Default
8

receive_window

Type
int32
Category
optional
Description
Size of the receive window.
Default
64

use_interface_mtu

Type
bool
Category
optional
Description
Use the interface MTU to calculate the TCP max segment size.
Default
True

max_segment_size

Type
int32
Category
optional
Description
Maximum TCP segment size.

nagles_algorithm

Type
bool
Category
optional
Description
Consolidates small data packets to send clients fewer but larger packets. Adversely affects real time protocols such as telnet or SSH.
Default
False

ip_dscp

Type
int32
Category
optional
Description
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.
Default
0

cc_algo

Type
enum
Category
optional
Description
Controls the congestion control algorithm we use.
Default
CC_ALGO_NEW_RENO
Choices
CC_ALGO_NEW_RENO, CC_ALGO_HTCP, CC_ALGO_CUBIC

aggressive_congestion_avoidance

Type
bool
Category
optional
Description
Controls the our congestion window to send, normally it's 1 mss, If this option is turned on, we use 10 msses
Default
False

TCPFastPathProfile

session_idle_timeout

Type
int32
Category
optional
Description
The amount of time (in sec) for which a connection needs to be idle before it is eligible to be deleted.
Default
300

enable_syn_protection

Type
bool
Category
optional
Description
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.
Default
False

UDPFastPathProfile

session_idle_timeout

Type
int32
Category
optional
Description
The amount of time (in sec) for which a flow needs to be idle before it is deleted.
Default
10

per_pkt_loadbalance

Type
bool
Category
optional
Description
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.
Default
False

snat

Type
bool
Category
optional
Description
When disabled, Source NAT will not be performed for all client UDP packets
Default
True

References

Tenant

Sub Objects

NetworkProfileInternal

API


    GET /api/networkprofile/&ltkey>/runtime/internal/&ltkey>

CLI


    show networkprofile &ltkey> internal

Data

NetworkProfileInternal

se_uuid

Type
string
Category
optional
Description

proc_id

Type
string
Category
optional
Description

network_profile_config

Type
NetworkProfile
Category
optional
Description

np_rtm_ref_l4

Type
int32
Category
required
Description