sensu.sensu_go.cluster_info – List available Sensu Go clusters¶
Note
This plugin is part of the sensu.sensu_go collection (version 1.9.4).
To install it use: ansible-galaxy collection install sensu.sensu_go
.
To use it in a playbook, specify: sensu.sensu_go.cluster_info
.
New in version 1.9.0: of sensu.sensu_go
Synopsis¶
Retrieve information about Sensu Go clusters.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/cluster-sensu/.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth
dictionary
|
Authentication parameters. Can define each of them with ENV as well.
|
||
api_key
string
added in 1.3.0 of sensu.sensu_go
|
The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked.
This replaces auth.user and auth.password parameters.
For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
|
||
ca_path
path
added in 1.5.0 of sensu.sensu_go
|
Path to the CA bundle that should be used to validate the backend certificate.
If this parameter is not set, module will use the CA bundle that python is using.
It is also possible to set this parameter via the SENSU_CA_PATH environment variable.
|
||
password
string
|
Default: "P@ssw0rd!"
|
The Sensu user's password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked.
This parameter is ignored if the auth.api_key parameter is set.
|
|
url
string
|
Default: "http://localhost:8080"
|
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.
|
|
user
string
|
Default: "admin"
|
The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked.
This parameter is ignored if the auth.api_key parameter is set.
|
|
verify
boolean
added in 1.5.0 of sensu.sensu_go
|
|
Flag that controls the certificate validation.
If you are using self-signed certificates, you can set this parameter to
false .ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.
It is also possible to set this parameter via the SENSU_VERIFY environment variable.
|
|
name
string
|
Retrieve information about this specific object instead of listing all objects.
|
See Also¶
See also
- sensu.sensu_go.cluster
The official documentation on the sensu.sensu_go.cluster module.
Examples¶
- name: List all Sensu Go clusters
sensu.sensu_go.etcd_replicator_info:
register: result
- name: Retrieve the selected Sensu Go cluster
sensu.sensu_go.etcd_replicator_info:
name: my-cluster
register: result
- name: Do something with result
ansible.builtin.debug:
msg: "{{ result.objects.0.api_urls }}"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Tadej Borovsak (@tadeboro)