yadro.tatlin_uni.tatlin_sp_pools_info module – Get information about configured pools.

Note

This module is part of the yadro.tatlin_uni collection (version 1.0.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 yadro.tatlin_uni.

To use it in a playbook, specify: yadro.tatlin_uni.tatlin_sp_pools_info.

Synopsis

  • This module is intended to get information about configured pools in a form of detailed inventory

  • Supports check mode

Parameters

Parameter

Comments

connection

dictionary / required

connection describes Tatlin Storage Processor (SP) connection configuration.

Only session connection supported.

Authorization is executed automatically with corresponding endpoint. ‘auth/login’ by default.

Client receives x-auth-token and uses it for following requests.

base_url

string / required

Tatlin REST API entrypoint.

password

string

Tatlin user password.

timeout

integer

Tatlin REST API request timeout.

Default: 60

username

string

Tatlin username to login.

validate_certs

boolean

Responsible for SSL certificates validation.

If set to False certificates won’t validated.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • All capacity values are returned in bytes size

Examples

---
- name: Get tatlin pools info
  yadro.tatlin_uni.tatlin_sp_pools_info:
    connection: "{{ connection }}"
  register: result

Return Values

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

Key

Description

error

string

Error details if raised

Returned: on error

msg

string

Operation status message

Returned: always

pools_info

list / elements=dictionary

Details of the pools

Returned: on success

Sample: [{“capacity_available”: 301989888, “capacity_failed”: 0, “capacity_total”: 301989888, “capacity_used”: 0, “critical_threshold”: 66, “name”: “testpool1”, “protection”: “1+1”, “provision”: “thin”, “resources”: [{“capacity_total”: 201326592, “capacity_used”: 201326592, “host_groups”: [“group_example1”, “group_example2”], “hosts”: [“host_example1”, “host_example2”], “name”: “example_resource”, “ports”: [“p00”, “p01”], “read_cache”: true, “status”: “online”, “type”: “block”, “warning_threshold”: 69, “write_cache”: true}], “resources_count”: 1, “spare_count”: 1, “status”: “ready”, “warning_threshold”: 65}, {“capacity_available”: 352321536, “capacity_failed”: 0, “capacity_total”: 369098752, “capacity_used”: 16777216, “critical_threshold”: null, “name”: “testpool2”, “protection”: “1+1”, “provision”: “thick”, “resources”: [], “resources_count”: 0, “spare_count”: 1, “status”: “ready”, “warning_threshold”: null}]

Authors

  • Sergey Kovalev (@kvlvs)