.. _system_session: system session ============== Session Entries session Specification --------------------- ===================================== ======================================================= ===================================== ======================================================= **Type** *Configuration Resource* **Element Name** session **Element URI** /axapi/v3/system/session **Element Attributes** session_attributes **Statistics Data URI** /axapi/v3/system/session/stats **Operational Data URI** /axapi/v3/system/session/oper **Schema** :download:`session schema ` ===================================== ======================================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/system/session .. raw:: html :ref:`767_session_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/system/session .. raw:: html :ref:`767_session_attributes` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/system/session .. raw:: html :ref:`767_session_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/system/session .. raw:: html :ref:`767_session_attributes` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/system/session .. raw:: html :ref:`767_session_attributes` .. raw:: html
.. _767_session_attributes: session attributes ------------------ **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _767_sampling-enable: sampling-enable ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_l4_conn': Total L4 Count; 'conn_counter': Conn Count; 'conn_freed_counter': Conn Freed; 'total_l4_packet_count': Total L4 Packet Count; 'total_l7_packet_count': Total L7 Packet Count; 'total_l4_conn_proxy': Total L4 Conn Proxy Count; 'total_l7_conn': Total L7 Conn; 'total_tcp_conn': Total TCP Conn; 'curr_free_conn': Curr Free Conn; 'tcp_est_counter': TCP Established; 'tcp_half_open_counter': TCP Half Open; 'tcp_half_close_counter': TCP Half Closed; 'udp_counter': UDP Count; 'ip_counter': IP Count; 'other_counter': Non TCP/UDP IP sessions; 'reverse_nat_tcp_ounter': Reverse NAT TCP; 'reverse_nat_udp_ounter': Reverse NAT UDP; 'tcp_syn_half_open_counter': TCP SYN Half Open; 'conn_smp_alloc_counter': Conn SMP Alloc; 'conn_smp_free_counter': Conn SMP Free; 'conn_smp_aged_counter': Conn SMP Aged; 'ssl_count_curr': Curr SSL Count; 'ssl_count_total': Total SSL Count; 'server_ssl_count_curr': Current SSL Server Count; 'server_ssl_count_total': Total SSL Server Count; 'client_ssl_reuse_total': Total SSL Client Reuse; 'server_ssl_reuse_total': Total SSL Server Reuse; 'ssl_failed_total': Total SSL Failures; 'ssl_failed_ca_verification': SSL Cert Auth Verification Errors; 'ssl_server_cert_error': SSL Server Cert Errors; 'ssl_client_cert_auth_fail': SSL Client Cert Auth Failures; 'total_ip_nat_donn': Total IP Nat Conn; 'total_l2l3_conn': Totl L2/L3 Connections; 'client_ssl_ctx_malloc_failure': Client SSL Ctx malloc Failures; 'conn_type_0_available': Conn Type 0 Available; 'conn_type_1_available': Conn Type 1 Available; 'conn_type_2_available': Conn Type 2 Available; 'conn_type_3_available': Conn Type 3 Available; 'conn_type_4_available': Conn Type 4 Available; 'conn_smp_type_0_available': Conn SMP Type 0 Available; 'conn_smp_type_1_available': Conn SMP Type 1 Available; 'conn_smp_type_2_available': Conn SMP Type 2 Available; 'conn_smp_type_3_available': Conn SMP Type 3 Available; 'conn_smp_type_4_available': Conn SMP Type 4 Available; 'sctp-half-open-counter': SCTP Half Open; 'sctp-est-counter': SCTP Established; 'nonssl_bypass': NON SSL Bypass Count; 'ssl_failsafe_total': Total SSL Failsafe Count; 'ssl_forward_proxy_failed_handshake_total': Total SSL Forward Proxy Failed Handshake Count; 'ssl_forward_proxy_failed_tcp_total': Total SSL Forward Proxy Failed TCP Count; 'ssl_forward_proxy_failed_crypto_total': Total SSL Forward Proxy Failed Crypto Count; 'ssl_forward_proxy_failed_cert_verify_total': Total SSL Forward Proxy Failed Certificate Verification Count; 'ssl_forward_proxy_invalid_ocsp_stapling_total': Total SSL Forward Proxy Invalid OCSP Stapling Count; 'ssl_forward_proxy_revoked_ocsp_total': Total SSL Forward Proxy Revoked OCSP Response Count; 'ssl_forward_proxy_failed_cert_signing_total': Total SSL Forward Proxy Failed Certificate Signing Count; 'ssl_forward_proxy_failed_ssl_version_total': Total SSL Forward Proxy Unsupported version Count; 'ssl_forward_proxy_sni_bypass_total': Total SSL Forward Proxy SNI Bypass Count; 'ssl_forward_proxy_client_auth_bypass_total': Total SSL Forward Proxy Client Auth Bypass Count; 'conn_app_smp_alloc_counter': Conn APP SMP Alloc; **Type:** string **Supported Values:** all, total_l4_conn, conn_counter, conn_freed_counter, total_l4_packet_count, total_l7_packet_count, total_l4_conn_proxy, total_l7_conn, total_tcp_conn, curr_free_conn, tcp_est_counter, tcp_half_open_counter, tcp_half_close_counter, udp_counter, ip_counter, other_counter, reverse_nat_tcp_ounter, reverse_nat_udp_ounter, tcp_syn_half_open_counter, conn_smp_alloc_counter, conn_smp_free_counter, conn_smp_aged_counter, ssl_count_curr, ssl_count_total, server_ssl_count_curr, server_ssl_count_total, client_ssl_reuse_total, server_ssl_reuse_total, ssl_failed_total, ssl_failed_ca_verification, ssl_server_cert_error, ssl_client_cert_auth_fail, total_ip_nat_donn, total_l2l3_conn, client_ssl_ctx_malloc_failure, conn_type_0_available, conn_type_1_available, conn_type_2_available, conn_type_3_available, conn_type_4_available, conn_smp_type_0_available, conn_smp_type_1_available, conn_smp_type_2_available, conn_smp_type_3_available, conn_smp_type_4_available, sctp-half-open-counter, sctp-est-counter, nonssl_bypass, ssl_failsafe_total, ssl_forward_proxy_failed_handshake_total, ssl_forward_proxy_failed_tcp_total, ssl_forward_proxy_failed_crypto_total, ssl_forward_proxy_failed_cert_verify_total, ssl_forward_proxy_invalid_ocsp_stapling_total, ssl_forward_proxy_revoked_ocsp_total, ssl_forward_proxy_failed_cert_signing_total, ssl_forward_proxy_failed_ssl_version_total, ssl_forward_proxy_sni_bypass_total, ssl_forward_proxy_client_auth_bypass_total, conn_app_smp_alloc_counter .. _767_stats_data: stats data ---------- .. list-table:: :widths: 10 20 30 80 :header-rows: 2 :stub-columns: 1 * - - Counter - Size - Description * - - - - * - - ssl_failed_ca_verification - 8 - SSL Cert Auth Verification Errors * - - server_ssl_count_total - 8 - Total SSL Server Count * - - tcp_est_counter - 8 - TCP Established * - - conn_smp_type_1_available - 8 - Conn SMP Type 1 Available * - - ssl_forward_proxy_failed_ssl_version_total - 8 - Total SSL Forward Proxy Unsupported version Count * - - total_l4_packet_count - 8 - Total L4 Packet Count * - - total_l7_conn - 8 - Total L7 Conn * - - conn_smp_aged_counter - 8 - Conn SMP Aged * - - reverse_nat_tcp_ounter - 8 - Reverse NAT TCP * - - conn_type_1_available - 8 - Conn Type 1 Available * - - ssl_server_cert_error - 8 - SSL Server Cert Errors * - - ip_counter - 8 - IP Count * - - total_l2l3_conn - 8 - Totl L2/L3 Connections * - - ssl_failed_total - 8 - Total SSL Failures * - - conn_type_3_available - 8 - Conn Type 3 Available * - - ssl_forward_proxy_failed_crypto_total - 8 - Total SSL Forward Proxy Failed Crypto Count * - - conn_type_4_available - 8 - Conn Type 4 Available * - - conn_app_smp_alloc_counter - 8 - Conn APP SMP Alloc * - - conn_type_2_available - 8 - Conn Type 2 Available * - - conn_smp_type_0_available - 8 - Conn SMP Type 0 Available * - - total_l7_packet_count - 8 - Total L7 Packet Count * - - total_tcp_conn - 8 - Total TCP Conn * - - tcp_half_open_counter - 8 - TCP Half Open * - - ssl_client_cert_auth_fail - 8 - SSL Client Cert Auth Failures * - - ssl_forward_proxy_invalid_ocsp_stapling_total - 8 - Total SSL Forward Proxy Invalid OCSP Stapling Count * - - ssl_count_total - 8 - Total SSL Count * - - ssl_forward_proxy_failed_tcp_total - 8 - Total SSL Forward Proxy Failed TCP Count * - - conn_freed_counter - 8 - Conn Freed * - - conn_type_0_available - 8 - Conn Type 0 Available * - - conn_smp_free_counter - 8 - Conn SMP Free * - - ssl_forward_proxy_failed_handshake_total - 8 - Total SSL Forward Proxy Failed Handshake Count * - - nonssl_bypass - 8 - NON SSL Bypass Count * - - curr_free_conn - 8 - Curr Free Conn * - - client_ssl_reuse_total - 8 - Total SSL Client Reuse * - - udp_counter - 8 - UDP Count * - - conn_smp_type_2_available - 8 - Conn SMP Type 2 Available * - - reverse_nat_udp_ounter - 8 - Reverse NAT UDP * - - ssl_forward_proxy_failed_cert_verify_total - 8 - Total SSL Forward Proxy Failed Certificate Verification Count * - - sctp-half-open-counter - 8 - SCTP Half Open * - - client_ssl_ctx_malloc_failure - 8 - Client SSL Ctx malloc Failures * - - ssl_forward_proxy_client_auth_bypass_total - 8 - Total SSL Forward Proxy Client Auth Bypass Count * - - tcp_syn_half_open_counter - 8 - TCP SYN Half Open * - - total_l4_conn_proxy - 8 - Total L4 Conn Proxy Count * - - ssl_failsafe_total - 8 - Total SSL Failsafe Count * - - conn_smp_type_3_available - 8 - Conn SMP Type 3 Available * - - conn_smp_alloc_counter - 8 - Conn SMP Alloc * - - conn_counter - 8 - Conn Count * - - other_counter - 8 - Non TCP/UDP IP sessions * - - server_ssl_count_curr - 8 - Current SSL Server Count * - - server_ssl_reuse_total - 8 - Total SSL Server Reuse * - - total_ip_nat_donn - 8 - Total IP Nat Conn * - - conn_smp_type_4_available - 8 - Conn SMP Type 4 Available * - - ssl_forward_proxy_revoked_ocsp_total - 8 - Total SSL Forward Proxy Revoked OCSP Response Count * - - tcp_half_close_counter - 8 - TCP Half Closed * - - ssl_forward_proxy_sni_bypass_total - 8 - Total SSL Forward Proxy SNI Bypass Count * - - total_l4_conn - 8 - Total L4 Count * - - ssl_forward_proxy_failed_cert_signing_total - 8 - Total SSL Forward Proxy Failed Certificate Signing Count * - - sctp-est-counter - 8 - SCTP Established * - - ssl_count_curr - 8 - Curr SSL Count .. _767_oper_data: operational data ---------------- .. list-table:: :widths: 10 20 30 80 :header-rows: 2 :stub-columns: 1 * - - Counter - Size - Description * - - - - * - - all - flag - all * - - uie - flag - uie * - - v6-source-port - number - v6-source-port * - - persist-source-port - number - persist-source-port * - - persist-v6-source-addr - ipv6-address - persist-v6-source-addr * - - v6-dest-port - number - v6-dest-port * - - persist-dest-v6-addr - ipv6-address - persist-dest-v6-addr * - - persist-ipv6 - flag - persist-ipv6 * - - sip - flag - sip * - - persist-ipv6-type - string - persist-ipv6-type * - - ipv4 - flag - ipv4 * - - persist-dest-port - number - persist-dest-port * - - persist - flag - persist * - - persist-v6-source-port - number - persist-v6-source-port * - - persist-source-v4-addr - ipv4-address - persist-source-v4-addr * - - source-v6-addr - ipv6-address - source-v6-addr * - - sip-source-port - number - sip-source-port * - - fw - flag - fw * - - source-v4-addr - ipv4-address - source-v4-addr * - - persist-type - string - persist-type * - - persist-v6-dest-port - number - persist-v6-dest-port * - - ipv6 - flag - ipv6 * - - dest-v6-addr - ipv6-address - dest-v6-addr * - - fw-ipv4 - flag - fw-ipv4 * - - filter-name - string - filter-name * - - fw-ipv6 - flag - fw-ipv6 * - - persist-dest-v4-addr - ipv4-address - persist-dest-v4-addr * - - dest-port - number - dest-port * - - source-port - number - source-port * - - sip-source-v6-addr - ipv6-address - sip-source-v6-addr * - - sip-dest-v4-addr - ipv4-address - sip-dest-v4-addr * - - persist-v6-dest-addr - ipv6-address - persist-v6-dest-addr * - - dest-v4-addr - ipv4-address - dest-v4-addr * - - sip-dest-v6-addr - ipv6-address - sip-dest-v6-addr * - - helper-sessions - flag - helper-sessions * - - persist-source-v6-addr - ipv6-address - persist-source-v6-addr * - - sip-source-v4-addr - ipv4-address - sip-source-v4-addr * - - sip-dest-port - number - sip-dest-port