Documentation
  • Docs »
  • na_ontap_aggregate - Manage NetApp ONTAP aggregates.

na_ontap_aggregate - Manage NetApp ONTAP aggregates.

New in version 2.6.

Synopsis

  • Create or destroy aggregates on NetApp cDOT.

Requirements

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

  • A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 9.3
  • Ansible 2.6
  • netapp-lib (2017.10.30). Install using ‘pip install netapp-lib’
  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter Choices/Defaults Comments
disk_count
Number of disks to place into the aggregate, including parity disks.
The disks in this newly-created aggregate come from the spare disk pool.
The smallest disks in this pool join the aggregate first, unless the disk-size argument is provided.
Either disk-count or disks must be supplied. Range [0..2^31-1].
Required when state=present.
hostname
required
The hostname or IP address of the ONTAP instance.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled https
name
required
The name of the aggregate to manage.
nodes
List of node for the aggregate
password
required
Password for the specified user.

aliases: pass
rename
The name of the aggregate that replaces the current name.
service_state
    Choices:
  • online
  • offline
Whether the specified aggregate should be enabled or disabled. Creates aggregate if doesnt exist.
state
    Choices:
  • present ←
  • absent
Whether the specified aggregate should exist or not.
unmount_volumes
bool
    Choices:
  • no
  • yes
If set to "TRUE", this option specifies that all of the volumes hosted by the given aggregate are to be unmounted
before the offline operation is executed.
By default, the system will reject any attempt to offline an aggregate that hosts one or more online volumes.
username
required
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://goo.gl/BRu78Z.

aliases: user

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: Create Aggregates
  na_ontap_aggregate:
    state: present
    service_state: online
    name: ansibleAggr
    disk_count: 1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Manage Aggregates
  na_ontap_aggregate:
    state: present
    service_state: offline
    unmount_volumes: true
    name: ansibleAggr
    disk_count: 1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Rename Aggregates
  na_ontap_aggregate:
    state: present
    service_state: online
    name: ansibleAggr
    rename: ansibleAggr2
    disk_count: 1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete Aggregates
  na_ontap_aggregate:
    state: absent
    service_state: offline
    unmount_volumes: true
    name: ansibleAggr
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.