opentelekomcloud.cloud.lb_healthmonitor (0.14.2) — module

Add//Update/Delete a health check for a backend server group in load balancer from OpenTelekomCloud

| "added in version" 0.0.3 of opentelekomcloud.cloud"

Authors: Anton Sidelnikov (@anton-sidelnikov)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Add or Remove a health check for a backend server group for Enhanced Load Balancer.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Add a health check to backend server group in ELB.
- opentelekomcloud.cloud.lb_healthmonitor:
    state: present
    name: member
    pool: "{{ pool_name_or_id }}"
    delay: 5
    max_retries: 3
    monitor_timeout: 15
    type: tcp
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Update a health check to backend server group in ELB.
- opentelekomcloud.cloud.lb_healthmonitor:
    state: present
    name: member
    pool: "{{ pool_name_or_id }}"
    delay: 1
    max_retries: 1
    monitor_timeout: 1
    type: tcp
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Delete a server group member from load balancer.
- opentelekomcloud.cloud.lb_healthmonitor:
    state: absent
    name: healthcheck

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
      param will need to contain whatever parameters that auth plugin requires. This parameter
      is not needed if a named cloud is provided or OpenStack OS_* environment variables
      are present.
    type: dict

name:
    description:
    - Specifies the health check name.
    type: str

pool:
    description:
    - Specifies the ID or Name of the backend server group.
    type: str

type:
    choices:
    - tcp
    - upd_connect
    - http
    description:
    - Specifies the health check protocol.
    type: str

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

delay:
    description:
    - Specifies the interval between health checks in the unit of second (1-50).
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Should the resource be present or absent.
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

url_path:
    description:
    - Specifies the HTTP request path for the health check.
    type: str

auth_type:
    description:
    - Name of the auth plugin to use. If the cloud uses something other than password
      authentication, the name of the plugin should be indicated here and the contents
      of the I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

api_timeout:
    description:
    - How long should the socket layer wait before timing out for API calls. If this is
      omitted, nothing will be passed to the requests library.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

domain_name:
    description:
    - Specifies the domain name of the HTTP request during the health check.
    type: str

http_method:
    choices:
    - get
    - head
    - post
    - put
    - delete
    - trace
    - options
    - connect
    - patch
    description:
    - Specifies the HTTP request method.
    type: str

max_retries:
    description:
    - Specifies the number of consecutive health checks when the health check result of
      a backend server changes from fail to success (1-10).
    type: int

region_name:
    description:
    - Name of the region.
    type: str

monitor_port:
    description:
    - Specifies the health check port.
    type: int

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

admin_state_up:
    description:
    - Specifies the administrative status of the health check.
    type: bool

expected_codes:
    description:
    - Specifies the expected HTTP status code.
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

monitor_timeout:
    description:
    - Specifies the health check timeout duration in the unit of second (1-50).
    type: int

Outputs

healthmonitor:
  contains:
    admin_state_up:
      description: Specifies the administrative status of the health check.
      type: bool
    delay:
      description: Specifies the interval between health checks in the unit of second.
      type: int
    domain_name:
      description: Specifies the domain name of the HTTP request during the health
        check.
      type: str
    expected_codes:
      description: Specifies the expected HTTP status code.
      type: str
    http_method:
      description: Specifies the HTTP request method.
      sample: GET
      type: str
    id:
      description: Specifies the health check ID.
      sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
      type: str
    max_retries:
      description: Specifies the number of consecutive health checks when the health
        check result of a backend server changes from fail to success.
      type: int
    monitor_port:
      description: Specifies the health check port.
      type: int
    name:
      description: Specifies the health check name.
      sample: bs_test
      type: str
    pools:
      description: Lists the IDs of backend server groups associated with the health
        check.
      type: list
    timeout:
      description: Specifies the health check timeout duration in the unit of second.
      type: int
    type:
      description: Specifies the health check protocol.
      sample: TCP
      type: str
    url_path:
      description: Specifies the HTTP request path for the health check.
      sample: /test
      type: str
  description: Specifies the health check.
  returned: On Success.
  type: complex