.. _a10_debug_hm_module:


a10_debug_hm
============

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Debug health monitor






Parameters
----------

 
| Parameters            | Choices/Defaults              | Comment                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| state                 | ['noop', 'present', 'absent'] | State of the object to be created.                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| str/required          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| ansible_host          |                               | Host for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| str/required          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| ansible_username      |                               | Username for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| str/required          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| ansible_password      |                               | Password for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| str/required          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| ansible_port          |                               | Port for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| int/required          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| a10_device_context_id | ['1-8']                       | Device ID for aVCS configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| int                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| a10_partition         |                               | Destination/target partition for object/command                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| level                 |                               | Debug level (Level 1-3)                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| int                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| pin_uid               |                               | Debug Pin Unique Id                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| int                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| method_type           |                               | 'icmp'= ICMP type; 'tcp'= TCP type; 'udp'= UDP type; 'ftp'= FTP type; 'http'= HTTP type; 'snmp'= SNMP type; 'smtp'= SMTP type; 'dns'= DNS type; 'dns-tcp'= DNS TCP type; 'pop3'= POP3 type; 'imap'= IMAP type; 'sip'= SIP type; 'sip-tcp'= SIP TCP type; 'radius'= RADIUS type; 'ldap'= LDAP type; 'rtsp'= RTSP type; 'kerberos-kdc'= Kerberos KDC type; 'database'= DATABASE type; 'external'= EXTERNAL type; 'https'= HTTPS type; 'ntp'= NTP type; 'compound'= Compound type; |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| uuid                  |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 







Examples
--------

.. code-block:: yaml+jinja

    



Return Values
-------------

modified_values (changed, dict, )
  Values modified (or potential changes if using check_mode) as a result of task operation


axapi_calls (always, list, )
  Sequential list of AXAPI calls made by the task


  endpoint (, str, ['/axapi/v3/slb/virtual_server', '/axapi/v3/file/ssl-cert'])
    The AXAPI endpoint being accessed.


  http_method (, str, ['POST', 'GET'])
    HTTP method being used by the primary task to interact with the AXAPI endpoint.


  request_body (, complex, )
    Params used to query the AXAPI


  response_body (, complex, )
    Response from the AXAPI






Status
------




- This module is not guaranteed to have a backwards compatible interface. *[preview]*


- This module is maintained by community.



Authors
~~~~~~~

- A10 Networks

