opentelekomcloud.cloud.dws_cluster_info module -- Get info about DWS 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.dws_cluster_info.
New in opentelekomcloud.cloud 0.14.4
Synopsis¶
Get DWS 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:
|
|
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 |
|
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.dws_cluster_info:
name: "dws-ea59"
register: result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Info about specified DWS cluster. Returned: On Success |
|
AZ name. Returned: success Sample: |
|
Cluster creation time. Format YYYY-MM-DDThh:mm:ssZ. Returned: success Sample: |
|
Private network connection information about the cluster. Returned: success |
|
Private network connection information. Returned: success Sample: |
|
Enterprise project ID. The value 0 indicates the ID of the default enterprise project. Returned: success Sample: |
|
The flavor of the cluster. Returned: success Sample: |
|
Cluster ID. Returned: success Sample: |
|
Cluster maintenance window. Returned: success |
|
Maintenance time in each week in the unit of day. Mon Tue Wed Thu Fri Sat Sun Returned: success Sample: |
|
Maintenance end time in HH:mm format. The time zone is GMT+0. Returned: success Sample: |
|
Maintenance start time in HH:mm format. The time zone is GMT+0. Returned: success Sample: |
|
Cluster name. Returned: success Sample: |
|
Subnet ID. Returned: success Sample: |
|
Cluster Instance. Returned: success |
|
Cluster instance ID. Returned: success Sample: |
|
Cluster instance name. Returned: success Sample: |
|
Cluster instance status. Returned: success Sample: |
|
Number of cluster instances. Returned: success Sample: |
|
Number of events. Returned: success Sample: |
|
Parameter group details. Returned: success |
|
Parameter group ID. Returned: success Sample: |
|
Parameter group name. Returned: success Sample: |
|
Cluster parameter status. In-Sync Applying Pending-Reboot Sync-Failure Returned: success Sample: |
|
Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000. Returned: success Sample: |
|
List of private network IP addresses. Returned: success Sample: |
|
Public network connection information about the cluster. Not used by default. Returned: success |
|
Public network connection information. Returned: success Sample: |
|
Public IP address. If the parameter is not specified, public connection is not used by default. Returned: success |
|
EIP ID Returned: success Sample: |
|
Binding type of an EIP. auto_assign not_use bind_existing Returned: success Sample: |
|
Cluster scale-out details. Returned: success |
|
Number of nodes before the scale-out. Returned: success Sample: |
|
Scale-out status. GROWING RESIZE_FAILURE Returned: success Sample: |
|
Scale-out start time. Format YYYY-MM-DDThh:mm:ss. Returned: success Sample: |
|
Number of nodes after the scale-out. Returned: success Sample: |
|
VPC ID. Returned: success Sample: |
|
Security group ID. Returned: success Sample: |
|
Cluster status. CREATING AVAILABLE UNAVAILABLE CREATION FAILED Returned: success Sample: |
|
Sub-status of clusters in the AVAILABLE state. NORMAL READONLY REDISTRIBUTING REDISTRIBUTION-FAILURE UNBALANCED UNBALANCED | READONLY DEGRADED DEGRADED | READONLY DEGRADED | UNBALANCED UNBALANCED | REDISTRIBUTING UNBALANCED | REDISTRIBUTION-FAILURE READONLY | REDISTRIBUTION-FAILURE UNBALANCED | READONLY | REDISTRIBUTION-FAILURE DEGRADED | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | READONLY Returned: success Sample: |
|
Labels in a cluster. Returned: success |
|
Key. Can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. Returned: success Sample: |
|
Value. Can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. Returned: success Sample: |
|
Cluster management task. RESTORING SNAPSHOTTING GROWING REBOOTING SETTING_CONFIGURATION CONFIGURING_EXT_DATASOURCE DELETING_EXT_DATASOURCE REBOOT_FAILURE RESIZE_FAILURE Returned: success Sample: |
|
Last modification time of a cluster. Format YYYY-MM-DDThh:mm:ssZ. Returned: success Sample: |
|
Username of the administrator. Returned: success Sample: |
|
Data warehouse version. Returned: success Sample: |