network_profile#

States module for managing Profiles Network Profiles.

async idem_vmware_alb.states.avilb.profiles.network_profile.present(hub, ctx, name: str, profile: profile, resource_id: str = None, configpb_attributes: configpb_attributes = None, connection_mirror: bool = None, description: str = None, markers: List[markers] = None, tenant_ref: str = None) → Dict[str, Any][source]#

None: None

Parameters:

name (str) – Idem name of the resource.
profile (dict[str, Any]) –
profile.
- sctp_fast_path_profile (dict[str, Any], Optional):
  sctp_fast_path_profile. Defaults to None.
  - enable_init_chunk_protection (bool, Optional):
    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. Defaults to None.
  - idle_timeout (int, Optional):
    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. Defaults to None.
- sctp_proxy_profile (dict[str, Any], Optional):
  sctp_proxy_profile. Defaults to None.
  - cookie_expiration_timeout (int, Optional):
    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. Defaults to None.
  - heartbeat_interval (int, Optional):
    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. Defaults to None.
  - idle_timeout (int, Optional):
    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. Defaults to None.
  - max_retransmissions_association (int, Optional):
    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. Defaults to None.
  - max_retransmissions_init_chunks (int, Optional):
    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. Defaults to None.
  - number_of_streams (int, Optional):
    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. Defaults to None.
  - receive_window (int, Optional):
    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. Defaults to None.
  - reset_timeout (int, Optional):
    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. Defaults to None.
- tcp_fast_path_profile (dict[str, Any], Optional):
  tcp_fast_path_profile. Defaults to None.
  - dsr_profile (dict[str, Any], Optional):
    dsr_profile. Defaults to None.
    
    dsr_encap_type (str):
    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 (str):
    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.
  - enable_syn_protection (bool, Optional):
    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. Defaults to None.
  - session_idle_timeout (int, Optional):
    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. Defaults to None.
- tcp_proxy_profile (dict[str, Any], Optional):
  tcp_proxy_profile. Defaults to None.
  - aggressive_congestion_avoidance (bool, Optional):
    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. Defaults to None.
  - auto_window_growth (bool, Optional):
    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. Defaults to None.
  - automatic (bool, Optional):
    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. Defaults to None.
  - cc_algo (str, Optional):
    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. Defaults to None.
  - congestion_recovery_scaling_factor (int, Optional):
    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. Defaults to None.
  - idle_connection_timeout (int, Optional):
    The duration for keepalive probes or session idle timeout. Max value is 14400 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. Defaults to None.
  - idle_connection_type (str, Optional):
    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. Defaults to None.
  - ignore_time_wait (bool, Optional):
    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. Defaults to None.
  - ip_dscp (int, Optional):
    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. Defaults to None.
  - keepalive_in_halfclose_state (bool, Optional):
    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. Defaults to None.
  - max_retransmissions (int, Optional):
    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. Defaults to None.
  - max_segment_size (int, Optional):
    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. Defaults to None.
  - max_syn_retransmissions (int, Optional):
    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. Defaults to None.
  - min_rexmt_timeout (int, Optional):
    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. Defaults to None.
  - nagles_algorithm (bool, Optional):
    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. Defaults to None.
  - reassembly_queue_size (int, Optional):
    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. Defaults to None.
  - receive_window (int, Optional):
    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. Defaults to None.
  - reorder_threshold (int, Optional):
    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. Defaults to None.
  - slow_start_scaling_factor (int, Optional):
    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. Defaults to None.
  - time_wait_delay (int, Optional):
    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. Defaults to None.
  - use_interface_mtu (bool, Optional):
    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. Defaults to None.
- type (str):
  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 (dict[str, Any], Optional):
  udp_fast_path_profile. Defaults to None.
  - dsr_profile (dict[str, Any], Optional):
    dsr_profile. Defaults to None.
    
    dsr_encap_type (str):
    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 (str):
    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.
  - per_pkt_loadbalance (bool, Optional):
    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. Defaults to None.
  - session_idle_timeout (int, Optional):
    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. Defaults to None.
  - snat (bool, Optional):
    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. Defaults to None.
- udp_proxy_profile (dict[str, Any], Optional):
  udp_proxy_profile. Defaults to None.
  - session_idle_timeout (int, Optional):
    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. Defaults to None.
resource_id (str, Optional) – profiles.network_profile unique ID. Defaults to None.
x_avi_tenant (str, Optional) – Avi Tenant Header. Defaults to None.
x_avi_tenant_uuid (str, Optional) – Avi Tenant Header UUID. Defaults to None.
x_csrf_token (str, Optional) – Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. Defaults to None.
_last_modified (str, Optional) – UNIX time since epoch in microseconds. Units(MICROSECONDS). Defaults to None.
configpb_attributes (dict[str, Any], Optional) –
configpb_attributes. Defaults to None.
- version (int, Optional):
  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. Defaults to None.
connection_mirror (bool, Optional) – 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. Defaults to None.
description (str, Optional) – Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
markers (List[dict[str, Any]], Optional) –
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. Defaults to None.
- key (str):
  Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
- values (List[str], Optional):
  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. Defaults to None.
tenant_ref (str, Optional) – It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.

Returns:

Dict[str, Any]

Example

idem_test_avilb.profiles.network_profile_is_present:
    avilb.avilb.profiles.network_profile.present:
    - configpb_attributes:
        version: int
    - connection_mirror: bool
    - description: string
    - markers:
      - key: string
        values:
        - value
    - profile:
        sctp_fast_path_profile:
          enable_init_chunk_protection: bool
          idle_timeout: int
        sctp_proxy_profile:
          cookie_expiration_timeout: int
          heartbeat_interval: int
          idle_timeout: int
          max_retransmissions_association: int
          max_retransmissions_init_chunks: int
          number_of_streams: int
          receive_window: int
          reset_timeout: int
        tcp_fast_path_profile:
          dsr_profile:
            dsr_encap_type: string
            dsr_type: string
          enable_syn_protection: bool
          session_idle_timeout: int
        tcp_proxy_profile:
          aggressive_congestion_avoidance: bool
          auto_window_growth: bool
          automatic: bool
          cc_algo: string
          congestion_recovery_scaling_factor: int
          idle_connection_timeout: int
          idle_connection_type: string
          ignore_time_wait: bool
          ip_dscp: int
          keepalive_in_halfclose_state: bool
          max_retransmissions: int
          max_segment_size: int
          max_syn_retransmissions: int
          min_rexmt_timeout: int
          nagles_algorithm: bool
          reassembly_queue_size: int
          receive_window: int
          reorder_threshold: int
          slow_start_scaling_factor: int
          time_wait_delay: int
          use_interface_mtu: bool
        type_: string
        udp_fast_path_profile:
          dsr_profile:
            dsr_encap_type: string
            dsr_type: string
          per_pkt_loadbalance: bool
          session_idle_timeout: int
          snat: bool
        udp_proxy_profile:
          session_idle_timeout: int
    - tenant_ref: string

async idem_vmware_alb.states.avilb.profiles.network_profile.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

None: None

Parameters:

name (str) – Idem name of the resource.
resource_id (str, Optional) – profiles.network_profile unique ID. Defaults to None.

Returns:

Dict[str, Any]

Example

idem_test_avilb.profiles.network_profile_is_absent:
  avilb.avilb.profiles.network_profile.absent:

async idem_vmware_alb.states.avilb.profiles.network_profile.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function

None: None

Args:

Returns:: Dict[str, Any]

Example

$ idem describe avilb.profiles.network_profile