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 support Data ONTAP 9.1 and onward

  • Ansible 2.6

  • Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’

  • Python3 netapp-lib (2018.11.13) or later. 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
    Choices:
  • ATA
  • BSAS
  • FCAL
  • FSAS
  • LUN
  • MSATA
  • SAS
  • SSD
  • VMDISK
Type of disk to use to build aggregate
disks
list
added in 2.8
Specific list of disks to use for the new aggregate.
To create a "mirrored" aggregate with a specific list of disks, both 'disks' and 'mirror_disks' options must be supplied. Additionally, the same number of disks must be supplied in both lists.
from_name
-
added in 2.7
Name of the aggregate to be renamed.
hostname
string / 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
    Choices:
  • no ←
  • yes
Enable and disable https
is_mirrored
boolean
added in 2.8
    Choices:
  • no
  • yes
Specifies that the new aggregate be mirrored (have two plexes).
If set to true, then the indicated disks will be split across the two plexes. By default, the new aggregate will not be mirrored.
This option cannot be used when a specific list of disks is supplied with either the 'disks' or 'mirror_disks' options.
mirror_disks
list
added in 2.8
List of mirror disks to use. It must contain the same number of disks specified in 'disks'.
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.
ontapi
integer
The ontap api version to use
password
string / 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
    Choices:
  • raid4
  • raid_dp
  • raid_tec
Specifies the type of RAID groups to use in the new aggregate.
service_state
-
    Choices:
  • online
  • offline
Whether the specified aggregate should be enabled or disabled. Creates aggregate if doesnt exist.
spare_pool
-
added in 2.8
    Choices:
  • Pool0
  • Pool1
Specifies the spare pool from which to select spare disks to use in creation of a new aggregate.
state
-
    Choices:
  • present ←
  • absent
Whether the specified aggregate should exist or not.
time_out
-
added in 2.8
 Default:
100
time to wait for aggregate creation in seconds
default is set to 100 seconds
unmount_volumes
boolean
    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
string / 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
    Choices:
  • no
  • yes ←
If set to no, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
wait_for_online
boolean
added in 2.8
    Choices:
  • no ←
  • yes
Set this parameter to 'true' for synchronous execution during create (wait until aggregate status is online)
Set this parameter to 'false' for asynchronous execution
For asynchronous, execution exits as soon as the request is sent, without checking aggregate status

Notes

Note

  • The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: Create Aggregates and wait 5 minutes until aggregate is online
  na_ontap_aggregate:
    state: present
    service_state: online
    name: ansibleAggr
    disk_count: 1
    wait_for_online: True
    time_out: 300
    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
    from_name: ansibleAggr
    name: 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

Authors

Hint

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