.. _aam_authentication_session_oper:

aam authentication session oper
===============================

Operational Status for the object session


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

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

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

	 **Element Name**                      session

	 **Element URI**                       /axapi/v3/aam/authentication/session/oper

	 **Element Attributes**                session_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`109_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/aam/authentication/session/oper



.. raw:: html

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


:ref:`109_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/aam/authentication/session/oper



.. raw:: html

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


:ref:`109_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/aam/authentication/session/oper



.. raw:: html

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


:ref:`109_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/aam/authentication/session/oper



.. raw:: html

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


:ref:`109_session_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _109_session_attributes:

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

    **oper**

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

        **Type:** Object

.. _109_oper:

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

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

    **cmd-type**

        **Description** 

        **Type:** string

        **Supported Values:** sess-only, attr-only, sess-attr

    **ipv4**

        **Description** 

        **Type:** string

    **ipv6**

        **Description** 

        **Type:** string

    **partition**

        **Description** 

        **Type:** string

    **session-list**

        **Type:** List

    **username**

        **Description** 

        **Type:** string

    **vserver**

        **Description** 

        **Type:** string

.. _109_oper_session-list:

oper_session-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **Client-IP**

        **Description** 

        **Type:** string

    **Created-Time**

        **Description** 

        **Type:** string

    **Domain**

        **Description** 

        **Type:** string

    **Domain-Group**

        **Description** 

        **Type:** string

    **Session-id**

        **Description** 

        **Type:** number

    **TTL-in-seconds**

        **Description** 

        **Type:** number

    **Token-Lifetime**

        **Description** 

        **Type:** string

    **Type**

        **Description** 

        **Type:** string

    **User**

        **Description** 

        **Type:** string

    **VIP**

        **Description** 

        **Type:** string

    **VPort**

        **Description** 

        **Type:** string