Try SpotterObtain information about a specified DB instance.
| "added in version" 0.9.0 of opentelekomcloud.cloud"
Authors: Yustina Kvrivishvili (@YustinaKvr)
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2
collections:
- name: opentelekomcloud.cloud
version: 0.14.2Get info about instances.
# 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
auth:
description:
- Dictionary containing auth information as needed by the cloud's auth plugin strategy.
For the default I(password) plugin, this would contain I(auth_url), I(username),
I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
or I(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.
type: dict
mode:
choices:
- sharding
- replicaset
description:
- Specifies the instance type.
type: str
wait:
default: true
description:
- Should ansible wait until the requested resource is complete.
type: bool
cloud:
description:
- Named cloud or cloud config to operate against. If I(cloud) is a string, it references
a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
provided or if OpenStack OS_* environment variables are present. If I(cloud) is
a dict, it contains a complete cloud configuration like would be in a section of
clouds.yaml.
type: raw
vpc_id:
description:
- Specifies the VPC ID.
type: str
ca_cert:
aliases:
- cacert
description:
- A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
type: str
timeout:
default: 180
description:
- How long should ansible wait for the requested resource.
type: int
instance:
description:
- Specifies the DB instance ID or name.
type: str
auth_type:
description:
- 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 I(auth) parameter should be updated accordingly.
type: str
interface:
aliases:
- endpoint_type
choices:
- admin
- internal
- public
default: public
description:
- Endpoint URL type to fetch from the service catalog.
type: str
subnet_id:
description:
- Specifies the network ID of the subnet.
type: str
client_key:
aliases:
- key
description:
- A path to a client key to use as part of the SSL transaction.
type: str
api_timeout:
description:
- 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.
type: int
client_cert:
aliases:
- cert
description:
- A path to a client certificate to use as part of the SSL transaction.
type: str
region_name:
description:
- Name of the region.
type: str
sdk_log_path:
description:
- Path to the logfile of the OpenStackSDK. If empty no log is written
type: str
sdk_log_level:
choices:
- ERROR
- WARN
- INFO
- DEBUG
default: WARN
description: Log level of the OpenStackSDK
type: str
datastore_type:
default: DDS-Community
description:
- Specifies the database type. The value is DDS-Community.
type: str
validate_certs:
aliases:
- verify
description:
- Whether or not SSL API requests should be verified.
- Before Ansible 2.3 this defaulted to C(yes).
type: bool
instance:
contains:
actions:
description: Indicates the operation that is executed on the DB instance.
sample: CREATE
type: list
availability_zone:
description: Indicates the AZ.
sample: null
type: str
backup_strategy:
contains:
keep_days:
description: Indicates the number of days to retain the generated backup
files.
sample: 7
type: int
start_time:
description:
- Indicates the backup time window.
- Automated backups will be triggered during the backup time window.
- The current time is the UTC time.
sample: 22:00-23:00
type: str
description: Indicates the backup policy.
type: complex
created:
description: Indicates the DB instance creation time.
sample: '2021-08-12T13:58:08'
type: str
datastore:
contains:
storage_engine:
description: Storage engine.
sample: null
type: str
type:
description: Indicates the DB engine.
sample: DDS-Community
type: str
version:
description: Indicates the database version.
sample: '3.4'
type: str
description: Specifies the domain name associated with the server certificate.
type: complex
datastore_type:
description: Specifies the database type.
sample: null
type: str
disk_encryption_id:
description: Indicates the disk encryption key ID.
sample: null
type: str
engine:
description: Indicates the storage engine.
sample: wiredTiger
type: str
flavor:
description: Indicates the DB instance flavor.
sample: null
type: str
groups:
contains:
id:
description:
- Indicates the group ID.
- This parameter is valid only when the node type is shard or config.
sample: null
type: str
name:
description: Indicates the group name.
sample: null
type: str
nodes:
contains:
availability_zone:
description: Indicates the AZ.
sample: null
type: str
id:
description: Indicates the node ID.
sample: 254c36d7e72a40d0b1667983a8a2fc09no02
type: str
name:
description: Indicates the node name.
sample: test_dds_replica_node_3
type: str
private_ip:
description:
- 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.
sample: 192.168.115.80
type: str
public_ip:
description:
- Indicates the EIP that has been bound.
- Valid only for mongos nodes of cluster instances.
sample: ''
type: str
role:
description: Indicates the node role.
sample: Primary
type: str
spec_code:
description: Indicates the resource specifications code.
sample: dds.mongodb.s2.medium.4.repset
type: str
status:
description: Indicates the node status.
sample: normal
type: str
description: Indicates the AZ.
type: complex
status:
description:
- Indicates the group status.
- This parameter is valid only when the node type is shard or config.
sample: null
type: str
type:
description: Indicates the node type.
sample: null
type: str
volume:
contains:
size:
description: Indicates the disk size. Unit GB
sample: '10'
type: str
used:
description: Indicates the disk usage. Unit GB
sample: '0.333129882812'
type: str
description: Indicates the volume information.
type: complex
description: Indicates group information.
type: complex
id:
description: Indicates the DB instance ID.
sample: 7ddf3c02aea54610bb6ba324e653484din02
type: str
maintenance_window:
description: Indicates the maintenance time window.
sample: 02:00-06:00
type: str
mode:
description: Indicates the instance type, which is the same as the request parameter.
sample: CREATE
type: str
name:
description: Indicates the operation that is executed on the DB instance.
sample: ReplicaSet
type: str
pay_mode:
description: Indicates the billing mode. 0 indicates the pay-per-use billing
mode.
sample: '0'
type: str
port:
description: Indicates the database port number. The port range is 2100 to 9500.
sample: 8635
type: int
region:
description: Indicates the region where the DB instance is deployed.
sample: eu-de
type: str
security_group_id:
description: Indicates the security group ID.
sample: 120888d9-65be-4899-b07d-aa151c2895d4
type: str
ssl:
description: Indicates that SSL is enabled or not.
sample: 0
type: bool
status:
description: Indicates the DB instance status.
sample: normal
type: str
subnet_id:
description: Indicates the subnet ID.
sample: c2fdde80-9a24-4a84-99fe-d07e942274b1
type: str
time_zone:
description: Indicates the time zone.
sample: ''
type: str
updated:
description: Indicates the time when a DB instance is updated.
sample: '2021-08-12T13:58:03'
type: str
vpc_id:
description: Indicates the VPC ID.
sample: 199dcd34-9c6f-49d5-b12a-5fa96351acf1
type: str
description:
- Info about a specified DB instance.
- If ID or name is not specified, info about all instances inside one project.
returned: On Success
type: complex