na_um_list_aggregates

orphan:

netapp.um_info.na_um_list_aggregates -- NetApp Unified Manager list aggregates.

Note

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

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

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

.. versionadded:: 20.5.0 of netapp.um_info

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• List Aggregates on AIQUM/OCUM.

Requirements

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

• A AIQUM/OCUM 9.7 system.
• Ansible 2.9

Parameters

Parameter	Choices/Defaults	Comments
hostname string / required		The hostname or IP address of the Unified Manager instance.
http_port integer		Override the default port (443) with this port
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

• The modules prefixed with na\_um are built to support the AIQUM/OCUM 9.7 platform.

Examples

- name: List Aggregates
  na_um_list_aggregates:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key	Returned	Description
records list / elements=string	always	Returns list of Aggregates information Sample: [{'_links': {'self': {'href': '...'}}, 'block_storage': {'hybrid_cache': {'enabled': '...', 'size': '...'}, 'mirror': {'state': '...'}, 'primary': {'raid_size': '...', 'raid_type': '...'}}, 'cluster': {'_links': {'self': {'href': '...'}}, 'key': '...', 'name': '...', 'uuid': '...'}, 'create_time': '...', 'data_encryption': {'software_encryption_enabled': '...'}, 'key': '...', 'name': '...', 'node': {'_links': {'self': {'href': '...'}}, 'key': '...', 'name': '...', 'uuid': '...'}, 'snaplock_type': '...', 'space': {'block_storage': {'available': '...', 'size': '...', 'used': '...'}, 'efficiency': {'logical_used': '...', 'savings': '...'}}, 'state': '...', 'type': '...', 'uuid': '...'}]

Authors

• NetApp Ansible Team (@carchi8py) <[email protected]>