netapp.ontap.na_ontap_restit module – NetApp ONTAP Run any REST API on ONTAP
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_restit.
New in netapp.ontap 20.4.0
Synopsis
Call a REST API on ONTAP.
Cluster REST API are run using a cluster admin account.
Vserver REST API can be run using a vsadmin account or using vserver tunneling (cluster admin with vserver_ options).
In case of success, a json dictionary is returned as
response.In case of a REST API error,
status_code,error_code,error_messageare set to help with diagnosing the issue,and the call is reported as an error (‘failed’).
Other errors (eg connection issues) are reported as Ansible error.
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 |
|---|---|
Value for the Accept request HTTP header. This is very infrequently needed, but required to read a file (see examples). For most cases, omit this field. Set it to “multipart/form-data” when expecting such a format. By default the module is using “application/json” or “application/hal+json” when hal_linking is true. |
|
The REST API to call (eg cluster/software, svms/svm). |
|
A dictionary for the info parameter |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
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. |
|
A dictionary for the parameters when using multipart/form-data. This is very infrequently needed, but required to write a file (see examples) When present, requests will automatically set the Content-Type header to multipart/form-data. |
|
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. |
|
if true, HAL-encoded links are returned in the response. Choices:
|
|
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. |
|
The REST method to use. Default: |
|
Password for the specified user. |
|
A list of dictionaries for the query parameters |
|
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:
|
|
if provided, forces vserver tunneling. username identifies a cluster admin account. |
|
if provided, forces vserver tunneling. username identifies a cluster admin account. |
|
when true, POST/PATCH/DELETE can be handled synchronously and asynchronously. if the response indicates that a job is in progress, the job status is checked periodically until is completes. when false, the call returns immediately. 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: Ontap REST API
hosts: localhost
gather_facts: false
vars:
login: &login
hostname: "{{ admin_ip }}"
username: "{{ admin_username }}"
password: "{{ admin_password }}"
https: true
validate_certs: false
svm_login: &svm_login
hostname: "{{ svm_admin_ip }}"
username: "{{ svm_admin_username }}"
password: "{{ svm_admin_password }}"
https: true
validate_certs: false
tasks:
- name: Run ontap REST API command as cluster admin
netapp.ontap.na_ontap_restit:
<<: *login
api: cluster/software
register: result
- name: Assertions
ansible.builtin.assert:
that: result.status_code==200
quiet: true
- name: Run ontap REST API command as cluster admin
netapp.ontap.na_ontap_restit:
<<: *login
api: cluster/software
query:
fields: version
register: result
- name: Assertions
ansible.builtin.assert:
that: result.status_code==200
quiet: true
- name: Run ontap REST API command as cluster admin
netapp.ontap.na_ontap_restit:
<<: *login
api: svm/svms
register: result
- name: Assertions
ansible.builtin.assert:
that: result.status_code==200
quiet: true
- name: Run ontap REST API command as cluster admin
netapp.ontap.na_ontap_restit:
<<: *login
api: svm/svms
query:
fields: aggregates,cifs,nfs,uuid
query_fields: name
query: trident_svm
hal_linking: true
register: result
- name: Run ontap REST API command as vsadmin
netapp.ontap.na_ontap_restit:
<<: *svm_login
api: svm/svms
register: result
- name: Assertions
ansible.builtin.assert:
that: result.status_code==200
quiet: true
- name: Run ontap REST API command as vserver tunneling
netapp.ontap.na_ontap_restit:
<<: *login
api: storage/volumes
vserver_name: ansibleSVM
register: result
- name: Assertions
ansible.builtin.assert:
that: result.status_code==200
quiet: true
- name: Store UUID
ansible.builtin.set_fact:
uuid: "{{ result.response.records | json_query(get_uuid) }}"
vars:
get_uuid: "[? name=='deleteme_ln1'].uuid"
- name: Run ontap REST API command as DELETE method with vserver tunneling
netapp.ontap.na_ontap_restit:
<<: *login
api: "storage/volumes/{{ uuid[0] }}"
method: DELETE
vserver_name: ansibleSVM
query:
return_timeout: 60
register: result
when: uuid | length == 1
- name: Assertions
ansible.builtin.assert:
that: result.skipped | default(false) or result.status_code | default(404) == 200
quiet: true
- name: Run ontap REST API command as POST method with vserver tunneling
netapp.ontap.na_ontap_restit:
<<: *login
api: storage/volumes
method: POST
vserver_name: ansibleSVM
query:
return_records: "true"
return_timeout: 60
body:
name: deleteme_ln1
aggregates:
- name: aggr1
register: result
- name: Assertions
ansible.builtin.assert:
that: result.status_code==201
quiet: true
- name: Run ontap REST API command as DELETE method with vserver tunneling
# delete test volume if present
netapp.ontap.na_ontap_restit:
<<: *login
api: "storage/volumes/{{ result.response.records[0].uuid }}"
method: DELETE
vserver_name: ansibleSVM
query:
return_timeout: 60
register: result
- name: Assertions
ansible.builtin.assert:
that: result.status_code==200
quiet: true
- name: Create a file
# assuming credentials are set using module_defaults
netapp.ontap.na_ontap_restit:
api: storage/volumes/f3c003cb-2974-11ed-b2f8-005056b38dae/files/laurent123.txt
method: post
files:
data: 'some data'
- name: Read a file
# assuming credentials are set using module_defaults
netapp.ontap.na_ontap_restit:
api: storage/volumes/f3c003cb-2974-11ed-b2f8-005056b38dae/files/laurent123.txt
method: get
accept_header: "multipart/form-data"
query:
length: 100
# error cases
- name: Run ontap REST API command
netapp.ontap.na_ontap_restit:
<<: *login
api: unknown/endpoint
register: result
ignore_errors: True
- name: Assertions
ansible.builtin.assert:
that: result.status_code==404
quiet: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
If the REST API was executed but failed, the error code set by the REST API. Not present if successful, or if the REST API call cannot be performed. Returned: On error |
|
If the REST API was executed but failed, the error message set by the REST API. Not present if successful, or if the REST API call cannot be performed. Returned: On error |
|
If successful, a json dictionary returned by the REST API. If the REST API was executed but failed, an empty dictionary. Not present if the REST API call cannot be performed. Returned: On success |
|
The http status code. When wait_for_completion is True, this is forced to 0. Returned: Always |