ansible.builtin.avi_gslbhealthmonitor (v2.8.13) — module

Install Ansible via pip

Install with pip install ansible==2.8.13

Description

This module is used to configure GslbHealthMonitor object

more examples at U(https://github.com/avinetworks/devops)

Requirements

• avisdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example to create GslbHealthMonitor object
  avi_gslbhealthmonitor:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_gslbhealthmonitor

Inputs

    
url:
    description:
    - Avi controller URL of the object.

name:
    description:
    - A user friendly name for this health monitor.
    required: true

type:
    description:
    - 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.
    required: true

uuid:
    description:
    - Uuid of the health monitor.

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state that should be applied on the entity.

tenant:
    default: admin
    description:
    - Name of tenant used for all Avi API calls and context of object.
    type: str

password:
    description:
    - Password of Avi user in Avi controller. The default value is the environment variable
      C(AVI_PASSWORD).
    type: str

username:
    description:
    - Username used for accessing Avi controller. The default value is the environment
      variable C(AVI_USERNAME).
    type: str

controller:
    description:
    - IP address or hostname of the controller. The default value is the environment variable
      C(AVI_CONTROLLER).
    type: str

tenant_ref:
    description:
    - It is a reference to an object of type tenant.

api_context:
    description:
    - Avi API context that includes current session ID and CSRF Token.
    - This allows user to perform single login and re-use the session.
    type: dict

api_version:
    default: 16.4.4
    description:
    - Avi API version of to use for Avi API and objects.
    type: str

description:
    description:
    - User defined description for the object.

dns_monitor:
    description:
    - Healthmonitordns settings for gslbhealthmonitor.

tcp_monitor:
    description:
    - Healthmonitortcp settings for gslbhealthmonitor.

tenant_uuid:
    default: ''
    description:
    - UUID of tenant used for all Avi API calls and context of object.
    type: str

udp_monitor:
    description:
    - Healthmonitorudp settings for gslbhealthmonitor.

http_monitor:
    description:
    - Healthmonitorhttp settings for gslbhealthmonitor.

monitor_port:
    description:
    - 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'.

failed_checks:
    description:
    - 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.

https_monitor:
    description:
    - Healthmonitorhttp settings for gslbhealthmonitor.

send_interval:
    description:
    - 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 5.

avi_credentials:
    description:
    - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller
      login details.
    suboptions:
      api_version:
        default: 16.4.4
        description:
        - Avi controller version
      controller:
        description:
        - Avi controller IP or SQDN
      csrftoken:
        default: ''
        description:
        - Avi controller API csrftoken to reuse existing session with session id
      password:
        description:
        - Avi controller password
      port:
        description:
        - Avi controller port
      session_id:
        default: ''
        description:
        - Avi controller API session id to reuse existing session with csrftoken
      tenant:
        default: admin
        description:
        - Avi controller tenant
      tenant_uuid:
        default: ''
        description:
        - Avi controller tenant UUID
      timeout:
        default: 300
        description:
        - Avi controller request timeout
      token:
        default: ''
        description:
        - Avi controller API token
      username:
        description:
        - Avi controller username
    type: dict

receive_timeout:
    description:
    - 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-300.
    - Default value when not specified in API or module is interpreted by Avi Controller
      as 4.

external_monitor:
    description:
    - Healthmonitorexternal settings for gslbhealthmonitor.

successful_checks:
    description:
    - 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.

avi_disable_session_cache_as_fact:
    default: false
    description:
    - It disables avi session information to be cached as a fact.
    type: bool

Outputs

obj:
  description: GslbHealthMonitor (api/gslbhealthmonitor) object
  returned: success, changed
  type: dict