Try SpotterNetApp ONTAP manage aggregates.
| "added in version" 2.6 of ansible.builtin"
Authors: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
preview | supported by certified
pipInstall with pip install ansible==2.9.26
Create, delete, or manage aggregates on ONTAP.
- 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 }}"
name:
description:
- The name of the aggregate to manage.
required: true
disks:
description:
- 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.
type: list
version_added: '2.8'
version_added_collection: ansible.builtin
https:
default: false
description:
- Enable and disable https.
- Ignored when using REST as only https is supported.
- Ignored when using SSL certificate authentication as it requires SSL.
type: bool
nodes:
description:
- 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.
state:
choices:
- present
- absent
default: present
description:
- Whether the specified aggregate should exist or not.
ontapi:
description:
- The ontap api version to use
type: int
hostname:
description:
- The hostname or IP address of the ONTAP instance.
required: true
type: str
password:
aliases:
- pass
description:
- Password for the specified user.
type: str
time_out:
default: 100
description:
- time to wait for aggregate creation in seconds
- default is set to 100 seconds
version_added: '2.8'
version_added_collection: ansible.builtin
use_rest:
choices:
- Never
- Always
- Auto
default: Auto
description:
- 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
type: str
username:
aliases:
- user
description:
- 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 U(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.
type: str
disk_size:
description:
- Disk size to use in 4K block size. Disks within 10% of specified size will be used.
version_added: '2.7'
version_added_collection: ansible.builtin
disk_type:
choices:
- ATA
- BSAS
- FCAL
- FSAS
- LUN
- MSATA
- SAS
- SSD
- VMDISK
description:
- Type of disk to use to build aggregate
version_added: '2.7'
version_added_collection: ansible.builtin
from_name:
description:
- Name of the aggregate to be renamed.
version_added: '2.7'
version_added_collection: ansible.builtin
http_port:
description:
- Override the default port (80 or 443) with this port
type: int
raid_size:
description:
- Sets the maximum number of drives per raid group.
version_added: '2.7'
version_added_collection: ansible.builtin
raid_type:
choices:
- raid4
- raid_dp
- raid_tec
description:
- Specifies the type of RAID groups to use in the new aggregate.
version_added: '2.7'
version_added_collection: ansible.builtin
disk_count:
description:
- 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 C(disk-size)
argument is provided.
- Either C(disk-count) or C(disks) must be supplied. Range [0..2^31-1].
- Required when C(state=present).
spare_pool:
choices:
- Pool0
- Pool1
description:
- Specifies the spare pool from which to select spare disks to use in creation of
a new aggregate.
version_added: '2.8'
version_added_collection: ansible.builtin
is_mirrored:
description:
- 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.
type: bool
version_added: '2.8'
version_added_collection: ansible.builtin
key_filepath:
description:
- path to SSL client key file.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
mirror_disks:
description:
- List of mirror disks to use. It must contain the same number of disks specified
in 'disks'.
type: list
version_added: '2.8'
version_added_collection: ansible.builtin
cert_filepath:
description:
- path to SSL client cert file (.pem).
- not supported with python 2.6.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
feature_flags:
description:
- 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.
type: dict
version_added: 20.5.0
version_added_collection: netapp.ontap
service_state:
choices:
- online
- offline
description:
- Whether the specified aggregate should be enabled or disabled. Creates aggregate
if doesnt exist.
validate_certs:
default: true
description:
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(False) used on personally controlled sites using self-signed
certificates.
type: bool
unmount_volumes:
description:
- 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.
type: bool
wait_for_online:
default: false
description:
- 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
type: bool
version_added: '2.8'
version_added_collection: ansible.builtin