opentelekomcloud.cloud.dds_instance_info module -- Obtain information about a specified DB instance.¶
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.dds_instance_info.
New in opentelekomcloud.cloud 0.9.0
Synopsis¶
Get info about instances.
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. |
|
Specifies the database type. The value is DDS-Community. Default: |
|
Specifies the DB instance ID or name. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Specifies the instance type. Choices:
|
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Specifies the network ID of the subnet. |
|
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:
|
|
Specifies the VPC ID. |
|
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 instances
- opentelekomcloud.cloud.dds_instance_info:
vpc_id: "7ea09482-793a-4aed-b4ce-447113d10d96"
register: result
- opentelekomcloud.cloud.dds_instance_info:
mode: "replicaset"
register: result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Info about a specified DB instance. If ID or name is not specified, info about all instances inside one project. Returned: On Success |
|
Indicates the operation that is executed on the DB instance. Returned: success Sample: |
|
Indicates the AZ. Returned: success |
|
Indicates the backup policy. Returned: success |
|
Indicates the number of days to retain the generated backup files. Returned: success Sample: |
|
Indicates the backup time window. Automated backups will be triggered during the backup time window. The current time is the UTC time. Returned: success Sample: |
|
Indicates the DB instance creation time. Returned: success Sample: |
|
Specifies the domain name associated with the server certificate. Returned: success |
|
Storage engine. Returned: success |
|
Indicates the DB engine. Returned: success Sample: |
|
Indicates the database version. Returned: success Sample: |
|
Specifies the database type. Returned: success |
|
Indicates the disk encryption key ID. Returned: success |
|
Indicates the storage engine. Returned: success Sample: |
|
Indicates the DB instance flavor. Returned: success |
|
Indicates group information. Returned: success |
|
Indicates the group ID. This parameter is valid only when the node type is shard or config. Returned: success |
|
Indicates the group name. Returned: success |
|
Indicates the AZ. Returned: success |
|
Indicates the AZ. Returned: success |
|
Indicates the node ID. Returned: success Sample: |
|
Indicates the node name. Returned: success Sample: |
|
Indicates the private IP address of a node. Valid only for mongos and replica set instances. The value exists only after ECSs are created successfully. Returned: success Sample: |
|
Indicates the EIP that has been bound. Valid only for mongos nodes of cluster instances. Returned: success Sample: |
|
Indicates the node role. Returned: success Sample: |
|
Indicates the resource specifications code. Returned: success Sample: |
|
Indicates the node status. Returned: success Sample: |
|
Indicates the group status. This parameter is valid only when the node type is shard or config. Returned: success |
|
Indicates the node type. Returned: success |
|
Indicates the volume information. Returned: success |
|
Indicates the disk size. Unit GB Returned: success Sample: |
|
Indicates the disk usage. Unit GB Returned: success Sample: |
|
Indicates the DB instance ID. Returned: success Sample: |
|
Indicates the maintenance time window. Returned: success Sample: |
|
Indicates the instance type, which is the same as the request parameter. Returned: success Sample: |
|
Indicates the operation that is executed on the DB instance. Returned: success Sample: |
|
Indicates the billing mode. 0 indicates the pay-per-use billing mode. Returned: success Sample: |
|
Indicates the database port number. The port range is 2100 to 9500. Returned: success Sample: |
|
Indicates the region where the DB instance is deployed. Returned: success Sample: |
|
Indicates the security group ID. Returned: success Sample: |
|
Indicates that SSL is enabled or not. Returned: success Sample: |
|
Indicates the DB instance status. Returned: success Sample: |
|
Indicates the subnet ID. Returned: success Sample: |
|
Indicates the time zone. Returned: success Sample: |
|
Indicates the time when a DB instance is updated. Returned: success Sample: |
|
Indicates the VPC ID. Returned: success Sample: |