Note
This module is part of the netapp.ontap collection (version 22.14.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. You need further requirements to be able to use this module, see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_cli_timeout.
New in netapp.ontap 22.9.0
The below requirements are needed on the host that executes this module.
Parameter | Comments |
|---|---|
cert_filepath string added in netapp.ontap 20.6.0 | path to SSL client cert file (.pem). not supported with python 2.6. |
feature_flags dictionary added in netapp.ontap 20.5.0 | 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. |
force_ontap_version string added in netapp.ontap 21.23.0 | Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. |
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. Choices:
|
key_filepath string added in netapp.ontap 20.6.0 | path to SSL client key file. |
password aliases: pass string | Password for the specified user. |
state string | Modify timeout value, only present is supported. Choices:
|
timeout integer / required | Specifies the timeout value, in minutes. To prevent CLI sessions from timing out, specify a value of 0 (zero). |
use_rest string | This module only supports REST. always – will always use the REST API. A warning is issued if the module does not support REST. Default: |
username aliases: user 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://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Two authentication methods are supported
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
validate_certs boolean | If set to This should only set to Choices:
|
Note
- name: Modify the timeout value for CLI sessions to be 15 minutes
netapp.ontap.na_ontap_cli_timeout:
state: present
timeout: 15
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
- name: Prevent CLI sessions from timing out
netapp.ontap.na_ontap_cli_timeout:
state: present
timeout: 0
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_cli_timeout_module.html