.. _system_session_oper:

system session oper
===================

Operational Status for the object session


session Specification
---------------------

	===================================== ============================================================
	 **Parameter**                         **Value** 

	===================================== ============================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      session

	 **Element URI**                       /axapi/v3/system/session/oper

	 **Element Attributes**                session_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`session schema <system-session-oper/system-session-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/system/session/oper



.. raw:: html

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


:ref:`3378_session_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/system/session/oper



.. raw:: html

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


:ref:`3378_session_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/system/session/oper



.. raw:: html

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


:ref:`3378_session_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/system/session/oper



.. raw:: html

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


:ref:`3378_session_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/system/session/oper



.. raw:: html

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


:ref:`3378_session_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3378_session_attributes:

session attributes
------------------

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`3378_oper` 

        **Type:** Object

.. _3378_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **all**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **dest-port**

        **Description** 

        **Type:** number

    **dest-v4-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **dest-v6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **filter-name**

        **Description** 

        **Type:** string

    **fw**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **fw-ipv4**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **fw-ipv6**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **helper-sessions**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **ipv4**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **ipv6**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **persist**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **persist-dest-port**

        **Description** 

        **Type:** number

    **persist-dest-v4-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **persist-dest-v6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **persist-ipv6**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **persist-ipv6-type**

        **Description** 

        **Type:** string

    **persist-source-port**

        **Description** 

        **Type:** number

    **persist-source-v4-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **persist-source-v6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **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

    **sip**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **sip-dest-port**

        **Description** 

        **Type:** number

    **sip-dest-v4-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **sip-dest-v6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **sip-source-port**

        **Description** 

        **Type:** number

    **sip-source-v4-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **sip-source-v6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **source-port**

        **Description** 

        **Type:** number

    **source-v4-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **source-v6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **uie**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **v6-dest-port**

        **Description** 

        **Type:** number

    **v6-source-port**

        **Description** 

        **Type:** number