.. _ldap_server:

ldap-server
===========

Configure LDAP server information


ldap-server Specification
-------------------------

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

	===================================== ====================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      ldap-server

	 **Element URI**                       /axapi/v3/ldap-server

	 **Element Attributes**                ldap-server_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ldap-server



.. raw:: html

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


ldap-server_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2214_ldap-server_attributes:

ldap-server attributes
----------------------

    **host**

        **Description:** host is a **JSON Block**.  Please see below for :ref:`2214_host` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ldap-server/host <ldap_server_host>`

.. _2214_host:

host
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv4-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ldap-server/host/ipv4/{ipv4-addr} <ldap_server_host_ipv4>`

    **ipv6-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ldap-server/host/ipv6/{ipv6-addr} <ldap_server_host_ipv6>`

    **ldap-hostname-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ldap-server/host/ldap-hostname/{hostname} <ldap_server_host_ldap_hostname>`

.. _2214_host_ldap-hostname-list:

host_ldap-hostname-list
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **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:`2214_host_ldap-hostname-list_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:`2214_host_ldap-hostname-list_hostname-cfg` 

        **Type:** Object

    **port-cfg**

        **Description:** port-cfg is a **JSON Block**.  Please see below for :ref:`2214_host_ldap-hostname-list_port-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2214_host_ldap-hostname-list_hostname-cfg:

host_ldap-hostname-list_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

.. _2214_host_ldap-hostname-list_port-cfg:

host_ldap-hostname-list_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

.. _2214_host_ldap-hostname-list_domain-cfg:

host_ldap-hostname-list_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

.. _2214_host_ipv4-list:

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

	 **Block object keys**             

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

    **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:`2214_host_ipv4-list_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

    **ipv4-addr**

        **Description** IPV4 address of ldap server

        **Type:** string

        **Format:** ipv4-address

    **ipv4-addr-cfg**

        **Description:** ipv4-addr-cfg is a **JSON Block**.  Please see below for :ref:`2214_host_ipv4-list_ipv4-addr-cfg` 

        **Type:** Object

    **port-cfg**

        **Description:** port-cfg is a **JSON Block**.  Please see below for :ref:`2214_host_ipv4-list_port-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2214_host_ipv4-list_ipv4-addr-cfg:

host_ipv4-list_ipv4-addr-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

.. _2214_host_ipv4-list_port-cfg:

host_ipv4-list_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

.. _2214_host_ipv4-list_domain-cfg:

host_ipv4-list_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

.. _2214_host_ipv6-list:

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

	 **Block object keys**             

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

    **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:`2214_host_ipv6-list_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

    **ipv6-addr**

        **Description** IPV6 address of ldap server

        **Type:** string

        **Format:** ipv6-address

    **ipv6-addr-cfg**

        **Description:** ipv6-addr-cfg is a **JSON Block**.  Please see below for :ref:`2214_host_ipv6-list_ipv6-addr-cfg` 

        **Type:** Object

    **port-cfg**

        **Description:** port-cfg is a **JSON Block**.  Please see below for :ref:`2214_host_ipv6-list_port-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2214_host_ipv6-list_port-cfg:

host_ipv6-list_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

.. _2214_host_ipv6-list_ipv6-addr-cfg:

host_ipv6-list_ipv6-addr-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

.. _2214_host_ipv6-list_domain-cfg:

host_ipv6-list_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