netapp.ontap.na_ontap_ssh_command module – NetApp ONTAP Run any cli command over plain SSH using paramiko.
Note
This module is part of the netapp.ontap collection (version 21.24.1).
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_ssh_command.
New in netapp.ontap 20.8.0
Synopsis
Run cli commands on ONTAP over SSH using paramiko.
Output is returned in
stdoutandstderr, and also asstdout_lines,stdout_lines_filtered,stderr_lines.Note that the module can succeed even though the command failed. You need to analyze stdout and check the results.
If the SSH host key is unknown and accepted,
warningsis updated.Options related to ZAPI or REST APIs are ignored.
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 |
|---|---|
When false, reject the connection if the host key is not in known_hosts file. When true, if the host key is unknown, accept it, but report a warning. Note that the key is not added to the file. You could add the key by manually using SSH. Choices:
|
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
a string containing the command and arguments. |
|
return only lines containing string pattern in Default: |
|
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. |
|
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 Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
return only lines containing string pattern in Default: |
|
path to SSL client key file. |
|
The ontap api version to use |
|
Password for the specified user. |
|
privilege level at which to run the command, eg admin, advanced. if set, the command is prefixed with |
|
whether the target system is ONTAP or the service processor (SP) only menaningful when privilege is set Choices:
|
|
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: |
|
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
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
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 using SSH
na_ontap_ssh_command:
hostname: "{{ hostname }}"
username: "{{ admin_username }}"
password: "{{ admin_password }}"
command: version
# Same as above, with parameters
- name: run ontap cli command
na_ontap_ssh_command:
hostname: "{{ hostname }}"
username: "{{ admin_username }}"
password: "{{ admin_password }}"
command: node show -fields node,health,uptime,model
privilege: admin
# Same as above, but with lines filtering
- name: run ontap cli command
na_ontap_ssh_command:
hostname: "{{ hostname }}"
username: "{{ admin_username }}"
password: "{{ admin_password }}"
command: node show -fields node,health,uptime,model
exclude_lines: 'ode ' # Exclude lines with 'Node ' or 'node'
# use with caution!
accept_unknown_host_keys: true
privilege: admin
- name: run ontap SSH command on SP
na_ontap_ssh_command:
# <<: *sp_login
command: sp switch-version
privilege: diag
sp: true
register: result
- debug: var=result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
In addition to stdout and stdout_lines, a list of non-white lines, excluding last and failed login information. The list can be further refined using the include_lines and exclude_lines filters. Returned: always |