opentelekomcloud.cloud.lb_healthmonitor_info module – Get health checks info from OpenTelekomCloud

Note

This module is part of the opentelekomcloud.cloud collection (version 0.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.lb_healthmonitor_info.

New in version 0.0.3: of opentelekomcloud.cloud

Synopsis

  • Get Enhanced Load Balancer health checks from the OTC.

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk

  • openstacksdk >= 0.36.0

  • otcextensions

  • python >= 3.6

Parameters

Parameter

Comments

admin_state_up

boolean

Optional the administrative status of the health check.

Choices:

  • no

  • yes

api_timeout

integer

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.

auth

dictionary

Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or 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.

auth_type

string

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 auth parameter should be updated accordingly.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

raw

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

delay

integer

Optional the interval between health checks in the unit of second.

domain_name

string

Optional health domain name of the HTTP request during the health check

expected_codes

string

Optional health check expected HTTP status code

http_method

string

Optional health check HTTP request method

Choices:

  • get

  • head

  • post

  • put

  • delete

  • trace

  • options

  • connect

  • patch

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • admin

  • internal

  • public ← (default)

max_retries

integer

Optional the number of consecutive health checks when the health check result of a backend server changes from fail to success.

monitor_port

integer

Optional health check port

monitor_timeout

integer

Optional the health check timeout duration in the unit of second.

name

string

Optional name or id of the health check

region_name

string

Name of the region.

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

type

string

Optional health check protocol

Choices:

  • tcp

  • udp_connect

  • http

url_path

string

Optional HTTP request path for the health check

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • no ← (default)

  • yes

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Get a lb health monitor info.
- lb_healthmonitor_info:
    name: hm-test
  register: healthmonitor

- opentelekomcloud.cloud.lb_healthmonitor_info:
    type: "http"
    admin_state_up: False
    expected_codes: "200,202,401"
  register: healthmonitor

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

healthmonitors

complex

Dictionary describing members.

Returned: On Success.

admin_state_up

boolean

Specifies the administrative status of the health check.

Returned: success

delay

integer

Specifies the interval between health checks in the unit of second.

Returned: success

domain_name

string

Specifies the domain name of the HTTP request during the health check.

Returned: success

expected_codes

string

Specifies the expected HTTP status code.

Returned: success

list / elements=string

Provides links to the previous or next page during pagination query, respectively.

Returned: success

http_method

string

Specifies the HTTP request method.

Returned: success

Sample: “GET”

id

string

Specifies the health check ID.

Returned: success

Sample: “39007a7e-ee4f-4d13-8283-b4da2e037c69”

max_retries

integer

Specifies the number of consecutive health checks when the health check result of a backend server changes from fail to success.

Returned: success

monitor_port

integer

Specifies the health check port.

Returned: success

name

string

Specifies the health check name.

Returned: success

Sample: “bs_test”

pools

list / elements=string

Lists the IDs of backend server groups associated with the health check.

Returned: success

timeout

integer

Specifies the health check timeout duration in the unit of second.

Returned: success

type

string

Specifies the health check protocol.

Returned: success

Sample: “TCP”

url_path

string

Specifies the HTTP request path for the health check.

Returned: success

Sample: “/test”

Authors

  • Anton Sidelnikov (@anton-sidelnikov)

Whats next

last updated: 2022-02-25 12:26