ldap-server host ldap-hostname¶

Specify the hostname of LDAP server

ldap-hostname Specification¶

Parameter Value

Type Collection

Object Key(s) hostname

Collection Name 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 ldap-hostname schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ldap-server/host/ldap-hostname	ldap-hostname attributes
Create List	POST	/axapi/v3/ldap-server/host/ldap-hostname	ldap-hostname attributes
Get Object	GET	/axapi/v3/ldap-server/host/ldap-hostname/{hostname}	ldap-hostname attributes
Get List	GET	/axapi/v3/ldap-server/host/ldap-hostname	ldap-hostname-list
Modify Object	POST	/axapi/v3/ldap-server/host/ldap-hostname/{hostname}	ldap-hostname attributes
Replace Object	PUT	/axapi/v3/ldap-server/host/ldap-hostname/{hostname}	ldap-hostname attributes
Replace List	PUT	/axapi/v3/ldap-server/host/ldap-hostname	ldap-hostname-list
Delete Object	DELETE	/axapi/v3/ldap-server/host/ldap-hostname/{hostname}	ldap-hostname attributes

ldap-hostname-list¶

ldap-hostname-list is JSON List of ldap-hostname attributes

ldap-hostname-list : [

{ ldap-hostname attributes },

{ 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 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 hostname-cfg

Type: Object

port-cfg

Description: port-cfg is a JSON Block. Please see below for port-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

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

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

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