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.11.0).

You might already have this collection installed if you are using the ansible package. 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.

To use it in a playbook, specify: opentelekomcloud.cloud.dds_instance_info.

New in version 0.9.0: of opentelekomcloud.cloud

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

api_timeout

integer

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.

auth

dictionary

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.

auth_type

string

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.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

raw

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.

datastore_type

string

Specifies the database type. The value is DDS-Community.

Default: “DDS-Community”

instance

string

Specifies the DB instance ID or name.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • admin

  • internal

  • public ← (default)

mode

string

Specifies the instance type.

Choices:

  • sharding

  • replicaset

region_name

string

Name of the region.

subnet_id

string

Specifies the network ID of the subnet.

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • no ← (default)

  • yes

vpc_id

string

Specifies the VPC ID.

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may 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

instance

complex

Info about a specified DB instance.

If ID or name is not specified, info about all instances inside one project.

Returned: On Success

actions

list / elements=string

Indicates the operation that is executed on the DB instance.

Returned: success

Sample: “CREATE”

availability_zone

string

Indicates the AZ.

Returned: success

backup_strategy

complex

Indicates the backup policy.

Returned: success

keep_days

integer

Indicates the number of days to retain the generated backup files.

Returned: success

Sample: 7

start_time

string

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: “22:00-23:00”

created

string

Indicates the DB instance creation time.

Returned: success

Sample: “2021-08-12T13:58:08”

datastore

complex

Specifies the domain name associated with the server certificate.

Returned: success

storage_engine

string

Storage engine.

Returned: success

type

string

Indicates the DB engine.

Returned: success

Sample: “DDS-Community”

version

string

Indicates the database version.

Returned: success

Sample: “3.4”

datastore_type

string

Specifies the database type.

Returned: success

disk_encryption_id

string

Indicates the disk encryption key ID.

Returned: success

engine

string

Indicates the storage engine.

Returned: success

Sample: “wiredTiger”

flavor

string

Indicates the DB instance flavor.

Returned: success

groups

complex

Indicates group information.

Returned: success

id

string

Indicates the group ID.

This parameter is valid only when the node type is shard or config.

Returned: success

name

string

Indicates the group name.

Returned: success

nodes

complex

Indicates the AZ.

Returned: success

availability_zone

string

Indicates the AZ.

Returned: success

id

string

Indicates the node ID.

Returned: success

Sample: “254c36d7e72a40d0b1667983a8a2fc09no02”

name

string

Indicates the node name.

Returned: success

Sample: “test_dds_replica_node_3”

private_ip

string

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: “192.168.115.80”

public_ip

string

Indicates the EIP that has been bound.

Valid only for mongos nodes of cluster instances.

Returned: success

Sample: “”

role

string

Indicates the node role.

Returned: success

Sample: “Primary”

spec_code

string

Indicates the resource specifications code.

Returned: success

Sample: “dds.mongodb.s2.medium.4.repset”

status

string

Indicates the node status.

Returned: success

Sample: “normal”

status

string

Indicates the group status.

This parameter is valid only when the node type is shard or config.

Returned: success

type

string

Indicates the node type.

Returned: success

volume

complex

Indicates the volume information.

Returned: success

size

string

Indicates the disk size. Unit GB

Returned: success

Sample: “10”

used

string

Indicates the disk usage. Unit GB

Returned: success

Sample: “0.333129882812”

id

string

Indicates the DB instance ID.

Returned: success

Sample: “7ddf3c02aea54610bb6ba324e653484din02”

maintenance_window

string

Indicates the maintenance time window.

Returned: success

Sample: “02:00-06:00”

mode

string

Indicates the instance type, which is the same as the request parameter.

Returned: success

Sample: “CREATE”

name

string

Indicates the operation that is executed on the DB instance.

Returned: success

Sample: “ReplicaSet”

pay_mode

string

Indicates the billing mode. 0 indicates the pay-per-use billing mode.

Returned: success

Sample: “0”

port

integer

Indicates the database port number. The port range is 2100 to 9500.

Returned: success

Sample: 8635

region

string

Indicates the region where the DB instance is deployed.

Returned: success

Sample: “eu-de”

security_group_id

string

Indicates the security group ID.

Returned: success

Sample: “120888d9-65be-4899-b07d-aa151c2895d4”

ssl

boolean

Indicates that SSL is enabled or not.

Returned: success

Sample: 0

status

string

Indicates the DB instance status.

Returned: success

Sample: “normal”

subnet_id

string

Indicates the subnet ID.

Returned: success

Sample: “c2fdde80-9a24-4a84-99fe-d07e942274b1”

time_zone

string

Indicates the time zone.

Returned: success

Sample: “”

updated

string

Indicates the time when a DB instance is updated.

Returned: success

Sample: “2021-08-12T13:58:03”

vpc_id

string

Indicates the VPC ID.

Returned: success

Sample: “199dcd34-9c6f-49d5-b12a-5fa96351acf1”

Authors

  • Yustina Kvrivishvili (@YustinaKvr)

Whats next

last updated: 2022-02-25 12:26