.. _health_monitor:
health monitor
==============
Define the Health Monitor object
monitor Specification
---------------------
===================================== ==============================================================
**Parameter** **Value**
===================================== ==============================================================
**Type** *Collection*
**Object Key(s)** *name*
**Collection Name** :ref:`1858_monitor_list`
**Collection URI** /axapi/v3/health/monitor
**Element Name** monitor
**Element URI** /axapi/v3/health/monitor/{name}
**Element Attributes** monitor_attributes
**Partition Visibility** shared
**Schema** :download:`monitor schema <health-monitor/health-monitor.txt>`
===================================== ==============================================================
**Operations Allowed:**
.. raw:: html
<script type="text/javascript">
function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
</script>
<table width='90%' style='margin-left:5%'>
.. raw:: html
<tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Create Object
.. raw:: html
</td><td valign = 'top'>
POST
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor
.. raw:: html
</td><td valign = 'top'>
:ref:`1858_monitor_attributes`
.. raw:: html
</td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='post_div' style='display:none'>
.. include:: ../artifacts/health_monitor_POST.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Create List
.. raw:: html
</td><td valign = 'top'>
POST
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor
.. raw:: html
</td><td valign = 'top'>
:ref:`1858_monitor_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Get Object
.. raw:: html
</td><td valign = 'top'>
GET
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`1858_monitor_attributes`
.. raw:: html
</td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='get_div' style='display:none'>
.. include:: ../artifacts/health_monitor_GET.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Get List
.. raw:: html
</td><td valign = 'top'>
GET
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor
.. raw:: html
</td><td valign = 'top'>
:ref:`1858_monitor_list`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Modify Object
.. raw:: html
</td><td valign = 'top'>
POST
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`1858_monitor_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Replace Object
.. raw:: html
</td><td valign = 'top'>
PUT
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`1858_monitor_attributes`
.. raw:: html
</td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='put_div' style='display:none'>
.. include:: ../artifacts/health_monitor_PUT.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Replace List
.. raw:: html
</td><td valign = 'top'>
PUT
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor
.. raw:: html
</td><td valign = 'top'>
:ref:`1858_monitor_list`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Delete Object
.. raw:: html
</td><td valign = 'top'>
DELETE
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/health/monitor/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`1858_monitor_attributes`
.. raw:: html
</td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='delete_div' style='display:none'>
.. include:: ../artifacts/health_monitor_DELETE.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
</table>
.. _1858_monitor_list:
monitor-list
------------
monitor-list is **JSON List** of :ref:`1858_monitor_attributes`
monitor-list : [
{ :ref:`1858_monitor_attributes` },
{ :ref:`1858_monitor_attributes` },
...
]
.. _1858_monitor_attributes:
monitor attributes
------------------
**default-state-up**
**Description** Initial health state will default to UP
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**disable-after-down**
**Description** Disable the target if health check failed
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**dplane**
**Description** 'enable': Enable health-check on dplane; 'disable': Disable health-check on dplane; 'auto(default)': Auto select;
**Type:** string
**Supported Values:** enable, disable, auto(default)
**Default:** auto
**dsr-l2-strict**
**Description** Enable strict L2dsr health-check
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**header-insert**
**Description:** header-insert is a **JSON Block**. Please see below for :ref:`1858_header-insert`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/header-insert <health_monitor>`
**interval**
**Description** Specify the Healthcheck Interval (Interval Value, in seconds (default 5))
**Type:** number
**Range:** 1-180
**method**
**Description:** method is a **JSON Block**. Please see below for :ref:`1858_method`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method <health_monitor>`
**name**
**Description** Monitor Name
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Default:** ping
**override-ipv4**
**Description** Override implicitly inherited IPv4 address from target
**Type:** string
**Format:** ipv4-address
**override-ipv6**
**Description** Override implicitly inherited IPv6 address from target
**Type:** string
**Format:** ipv6-address
**override-port**
**Description** Override implicitly inherited port from target (Port number (1-65534))
**Type:** number
**Range:** 1-65534
**passive**
**Description** Specify passive mode
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**passive-interval**
**Description** Interval to do manual health checking while in passive mode (Specify value in seconds (Default is 10 s))
**Type:** number
**Range:** 1-180
**Default:** 10
**proxy-header**
**Description:** proxy-header is a **JSON Block**. Please see below for :ref:`1858_proxy-header`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/proxy-header <health_monitor>`
**retry**
**Description** Specify the Healthcheck Retries (Retry Count (default 3))
**Type:** number
**Range:** 1-10
**sample-threshold**
**Description** Number of samples in one epoch above which passive HC is enabled. If below or equal to the threshold, passive HC is disabled (Specify number of samples in one second (Default is 50). If the number of samples is 0, no action is taken)
**Type:** number
**Range:** 1-10000
**Default:** 50
**ssl-ciphers**
**Description** Specify OpenSSL Cipher Suite name(s) for Health check (OpenSSL Cipher Suite(s) (Eg: AES128-SHA256), if the cipher is invalid, would give information at HM down reason)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**Default:** DEFAULT
**ssl-dgversion**
**Description** Lower TLS/SSL version can be downgraded
**Type:** number
**Range:** 31-34
**Default:** 31
**ssl-ticket**
**Description** Enable SSL-Ticket Session Resumption
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**ssl-ticket-lifetime**
**Description** SSL-Ticket lifetime (seconds)
**Type:** number
**Range:** 1-604800
**ssl-version**
**Description** TLS/SSL version (TLS/SSL version: 31-TLSv1.0, 32-TLSv1.1, 33-TLSv1.2 and 34-TLSv1.3)
**Type:** number
**Range:** 31-34
**Default:** 34
**status-code**
**Description** 'status-code-2xx': Enable passive mode with 2xx http status code; 'status-code-non-5xx': Enable passive mode with non-5xx http status code;
**Type:** string
**Supported Values:** status-code-2xx, status-code-non-5xx
**strict-retry-on-server-err-resp**
**Description** Require strictly retry
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**template-server-ssl**
**Description** Server side SSL template for health monitor (Server side SSL Name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/slb/template/server-ssl <slb_template_server_ssl>`
**threshold**
**Description** Threshold percentage above which passive mode is enabled (Specify percentage (Default is 75%))
**Type:** number
**Range:** 0-100
**Default:** 75
**timeout**
**Description** Specify the Healthcheck Timeout (Timeout Value, in seconds(default 5), Timeout should be less than or equal to interval)
**Type:** number
**Range:** 1-180
**up-retry**
**Description** Specify the Healthcheck Retries before declaring target up (Up-retry count (default 1))
**Type:** number
**Range:** 1-10
**user-tag**
**Description** Customized tag
**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
.. _1858_header-insert:
header-insert
^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**insert-list**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _1858_header-insert_insert-list:
header-insert_insert-list
^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**insert-content**
**Description** Header Content (Format: "[name]:[value]")
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
.. _1858_method:
method
^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**compound**
**Description:** compound is a **JSON Block**. Please see below for :ref:`1858_method_compound`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/compound <health_monitor>`
**database**
**Description:** database is a **JSON Block**. Please see below for :ref:`1858_method_database`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/database <health_monitor>`
**dns**
**Description:** dns is a **JSON Block**. Please see below for :ref:`1858_method_dns`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/dns <health_monitor>`
**external**
**Description:** external is a **JSON Block**. Please see below for :ref:`1858_method_external`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/external <health_monitor>`
**ftp**
**Description:** ftp is a **JSON Block**. Please see below for :ref:`1858_method_ftp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/ftp <health_monitor>`
**http**
**Description:** http is a **JSON Block**. Please see below for :ref:`1858_method_http`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/http <health_monitor>`
**https**
**Description:** https is a **JSON Block**. Please see below for :ref:`1858_method_https`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/https <health_monitor>`
**icmp**
**Description:** icmp is a **JSON Block**. Please see below for :ref:`1858_method_icmp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/icmp <health_monitor>`
**imap**
**Description:** imap is a **JSON Block**. Please see below for :ref:`1858_method_imap`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/imap <health_monitor>`
**kerberos-kdc**
**Description:** kerberos-kdc is a **JSON Block**. Please see below for :ref:`1858_method_kerberos-kdc`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/kerberos-kdc <health_monitor>`
**ldap**
**Description:** ldap is a **JSON Block**. Please see below for :ref:`1858_method_ldap`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/ldap <health_monitor>`
**ntp**
**Description:** ntp is a **JSON Block**. Please see below for :ref:`1858_method_ntp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/ntp <health_monitor>`
**pop3**
**Description:** pop3 is a **JSON Block**. Please see below for :ref:`1858_method_pop3`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/pop3 <health_monitor>`
**quic**
**Description:** quic is a **JSON Block**. Please see below for :ref:`1858_method_quic`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/quic <health_monitor>`
**radius**
**Description:** radius is a **JSON Block**. Please see below for :ref:`1858_method_radius`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/radius <health_monitor>`
**rtsp**
**Description:** rtsp is a **JSON Block**. Please see below for :ref:`1858_method_rtsp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/rtsp <health_monitor>`
**sip**
**Description:** sip is a **JSON Block**. Please see below for :ref:`1858_method_sip`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/sip <health_monitor>`
**smtp**
**Description:** smtp is a **JSON Block**. Please see below for :ref:`1858_method_smtp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/smtp <health_monitor>`
**snmp**
**Description:** snmp is a **JSON Block**. Please see below for :ref:`1858_method_snmp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/snmp <health_monitor>`
**tacplus**
**Description:** tacplus is a **JSON Block**. Please see below for :ref:`1858_method_tacplus`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/tacplus <health_monitor>`
**tcp**
**Description:** tcp is a **JSON Block**. Please see below for :ref:`1858_method_tcp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/tcp <health_monitor>`
**udp**
**Description:** udp is a **JSON Block**. Please see below for :ref:`1858_method_udp`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/health/monitor/{name}/method/udp <health_monitor>`
.. _1858_method_rtsp:
method_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
.. _1858_method_smtp:
method_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
.. _1858_method_tcp:
method_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 :ref:`1858_method_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
.. _1858_method_tcp_port-resp:
method_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
.. _1858_method_radius:
method_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
.. _1858_method_https:
method_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 :ref:`1858_method_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
.. _1858_method_https_https-kerberos-kdc:
method_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
.. _1858_method_ftp:
method_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
.. _1858_method_sip:
method_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
.. _1858_method_snmp:
method_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 :ref:`1858_method_snmp_oid`
**Type:** Object
**operation**
**Description:** operation is a **JSON Block**. Please see below for :ref:`1858_method_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
.. _1858_method_snmp_oid:
method_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
.. _1858_method_snmp_operation:
method_snmp_operation
^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**oper-type**
**Description** 'getnext': Get-Next-Request command; 'get': Get-Request command;
**Type:** string
**Supported Values:** getnext, get
.. _1858_method_dns:
method_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 :ref:`1858_method_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 :ref:`1858_method_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 :ref:`1858_method_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
.. _1858_method_dns_dns-domain-expect:
method_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
.. _1858_method_dns_dns-ipv6-expect:
method_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
.. _1858_method_dns_dns-ipv4-expect:
method_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
.. _1858_method_ldap:
method_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
.. _1858_method_kerberos-kdc:
method_kerberos-kdc
^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**kerberos-cfg**
**Description:** kerberos-cfg is a **JSON Block**. Please see below for :ref:`1858_method_kerberos-kdc_kerberos-cfg`
**Type:** Object
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _1858_method_kerberos-kdc_kerberos-cfg:
method_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
.. _1858_method_udp:
method_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
.. _1858_method_http:
method_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 :ref:`1858_method_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
.. _1858_method_http_http-kerberos-kdc:
method_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
.. _1858_method_quic:
method_quic
^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**quic**
**Description** QUIC type
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**quic-port**
**Description** Specify QUIC port (Port Number (default 443))
**Type:** number
**Range:** 1-65534
**Default:** 443
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _1858_method_ntp:
method_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
.. _1858_method_pop3:
method_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
.. _1858_method_external:
method_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
.. _1858_method_compound:
method_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
.. _1858_method_icmp:
method_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
.. _1858_method_imap:
method_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
.. _1858_method_database:
method_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
.. _1858_method_tacplus:
method_tacplus
^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**secret-encrypted**
**Description**
**tacplus**
**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
.. _1858_proxy-header:
proxy-header
^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**proxy-header-ver**
**Description** 'v1': version 1; 'v2': version 2; (version number)
**Type:** string
**Supported Values:** v1, v2
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters