health monitor method¶
Define the health method object, default is ICMP
method Specification¶
Parameter Value Type Intermediate Resource Element Name method Element URI /axapi/v3/health/monitor/{name}/method Element Attributes method_attributes Partition Visibility shared Schema method schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/health/monitor/{name}/method | method_attributes |
method attributes¶
compound
Description: compound is a JSON Block. Please see below for compound
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/compound
database
Description: database is a JSON Block. Please see below for database
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/database
dns
Description: dns is a JSON Block. Please see below for dns
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/dns
external
Description: external is a JSON Block. Please see below for external
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/external
ftp
Description: ftp is a JSON Block. Please see below for ftp
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/ftp
http
Description: http is a JSON Block. Please see below for http
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/http
https
Description: https is a JSON Block. Please see below for https
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/https
icmp
Description: icmp is a JSON Block. Please see below for icmp
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/icmp
imap
Description: imap is a JSON Block. Please see below for imap
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/imap
kerberos-kdc
Description: kerberos-kdc is a JSON Block. Please see below for kerberos-kdc
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/kerberos-kdc
ldap
Description: ldap is a JSON Block. Please see below for ldap
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/ldap
ntp
Description: ntp is a JSON Block. Please see below for ntp
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/ntp
pop3
Description: pop3 is a JSON Block. Please see below for pop3
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/pop3
quic
Description: quic is a JSON Block. Please see below for quic
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/quic
radius
Description: radius is a JSON Block. Please see below for radius
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/radius
rtsp
Description: rtsp is a JSON Block. Please see below for rtsp
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/rtsp
sip
Description: sip is a JSON Block. Please see below for sip
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/sip
smtp
Description: smtp is a JSON Block. Please see below for smtp
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/smtp
snmp
Description: snmp is a JSON Block. Please see below for snmp
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/snmp
tacplus
Description: tacplus is a JSON Block. Please see below for tacplus
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/tacplus
tcp
Description: tcp is a JSON Block. Please see below for tcp
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/tcp
udp
Description: udp is a JSON Block. Please see below for udp
Type: Object
Reference Object: /axapi/v3/health/monitor/{name}/method/udp
rtsp¶
Specification Value Type object rtsp
Description RTSP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rtsp-port
Description Specify RTSP port, default is 554 (Port Number (default 554))
Type: number
Range: 1-65534
Default: 554
rtspurl
Description Specify URL string (Specify the path on the server)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
smtp¶
Specification Value Type object mail-from
Description Specify SMTP Sender
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
rcpt-to
Description Specify SMTP Receiver
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
smtp
Description SMTP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
smtp-domain
Description Specify domain name of ‘helo’ command
Type: string
Format: host
Maximum Length: 254 characters
Maximum Length: 1 characters
smtp-port
Description Specify SMTP port, default is 25 (Port Number (default 25))
Type: number
Range: 1-65534
Default: 25
smtp-starttls
Description Check the STARTTLS support at helo response
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tcp¶
Specification Value Type object maintenance
Description Specify response text for maintenance
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
maintenance-text
Description Specify text for maintenance
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
method-tcp
Description TCP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-halfopen
Description Set TCP SYN check
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: port-halfopen and port-send are mutually exclusive
port-resp
Description: port-resp is a JSON Block. Please see below for tcp_port-resp
Type: Object
port-send
Description Send a string to server (Specify the string)
Type: string
Format: string-rlx
Maximum Length: 511 characters
Maximum Length: 1 characters
Mutual Exclusion: port-send and port-halfopen are mutually exclusive
tcp-port
Description Specify TCP port (Specify port number)
Type: number
Range: 1-65534
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tcp_port-resp¶
Specification Value Type object port-contains
Description Mark server up if response string contains string (Specify the string)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
radius¶
Specification Value Type object radius
Description RADIUS type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
radius-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)radius-expect
Description Specify what you expect from the response message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
radius-password-string
Description Configure password, ‘’ means empty password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
radius-port
Description Specify the RADIUS port, default is 1812 (Port number (default 1812))
Type: number
Range: 1-65534
Default: 1812
radius-response-code
Description Specify response code range (e.g. 2,4-7) (Format is xx,xx-xx (xx between [1, 13]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
radius-secret
Description Configure shared secret of RADIUS server
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
radius-secret-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)radius-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
https¶
Specification Value Type object cert
Description Specify client certificate (Certificate name)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
cert-key-shared
Description Select shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable-sslv2hello
Description Disable SSLv2Hello for HTTPs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-version
Description ‘http-version2’: HTTP version 2 for HTTPs; ‘http-version3’: HTTP version 3 for HTTPs;
Type: string
Supported Values: http-version2, http-version3
https
Description HTTPS type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
https-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)https-expect
Description Specify what you expect from the response message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
https-host
Description Specify “Host:” header used in request (enclose IPv6 address in [])
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
https-kerberos-auth
Description Https Kerberos Auth
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
https-kerberos-kdc
Description: https-kerberos-kdc is a JSON Block. Please see below for https_https-kerberos-kdc
Type: Object
https-kerberos-realm
Description Specify realm of Kerberos server
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
https-key-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)https-maintenance-code
Description Specify response code for maintenance (Format is xx,xx-xx (xx between [100, 899])
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
https-password
Description Specify the user password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
https-password-string
Description Configure password, ‘’ means empty password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
https-postdata
Description Specify the HTTP post data (Input post data here)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
https-postfile
Description Specify the HTTP post data (Input post data file name here)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
https-response-code
Description Specify response code range (e.g. 200,400-430) (Format is xx,xx-xx (xx between [100, 899])
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: https-response-code and https-text are mutually exclusive
https-server-cert-name
Description Expect Server Cert commonName
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
https-text
Description Specify text expected
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: https-text, https-response-code, and text-regex are mutually exclusive
https-url
Description Specify URL string, default is GET /
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
https-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
key
Description Specify client private key (Key name)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
key-pass-phrase
Description Client private key password phrase
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
key-phrase
Description Password Phrase
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
maintenance
Description Specify response text for maintenance
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
maintenance-text
Description Specify text for maintenance
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: maintenance-text and maintenance-text-regex are mutually exclusive
maintenance-text-regex
Description Specify Regex text for maintenance
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: maintenance-text-regex and maintenance-text are mutually exclusive
post-path
Description Specify URL path, default is “/”
Type: string
Format: string-rlx
Maximum Length: 500 characters
Maximum Length: 1 characters
post-type
Description ‘postdata’: Specify the HTTP post data; ‘postfile’: Specify the HTTP post data;
Type: string
Supported Values: postdata, postfile
response-code-regex
Description Specify response code range with Regex (code with Regex, such as [2-5][0-9][0-9])
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
sni
Description Server Name Indication for HTTPs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
text-regex
Description Specify text expected with Regex
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: text-regex and https-text are mutually exclusive
url-path
Description Specify URL path, default is “/”
Type: string
Format: string-rlx
Maximum Length: 500 characters
Maximum Length: 1 characters
url-type
Description ‘GET’: HTTP GET method; ‘POST’: HTTP POST method; ‘HEAD’: HTTP HEAD method;
Type: string
Supported Values: GET, POST, HEAD
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
web-port
Description Specify HTTPS port (Port Number (default 443))
Type: number
Range: 1-65534
Default: 443
https_https-kerberos-kdc¶
Specification Value Type object https-kerberos-hostip
Description Kdc’s hostname(length:1-31) or IP address
Type: string
Format: host
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: https-kerberos-hostip and https-kerberos-hostipv6 are mutually exclusive
https-kerberos-hostipv6
Description Server’s IPV6 address
Type: string
Format: ipv6-address
Mutual Exclusion: https-kerberos-hostipv6 and https-kerberos-hostip are mutually exclusive
https-kerberos-port
Description Specify the kdc port
Type: number
Range: 1-65535
https-kerberos-portv6
Description Specify the kdc port
Type: number
Range: 1-65535
ftp¶
Specification Value Type object ftp
Description FTP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ftp-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)ftp-password
Description Specify the user password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ftp-password-string
Description Specify the user password, ‘’ means empty password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
ftp-port
Description Specify FTP port (Specify port number, default is 21)
Type: number
Range: 1-65534
Default: 21
ftp-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sip¶
Specification Value Type object expect-response-code
Description Specify accepted response codes (e.g. 200, 400-430, any) (Format is xxx,xxx-xxx,any (xxx between [100,899]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
register
Description Send SIP REGISTER message, default is to send OPTION message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sip
Description SIP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sip-hostname
Description Specify the SIP hostname that used in request
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
sip-port
Description Specify the SIP port, default is 5060 (Port Number)
Type: number
Range: 1-65534
Default: 5060
sip-tcp
Description Use TCP for transmission, default is UDP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
snmp¶
Specification Value Type object community
Description Specify SNMP community, default is “public” (Community String)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Default: public
oid
Description: oid is a JSON Block. Please see below for snmp_oid
Type: Object
operation
Description: operation is a JSON Block. Please see below for snmp_operation
Type: Object
snmp
Description SNMP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
snmp-port
Description Specify SNMP port, default is 161 (Port Number)
Type: number
Range: 1-65534
Default: 161
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
snmp_oid¶
Specification Value Type object asn
Description Specify the format in ASN.1 style
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: asn and mib are mutually exclusive
mib
Description ‘sysDescr’: The MIB-2 OID of system description, 1.1.0; ‘sysUpTime’: The MIB-2 OID of system up time, 1.3.0; ‘sysName’: The MIB-2 OID of system nume, 1.5.0;
Type: string
Supported Values: sysDescr, sysUpTime, sysName
Mutual Exclusion: mib and asn are mutually exclusive
snmp_operation¶
Specification Value Type object oper-type
Description ‘getnext’: Get-Next-Request command; ‘get’: Get-Request command;
Type: string
Supported Values: getnext, get
dns¶
Specification Value Type object dns
Description DNS type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns-domain
Description Specify fully qualified domain name of the host
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-domain and dns-ip-key are mutually exclusive
dns-domain-expect
Description: dns-domain-expect is a JSON Block. Please see below for dns_dns-domain-expect
Type: Object
dns-domain-port
Description Specify DNS port, default is 53 (DNS Port(default 53))
Type: number
Range: 1-65534
Default: 53
dns-domain-recurse
Description ‘enabled’: Set the recursion bit; ‘disabled’: Clear the recursion bit;
Type: string
Supported Values: enabled, disabled
Default: enabled
dns-domain-tcp
Description Configure DNS transport over TCP, default is UDP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns-domain-type
Description ‘A’: Used for storing Ipv4 address (default); ‘CNAME’: Canonical name for a DNS alias; ‘SOA’: Start of authority; ‘PTR’: Domain name pointer; ‘MX’: Mail exchanger; ‘TXT’: Text string; ‘AAAA’: Used for storing Ipv6 128-bits address;
Type: string
Supported Values: A, CNAME, SOA, PTR, MX, TXT, AAAA
Default: A
dns-ip-key
Description Reverse DNS lookup (Specify IPv4 or IPv6 address)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: dns-ip-key and dns-domain are mutually exclusive
dns-ipv4-addr
Description Specify IPv4 address
Type: string
Format: ipv4-address
Mutual Exclusion: dns-ipv4-addr and dns-ipv6-addr are mutually exclusive
dns-ipv4-expect
Description: dns-ipv4-expect is a JSON Block. Please see below for dns_dns-ipv4-expect
Type: Object
dns-ipv4-port
Description Specify DNS port, default is 53 (DNS Port(default 53))
Type: number
Range: 1-65534
Default: 53
dns-ipv4-recurse
Description ‘enabled’: Set the recursion bit; ‘disabled’: Clear the recursion bit;
Type: string
Supported Values: enabled, disabled
Default: enabled
dns-ipv4-tcp
Description Configure DNS transport over TCP, default is UDP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns-ipv6-addr
Description Specify IPv6 address
Type: string
Format: ipv6-address
Mutual Exclusion: dns-ipv6-addr and dns-ipv4-addr are mutually exclusive
dns-ipv6-expect
Description: dns-ipv6-expect is a JSON Block. Please see below for dns_dns-ipv6-expect
Type: Object
dns-ipv6-port
Description Specify DNS port, default is 53 (DNS Port(default 53))
Type: number
Range: 1-65534
Default: 53
dns-ipv6-recurse
Description ‘enabled’: Set the recursion bit; ‘disabled’: Clear the recursion bit;
Type: string
Supported Values: enabled, disabled
Default: enabled
dns-ipv6-tcp
Description Configure DNS transport over TCP, default is UDP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns_dns-domain-expect¶
Specification Value Type object dns-domain-fqdn
Description Specify fully qualified domain name expected in DNS response answer
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-domain-fqdn,dns-domain-response, dns-domain-ipv4, and dns-domain-ipv6 are mutually exclusive
dns-domain-ipv4
Description Specify expected resolved IPv4 address
Type: string
Format: ipv4-address
Mutual Exclusion: dns-domain-ipv4,dns-domain-response, dns-domain-fqdn, and dns-domain-ipv6 are mutually exclusive
dns-domain-ipv6
Description Specify expected resolved IPv6 address
Type: string
Format: ipv6-address
Mutual Exclusion: dns-domain-ipv6,dns-domain-response, dns-domain-fqdn, and dns-domain-ipv4 are mutually exclusive
dns-domain-response
Description Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-domain-response,dns-domain-fqdn, dns-domain-ipv4, and dns-domain-ipv6 are mutually exclusive
dns_dns-ipv6-expect¶
Specification Value Type object dns-ipv6-fqdn
Description Specify fully qualified domain name expected in DNS response answer
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-ipv6-fqdn and dns-ipv6-response are mutually exclusive
dns-ipv6-response
Description Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-ipv6-response and dns-ipv6-fqdn are mutually exclusive
dns_dns-ipv4-expect¶
Specification Value Type object dns-ipv4-fqdn
Description Specify fully qualified domain name expected in DNS response answer
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-ipv4-fqdn and dns-ipv4-response are mutually exclusive
dns-ipv4-response
Description Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-ipv4-response and dns-ipv4-fqdn are mutually exclusive
ldap¶
Specification Value Type object 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
kerberos-kdc¶
Specification Value Type object kerberos-cfg
Description: kerberos-cfg is a JSON Block. Please see below for kerberos-kdc_kerberos-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
kerberos-kdc_kerberos-cfg¶
Specification Value Type object kadmin
Description Kerberos admin
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: kadmin, kinit, and kpasswd are mutually exclusive
kadmin-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)kadmin-kdc
Description Specify the kdc server, host|ip [:port]
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
kadmin-password
Description Password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
kadmin-pricipal-name
Description Specify the principal name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
kadmin-realm
Description Specify the realm
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
kadmin-server
Description Specify the admin server, host|ip [:port]
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
kinit
Description Kerberos KDC
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: kinit, kadmin, and kpasswd are mutually exclusive
kinit-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)kinit-kdc
Description Specify the kdc server, host|ip [:port]
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
kinit-password
Description Password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
kinit-pricipal-name
Description Specify the principal name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
kpasswd
Description Kerberos change passwd
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: kpasswd, kinit, and kadmin are mutually exclusive
kpasswd-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)kpasswd-kdc
Description Specify the kdc server, host|ip [:port]
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
kpasswd-password
Description Password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
kpasswd-pricipal-name
Description Specify the principal name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
kpasswd-server
Description Specify the Kerberos password server, host|ip [:port]
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
tcp-only
Description Specify the kerberos tcp only
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
udp¶
Specification Value Type object force-up-with-single-healthcheck
Description Force Up with no response at the first time
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
udp
Description UDP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
udp-port
Description Specify UDP port (Specify port number)
Type: number
Range: 1-65534
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
http¶
Specification Value Type object http
Description HTTP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)http-expect
Description Specify what you expect from the response message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-host
Description Specify “Host:” header used in request (enclose IPv6 address in [])
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
http-kerberos-auth
Description Http Kerberos Auth
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-kerberos-kdc
Description: http-kerberos-kdc is a JSON Block. Please see below for http_http-kerberos-kdc
Type: Object
http-kerberos-realm
Description Specify realm of Kerberos server
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
http-maintenance-code
Description Specify response code for maintenance (Format is xx,xx-xx (xx between [100, 899]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
http-password
Description Specify the user password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-password-string
Description Specify password, ‘’ means empty password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
http-port
Description Specify HTTP Port (Specify port number (default 80))
Type: number
Range: 1-65534
Default: 80
http-postdata
Description Specify the HTTP post data (Input post data here)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
http-postfile
Description Specify the HTTP post data (Input post data file name here)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
http-response-code
Description Specify response code range (e.g. 200,400-430) (Format is xx,xx-xx (xx between [100, 899]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: http-response-code and http-text are mutually exclusive
http-text
Description Specify text expected
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: http-text, http-response-code, and text-regex are mutually exclusive
http-url
Description Specify URL string, default is GET /
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
maintenance
Description Specify response text for maintenance
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
maintenance-text
Description Specify text for maintenance
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: maintenance-text and maintenance-text-regex are mutually exclusive
maintenance-text-regex
Description Specify Regex text for maintenance
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: maintenance-text-regex and maintenance-text are mutually exclusive
post-path
Description Specify URL path, default is “/”
Type: string
Format: string-rlx
Maximum Length: 500 characters
Maximum Length: 1 characters
post-type
Description ‘postdata’: Specify the HTTP post data; ‘postfile’: Specify the HTTP post data;
Type: string
Supported Values: postdata, postfile
response-code-regex
Description Specify response code range with Regex (code with Regex, such as [2-5][0-9][0-9])
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
text-regex
Description Specify text expected with Regex
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: text-regex and http-text are mutually exclusive
url-path
Description Specify URL path, default is “/”
Type: string
Format: string-rlx
Maximum Length: 500 characters
Maximum Length: 1 characters
url-type
Description ‘GET’: HTTP GET method; ‘POST’: HTTP POST method; ‘HEAD’: HTTP HEAD method;
Type: string
Supported Values: GET, POST, HEAD
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
version2
Description Specify HTTP version2 (Specify http version 2)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http_http-kerberos-kdc¶
Specification Value Type object http-kerberos-hostip
Description Kdc’s hostname(length:1-31) or IP address
Type: string
Format: host
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: http-kerberos-hostip and http-kerberos-hostipv6 are mutually exclusive
http-kerberos-hostipv6
Description Server’s IPV6 address
Type: string
Format: ipv6-address
Mutual Exclusion: http-kerberos-hostipv6 and http-kerberos-hostip are mutually exclusive
http-kerberos-port
Description Specify the kdc port
Type: number
Range: 1-65535
http-kerberos-portv6
Description Specify the kdc port
Type: number
Range: 1-65535
quic¶
Specification Value Type object quic
Description QUIC type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ntp¶
Specification Value Type object ntp
Description NTP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ntp-port
Description Specify the NTP port, default is 123 (Port Number (default 123))
Type: number
Range: 1-65534
Default: 123
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
pop3¶
Specification Value Type object pop3
Description POP3 type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pop3-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)pop3-password
Description Specify the user password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pop3-password-string
Description Specify the user password, ‘’ means empty password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
pop3-port
Description Specify the POP3 port, default is 110 (Port Number (default 110))
Type: number
Range: 1-65534
Default: 110
pop3-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
external¶
Specification Value Type object ext-arguments
Description Specify external application’s arguments (Application arguments)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
ext-port
Description Specify the server port (Port Number)
Type: number
Range: 1-65534
ext-preference
Description Get server’s perference
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ext-program
Description Specify external application (Program name)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
ext-program-shared
Description Specify external application (Program name)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
external
Description EXTERNAL type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
shared-partition-program
Description external application from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
compound¶
Specification Value Type object compound
Description Compound type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rpn-string
Description Enter Reverse Polish Notation, example: sub hm1 sub hm2 and
Type: string
Format: string-rlx
Maximum Length: 512 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp¶
Specification Value Type object icmp
Description ICMP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
ip
Description Specify IPv4 address of destination behind monitored node
Type: string
Format: ipv4-address
Mutual Exclusion: ip and ipv6 are mutually exclusive
ipv6
Description Specify IPv6 address of destination behind monitored node
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6 and ip are mutually exclusive
transparent
Description Apply transparent mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
imap¶
Specification Value Type object imap
Description IMAP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
imap-cram-md5
Description Challenge-response authentication mechanism
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
imap-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)imap-login
Description Simple login
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
imap-password
Description Specify the user password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
imap-password-string
Description Configure password, ‘’ means empty password
Type: string
Format: password
Maximum Length: 63 characters
Maximum Length: 1 characters
imap-plain
Description Plain text
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
imap-port
Description Specify the IMAP port, default is 143 (Port Number (default 143))
Type: number
Range: 1-65534
Default: 143
imap-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
pwd-auth
Description Specify the Authentication method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
database¶
Specification Value Type object database
Description DATABASE type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
database-name
Description ‘mssql’: Specify MSSQL database; ‘mysql’: Specify MySQL database; ‘oracle’: Specify Oracle database; ‘postgresql’: Specify PostgreSQL database;
Type: string
Supported Values: mssql, mysql, oracle, postgresql
db-column
Description Specify the column number for receiving
Type: number
Range: 1-10
db-column-integer
Description Specify the column number for receiving
Type: number
Range: 1-10
db-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)db-name
Description Specify the database name
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
db-password
Description Specify the user password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
db-password-str
Description Configure password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
db-receive
Description Specify the response string
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: db-receive and db-receive-integer are mutually exclusive
db-receive-integer
Description Specify the response integer
Type: number
Range: 0-2147483647
Mutual Exclusion: db-receive-integer and db-receive are mutually exclusive
db-row
Description Specify the row number for receiving
Type: number
Range: 1-10
db-row-integer
Description Specify the row number for receiving
Type: number
Range: 1-10
db-send
Description Specify the SQL query
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
db-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tacplus¶
Specification Value Type object secret-encrypted
Descriptiontacplus
Description TACACS+ type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tacplus-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)tacplus-password
Description Specify the user password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tacplus-password-string
Description Configure password, ‘’ means empty password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
tacplus-port
Description Specify the TACACS+ port, default 49 (Port number (default 49))
Type: number
Range: 1-65534
Default: 49
tacplus-secret
Description Specify the shared secret of TACACS+ server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tacplus-secret-string
Description Shared Crypto Key
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
tacplus-type
Description ‘inbound-ascii-login’: Specify Inbound ASCII Login type;
Type: string
Supported Values: inbound-ascii-login
Default: inbound-ascii-login
tacplus-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters