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:

Operation Method URI Payload

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

BaseDN

Description: Specify LDAP DN distinguished name

Type: string

Format: string-rlx

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

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

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

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