yadro.tatlin_uni.tatlin_sp_ports_info module – Get information about data ports

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_ports_info.

New in version 1.0.0: of yadro.tatlin_uni

Synopsis

  • This module is intended to get information about data ports in a form of detailed inventory

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)

Examples

---
- name: Get ports info
  yadro.tatlin_uni.tatlin_sp_ports_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

ports_info

dictionary

Details of the data ports

Returned: on success

Sample: {“p00”: {“gateway”: “192.168.1.1”, “mac”: {“sp-0”: “00:00:00:00:00:00”, “sp-1”: “00:00:00:00:00:01”}, “mtu”: 1500, “nodes”: {“sp-0”: [{“ip”: “192.168.1.2”, “mask”: “24”, “status”: “online”}], “sp-1”: [{“ip”: “192.168.1.3”, “mask”: “24”, “status”: “online”}]}, “port_type”: “ip”, “virtual_address”: “None”, “wwpn”: “None”}, “p01”: {“gateway”: “192.168.2.1”, “mac”: {“sp-0”: “00:00:00:00:00:10”, “sp-1”: “00:00:00:00:00:11”}, “mtu”: 1500, “nodes”: {“sp-0”: [{“ip”: “192.168.2.2”, “mask”: “24”, “status”: “online”}], “sp-1”: [{“ip”: “192.168.2.3”, “mask”: “24”, “status”: “online”}]}, “port_type”: “ip”, “virtual_address”: “None”, “wwpn”: “None”}}

Authors

  • Sergey Kovalev (@kvlvs)