ansible.builtin.na_ontap_ndmp (v2.9.26) — module

Install Ansible via pip

Install with pip install ansible==2.9.26

Description

Modify NDMP Services.

Requirements

• 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;'

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - 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

Inputs

    
https:
    default: false
    description:
    - Enable and disable https.
    - Ignored when using REST as only https is supported.
    - Ignored when using SSL certificate authentication as it requires SSL.
    type: bool

enable:
    description:
    - Enable NDMP on vserver.
    type: bool

ontapi:
    description:
    - The ontap api version to use
    type: int

vserver:
    description:
    - Name of the vserver.
    required: true
    type: str

authtype:
    description:
    - Authentication type.
    type: list

hostname:
    description:
    - The hostname or IP address of the ONTAP instance.
    required: true
    type: str

password:
    aliases:
    - pass
    description:
    - Password for the specified user.
    type: str

use_rest:
    choices:
    - Never
    - Always
    - Auto
    default: Auto
    description:
    - 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
    type: str

username:
    aliases:
    - user
    description:
    - 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 U(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.
    type: str

http_port:
    description:
    - Override the default port (80 or 443) with this port
    type: int

tcpnodelay:
    description:
    - Enable TCP nodelay.
    type: bool

tcpwinsize:
    description:
    - TCP window size.
    type: int

debug_enable:
    description:
    - Enable debug.
    type: bool

debug_filter:
    description:
    - Debug filter.
    type: str

key_filepath:
    description:
    - path to SSL client key file.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

cert_filepath:
    description:
    - path to SSL client cert file (.pem).
    - not supported with python 2.6.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

feature_flags:
    description:
    - 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.
    type: dict
    version_added: 20.5.0
    version_added_collection: netapp.ontap

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(False) used on personally controlled sites using self-signed
      certificates.
    type: bool

data_port_range:
    description:
    - Data port range.
    type: str

backup_log_enable:
    description:
    - Enable backup log.
    type: bool

dump_logical_find:
    description:
    - Enable logical find for dump.
    type: str

offset_map_enable:
    description:
    - Enable offset map.
    type: bool

abort_on_disk_error:
    description:
    - Enable abort on disk error.
    type: bool

dump_detailed_stats:
    description:
    - Enable logging of VM stats for dump.
    type: bool

ignore_ctime_enabled:
    description:
    - Ignore ctime.
    type: bool

fh_dir_retry_interval:
    description:
    - FH throttle value for dir.
    type: int

restore_vm_cache_size:
    description:
    - Restore VM file cache size.
    type: int

fh_node_retry_interval:
    description:
    - FH throttle value for node.
    type: int

secondary_debug_filter:
    description:
    - Secondary debug filter.
    type: str

per_qtree_exclude_enable:
    description:
    - Enable per qtree exclusion.
    type: bool

preferred_interface_role:
    description:
    - Preferred interface role.
    type: list

is_secure_control_connection_enabled:
    description:
    - Is secure control connection enabled.
    type: bool