netapp.ontap.na_ontap_ndmp module – NetApp ONTAP NDMP services configuration

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_ndmp.

New in netapp.ontap 2.9.0

Synopsis

  • Modify NDMP Services.

Requirements

The below requirements are needed on the host that executes this module.

  • Ansible 2.9 or later - 2.12 or later is recommended.

  • Python3 - 3.9 or later is recommended.

  • When using ZAPI, 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.

Parameters

Parameter

Comments

abort_on_disk_error

boolean

Enable abort on disk error.

Choices:

  • false

  • true

authtype

list / elements=string

Authentication type.

backup_log_enable

boolean

Enable backup log.

Choices:

  • false

  • true

cert_filepath

string

added in netapp.ontap 20.6.0

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

Enable debug.

Choices:

  • false

  • true

debug_filter

string

Debug filter.

dump_detailed_stats

boolean

Enable logging of VM stats for dump.

Choices:

  • false

  • true

dump_logical_find

string

Enable logical find for dump.

enable

boolean

Enable NDMP on vserver.

Choices:

  • false

  • true

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.

fh_dir_retry_interval

integer

FH throttle value for dir.

fh_node_retry_interval

integer

FH throttle value for node.

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.

When use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

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:

  • false ← (default)

  • true

ignore_ctime_enabled

boolean

Ignore ctime.

Choices:

  • false

  • true

is_secure_control_connection_enabled

boolean

Is secure control connection enabled.

Choices:

  • false

  • true

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

offset_map_enable

boolean

Enable offset map.

Choices:

  • false

  • true

ontapi

integer

The ontap api version to use

password

aliases: pass

string

Password for the specified user.

per_qtree_exclude_enable

boolean

Enable per qtree exclusion.

Choices:

  • false

  • true

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

Enable TCP nodelay.

Choices:

  • false

  • true

tcpwinsize

integer

TCP window size.

use_rest

string

Whether to use REST or ZAPI.

always -- will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST.

never -- will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI.

auto -- will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise.

Default: "auto"

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

  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.

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.

Choices:

  • false

  • true ← (default)

vserver

string / required

Name of the vserver.

Notes

Note

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

  • https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Examples

- name: Modify ndmp
  netapp.ontap.na_ontap_ndmp:
    vserver: ansible
    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
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true

Authors

  • NetApp Ansible Team (@carchi8py)