.. _aam_authentication_server_oper:

aam authentication server oper
==============================

Operational Status for the object server


server Specification
--------------------

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

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

	 **Element Name**                      server

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

	 **Element Attributes**                server_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`90_server_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/server/oper



.. raw:: html

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


:ref:`90_server_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/server/oper



.. raw:: html

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


:ref:`90_server_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/server/oper



.. raw:: html

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


:ref:`90_server_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/server/oper



.. raw:: html

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


:ref:`90_server_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _90_server_attributes:

server attributes
-----------------

    **ldap**

        **Description:** ldap is a **JSON Block**.  Please see below for :ref:`90_ldap` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/ldap <aam_authentication_server_ldap>`

    **ocsp**

        **Description:** ocsp is a **JSON Block**.  Please see below for :ref:`90_ocsp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/ocsp <aam_authentication_server_ocsp>`

    **oper**

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

        **Type:** Object

    **windows**

        **Description:** windows is a **JSON Block**.  Please see below for :ref:`90_windows` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/windows <aam_authentication_server_windows>`

.. _90_oper:

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

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

    **get-count**

        **Description** 

        **Type:** string

    **name**

        **Description** 

        **Type:** string

    **part-id**

        **Description** 

        **Type:** number

    **rport-count**

        **Description** 

        **Type:** number

    **rserver-count**

        **Description** 

        **Type:** number

    **rserver-list**

        **Type:** List

.. _90_oper_rserver-list:

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

	 **Block object keys**             

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

    **hm**

        **Description** 

        **Type:** string

    **host**

        **Description** 

        **Type:** string

    **ip**

        **Description** 

        **Type:** string

    **max-conn**

        **Description** 

        **Type:** number

    **rport-list**

        **Type:** List

    **server-name**

        **Description** 

        **Type:** string

    **status**

        **Description** 

        **Type:** string

    **weight**

        **Description** 

        **Type:** number

.. _90_oper_rserver-list_rport-list:

oper_rserver-list_rport-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **port**

        **Description** 

        **Type:** number

    **port-hm**

        **Description** 

        **Type:** string

    **port-max-conn**

        **Description** 

        **Type:** number

    **port-state**

        **Description** 

        **Type:** string

    **port-status**

        **Description** 

        **Type:** string

    **port-weight**

        **Description** 

        **Type:** number

    **protocol**

        **Description** 

        **Type:** string

    **sg-list**

        **Type:** List

.. _90_oper_rserver-list_rport-list_sg-list:

oper_rserver-list_rport-list_sg-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **sg-name**

        **Description** 

        **Type:** string

    **sg-state**

        **Description** 

        **Type:** string

.. _90_windows:

windows
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`90_windows_oper` 

        **Type:** Object

.. _90_windows_oper:

windows_oper
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **name**

        **Description** 

        **Type:** string

    **stats-clear-type**

        **Description** 

        **Type:** string

        **Supported Values:** windows, kerberos, ntlm

.. _90_ocsp:

ocsp
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`90_ocsp_oper` 

        **Type:** Object

.. _90_ocsp_oper:

ocsp_oper
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **name**

        **Description** 

        **Type:** string

    **stats-clear-type**

        **Description** 

        **Type:** string

        **Supported Values:** ocsp, ocsp-stapling

.. _90_ldap:

ldap
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`90_ldap_oper` 

        **Type:** Object

.. _90_ldap_oper:

ldap_oper
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ldaps-server-list**

        **Type:** List

.. _90_ldap_oper_ldaps-server-list:

ldap_oper_ldaps-server-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ldap-uri**

        **Description** 

        **Type:** string

    **ldaps-idle-conn-fd-list**

        **Description** 

        **Type:** string

    **ldaps-idle-conn-num**

        **Description** 

        **Type:** number

    **ldaps-inuse-conn-fd-list**

        **Description** 

        **Type:** string

    **ldaps-inuse-conn-num**

        **Description** 

        **Type:** number