ldap-server¶
Configure LDAP server information
ldap-server Specification¶
Type Intermediate Resource Element Name ldap-server Element URI /axapi/v3/ldap-server Element Attributes ldap-server_attributes Schema ldap-server schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/ldap-server | ldap-server_attributes |
ldap-server attributes¶
host
Description: host is a JSON Block. Please see below for host
Type: Object
Reference Object: /axapi/v3/ldap-server/host
host¶
Specification Type object ipv4-list
Type: List
Reference Object: /axapi/v3/ldap-server/host/ipv4/{ipv4-addr}
ipv6-list
Type: List
Reference Object: /axapi/v3/ldap-server/host/ipv6/{ipv6-addr}
ldap-hostname-list
Type: List
Reference Object: /axapi/v3/ldap-server/host/ldap-hostname/{hostname}
host_ldap-hostname-list¶
Specification 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 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 host_ldap-hostname-list_hostname-cfg
Type: Object
port-cfg
Description: port-cfg is a JSON Block. Please see below for host_ldap-hostname-list_port-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
host_ldap-hostname-list_hostname-cfg¶
Specification 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
host_ldap-hostname-list_port-cfg¶
Specification 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
host_ldap-hostname-list_domain-cfg¶
Specification 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
host_ipv4-list¶
Specification 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 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 host_ipv4-list_ipv4-addr-cfg
Type: Object
port-cfg
Description: port-cfg is a JSON Block. Please see below for host_ipv4-list_port-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
host_ipv4-list_ipv4-addr-cfg¶
Specification 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
host_ipv4-list_port-cfg¶
Specification 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
host_ipv4-list_domain-cfg¶
Specification 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
host_ipv6-list¶
Specification 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 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 host_ipv6-list_ipv6-addr-cfg
Type: Object
port-cfg
Description: port-cfg is a JSON Block. Please see below for host_ipv6-list_port-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
host_ipv6-list_port-cfg¶
Specification 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
host_ipv6-list_ipv6-addr-cfg¶
Specification 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
host_ipv6-list_domain-cfg¶
Specification 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