.. _sessions_oper:
sessions oper
=============
Operational Status for the object sessions
sessions Specification
----------------------
===================================== ======================================================
**Parameter** **Value**
===================================== ======================================================
**Type** *Configuration Resource*
**Element Name** sessions
**Element URI** /axapi/v3/sessions/oper
**Element Attributes** sessions_attributes
**Partition Visibility** None
**Schema** :download:`sessions schema <sessions-oper/sessions-oper.txt>`
===================================== ======================================================
**Operations Allowed:**
.. raw:: html
<script type="text/javascript">
function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
</script>
<table width='90%' style='margin-left:5%'>
.. raw:: html
<tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Create Object
.. raw:: html
</td><td valign = 'top'>
POST
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/sessions/oper
.. raw:: html
</td><td valign = 'top'>
:ref:`2678_sessions_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Get Object
.. raw:: html
</td><td valign = 'top'>
GET
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/sessions/oper
.. raw:: html
</td><td valign = 'top'>
:ref:`2678_sessions_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Modify Object
.. raw:: html
</td><td valign = 'top'>
POST
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/sessions/oper
.. raw:: html
</td><td valign = 'top'>
:ref:`2678_sessions_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Replace Object
.. raw:: html
</td><td valign = 'top'>
PUT
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/sessions/oper
.. raw:: html
</td><td valign = 'top'>
:ref:`2678_sessions_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Delete Object
.. raw:: html
</td><td valign = 'top'>
DELETE
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/sessions/oper
.. raw:: html
</td><td valign = 'top'>
:ref:`2678_sessions_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
</table>
.. _2678_sessions_attributes:
sessions attributes
-------------------
**ext**
**Description:** ext is a **JSON Block**. Please see below for :ref:`2678_ext`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/sessions/ext <sessions_ext>`
**oper**
**Description:** oper is a **JSON Block**. Please see below for :ref:`2678_oper`
**Type:** Object
**smp**
**Description:** smp is a **JSON Block**. Please see below for :ref:`2678_smp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/sessions/ext/smp <sessions_ext_smp>`
**smp-table**
**Description:** smp-table is a **JSON Block**. Please see below for :ref:`2678_smp-table`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/sessions/ext/smp/smp-table <sessions_ext_smp_smp_table>`
.. _2678_oper:
oper
^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**app**
**Description**
**Type:** string
**app-category**
**Description**
**Type:** string
**app-sessions**
**Description**
**Type:** number
**application**
**Description**
**Type:** string
**bucket**
**Description**
**Type:** number
**check-inside-user**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**dest-port**
**Description**
**Type:** number
**dst-ipv4-addr**
**Description**
**Type:** string
**Format:** ipv4-cidr
**dst-ipv6-addr**
**Description**
**Type:** string
**Format:** ipv6-address
**dst-ipv6-prefix**
**Description**
**Type:** string
**Format:** ipv6-address-plen
**ext-filter-name**
**Description**
**Type:** string
**filter_type**
**Description**
**Type:** string
**Supported Values:** ipv4, ipv6, nat44, nat64, persist-ipv6-src-ip, persist-ipv6-dst-ip, persist-ipv6-ssl-id, persist-dst-ip, persist-src-ip, persist-uie, persist-ssl-id, radius, server, virtual-server, sip, sixrd, filter, ds-lite, dns-id-switch, local, fw, clear-all, full-width, debug, application, ipsec, diameter, zone, source-port-rate-limit, source-port-rate-limitv4, source-port-rate-limitv6, gtp, extended_filter, hm
**full-width**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**fw-dest-obj**
**Description**
**Type:** string
**fw-dest-obj-grp**
**Description**
**Type:** string
**fw-dest-rserver**
**Description**
**Type:** string
**fw-dest-vserver**
**Description**
**Type:** string
**fw-dest-zone**
**Description**
**Type:** string
**fw-helper-sessions**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**fw-ip-type**
**Description**
**Type:** string
**Supported Values:** ipv4, ipv6
**fw-rule**
**Description**
**Type:** string
**fw-src-obj**
**Description**
**Type:** string
**fw-src-obj-grp**
**Description**
**Type:** string
**fw-src-rserver**
**Description**
**Type:** string
**fw-src-zone**
**Description**
**Type:** string
**gtp-msg-type**
**Description**
**Type:** string
**gtp-version**
**Description**
**Type:** string
**imsi**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**imsi-val**
**Description**
**Type:** string
**l4-protocol**
**Description**
**Type:** string
**Supported Values:** udp, tcp, icmp, icmpv6
**msisdn**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**msisdn-val**
**Description**
**Type:** string
**name-str**
**Description**
**Type:** string
**nat-ipv4-addr**
**Description**
**Type:** string
**Format:** ipv4-address
**nat-port**
**Description**
**Type:** number
**persist-dest-addr**
**Description**
**Type:** string
**Format:** ipv4-address
**persist-dest-port**
**Description**
**Type:** number
**persist-ipv4**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**persist-ipv6**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**persist-ipv6-type**
**Description**
**Type:** string
**persist-source-addr**
**Description**
**Type:** string
**Format:** ipv4-address
**persist-source-port**
**Description**
**Type:** number
**persist-type**
**Description**
**Type:** string
**persist-v6-dest-addr**
**Description**
**Type:** string
**Format:** ipv6-address
**persist-v6-dest-port**
**Description**
**Type:** number
**persist-v6-source-addr**
**Description**
**Type:** string
**Format:** ipv6-address
**persist-v6-source-port**
**Description**
**Type:** number
**rev-dest-teid**
**Description**
**Type:** number
**session-id**
**Description**
**Type:** string
**session-list**
**Type:** List
**sport-rate-limit-curr**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**sport-rate-limit-exceed**
**Description**
**Type:** boolean
**Supported Values:** true, false, 1, 0
**src-ipv4-addr**
**Description**
**Type:** string
**Format:** ipv4-cidr
**src-ipv6-addr**
**Description**
**Type:** string
**Format:** ipv6-address
**src-ipv6-prefix**
**Description**
**Type:** string
**Format:** ipv6-address-plen
**src-port**
**Description**
**Type:** number
**thread**
**Description**
**Type:** number
**total-sessions**
**Description**
**Type:** number
**uie**
**Description**
**Type:** string
**zone-name**
**Description**
**Type:** string
.. _2678_oper_session-list:
oper_session-list
^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**100ms**
**Description**
**Type:** string
**age**
**Description**
**Type:** number
**app-name**
**Description**
**Type:** string
**app-type**
**Description**
**Type:** string
**bytes**
**Description**
**Type:** number
**category-name**
**Description**
**Type:** string
**conn_idx**
**Description**
**Type:** number
**ddos_current_pkt_rate**
**Description**
**Type:** number
**ddos_exceeded_pkt_rate**
**Description**
**Type:** number
**ddos_total_fwd_bytes**
**Description**
**Type:** number
**ddos_total_out_of_order**
**Description**
**Type:** number
**ddos_total_retrans**
**Description**
**Type:** number
**ddos_total_rev_bytes**
**Description**
**Type:** number
**ddos_total_zero_window**
**Description**
**Type:** number
**dns_id**
**Description**
**Type:** number
**drop**
**Description**
**Type:** number
**duration**
**Description**
**Type:** number
**extension-fields-list**
**Type:** List
**flags**
**Description**
**Type:** string
**forward-dest**
**Description**
**Type:** string
**forward-source**
**Description**
**Type:** string
**hash**
**Description**
**Type:** number
**hash_idx**
**Description**
**Type:** number
**limit**
**Description**
**Type:** number
**peak-rate**
**Description**
**Type:** number
**protocol**
**Description**
**Type:** string
**rate**
**Description**
**Type:** number
**reverse-dest**
**Description**
**Type:** string
**reverse-source**
**Description**
**Type:** string
**rserver-name**
**Description**
**Type:** string
**service-name**
**Description**
**Type:** string
**sip_call_id**
**Description**
**Type:** string
.. _2678_oper_session-list_extension-fields-list:
oper_session-list_extension-fields-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**ext-field-name**
**Description**
**Type:** string
**ext-field-val**
**Description**
**Type:** string
.. _2678_ext:
ext
^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**oper**
**Description:** oper is a **JSON Block**. Please see below for :ref:`2678_ext_oper`
**Type:** Object
.. _2678_ext_oper:
ext_oper
^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**session-ext-list**
**Type:** List
.. _2678_ext_oper_session-ext-list:
ext_oper_session-ext-list
^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**alloc**
**Description**
**Type:** number
**alloc-exceed**
**Description**
**Type:** number
**cpu-round-robin-fail**
**Description**
**Type:** number
**fail**
**Description**
**Type:** number
**free**
**Description**
**Type:** number
**type**
**Description**
**Type:** string
.. _2678_smp-table:
smp-table
^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**oper**
**Description:** oper is a **JSON Block**. Please see below for :ref:`2678_smp-table_oper`
**Type:** Object
.. _2678_smp-table_oper:
smp-table_oper
^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**entry-list**
**Type:** List
.. _2678_smp-table_oper_entry-list:
smp-table_oper_entry-list
^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**dst4**
**Description**
**Type:** string
**Format:** ipv4-address
**dst6**
**Description**
**Type:** string
**Format:** ipv6-address
**dstport**
**Description**
**Type:** number
**payload**
**Description**
**Type:** string
**src4**
**Description**
**Type:** string
**Format:** ipv4-address
**src6**
**Description**
**Type:** string
**Format:** ipv6-address
**srcport**
**Description**
**Type:** number
**ttl**
**Description**
**Type:** number
**type**
**Description**
**Type:** string
.. _2678_smp:
smp
^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**oper**
**Description:** oper is a **JSON Block**. Please see below for :ref:`2678_smp_oper`
**Type:** Object
.. _2678_smp_oper:
smp_oper
^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**session-smp-list**
**Type:** List
.. _2678_smp_oper_session-smp-list:
smp_oper_session-smp-list
^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**alloc**
**Description**
**Type:** number
**alloc-fail**
**Description**
**Type:** number
**free**
**Description**
**Type:** number
**type**
**Description**
**Type:** string