lb_healthmonitor_info

updated: None

lb_healthmonitor_info

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.0.1).

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 Choices/Defaults Comments
admin_state_up
boolean
    Choices:
  • no
  • yes
Optional the administrative status of the health check.
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
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
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
    Choices:
  • get
  • head
  • post
  • put
  • delete
  • trace
  • options
  • connect
  • patch
Optional health check HTTP request method
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
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
Default:
180
How long should ansible wait for the requested resource.
type
string
    Choices:
  • tcp
  • udp_connect
  • http
Optional health check protocol
url_path
string
Optional HTTP request path for the health check
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

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

Return Values

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

Key Returned Description
healthmonitors
complex
On Success.
Dictionary describing members.
 
admin_state_up
boolean
success
Specifies the administrative status of the health check.
 
delay
integer
success
Specifies the interval between health checks in the unit of second.
 
domain_name
string
success
Specifies the domain name of the HTTP request during the health check.
 
expected_codes
string
success
Specifies the expected HTTP status code.
  healthmonitors_links
list / elements=string
success
Provides links to the previous or next page during pagination query, respectively.
 
http_method
string
success
Specifies the HTTP request method.

Sample:
GET
 
id
string
success
Specifies the health check ID.

Sample:
39007a7e-ee4f-4d13-8283-b4da2e037c69
 
max_retries
integer
success
Specifies the number of consecutive health checks when the health check result of a backend server changes from fail to success.
 
monitor_port
integer
success
Specifies the health check port.
 
name
string
success
Specifies the health check name.

Sample:
bs_test
 
pools
list / elements=string
success
Lists the IDs of backend server groups associated with the health check.
 
timeout
integer
success
Specifies the health check timeout duration in the unit of second.
 
type
string
success
Specifies the health check protocol.

Sample:
TCP
 
url_path
string
success
Specifies the HTTP request path for the health check.

Sample:
/test


Authors

  • Anton Sidelnikov (@anton-sidelnikov)

updated: None