na_ontap_aggregate – NetApp ONTAP manage aggregates.
New in version 2.6.
Synopsis
- Create, delete, or manage aggregates on ONTAP.
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 . | |
disk_size - added in 2.7 | Disk size to use in 4K block size. Disks within 10% of specified size will be used. | |
disk_type - added in 2.7 |
| Type of disk to use to build aggregate |
from_name - added in 2.7 | Name of the aggregate to be renamed. | |
hostname - / required | The hostname or IP address of the ONTAP instance. | |
http_port integer | Override the default port (80 or 443) with this port | |
https boolean |
| Enable and disable https |
name - / required | The name of the aggregate to manage. | |
nodes - | Node(s) for the aggregate to be created on. If no node specified, mgmt lif home will be used. If multiple nodes specified an aggr stripe will be made. | |
password - / required | Password for the specified user. aliases: pass | |
raid_size - added in 2.7 | Sets the maximum number of drives per raid group. | |
raid_type - added in 2.7 | Specifies the type of RAID groups to use in the new aggregate. The default value is raid4 on most platforms. | |
service_state - |
| Whether the specified aggregate should be enabled or disabled. Creates aggregate if doesnt exist. |
state - |
| Whether the specified aggregate should exist or not. |
unmount_volumes boolean |
| 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://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. aliases: user | |
validate_certs boolean |
| 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_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 not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- NetApp Ansible Team (ng-ansibleteam@netapp.com)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/na_ontap_aggregate_module.html