netapp.ontap.na_ontap_aggregate – NetApp ONTAP manage aggregates.¶
Note
This plugin is part of the netapp.ontap collection (version 21.4.0).
To install it use: ansible-galaxy collection install netapp.ontap
.
To use it in a playbook, specify: netapp.ontap.na_ontap_aggregate
.
New in version 2.6.0: of netapp.ontap
Requirements¶
The below requirements are needed on the host that executes this module.
Ansible 2.9
Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
REST support requires ONTAP 9.6 or later.
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 |
---|---|---|
cert_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client cert file (.pem).
not supported with python 2.6.
|
|
disk_count
integer
|
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 .Modifiable only if specified disk_count is larger than current disk_count.
Cannot create raidgroup with 1 disk when using raid type raid4.
If the disk_count % raid_size == 1, only disk_count/raid_size * raid_size will be added.
If disk_count is 6, raid_type is raid4, raid_size 4, all 6 disks will be added.
If disk_count is 5, raid_type is raid4, raid_size 4, 5/4 * 4 = 4 will be added. 1 will not be added.
|
|
disk_size
integer
added in 2.7.0 of netapp.ontap
|
Disk size to use in 4K block size. Disks within 10% of specified size will be used.
|
|
disk_size_with_unit
string
|
Disk size to use in the specified unit.
It is a positive integer number followed by unit of T/G/M/K. For example, 72G, 1T and 32M.
This option is ignored if a specific list of disks is specified through the "disks" parameter.
You must only use one of either "disk-size" or "disk-size-with-unit" parameters.
|
|
disk_type
string
added in 2.7.0 of netapp.ontap
|
|
Type of disk to use to build aggregate
|
disks
list
/ elements=string
added in 2.8.0 of netapp.ontap
|
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.
|
|
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
|
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.
|
|
from_name
string
added in 2.7.0 of netapp.ontap
|
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
|
|
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
|
ignore_pool_checks
boolean
added in 20.8.0 of netapp.ontap
|
|
only valid when disks option is used.
disks in a plex should belong to the same spare pool, and mirror disks to another spare pool.
when set to true, these checks are ignored.
|
is_mirrored
boolean
added in 2.8.0 of netapp.ontap
|
|
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.
|
key_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client key file.
|
|
mirror_disks
list
/ elements=string
added in 2.8.0 of netapp.ontap
|
List of mirror disks to use. It must contain the same number of disks specified in 'disks'.
|
|
name
string
/ required
|
The name of the aggregate to manage.
|
|
nodes
list
/ elements=string
|
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.
|
|
object_store_name
string
added in 2.9.0 of netapp.ontap
|
Name of the object store configuration attached to the aggregate
|
|
ontapi
integer
|
The ontap api version to use
|
|
password
string
|
Password for the specified user.
aliases: pass |
|
raid_size
integer
added in 2.7.0 of netapp.ontap
|
Sets the maximum number of drives per raid group.
|
|
raid_type
string
added in 2.7.0 of netapp.ontap
|
|
Specifies the type of RAID groups to use in the new aggregate.
raid_0 is only available on ONTAP Select.
|
service_state
string
|
|
Whether the specified aggregate should be enabled or disabled. Creates aggregate if doesnt exist.
|
snaplock_type
string
added in 20.1.0 of netapp.ontap
|
|
Type of snaplock for the aggregate being created.
|
spare_pool
string
added in 2.8.0 of netapp.ontap
|
|
Specifies the spare pool from which to select spare disks to use in creation of a new aggregate.
|
state
string
|
|
Whether the specified aggregate should exist or not.
|
time_out
integer
added in 2.8.0 of netapp.ontap
|
Default: 100
|
time to wait for aggregate creation in seconds
default is set to 100 seconds
|
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.
|
use_rest
string
|
Default: "auto"
|
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
always -- will always use the REST API
never -- will always use the ZAPI
auto -- will try to use the REST Api
|
username
string
|
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/.
Two authentication methods are supported
1. basic authentication, using username and password,
2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.
aliases: user |
|
validate_certs
boolean
|
|
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.0 of netapp.ontap
|
|
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
|
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
snaplock_type: non_snaplock
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: Attach object store
na_ontap_aggregate:
state: present
name: aggr4
object_store_name: sgws_305
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 }}"
Authors¶
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>