netapp.ontap.na_ontap_ndmp – NetApp ONTAP NDMP services configuration

Note

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

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

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

New in version 2.9.0: of netapp.ontap

Synopsis

  • Modify NDMP Services.

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.

  • REST support requires ONTAP 9.6 or later.

  • Ansible 2.6

  • Ansible 2.9 or later is strongly recommended as it enables the new collection delivery system.

  • 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’

  • netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.

  • 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
    Choices:
  • no
  • yes
Enable abort on disk error.
authtype
list / elements=string
Authentication type.
backup_log_enable
boolean
    Choices:
  • no
  • yes
Enable backup log.
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
data_port_range
string
Data port range. Modification not supported for data Vservers.
debug_enable
boolean
    Choices:
  • no
  • yes
Enable debug.
debug_filter
string
Debug filter.
dump_detailed_stats
boolean
    Choices:
  • no
  • yes
Enable logging of VM stats for dump.
dump_logical_find
string
Enable logical find for dump.
enable
boolean
    Choices:
  • no
  • yes
Enable NDMP on vserver.
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.
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
    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.
ignore_ctime_enabled
boolean
    Choices:
  • no
  • yes
Ignore ctime.
is_secure_control_connection_enabled
boolean
    Choices:
  • no
  • yes
Is secure control connection enabled.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
offset_map_enable
boolean
    Choices:
  • no
  • yes
Enable offset map.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
per_qtree_exclude_enable
boolean
    Choices:
  • no
  • yes
Enable per qtree exclusion.
preferred_interface_role
list / elements=string
Preferred interface role.
restore_vm_cache_size
integer
Restore VM file cache size. Value range [4-1024]
secondary_debug_filter
string
Secondary debug filter.
tcpnodelay
boolean
    Choices:
  • no
  • yes
Enable TCP nodelay.
tcpwinsize
integer
TCP window size.
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.
vserver
string / required
Name of the vserver.

Notes

Note

  • The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

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

Authors