W3cubDocs

/Ansible

netapp.um_info.na_um_clusters_info – NetApp Unified Manager list cluster.

Note

This plugin is part of the netapp.um_info collection (version 21.7.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 netapp.um_info.

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

New in version 20.5.0: of netapp.um_info

Synopsis

  • List Cluster 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 Clusters
  netapp.um_info.na_um_clusters_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 Clusters information

Sample:
[{'_links': {'self': {'href': '...'}}, 'contact': '...', 'isSanOptimized': '...', 'key': '', 'location': '...', 'management_ip': '...', 'name': '...', 'nodes': [{'_links': {'self': {'href': '...'}}, 'key': '...', 'location': '...', 'model': '...', 'name': '...', 'serial_number': '...', 'uptime': '...', 'uuid': '...', 'version': {'full': '...', 'generation': '...', 'major': '...', 'minor': '...'}}], 'uuid': '...', 'version': {'full': '...', 'generation': '...', 'major': '...', 'minor': '...'}}]


Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/um_info/na_um_clusters_info_module.html