opentelekomcloud.cloud.css_cluster_info module -- Get info about CSS clusters.¶
Note
This module is part of the opentelekomcloud.cloud collection (version 0.14.6).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: opentelekomcloud.cloud.css_cluster_info.
New in opentelekomcloud.cloud 0.9.0
Synopsis¶
Get CSS cluster info 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 |
|---|---|
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. |
|
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. |
|
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. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
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. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Number of clusters to be queried. The default value is 10, indicating that 10 clusters are queried at a time. |
|
name or ID of the cluster to be queried. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Start value of the query. The default value is 1, indicating that the query starts from the first cluster. Default: |
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes¶
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay 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 info about clusters
- opentelekomcloud.cloud.css_cluster_info:
name: "css-ea59"
start: 1
limit: 5
register: result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Info about specified CSS cluster. Returned: On Success |
|
Indicates the operation that is executed on the cluster. Returned: success Sample: |
|
Key ID used for disk encryption. Returned: success Sample: |
|
Time when a cluster is created. The format is ISO8601. Returned: success Sample: |
|
Type of the data search engine. Returned: success |
|
Supported type is elasticsearch Returned: success Sample: |
|
Engine version number. The current version is 6.2.3, 7.1.1, or 7.6.2. Returned: success Sample: |
|
Whether disks are encrypted. Returned: success Sample: |
|
Indicates the IP address and port number of the user used to access the VPC. Returned: success Sample: |
|
Error codes. CSS.6000 indicates that a cluster fails to be created. CSS.6001 indicates that capacity expansion of a cluster fails. CSS.6002 indicates that a cluster fails to be restarted. CSS.6004 indicates that a node fails to be created in a cluster. CSS.6005 indicates that the service fails to be initialized. Returned: success Sample: |
|
Cluster ID. Returned: success Sample: |
|
Whether disks are encrypted. Returned: success Sample: |
|
Communication encryption status. Returned: success Sample: |
|
Cluster name. Returned: success Sample: |
|
Info about nodes included in cluster. Returned: success |
|
AZ to which a node belongs. Returned: success Sample: |
|
Node ID. Returned: success Sample: |
|
Node name. Returned: success Sample: |
|
Node specifications. Returned: success Sample: |
|
Node status. 100 The operation, such as node creation, is in progress. 200 The instance is available. 303 The instance is unavailable. Returned: success Sample: |
|
Supported type is ess (indicating the Elasticsearch node) Returned: success Sample: |
|
Cluster operation progress, which indicates the progress of cluster creation. Returned: success |
|
Inicates creation of cluster in percentage. Returned: success Sample: |
|
Indicates the VPC ID. Returned: success Sample: |
|
Security group ID. Returned: success Sample: |
|
Return value. 400 BadRequest. Invalid request. 404 NotFound. The requested resource cannot be found. 200 OK. The request is processed successfully. Returned: success Sample: |
|
Subnet ID. Returned: success Sample: |
|
Last modification time of a cluster. The format is ISO8601. Returned: success Sample: |