{ "id":"/axapi/v3/health/monitor/{name}/method", "type":"object", "node-type":"intermediate", "title":"method", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "description":"Define the health method object, default is ICMP", "properties":{ "icmp":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/icmp", "properties":{ "icmp":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"ICMP type" }, "transparent":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Apply transparent mode" }, "ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"ip", "description":"Specify IPv6 address of destination behind monitored node" }, "ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not":"ipv6", "description":"Specify IPv4 address of destination behind monitored node" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "quic":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/quic", "properties":{ "quic":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"QUIC type" }, "quic-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":443, "partition-visibility":"shared", "description":"Specify QUIC port (Port Number (default 443))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "tcp":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/tcp", "properties":{ "method-tcp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"TCP type" }, "tcp-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "description":"Specify TCP port (Specify port number)" }, "port-halfopen":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"port-send", "description":"Set TCP SYN check" }, "port-send":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":511, "partition-visibility":"shared", "not":"port-halfopen", "description":"Send a string to server (Specify the string)" }, "port-resp":{ "type":"object", "properties":{ "port-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Mark server up if response string contains string (Specify the string)" } } }, "maintenance":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify response text for maintenance" }, "maintenance-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify text for maintenance" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "udp":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/udp", "properties":{ "udp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"UDP type" }, "udp-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "description":"Specify UDP port (Specify port number)" }, "force-up-with-single-healthcheck":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Force Up with no response at the first time" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "http":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/http", "properties":{ "http":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"HTTP type" }, "http-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":80, "partition-visibility":"shared", "description":"Specify HTTP Port (Specify port number (default 80))" }, "version2":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify HTTP version2 (Specify http version 2)" }, "http-expect":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify what you expect from the response message" }, "http-response-code":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"http-text", "description":"Specify response code range (e.g. 200,400-430) (Format is xx,xx-xx (xx between [100, 899]))" }, "response-code-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify response code range with Regex (code with Regex, such as [2-5][0-9][0-9])" }, "http-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not-list":[ "http-response-code", "text-regex" ], "description":"Specify text expected" }, "text-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"http-text", "description":"Specify text expected with Regex" }, "http-host":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify \"Host:\" header used in request (enclose IPv6 address in [])" }, "http-maintenance-code":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify response code for maintenance (Format is xx,xx-xx (xx between [100, 899]))" }, "http-url":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify URL string, default is GET /" }, "url-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'GET': HTTP GET method; 'POST': HTTP POST method; 'HEAD': HTTP HEAD method; ", "enum":[ "GET", "POST", "HEAD" ] }, "maintenance":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify response text for maintenance" }, "maintenance-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"maintenance-text-regex", "description":"Specify text for maintenance" }, "maintenance-text-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"maintenance-text", "description":"Specify Regex text for maintenance" }, "url-path":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":500, "partition-visibility":"shared", "description":"Specify URL path, default is \"/\"" }, "post-path":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":500, "partition-visibility":"shared", "description":"Specify URL path, default is \"/\"" }, "post-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'postdata': Specify the HTTP post data; 'postfile': Specify the HTTP post data; ", "enum":[ "postdata", "postfile" ] }, "http-postdata":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify the HTTP post data (Input post data here)" }, "http-postfile":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the HTTP post data (Input post data file name here)" }, "http-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the username" }, "http-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the user password" }, "http-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify password, '' means empty password" }, "http-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "http-kerberos-auth":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Http Kerberos Auth" }, "http-kerberos-realm":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify realm of Kerberos server" }, "http-kerberos-kdc":{ "type":"object", "properties":{ "http-kerberos-hostip":{ "type":"string", "format":"host", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"http-kerberos-hostipv6", "description":"Kdc's hostname(length:1-31) or IP address" }, "http-kerberos-hostipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"http-kerberos-hostip", "description":"Server's IPV6 address" }, "http-kerberos-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify the kdc port" }, "http-kerberos-portv6":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify the kdc port" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "ftp":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/ftp", "properties":{ "ftp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"FTP type" }, "ftp-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":21, "partition-visibility":"shared", "description":"Specify FTP port (Specify port number, default is 21)" }, "ftp-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the username" }, "ftp-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the user password" }, "ftp-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the user password, '' means empty password" }, "ftp-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "snmp":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/snmp", "properties":{ "snmp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"SNMP type" }, "snmp-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":161, "partition-visibility":"shared", "description":"Specify SNMP port, default is 161 (Port Number)" }, "community":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "default":"public", "partition-visibility":"shared", "description":"Specify SNMP community, default is \"public\" (Community String)" }, "oid":{ "type":"object", "properties":{ "mib":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not":"asn", "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; ", "enum":[ "sysDescr", "sysUpTime", "sysName" ] }, "asn":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "not":"mib", "description":"Specify the format in ASN.1 style" } } }, "operation":{ "type":"object", "properties":{ "oper-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'getnext': Get-Next-Request command; 'get': Get-Request command; ", "enum":[ "getnext", "get" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "smtp":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/smtp", "properties":{ "smtp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"SMTP type" }, "smtp-domain":{ "type":"string", "format":"host", "minLength":1, "maxLength":254, "partition-visibility":"shared", "description":"Specify domain name of 'helo' command" }, "smtp-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":25, "partition-visibility":"shared", "description":"Specify SMTP port, default is 25 (Port Number (default 25))" }, "smtp-starttls":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Check the STARTTLS support at helo response" }, "mail-from":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify SMTP Sender" }, "rcpt-to":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify SMTP Receiver" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "dns":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/dns", "properties":{ "dns":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"DNS type" }, "dns-ip-key":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"dns-domain", "description":"Reverse DNS lookup (Specify IPv4 or IPv6 address)" }, "dns-ipv4-addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not":"dns-ipv6-addr", "description":"Specify IPv4 address" }, "dns-ipv6-addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"dns-ipv4-addr", "description":"Specify IPv6 address" }, "dns-ipv4-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":53, "partition-visibility":"shared", "description":"Specify DNS port, default is 53 (DNS Port(default 53))" }, "dns-ipv4-expect":{ "type":"object", "properties":{ "dns-ipv4-response":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"dns-ipv4-fqdn", "description":"Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))" }, "dns-ipv4-fqdn":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "partition-visibility":"shared", "not":"dns-ipv4-response", "description":"Specify fully qualified domain name expected in DNS response answer" } } }, "dns-ipv4-recurse":{ "type":"string", "format":"enum", "default":"enabled", "partition-visibility":"shared", "description":"'enabled': Set the recursion bit; 'disabled': Clear the recursion bit; ", "enum":[ "enabled", "disabled" ] }, "dns-ipv4-tcp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure DNS transport over TCP, default is UDP" }, "dns-ipv6-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":53, "partition-visibility":"shared", "description":"Specify DNS port, default is 53 (DNS Port(default 53))" }, "dns-ipv6-expect":{ "type":"object", "properties":{ "dns-ipv6-response":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"dns-ipv6-fqdn", "description":"Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))" }, "dns-ipv6-fqdn":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "partition-visibility":"shared", "not":"dns-ipv6-response", "description":"Specify fully qualified domain name expected in DNS response answer" } } }, "dns-ipv6-recurse":{ "type":"string", "format":"enum", "default":"enabled", "partition-visibility":"shared", "description":"'enabled': Set the recursion bit; 'disabled': Clear the recursion bit; ", "enum":[ "enabled", "disabled" ] }, "dns-ipv6-tcp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure DNS transport over TCP, default is UDP" }, "dns-domain":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "partition-visibility":"shared", "not":"dns-ip-key", "description":"Specify fully qualified domain name of the host" }, "dns-domain-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":53, "partition-visibility":"shared", "description":"Specify DNS port, default is 53 (DNS Port(default 53))" }, "dns-domain-type":{ "type":"string", "format":"enum", "default":"A", "partition-visibility":"shared", "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; ", "enum":[ "A", "CNAME", "SOA", "PTR", "MX", "TXT", "AAAA" ] }, "dns-domain-expect":{ "type":"object", "properties":{ "dns-domain-response":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not-list":[ "dns-domain-fqdn", "dns-domain-ipv4", "dns-domain-ipv6" ], "description":"Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))" }, "dns-domain-fqdn":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "partition-visibility":"shared", "not-list":[ "dns-domain-response", "dns-domain-ipv4", "dns-domain-ipv6" ], "description":"Specify fully qualified domain name expected in DNS response answer" }, "dns-domain-ipv4":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "dns-domain-response", "dns-domain-fqdn", "dns-domain-ipv6" ], "description":"Specify expected resolved IPv4 address" }, "dns-domain-ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not-list":[ "dns-domain-response", "dns-domain-fqdn", "dns-domain-ipv4" ], "description":"Specify expected resolved IPv6 address" } } }, "dns-domain-recurse":{ "type":"string", "format":"enum", "default":"enabled", "partition-visibility":"shared", "description":"'enabled': Set the recursion bit; 'disabled': Clear the recursion bit; ", "enum":[ "enabled", "disabled" ] }, "dns-domain-tcp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure DNS transport over TCP, default is UDP" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "pop3":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/pop3", "properties":{ "pop3":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"POP3 type" }, "pop3-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the username" }, "pop3-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the user password" }, "pop3-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the user password, '' means empty password" }, "pop3-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "pop3-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":110, "partition-visibility":"shared", "description":"Specify the POP3 port, default is 110 (Port Number (default 110))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "imap":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/imap", "properties":{ "imap":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"IMAP type" }, "imap-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":143, "partition-visibility":"shared", "description":"Specify the IMAP port, default is 143 (Port Number (default 143))" }, "imap-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the username" }, "imap-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the user password" }, "imap-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Configure password, '' means empty password" }, "imap-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "pwd-auth":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the Authentication method" }, "imap-plain":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Plain text" }, "imap-cram-md5":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Challenge-response authentication mechanism" }, "imap-login":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Simple login" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "sip":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/sip", "properties":{ "sip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"SIP type" }, "register":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send SIP REGISTER message, default is to send OPTION message" }, "sip-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":5060, "partition-visibility":"shared", "description":"Specify the SIP port, default is 5060 (Port Number)" }, "expect-response-code":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify accepted response codes (e.g. 200, 400-430, any) (Format is xxx,xxx-xxx,any (xxx between [100,899]))" }, "sip-tcp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use TCP for transmission, default is UDP" }, "sip-hostname":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify the SIP hostname that used in request" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "radius":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/radius", "properties":{ "radius":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"RADIUS type" }, "radius-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the username" }, "radius-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Configure password, '' means empty password" }, "radius-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "radius-secret":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Configure shared secret of RADIUS server" }, "radius-secret-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "radius-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":1812, "partition-visibility":"shared", "description":"Specify the RADIUS port, default is 1812 (Port number (default 1812))" }, "radius-expect":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify what you expect from the response message" }, "radius-response-code":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify response code range (e.g. 2,4-7) (Format is xx,xx-xx (xx between [1, 13]))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "ldap":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/ldap", "properties":{ "ldap":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"LDAP type" }, "ldap-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":389, "partition-visibility":"shared", "description":"Specify the LDAP port (Speciry port number, default is 389, or 636 if LDAP over SSL)" }, "ldap-security":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'overssl': Set LDAP over SSL; 'StartTLS': LDAP switch to TLS; ", "enum":[ "overssl", "StartTLS" ] }, "ldap-binddn":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the distinguished name for bindRequest (LDAP DN distinguished name)" }, "ldap-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the user password" }, "ldap-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Configure password, '' means empty password" }, "ldap-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "ldap-run-search":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify a query to be executed" }, "BaseDN":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify LDAP DN distinguished name" }, "ldap-query":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"LDAP query to be excuted" }, "AcceptResRef":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Mark server up on receiving a search result reference response" }, "AcceptNotFound":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Mark server up on receiving a not-found response" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "rtsp":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/rtsp", "properties":{ "rtsp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"RTSP type" }, "rtspurl":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify URL string (Specify the path on the server)" }, "rtsp-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":554, "partition-visibility":"shared", "description":"Specify RTSP port, default is 554 (Port Number (default 554))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "database":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/database", "properties":{ "database":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"DATABASE type" }, "database-name":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'mssql': Specify MSSQL database; 'mysql': Specify MySQL database; 'oracle': Specify Oracle database; 'postgresql': Specify PostgreSQL database; ", "enum":[ "mssql", "mysql", "oracle", "postgresql" ] }, "db-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the database name" }, "db-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the username" }, "db-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the user password" }, "db-password-str":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Configure password" }, "db-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "db-send":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the SQL query" }, "db-receive":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"db-receive-integer", "description":"Specify the response string" }, "db-row":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "partition-visibility":"shared", "description":"Specify the row number for receiving" }, "db-column":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "partition-visibility":"shared", "description":"Specify the column number for receiving" }, "db-receive-integer":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "partition-visibility":"shared", "not":"db-receive", "description":"Specify the response integer" }, "db-row-integer":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "partition-visibility":"shared", "description":"Specify the row number for receiving" }, "db-column-integer":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "partition-visibility":"shared", "description":"Specify the column number for receiving" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "external":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/external", "properties":{ "external":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"EXTERNAL type" }, "ext-program":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify external application (Program name)" }, "shared-partition-program":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"external application from shared partition" }, "ext-program-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify external application (Program name)" }, "ext-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "description":"Specify the server port (Port Number)" }, "ext-arguments":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify external application's arguments (Application arguments)" }, "ext-preference":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Get server's perference" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "ntp":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/ntp", "properties":{ "ntp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"NTP type" }, "ntp-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":123, "partition-visibility":"shared", "description":"Specify the NTP port, default is 123 (Port Number (default 123))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "kerberos-kdc":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/kerberos-kdc", "properties":{ "kerberos-cfg":{ "type":"object", "properties":{ "kinit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "kadmin", "kpasswd" ], "description":"Kerberos KDC" }, "kinit-pricipal-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the principal name" }, "kinit-password":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Password" }, "kinit-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "kinit-kdc":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the kdc server, host|ip [:port]" }, "tcp-only":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the kerberos tcp only" }, "kadmin":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "kinit", "kpasswd" ], "description":"Kerberos admin" }, "kadmin-realm":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the realm" }, "kadmin-pricipal-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the principal name" }, "kadmin-password":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Password" }, "kadmin-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "kadmin-server":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the admin server, host|ip [:port]" }, "kadmin-kdc":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the kdc server, host|ip [:port]" }, "kpasswd":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "kinit", "kadmin" ], "description":"Kerberos change passwd" }, "kpasswd-pricipal-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the principal name" }, "kpasswd-password":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Password" }, "kpasswd-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "kpasswd-server":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the Kerberos password server, host|ip [:port]" }, "kpasswd-kdc":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the kdc server, host|ip [:port]" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "https":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/https", "properties":{ "https":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"HTTPS type" }, "web-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":443, "partition-visibility":"shared", "description":"Specify HTTPS port (Port Number (default 443))" }, "disable-sslv2hello":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable SSLv2Hello for HTTPs" }, "http-version":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'http-version2': HTTP version 2 for HTTPs; 'http-version3': HTTP version 3 for HTTPs; ", "enum":[ "http-version2", "http-version3" ] }, "https-host":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify \"Host:\" header used in request (enclose IPv6 address in [])" }, "sni":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Server Name Indication for HTTPs" }, "https-expect":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify what you expect from the response message" }, "https-response-code":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"https-text", "description":"Specify response code range (e.g. 200,400-430) (Format is xx,xx-xx (xx between [100, 899])" }, "response-code-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify response code range with Regex (code with Regex, such as [2-5][0-9][0-9])" }, "https-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not-list":[ "https-response-code", "text-regex" ], "description":"Specify text expected" }, "text-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"https-text", "description":"Specify text expected with Regex" }, "https-url":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify URL string, default is GET /" }, "url-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'GET': HTTP GET method; 'POST': HTTP POST method; 'HEAD': HTTP HEAD method; ", "enum":[ "GET", "POST", "HEAD" ] }, "url-path":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":500, "partition-visibility":"shared", "description":"Specify URL path, default is \"/\"" }, "post-path":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":500, "partition-visibility":"shared", "description":"Specify URL path, default is \"/\"" }, "post-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'postdata': Specify the HTTP post data; 'postfile': Specify the HTTP post data; ", "enum":[ "postdata", "postfile" ] }, "https-postdata":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify the HTTP post data (Input post data here)" }, "https-postfile":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the HTTP post data (Input post data file name here)" }, "https-maintenance-code":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify response code for maintenance (Format is xx,xx-xx (xx between [100, 899])" }, "maintenance":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify response text for maintenance" }, "maintenance-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"maintenance-text-regex", "description":"Specify text for maintenance" }, "maintenance-text-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"maintenance-text", "description":"Specify Regex text for maintenance" }, "https-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the username" }, "https-server-cert-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Expect Server Cert commonName" }, "https-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the user password" }, "https-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Configure password, '' means empty password" }, "https-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "https-kerberos-auth":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Https Kerberos Auth" }, "https-kerberos-realm":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify realm of Kerberos server" }, "https-kerberos-kdc":{ "type":"object", "properties":{ "https-kerberos-hostip":{ "type":"string", "format":"host", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"https-kerberos-hostipv6", "description":"Kdc's hostname(length:1-31) or IP address" }, "https-kerberos-hostipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"https-kerberos-hostip", "description":"Server's IPV6 address" }, "https-kerberos-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify the kdc port" }, "https-kerberos-portv6":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify the kdc port" } } }, "cert-key-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Select shared partition" }, "cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify client certificate (Certificate name)" }, "key":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify client private key (Key name)" }, "key-pass-phrase":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Client private key password phrase" }, "key-phrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Password Phrase" }, "https-key-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "tacplus":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/tacplus", "properties":{ "tacplus":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"TACACS+ type" }, "tacplus-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify the username" }, "tacplus-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the user password" }, "tacplus-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Configure password, '' means empty password" }, "tacplus-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "tacplus-secret":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the shared secret of TACACS+ server" }, "tacplus-secret-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Shared Crypto Key" }, "secret-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared" }, "tacplus-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":49, "partition-visibility":"shared", "description":"Specify the TACACS+ port, default 49 (Port number (default 49))" }, "tacplus-type":{ "type":"string", "format":"enum", "default":"inbound-ascii-login", "partition-visibility":"shared", "description":"'inbound-ascii-login': Specify Inbound ASCII Login type; ", "enum":[ "inbound-ascii-login" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "compound":{ "type":"object", "$ref":"/axapi/v3/health/monitor/{name}/method/compound", "properties":{ "compound":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Compound type" }, "rpn-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":512, "partition-visibility":"shared", "description":"Enter Reverse Polish Notation, example: sub hm1 sub hm2 and" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }