fabiog1901.cockroachdb.cc_databases_info module – List databases for a cluster.
Note
This module is part of the fabiog1901.cockroachdb collection (version 1.0.0).
To install it, use: ansible-galaxy collection install fabiog1901.cockroachdb
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fabiog1901.cockroachdb.cc_databases_info
.
New in fabiog1901.cockroachdb 1.0.0
Synopsis
List databases for a cluster.
A Cockroach Cloud Service Account API Key is required.
Export the key as environment variable ‘CC_KEY’ or pass it on module invokation
Requirements
The below requirements are needed on the host that executes this module.
cockroachdb-cloud-client
Parameters
Parameter |
Comments |
---|---|
Define details for the API client |
|
The API version to use Default: |
|
The Service Account API key This value is log redacted By default it reads the env variable ‘CC_KEY’ |
|
the hostname of the API server Default: |
|
the path to the API endpoint Default: |
|
the port number, as a string, for the API server Default: |
|
http or https Choices:
|
|
whether the client should verify the server cert Choices:
|
|
The UUID or name of the cluster. |
Examples
- name: list databases for my cluster
fabiog1901.cockroachdb.cc_databases_info:
cluster_id: 9592afea-2bf8-4dc1-95ec-9369b7f684ca
api_client:
api_version: '2022-09-20'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A list of databases Returned: always Sample: |
|
Returned: always |
|
Returned: always |
Authors
Cockroach Labs