Docs4dev
Docs
ansible / latest / collections / netapp / ontap / na_ontap_volume_autosize_module.html

netapp.ontap.na_ontap_volume_autosize – NetApp ONTAP manage volume autosize

Note

This plugin is part of the netapp.ontap collection (version 21.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netapp.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_volume_autosize.

New in version 2.9.0: of netapp.ontap

Synopsis

  • Modify Volume AutoSize

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.
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.
grow_threshold_percent
integer
Specifies the percentage of the flexible volume's capacity at which autogrow is initiated.
The default grow threshold varies from 85% to 98%, depending on the volume size.
It is an error for the grow threshold to be less than or equal to the shrink threshold.
Range between 0 and 100
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.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
increment_size
string
Specify the flexible volume's increment size using the following format < number > [k|m|g|t]
The amount is the absolute size to set.
The trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively).
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
maximum_size
string
Specify the flexible volume's maximum allowed size using the following format < number > [k|m|g|t]
The amount is the absolute size to set.
The trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively).
The default value is 20% greater than the volume size at the time autosize was enabled.
It is an error for the maximum volume size to be less than the current volume size.
It is also an error for the maximum size to be less than or equal to the minimum size.
minimum_size
string
Specify the flexible volume's minimum allowed size using the following format < number > [k|m|g|t] The amount is the absolute size to set.
The trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively).
The default value is the size of the volume at the time the 'grow_shrink' mode was enabled.
It is an error for the minimum size to be greater than or equal to the maximum size.
mode
string
    Choices:
  • grow
  • grow_shrink
  • off
Specify the flexible volume's autosize mode of operation.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
reset
boolean
    Choices:
  • no
  • yes
Sets the values of maximum_size, increment_size, minimum_size, grow_threshold_percent, shrink_threshold_percent and mode to their defaults
If reset paramater is present system will always perform reset action, so idempotency is not supported.
shrink_threshold_percent
integer
Specifies the percentage of the flexible volume's capacity at which autoshrink is initiated.
The default shrink theshold is 50%. It is an error for the shrink threshold to be greater than or equal to the grow threshold.
Range between 0 and 100
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
    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.
volume
string / required
The name of the flexible volume for which we want to set autosize.
vserver
string / required
Name of the vserver to use.

Notes

Note

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

Examples

- name: Modify volume autosize
  na_ontap_volume_autosize:
    hostname: 10.193.79.189
    username: admin
    password: netapp1!
    volume: ansibleVolumesize12
    mode: grow
    grow_threshold_percent: 99
    increment_size: 50m
    maximum_size: 10g
    minimum_size: 21m
    shrink_threshold_percent: 40
    vserver: ansible_vserver

- name: Reset volume autosize
  na_ontap_volume_autosize:
    hostname: 10.193.79.189
    username: admin
    password: netapp1!
    volume: ansibleVolumesize12
    reset: true
    vserver: ansible_vserver

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_volume_autosize_module.html