.. _health_monitor_method_ldap:

health monitor method ldap
==========================

LDAP type


ldap Specification
------------------

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

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

	 **Element Name**                      ldap

	 **Element URI**                       /axapi/v3/health/monitor/{name}/method/ldap

	 **Element Attributes**                ldap_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ldap schema <health-monitor-method-ldap/health-monitor-method-ldap.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/health/monitor/{name}/method/ldap



.. raw:: html

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


:ref:`1844_ldap_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/health_monitor_method_ldap_POST.txt
   :literal:




.. raw:: html

   </div></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/health/monitor/{name}/method/ldap



.. raw:: html

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


:ref:`1844_ldap_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/health_monitor_method_ldap_GET.txt
   :literal:




.. raw:: html

   </div></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/health/monitor/{name}/method/ldap



.. raw:: html

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


:ref:`1844_ldap_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/health/monitor/{name}/method/ldap



.. raw:: html

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


:ref:`1844_ldap_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/health_monitor_method_ldap_PUT.txt
   :literal:




.. raw:: html

   </div></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/health/monitor/{name}/method/ldap



.. raw:: html

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


:ref:`1844_ldap_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/health_monitor_method_ldap_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1844_ldap_attributes:

ldap attributes
---------------

    **AcceptNotFound**

        **Description** Mark server up on receiving a not-found response

        **Type:** boolean

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

        **Default:** 0

    **AcceptResRef**

        **Description** Mark server up on receiving a search result reference response

        **Type:** boolean

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

        **Default:** 0

    **BaseDN**

        **Description** Specify LDAP DN distinguished name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **ldap**

        **Description** LDAP type

        **Type:** boolean

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

        **Default:** 0

    **ldap-binddn**

        **Description** Specify the distinguished name for bindRequest (LDAP DN distinguished name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **ldap-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **ldap-password**

        **Description** Specify the user password

        **Type:** boolean

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

        **Default:** 0

    **ldap-password-string**

        **Description** Configure password, '' means empty password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **ldap-port**

        **Description** Specify the LDAP port (Speciry port number, default is 389, or 636 if LDAP over SSL)

        **Type:** number

        **Range:** 1-65534

        **Default:** 389

    **ldap-query**

        **Description** LDAP query to be excuted

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **ldap-run-search**

        **Description** Specify a query to be executed

        **Type:** boolean

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

        **Default:** 0

    **ldap-security**

        **Description** 'overssl': Set LDAP over SSL; 'StartTLS': LDAP switch to TLS; 

        **Type:** string

        **Supported Values:** overssl, StartTLS

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters