netapp.ontap.na_ontap_rest_cli module – NetApp ONTAP run any CLI command using REST api/private/cli/
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_rest_cli.
New in netapp.ontap 2.9.0
Synopsis
Run CLI commands on ONTAP through REST api/private/cli/.
This module can run as admin or vsdamin and requires HTTP application to be enabled.
Access permissions can be customized using ONTAP rest-role.
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 |
|---|---|
a dictionary for info specification |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
A CLI command. |
|
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. |
|
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:
|
|
path to SSL client key file. |
|
a dictionary of parameters to pass into the api call |
|
Password for the specified user. |
|
This module only supports REST. always -- will always use the REST API. A warning is issued if the module does not support REST. 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://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. 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:
|
|
Define which action to perform with the provided command. Values are mapped to show, create, modify, delete. OPTIONS is useful to know which verbs are supported by the REST API 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 REST CLI command
netapp.ontap.na_ontap_rest_cli:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
command: version
verb: GET
# The fields key allows returning a subset of parameters for a given object
- name: Run volume show command with a filter to only return volumes matching the provided vserver and policy values.
netapp.ontap.na_ontap_rest_cli:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
command: volume
verb: GET
params:
vserver: vs0
policy: default
fields: vserver,volume,policy
register: vs0_volumes
- name: Run security login motd modify command
netapp.ontap.na_ontap_rest_cli:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
command: security/login/motd
verb: PATCH
params:
vserver: ansibleSVM
body:
message: test
- name: Set option
netapp.ontap.na_ontap_rest_cli:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
command: options
verb: PATCH
params:
option_name: lldp.enable
body:
option_value: "on"
- name: Run security certificate delete command
netapp.ontap.na_ontap_rest_cli:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
command: security/certificate
verb: DELETE
body:
vserver: vs1
common-name: cluster01
ca: cluster01
type: server
serial: 17EBE9D26GGE91B9
- name: Run volume create command
netapp.ontap.na_ontap_rest_cli:
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
command: volume
verb: POST
body:
vserver: vs1
volume: my_test_volume
size: 10g
aggregate: aggr1_node1
policy: default
type: RW