netapp.ontap.na_ontap_ssh_command – NetApp ONTAP Run any cli command over plain SSH using paramiko.

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Run cli commands on ONTAP over SSH using paramiko.
• Output is returned in stdout and stderr, and also as stdout_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, warnings is 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
• 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.
• 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.
• To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Notes

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:

Authors

• NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>