Skip to content

Latest commit

 

History

History
239 lines (206 loc) · 9.01 KB

community.missing_collection.rethinkdb_admin_info_module.rst

File metadata and controls

239 lines (206 loc) · 9.01 KB

community.missing_collection.rethinkdb_admin_info

Get information from RethinkDB Database.

Version added: 0.2.0

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • rethinkdb

Parameters

Parameter Choices/Defaults Comments
host
string / required
hostname of rethinkdb.
limit
integer / required
Default:
10
limit number of results to fetch.
password
string
Default:
""
password for rethinkdb user.
port
integer
Default:
28015
port number of rethinkdb.
ssl
dictionary
Default:
"None"
use SSL for rethinkdb connection.
may not work!.
table
string
    Choices:
  • table_config
  • server_config
  • db_config
  • cluster_config
  • table_status
  • server_status ←
  • current_issues
  • users
  • permissions
  • jobs
  • stats
  • logs
name of the system table.
user
string
Default:
"admin"
rethinkdb username.

Examples

- name: get server status from rethinkdb
  community.missing_collection.rethinkdb_admin_info:
    host: 'localhost'
    port: 28015
    user: 'admin'
    password: ''
    table: 'server_status'

- name: get user list from rethinkdb
  community.missing_collection.rethinkdb_admin_info:
    host: 'localhost'
    port: 28015
    user: 'admin'
    password: ''
    table: 'users'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
result
list
when success.
result of the database query.

Sample:
[{'id': 'f3389b47-3a78-4108-b85e-45cd06bcc69a', 'name': '555e32d208e5_mgu', 'network': {'canonical_addresses': [{'host': '127.0.0.1', 'port': 29015}, {'host': '172.17.0.2', 'port': 29015}], 'cluster_port': 29015, 'connected_to': {}, 'hostname': '555e32d208e5', 'http_admin_port': 8080, 'reql_port': 28015, 'time_connected': '2021-07-20T16:35:58.725000+00:00'}, 'process': {'argv': ['rethinkdb', '--bind', 'all'], 'cache_size_mb': 11712.3125, 'pid': 1, 'time_started': '2021-07-20T16:35:58.723000+00:00', 'version': 'rethinkdb 2.4.1~0buster (CLANG 7.0.1 (tags/RELEASE_701/final))'}}]


Status

Authors