.. _sessions:

sessions
========




sessions Specification
----------------------

	===================================== =================================================
	===================================== =================================================
	 **Type**                              *operational*

	 **Element Name**                      sessions

	 **Element URI**                       /axapi/v3/sessions

	 **Element Attributes**                sessions_attributes

	 **Operational Data URI**              /axapi/v3/sessions/oper

	 **Schema**                             :download:`sessions schema <sessions/sessions.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'>


EXECUTE Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sessions



.. raw:: html

   </td><td valign = 'top'>


:ref:`1610_sessions_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _1610_sessions_attributes:

sessions attributes
-------------------

    **ext**

        **Description:** ext is a **JSON Block**.  Please see below for :ref:`1610_ext` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sessions/ext <sessions_ext>`

    **smp**

        **Description:** smp is a **JSON Block**.  Please see below for :ref:`1610_smp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sessions/smp <sessions_smp>`

    **smp-table**

        **Description:** smp-table is a **JSON Block**.  Please see below for :ref:`1610_smp-table` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sessions/smp-table <sessions_smp_table>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1610_ext:

ext
^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1610_smp-table:

smp-table
^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1610_smp:

smp
^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1610_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - sport-rate-limit-exceed
      - flag
      - sport-rate-limit-exceed

   *  - 
      - app
      - string
      - app

   *  - 
      - gtp-msg-type
      - string
      - gtp-msg-type

   *  - 
      - fw-dest-zone
      - string
      - fw-dest-zone

   *  - 
      - src-port
      - number
      - src-port

   *  - 
      - fw-dest-vserver
      - string
      - fw-dest-vserver

   *  - 
      - nat-port
      - number
      - nat-port

   *  - 
      - dst-ipv4-addr
      - ipv4-cidr
      - dst-ipv4-addr

   *  - 
      - app-sessions
      - number
      - app-sessions

   *  - 
      - fw-rule
      - string
      - fw-rule

   *  - 
      - fw-src-obj
      - string
      - fw-src-obj

   *  - 
      - fw-src-rserver
      - string
      - fw-src-rserver

   *  - 
      - imsi-val
      - string
      - imsi-val

   *  - 
      - application
      - string
      - application

   *  - 
      - session-id
      - string
      - session-id

   *  - 
      - nat-ipv4-addr
      - ipv4-address
      - nat-ipv4-addr

   *  - 
      - session-list
      - 
      - session-list

   *  - 
      - full-width
      - flag
      - full-width

   *  - 
      - fw-dest-obj-grp
      - string
      - fw-dest-obj-grp

   *  - 
      - src-ipv6-prefix
      - ipv6-address-plen
      - src-ipv6-prefix

   *  - 
      - l4-protocol
      - enum
      -  Output contains one of the following values: - udp, tcp, icmp, icmpv6

   *  - 
      - imsi
      - flag
      - imsi

   *  - 
      - fw-src-obj-grp
      - string
      - fw-src-obj-grp

   *  - 
      - check-inside-user
      - flag
      - check-inside-user

   *  - 
      - gtp-version
      - string
      - gtp-version

   *  - 
      - sport-rate-limit-curr
      - flag
      - sport-rate-limit-curr

   *  - 
      - name-str
      - string
      - name-str

   *  - 
      - msisdn
      - flag
      - msisdn

   *  - 
      - total-sessions
      - number
      - total-sessions

   *  - 
      - zone-name
      - string
      - zone-name

   *  - 
      - fw-dest-rserver
      - string
      - fw-dest-rserver

   *  - 
      - fw-helper-sessions
      - flag
      - fw-helper-sessions

   *  - 
      - rev-dest-teid
      - number
      - rev-dest-teid

   *  - 
      - fw-ip-type
      - enum
      -  Output contains one of the following values: - ipv4, ipv6

   *  - 
      - fw-dest-obj
      - string
      - fw-dest-obj

   *  - 
      - filter_type
      - enum
      -  Output contains one of the following 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

   *  - 
      - dst-ipv6-prefix
      - ipv6-address-plen
      - dst-ipv6-prefix

   *  - 
      - src-ipv6-addr
      - ipv6-address
      - src-ipv6-addr

   *  - 
      - dst-ipv6-addr
      - ipv6-address
      - dst-ipv6-addr

   *  - 
      - fw-src-zone
      - string
      - fw-src-zone

   *  - 
      - src-ipv4-addr
      - ipv4-cidr
      - src-ipv4-addr

   *  - 
      - app-category
      - string
      - app-category

   *  - 
      - msisdn-val
      - string
      - msisdn-val

   *  - 
      - dest-port
      - number
      - dest-port