W3cubDocs

/Ansible

netapp.ontap.na_ontap_command module – NetApp ONTAP Run any cli command, the username provided needs to have console login permission.

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

New in netapp.ontap 2.7.0

Synopsis

  • Run system-cli commands on ONTAP.
  • Can’t be used with cert authentication and domain authentication accounts.
  • Requires ontapi and console permissions. Console is not supported for data vservers.
  • Requires write permissions, even for show commands! ONTAP reports “Insufficient privileges” and “user ‘xxxxx’ does not have write access to this resource” for a readonly user.

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

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

command

list / elements=string / required

a comma separated list containing the command and arguments.

exclude_lines

string

added in netapp.ontap 19.10.0

applied only when return_dict is true

return only lines containing string pattern in stdout_lines_filter

Default: ""

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.

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

include_lines

string

added in netapp.ontap 19.10.0

applied only when return_dict is true

return only lines containing string pattern in stdout_lines_filter

Default: ""

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

ontapi

integer

The ontap api version to use

password

aliases: pass

string

Password for the specified user.

privilege

string

added in netapp.ontap 2.8.0

privilege level at which to run the command.

Choices:

  • "admin" ← (default)
  • "advanced"

return_dict

boolean

added in netapp.ontap 2.9.0

Returns a parsesable dictionary instead of raw XML output

result_value

status > passed, failed.

stdout > command output in plaintext.

stdout_lines > list of command output lines.

stdout_lines_filter > empty list or list of command output lines matching include_lines or exclude_lines parameters.

xml_dict > JSON representation of what the CLI returned.

Choices:

  • false ← (default)
  • true

use_rest

string

This module only supports ZAPI and can not be swtiched to 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 always use ZAPI.

Default: "never"

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

added in netapp.ontap 19.10.0

If running as vserver admin, you must give a vserver or module will fail

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: Run ONTAP CLI command
  netapp.ontap.na_ontap_command:
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    command: ['version']

# Same as above, but returns parseable dictonary
- name: Run ONTAP CLI command
  netapp.ontap.na_ontap_command:
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    command: ['node', 'show', '-fields', 'node,health,uptime,model']
    privilege: 'admin'
    return_dict: true

# Same as above, but with lines filtering
- name: Run ONTAP CLI command
  netapp.ontap.na_ontap_command:
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    command: ['node', 'show', '-fields', 'node,health,uptime,model']
    exclude_lines: 'ode ' # Exclude lines with 'Node ' or 'node ', or anything else containing 'ode '.
    privilege: 'admin'
    return_dict: true

Authors

  • NetApp Ansible Team (@carchi8py)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_command_module.html