na_ontap_ndmp – NetApp ONTAP NDMP services configuration¶
New in version 2.9.
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 |
---|---|---|
abort_on_disk_error
boolean
|
|
Enable abort on disk error.
|
authtype
list
|
Authentication type.
|
|
backup_log_enable
boolean
|
|
Enable backup log.
|
data_port_range
string
|
Data port range.
|
|
debug_enable
boolean
|
|
Enable debug.
|
debug_filter
string
|
Debug filter.
|
|
dump_detailed_stats
boolean
|
|
Enable logging of VM stats for dump.
|
dump_logical_find
string
|
Enable logical find for dump.
|
|
enable
boolean
|
|
Enable NDMP on vserver.
|
fh_dir_retry_interval
integer
|
FH throttle value for dir.
|
|
fh_node_retry_interval
integer
|
FH throttle value for node.
|
|
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
|
ignore_ctime_enabled
boolean
|
|
Ignore ctime.
|
is_secure_control_connection_enabled
boolean
|
|
Is secure control connection enabled.
|
offset_map_enable
boolean
|
|
Enable offset map.
|
ontapi
integer
|
The ontap api version to use
|
|
password
string
/ required
|
Password for the specified user.
aliases: pass |
|
per_qtree_exclude_enable
boolean
|
|
Enable per qtree exclusion.
|
preferred_interface_role
list
|
Preferred interface role.
|
|
restore_vm_cache_size
integer
|
Restore VM file cache size.
|
|
secondary_debug_filter
string
|
Secondary debug filter.
|
|
tcpnodelay
boolean
|
|
Enable TCP nodelay.
|
tcpwinsize
integer
|
TCP window size.
|
|
use_rest
string
|
|
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
/ 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
|
|
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. |
vserver
string
/ required
|
Name of the vserver.
|
Examples¶
- name: modify ndmp
na_ontap_ndmp:
vserver: ansible
hostname: "{{ hostname }}"
abort_on_disk_error: true
authtype: plaintext,challenge
backup_log_enable: true
data_port_range: 8000-9000
debug_enable: true
debug_filter: filter
dump_detailed_stats: true
dump_logical_find: default
enable: true
fh_dir_retry_interval: 100
fh_node_retry_interval: 100
ignore_ctime_enabled: true
is_secure_control_connection_enabled: true
offset_map_enable: true
per_qtree_exclude_enable: true
preferred_interface_role: node_mgmt,intercluster
restore_vm_cache_size: 1000
secondary_debug_filter: filter
tcpnodelay: true
tcpwinsize: 10000
username: user
password: pass
https: False
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
Hint
If you notice any issues in this documentation, you can edit this document to improve it.