Installation

ansible-galaxy collection install netapp.ontap

To use this collection, add the following to the top of your playbook, without this you will be using Ansible 2.9 version of the module

collections:
  - netapp.ontap

Requirements

ansible-core >= 2.16
requests >= 2.20
netapp-lib version >= 2018.11.13 (For ZAPI)

Module documentation

https://docs.ansible.com/ansible/devel/collections/netapp/ontap/

Deprecation warning

The 'netapp-lib' library is no longer maintained. Proceed at your own risk when using ZAPI. Please refer to CPC to stay updated with ONTAPI (ZAPI) End-of-Availability announcement.

Mapping of ZAPI-Only Modules to their RESTful Equivalents

A mapping between ZAPI-only modules and their RESTful equivalents is provided below. Use this as a reference when migrating playbooks to ensure compatibility with REST APIs, as REST modules may return data in a different format and offer additional features not available in ZAPI.

na_ontap_broadcast_domain_ports -> na_ontap_ports
na_ontap_command -> na_ontap_rest_cli
na_ontap_firewall_policy -> na_ontap_service_policy
na_ontap_info -> na_ontap_rest_info
na_ontap_ldap -> na_ontap_ldap_client
na_ontap_motd -> na_ontap_login_messages
na_ontap_ntfs_dacl -> na_ontap_file_security_permissions
na_ontap_ntfs_sd -> na_ontap_file_security_permissions
na_ontap_qos_adaptive_policy_group -> na_ontap_qos_policy_group
na_ontap_volume_snaplock -> na_ontap_volume
na_ontap_vserver_cifs_security -> na_ontap_cifs_server
na_ontap_zapit -> na_ontap_restit

ZAPI-only Modules

The following modules do not have REST equivalent APIs.

na_ontap_file_directory_policy
na_ontap_quota_policy
na_ontap_svm_options

Support

Certain modules and options in the collection are only available from specific versions of ONTAP. The versions that a module or option supports are documented in the individual module documentation.

AWS FSx for NetApp ONTAP

Note: Each module's documentation indicates whether it supports AWS FSx for NetApp ONTAP functionality.

Please find below an example for using Lambda proxy functionality.

---
- name: Manage volume using Lambda Proxy
  hosts: localhost
  gather_facts: false
  
  vars:
    # ONTAP and Lambda configuration
    ontap_config:
      hostname: "hostname"
      username: "user"
      password: "password"
      use_lambda: true
      lambda_config:
        function_name: "netapp-ontap-automation"
        aws_region: "us-east-1"
        aws_profile: "default"  # Optional

  tasks:
    - name: Create a volume
      netapp.ontap.na_ontap_volume:
        hostname: "{{ ontap_config.hostname }}"
        username: "{{ ontap_config.username }}"
        password: "{{ ontap_config.password }}"
        use_lambda: "{{ ontap_config.use_lambda }}"
        lambda_config: "{{ ontap_config.lambda_config }}"
        name: test_volume
        vserver: test_svm
        size: 20
        size_unit: mb
        aggregate_name: test_aggr
        state: present
        use_rest: always
      register: volume_create_result

Need help

Join our Discord and look for our #ansible channel.

Release Notes

Please refer to CHANGELOG.md for release notes.

Related Information

For debugging connectivity issues or for tracing API calls, please refer to this page.

For creating any new issues or enhancements, please visit this page.

License Information

GNU General Public License v3.0 See LICENSE to see the full text.

Netapp.ontap

Install / Use

README