netapp.um_info.na_um_volumes_info – NetApp Unified Manager list volumes.

Note

This plugin is part of the netapp.um_info collection (version 21.7.0).

To install it use: ansible-galaxy collection install netapp.um_info.

To use it in a playbook, specify: netapp.um_info.na_um_volumes_info.

New in version 20.6.0: of netapp.um_info

Synopsis

  • List Volumes on AIQUM.

Requirements

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

  • A AIQUM 9.7 system.

  • Ansible 2.9 or later.

Parameters

Parameter Choices/Defaults Comments
feature_flags
dictionary
added in 21.7.0 of netapp.um_info
Enable or disable a new feature.
This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility.
Supported keys and values are subject to change without notice. Unknown keys are ignored.
trace_apis can be set to true to enable tracing, data is written to /tmp/um_apis.log.
hostname
string / required
The hostname or IP address of the Unified Manager instance.
http_port
integer
Override the default port (443) with this port
max_records
integer
added in 21.7.0 of netapp.um_info
Maximum number of records retrieved in a single GET request.
This module loops on GET requests until all available records are fetched.
If absent, AIQUM uses 1000.
password
string / required
Password for the specified user.
username
string / required
username of the Unified Manager instance.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If set to False, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.

Notes

Note

  • With the 21.6.0 release, all modules have been renamed to na_um_<module>_info. The old ones will continue to work but will be depecrated in the future.

  • The modules prefixed with na_um are built to support the AIQUM 9.7 platform.

  • Supports check_mode.

Examples

- name: List Volumes
  netapp.um_info.na_um_volumes_info:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

Return Values

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

Key Returned Description
records
list / elements=string
always
Returns list of Volumes information

Sample:
[{'_links': {'self': {'href': '...'}}, 'aggregates': [{'...': None}], 'autosize': {'...': None}, 'cluster': {'...': None}, 'create_time': '...', 'key': '...', 'language': '...', 'name': '...', 'qos': {'...': None}, 'snapmirror': {'...': None}, 'snapshot_policy': {'...': None}, 'space': {'...': None}, 'state': '...', 'style': '...', 'svm': {'...': None, '_links': {'self': {'...': None}}}, 'tiering': {'...': None}, 'type': '...', 'uuid': '...'}]


Authors