community.network.avi_healthmonitor – Module for setup of HealthMonitor Avi RESTful Object  Note This plugin is part of the community.network collection (version 1.3.0). To install it use: ansible-galaxy collection install community.network. To use it in a playbook, specify: community.network.avi_healthmonitor.   Synopsis Requirements Parameters Notes Examples Return Values  Synopsis  This module is used to configure HealthMonitor object more examples at https://github.com/avinetworks/devops
  Requirements The below requirements are needed on the host that executes this module.  avisdk  Parameters   Parameter Choices/Defaults Comments    api_context  dictionary      Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session.     api_version  string    Default:"16.4.4"   Avi API version of to use for Avi API and objects.     avi_api_patch_op  string    
Choices: add replace delete    Patch operation to use when using avi_api_update_method as patch.     avi_api_update_method  string    
Choices: 
put ← patch    Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH.     avi_credentials  dictionary      Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.      api_version  string    Default:"16.4.4"   Avi controller version      controller  string      Avi controller IP or SQDN      csrftoken  string      Avi controller API csrftoken to reuse existing session with session id      password  string      Avi controller password      port  string      Avi controller port      session_id  string      Avi controller API session id to reuse existing session with csrftoken      tenant  string    Default:"admin"   Avi controller tenant      tenant_uuid  string      Avi controller tenant UUID      timeout  string    Default:300   Avi controller request timeout      token  string      Avi controller API token      username  string      Avi controller username     avi_disable_session_cache_as_fact  boolean    
Choices: 
no ← yes    It disables avi session information to be cached as a fact.     controller  string    Default:""   IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.     description  string      User defined description for the object.     dns_monitor  string      Healthmonitordns settings for healthmonitor.     external_monitor  string      Healthmonitorexternal settings for healthmonitor.     failed_checks  string      Number of continuous failed health checks before the server is marked down. Allowed values are 1-50. Default value when not specified in API or module is interpreted by Avi Controller as 2.     http_monitor  string      Healthmonitorhttp settings for healthmonitor.     https_monitor  string      Healthmonitorhttp settings for healthmonitor.     is_federated  boolean    
Choices: no yes    This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 17.1.3. Default value when not specified in API or module is interpreted by Avi Controller as False.     monitor_port  string      Use this port instead of the port defined for the server in the pool. If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the pool. Allowed values are 1-65535. Special values are 0 - 'use server port'.     name  string / required      A user friendly name for this health monitor.     password  string    Default:""   Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.     radius_monitor  string      Health monitor for radius. Field introduced in 18.2.3.     receive_timeout  string      A valid response from the server is expected within the receive timeout window. This timeout must be less than the send interval. If server status is regularly flapping up and down, consider increasing this value. Allowed values are 1-2400. Default value when not specified in API or module is interpreted by Avi Controller as 4.     send_interval  string      Frequency, in seconds, that monitors are sent to a server. Allowed values are 1-3600. Default value when not specified in API or module is interpreted by Avi Controller as 10.     sip_monitor  string      Health monitor for sip. Field introduced in 17.2.8, 18.1.3, 18.2.1.     state  string    
Choices: absent 
present ←    The state that should be applied on the entity.     successful_checks  string      Number of continuous successful health checks before server is marked up. Allowed values are 1-50. Default value when not specified in API or module is interpreted by Avi Controller as 2.     tcp_monitor  string      Healthmonitortcp settings for healthmonitor.     tenant  string    Default:"admin"   Name of tenant used for all Avi API calls and context of object.     tenant_ref  string      It is a reference to an object of type tenant.     tenant_uuid  string    Default:""   UUID of tenant used for all Avi API calls and context of object.     type  string / required      Type of the health monitor. Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB, HEALTH_MONITOR_SIP, HEALTH_MONITOR_RADIUS.     udp_monitor  string      Healthmonitorudp settings for healthmonitor.     url  string      Avi controller URL of the object.     username  string    Default:""   Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.     uuid  string      Uuid of the health monitor.     Notes  Note  For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.   Examples - name: Create a HTTPS health monitor
  community.network.avi_healthmonitor:
    controller: 207.955.0837
    username: admin
    password: AviNetworks123!
    https_monitor:
      http_request: HEAD / HTTP/1.0
      http_response_code:
        - HTTP_2XX
        - HTTP_3XX
    receive_timeout: 4
    failed_checks: 3
    send_interval: 10
    successful_checks: 3
    type: HEALTH_MONITOR_HTTPS
    name: MyWebsite-HTTPS
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    obj  dictionary   success, changed  HealthMonitor (api/healthmonitor) object      Authors  Gaurav Rastogi (@grastogi23) <luiswilliams@example.org> 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.10/collections/community/network/avi_healthmonitor_module.html', 'source': 'DevDocs.IO'}