netapp.ontap.na_ontap_support_config_backup module – NetApp ONTAP support configuration backup

Note

This module is part of the netapp.ontap collection (version 23.1.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_support_config_backup.

New in netapp.ontap 23.0.0

Synopsis

  • Retrieves and modify the cluster configuration backup information.

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.

  • netapp-lib only when using ZAPI (install using ‘pip install netapp-lib’), Please note that netapp-lib is deprecated and no longer maintained. Proceed at your own risk.

  • 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

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:

  • false ← (default)

  • true

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

name

string

Use this parameter to specify the user name to use to log in to the destination system and perform the upload.

The option “name” should be used in parameter instead of “username”.

password

aliases: pass

string

Password for the specified user.

set_password

string

added in netapp.ontap 23.1.0

Password used to uploads configuration backups.

The option “set_password” should be used in parameter instead of “password”.

state

string

This module supports only system backup configuration modify, hence only present state is supported.

Choices:

  • "present" ← (default)

url

string

An external backup location for the cluster configuration.

This is mostly required for single node clusters where node and cluster configuration backups cannot be copied to other nodes in the cluster.

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: "always"

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_certificate

boolean

Use this parameter with the value “true” to validate the digital certificate of the remote server.

Digital certificate validation is available only when the HTTPS protocol is used in the URL; it is disabled by default.

Choices:

  • false

  • true

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)

Notes

Note

  • Only supported with REST and requires ONTAP 9.6 or later.

  • The option ‘validate_certificate’ requires ONTAP 9.7 or later.

  • 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: Get support config backup
  netapp.ontap.na_ontap_support_config_backup:
    state: present
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    validate_certificate: false
    url: "{{ backup_url }}"
    name: Netappuser

- name: Modify the support config_backup
  netapp.ontap.na_ontap_support_config_backup:
    state: present
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    validate_certificate: true
    url: "{{ backup_url }}"
    name: ftpuser
    set_password: "netapp"
    feature_flags:
      trace_apis: true

Authors

  • NetApp Ansible Team (@carchi8py)