health monitor method ldap

LDAP type

ldap Specification

   
Type Configuration Resource
Element Name ldap
Element URI /axapi/v3/health/monitor/{name}/method/ldap
Element Attributes ldap_attributes
Schema ldap schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/health/monitor/{name}/method/ldap

ldap attributes

Get Object

GET

/axapi/v3/health/monitor/{name}/method/ldap

ldap attributes

Modify Object

POST

/axapi/v3/health/monitor/{name}/method/ldap

ldap attributes

Replace Object

PUT

/axapi/v3/health/monitor/{name}/method/ldap

ldap attributes

Delete Object

DELETE

/axapi/v3/health/monitor/{name}/method/ldap

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