.. _ldap_server_host_ldap_hostname:

ldap-server host ldap-hostname
==============================

Specify the hostname of LDAP server


ldap-hostname Specification
---------------------------

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

	===================================== ==================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *hostname*

	 **Collection Name**                   :ref:`2212_ldap-hostname_list`

	 **Collection URI**                    /axapi/v3/ldap-server/host/ldap-hostname

	                                       

	 **Element Name**                      ldap-hostname

	 **Element URI**                       /axapi/v3/ldap-server/host/ldap-hostname/{hostname}

	 **Element Attributes**                ldap-hostname_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ldap-hostname schema <ldap-server-host-ldap-hostname/ldap-server-host-ldap-hostname.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/ldap-server/host/ldap-hostname



.. raw:: html

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


:ref:`2212_ldap-hostname_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/ldap_server_host_ldap_hostname_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ldap-server/host/ldap-hostname



.. raw:: html

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


:ref:`2212_ldap-hostname_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/ldap-server/host/ldap-hostname/{hostname}



.. raw:: html

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


:ref:`2212_ldap-hostname_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/ldap_server_host_ldap_hostname_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ldap-server/host/ldap-hostname



.. raw:: html

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


:ref:`2212_ldap-hostname_list`



.. 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/ldap-server/host/ldap-hostname/{hostname}



.. raw:: html

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


:ref:`2212_ldap-hostname_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/ldap-server/host/ldap-hostname/{hostname}



.. raw:: html

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


:ref:`2212_ldap-hostname_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/ldap_server_host_ldap_hostname_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/ldap-server/host/ldap-hostname



.. raw:: html

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


:ref:`2212_ldap-hostname_list`



.. 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/ldap-server/host/ldap-hostname/{hostname}



.. raw:: html

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


:ref:`2212_ldap-hostname_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/ldap_server_host_ldap_hostname_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2212_ldap-hostname_list:

ldap-hostname-list
------------------


    ldap-hostname-list is **JSON List** of :ref:`2212_ldap-hostname_attributes` 

        ldap-hostname-list : [

             { :ref:`2212_ldap-hostname_attributes` },

             { :ref:`2212_ldap-hostname_attributes` },

             ...

         ]

.. _2212_ldap-hostname_attributes:

ldap-hostname attributes
------------------------

    **base**

        **Description** Configure the group DN which user belongs to

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **cn-value**

        **Description** LDAP common name identifier (i.e.: cn, uid)

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **dn-value**

        **Description** LDAP distinguished name (dn)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **domain**

        **Description** Configure AD domain name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **domain-cfg**

        **Description:** domain-cfg is a **JSON Block**.  Please see below for :ref:`2212_domain-cfg` 

        **Type:** Object

    **group**

        **Description** Configure the group DN which user belongs to

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **hostname**

        **Description** Hostname of LDAP server

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **hostname-cfg**

        **Description:** hostname-cfg is a **JSON Block**.  Please see below for :ref:`2212_hostname-cfg` 

        **Type:** Object

    **port-cfg**

        **Description:** port-cfg is a **JSON Block**.  Please see below for :ref:`2212_port-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2212_hostname-cfg:

hostname-cfg
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **port**

        **Description** Specify the LDAP server's port (default 3268 without ssl or 3269 with ssl)

        **Type:** number

        **Range:** 1-65535

    **ssl**

        **Description** Use SSL

        **Type:** boolean

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

        **Default:** 0

    **timeout**

        **Description** Specify the LDAP server's timeout (default 3)

        **Type:** number

        **Range:** 1-60

.. _2212_port-cfg:

port-cfg
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **port**

        **Description** Specify the LDAP server's port (default 389 without ssl or 636 with ssl)

        **Type:** number

        **Range:** 1-65535

    **ssl**

        **Description** Use SSL

        **Type:** boolean

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

        **Default:** 0

    **timeout**

        **Description** Specify the LDAP server's timeout (default 3)

        **Type:** number

        **Range:** 1-60

.. _2212_domain-cfg:

domain-cfg
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **port**

        **Description** Specify the LDAP server's port (default 389 without ssl or 636 with ssl)

        **Type:** number

        **Range:** 1-65535

    **ssl**

        **Description** Use SSL

        **Type:** boolean

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

        **Default:** 0

    **timeout**

        **Description** Specify the LDAP server's timeout (default 3)

        **Type:** number

        **Range:** 1-60