-
Notifications
You must be signed in to change notification settings - Fork 36
Rest_Support
Chris Archibald edited this page Oct 20, 2023
·
95 revisions
This page list which ONTAP API the Ansible modules currently support. Most ansible modules will have REST support, any modules that will not support Rest will be called out below.
As of 21.24.0 (published Oct 5th, 2022), REST support reached parity with ZAPI support in the ONTAP Ansible Collection. There are actually new features that are only supported in REST and not ZAPI, so REST is now a superset of ZAPI.
- even if REST support is added, some options that were available with ZAPI may not be supported in REST.
- new features and options may be added in REST, but not in ZAPI.
-
na_ontap_rest_cliandna_ontap_rest_infoshould be used in preference tona_ontap_commandandna_ontap_info, but the output formats are different.
The 2022-Q4 ONTAP release will be the last ONTAP version to support ONTAPI (ZAPI). Future versions of ONTAP will only support REST. This change will effect the modules listed below.
These are modules user will need to migrate from their playbook to use the REST version of the module. Do note because REST return values differently than ZAPI you will need to update your playbooks to work with the new module.
| ZAPI Only Modules | REST modules |
|---|---|
| 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_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 |
The following modules do not have REST equivalent APIs. They will stop working on any ONTAP release after the CY22-Q4 release.
- na_ontap_file_directory_policy
- na_ontap_svm_options
- na_ontap_quota_policy
| Module | Zapi Support | Rest Support | Ansible Version added | Minimum ONTAP version for Rest | Note |
|---|---|---|---|---|---|
| na_ontap_active_directory | Yes | Yes | 22.2.0 | 9.12.1 | |
| na_ontap_active_directory_domain_controllers | No | Yes | 22.7.0 | 9.12.0 | REST requires ONTAP 9.12.0 or later and private cli for lower ONTAP versions. |
| na_ontap_aggregate | Yes | Yes | 21.16.0 | 9.6 | |
| na_ontap_autosupport | Yes | Yes | 21.5.0 | 9.6 | |
| na_ontap_autosupport_invoke | Yes | Yes | 21.4.1 | 9.6 | |
| na_ontap_bgp_peer_group | No | Yes | 22.0.0 | 9.7 | |
| na_ontap_broadcast_domain | Yes | Yes | 21.15.0 | 9.6 | |
| na_ontap_broadcast_domain_ports | Yes | No | Deprecated, use na_ontap_ports | ||
| na_ontap_cg_snapshot | Yes | Yes | 22.8.0 | 9.10.1 | |
| na_ontap_cifs | Yes | Yes | 21.17.0 | 9.6 | |
| na_ontap_cifs_acl | Yes | Yes | 21.17.0 | 9.6 | |
| na_ontap_cifs_local_group | No | Yes | 22.1.0 | 9.10.1 | This module is REST only and requires ONTAP 9.10.1. |
| na_ontap_cifs_local_group_member | Yes | Yes | 21.2.0 | 9.10.1 | This module requires ONTAP 9.10.1 or later for REST. |
| na_ontap_cifs_local_user_modify | Yes | Yes | 21.4.0 | 9.6 | |
| na_ontap_cifs_local_user_set_password | Yes | Yes | 21.23.0 | 9.10.1 | |
| na_ontap_cifs_server | Yes | Yes | 21.16.0 | 9.6 | |
| na_ontap_cluster | Yes | Yes | 21.12.0 | 9.6 | |
| na_ontap_cluster_ha | Yes | Yes | 21.23.0 | 9.6 | |
| na_ontap_cluster_peer | Yes | Yes | 21.17.0 | 9.6 | |
| na_ontap_command | Yes | No | ZAPI only, requires console access and cluster admin permissions | ||
| na_ontap_debug | Yes | Yes | 21.1.0 | 9.6 | This module check for common error and connection issues |
| na_ontap_disk_options | No | Yes | 21.4.0 | 9.6 | |
| na_ontap_disks | Yes | Yes | 21.7.0 | 9.6 | |
| na_ontap_dns | Yes | Yes | 20.1.0 | 9.6 | |
| na_ontap_domain_tunnel | No | Yes | 21.3.0 | 9.7 | |
| na_ontap_efficiency_policy | Yes | Yes | 21.18.0 | 9.8 | |
| na_ontap_ems_config | No | Yes | 22.8.0 | 9.6 | pubsub_enabled requires ONTAP 9.10.1 or later |
| na_ontap_ems_destination | No | Yes | 21.23.0 | 9.6 | |
| na_ontap_ems_filter | No | Yes | 22.3.0 | 9.6 | |
| na_ontap_export_policy | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_export_policy_rule | Yes | Yes | 21.15.0 | 9.6 | |
| na_ontap_fcp | Yes | Yes | 21.14.0 | 9.6 | |
| na_ontap_fdsd | No | Yes | 21.8.0 | 9.6 | |
| na_ontap_fdsp | No | Yes | 21.8.0 | 9.6 | |
| na_ontap_fdspt | No | Yes | 21.8.0 | 9.6 | |
| na_ontap_fdss | No | Yes | 21.8.0 | 9.6 | |
| na_ontap_file_directory_policy | Yes | No | No REST equivalent | ||
| na_ontap_file_security_permissions | No | Yes | 22.0.0 | 9.9.1 | REST only (9.10.1 for SLAG in access_control) |
| na_ontap_file_security_permissions_acl | No | Yes | 22.0.0 | 9.9.1 | REST only (9.10.1 for SLAG in access_control) |
| na_ontap_firewall_policy | Yes | No | No REST equivalent, use na_ontap_service_policy module. | ||
| na_ontap_firmware_upgrade | Yes | Yes | 21.15.0 | 9.6 | |
| na_ontap_flexcache | Yes | Yes | 21.3.0 | 9.6 | |
| na_ontap_fpolicy_event | Yes | Yes | 21.4.0 | 9.6 | |
| na_ontap_fpolicy_ext_engine | Yes | Yes | 21.4.0 | 9.6 | |
| na_ontap_fpolicy_policy | Yes | Yes | 21.3.0 | 9.6 | |
| na_ontap_fpolicy_scope | Yes | Yes | 21.4.0 | 9.6 | |
| na_ontap_fpolicy_status | Yes | Yes | 21.4.0 | 9.6 | |
| na_ontap_igroup | Yes | Yes | 21.2.0 | 9.9.1 | |
| na_ontap_igroup_initiator | Yes | Yes | 21.19.0 | 9.6 | |
| na_ontap_info | Yes | No | ZAPI only, use na_ontap_rest_info for rest | ||
| na_ontap_interface | Yes | Yes | 21.13.0 | 9.7 | Requires use_rest: always |
| na_ontap_ipspace | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_iscsi | Yes | Yes | 21.19.0 | 9.6 | |
| na_ontap_iscsi_security | No | Yes | 19.10.0 | 9.6 | |
| na_ontap_job_schedule | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_kerberos_interface | No | Yes | 22.6.0 | 9.7 | machine_account requires ONTAP 9.12.1 or later. |
| na_ontap_kerberos_realm | Yes | Yes | 21.23.0 | 9.6 | |
| na_ontap_ldap | Yes | No | ZAPI only, use na_ontap_ldap_client for REST. | ||
| na_ontap_ldap_client | Yes | Yes | 21.22.0 | 9.6 | |
| na_ontap_license | Yes | Yes | 21.15.0 | 9.6 | |
| na_ontap_local_hosts | No | Yes | 22.0.0 | 9.10.1 | This module requires ontap version 9.10.1 and REST only. |
| na_ontap_log_forward | Yes | Yes | 21.2.0 | 9.6 | |
| na_ontap_login_messages | Yes | Yes | 21.1.0 | 9.6 | |
| na_ontap_lun | Yes | Yes | 21.18.0 | 9.6 | san_application_template requires 9.7, space_allocation requires 9.10 |
| na_ontap_lun_copy | Yes | Yes | 21.23.0 | 9.10.1 | |
| na_ontap_lun_map | Yes | Yes | 21.17.0 | 9.6 | |
| na_ontap_lun_map_reporting_nodes | Yes | Yes | 21.23.0 | 9.10.1 | |
| na_ontap_mcc_mediator | No | Yes | 20.9.0 | 9.8 | |
| na_ontap_metrocluster | No | Yes | 20.9.0 | 9.8 | |
| na_ontap_metrocluster_dr_group | No | Yes | 20.11.0 | 9.8 | |
| na_ontap_motd | Yes | No | Module is deprecated. Use the na_ontap_login_messages module | ||
| na_ontap_name_mappings | No | Yes | 22.0.0 | 9.6 | new_index option support is from 9.7, this module is REST only. |
| na_ontap_name_service_switch | Yes | Yes | 21.22.0 | 9.6 | Deleting name service switch not supported in REST. |
| na_ontap_ndmp | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_net_ifgrp | Yes | Yes | 21.14.0 | 9.6 | |
| na_ontap_net_port | Yes | Yes | 21.14.0 | 9.6 | |
| na_ontap_net_routes | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_net_subnet | Yes | Yes | 21.24.0 | 9.11.1 | |
| na_ontap_net_vlan | Yes | Yes | 21.13.0 | 9.6 | |
| na_ontap_nfs | Yes | Yes | 21.17.0 | 9.6 | |
| na_ontap_node | Yes | Yes | 21.3.0 | 9.6 | |
| na_ontap_ntfs_dacl | Yes | No | Module is deprecated. | ||
| na_ontap_ntfs_sd | Yes | No | Module is deprecated. | ||
| na_ontap_ntp | Yes | Yes | 21.11.0 | 9.6 | |
| na_ontap_ntp_key | No | Yes | 21.21.0 | 9.7 | |
| na_ontap_nvme | Yes | Yes | 21.19.0 | 9.6 | |
| na_ontap_nvme_namespace | Yes | Yes | 21.20.0 | 9.6 | |
| na_ontap_nvme_subsystem | Yes | Yes | 21.20.0 | 9.6 | |
| na_ontap_object_store | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_partitions | No | Yes | 21.8.0 | 9.6 | |
| na_ontap_ports | Yes | Yes | 21.16.0 | 9.6 | Adding/removing ports in portset requires ONTAP 9.9 in REST. |
| na_ontap_portset | Yes | Yes | 21.20.0 | 9.9.1 | |
| na_ontap_publickey | No | Yes | 21.7.0 | 9.7 | |
| na_ontap_qos_adaptive_policy_group | Yes | No | Deprecated, use netapp.ontap.na_ontap_qos_policy_group. | ||
| na_ontap_qos_policy_group | Yes | Yes | 21.19.0 | 9.6 | |
| na_ontap_qtree | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_quota_policy | Yes | No | Quotas policy not supported in REST. | ||
| na_ontap_quotas | Yes | Yes | 21.24.0 | 9.6 | Quotas policy not supported in REST. Default policy is always used. |
| na_ontap_rest_cli | No | Yes | 19.10.0 | 9.6 | |
| na_ontap_rest_info | No | Yes | 20.5.0 | 9.6 | |
| na_ontap_restit | No | Yes | 20.4.0 | 9.6 | |
| na_ontap_s3_buckets | No | Yes | 21.19.0 | 9.8 | |
| na_ontap_s3_groups | No | Yes | 21.21.0 | 9.8 | |
| na_ontap_s3_policies | No | Yes | 21.21.0 | 9.8 | |
| na_ontap_s3_services | No | Yes | 21.20.0 | 9.8 | |
| na_ontap_s3_users | No | Yes | 21.20.0 | 9.8 | |
| na_ontap_security_certificates | Yes | Yes | 20.7.0 | 9.6 | |
| na_ontap_security_config | Yes | Yes | 21.3.0 | 9.6 | |
| na_ontap_security_ipsec_ca_certificate | No | Yes | 22.1.0 | 9.10.1 | |
| na_ontap_security_ipsec_config | No | Yes | 22.1.0 | 9.8 | |
| na_ontap_security_ipsec_policy | No | Yes | 22.1.0 | 9.8 | authentication_method and certificate requires 9.10.1 or later. |
| na_ontap_security_key_manager | Yes | Yes | 21.23.0 | 9.6 | supporting certificates by name requires 9.8. common_name can be used with 9.6 |
| na_ontap_security_ssh | No | Yes | 21.24.0 | 9.10.1 | This module requires ontap version 9.10.1 and REST only. |
| na_ontap_service_policy | No | Yes | 21.7.0 | 9.8 | |
| na_ontap_service_processor_network | Yes | Yes | 21.21.0 | 9.6 | disable service processor network status not supported in REST. |
| na_ontap_snaplock_clock | Yes | Yes | 21.4.0 | 9.6 | |
| na_ontap_snapmirror | Yes | Yes | 21.15.0 | 9.6 | create_destination, source_cluster, destination_cluster, require ONTAP 9.7 in REST |
| na_ontap_snapmirror_policy | Yes | Yes | 20.3.0 | 9.6 | |
| na_ontap_snapshot | Yes | Yes | 21.8.0 | 9.6 | |
| na_ontap_snapshot_policy | Yes | Yes | 21.18.0 | 9.6 | add, modify and schedule snapshot schedule requires ONTAP 9.8 in REST. |
| na_ontap_snmp | Yes | Yes | 21.9.0 | 9.6 | |
| na_ontap_snmp_traphosts | No | Yes | 20.4.0 | 9.6 | |
| na_ontap_software_update | Yes | Yes | 21.20.0 | 9.6 | Some options require 9.8 or 9.9 when using REST. |
| na_ontap_ssh_command | NA | NA | This module only uses SSH, it does not depend on REST or ZAPI. | ||
| na_ontap_storage_auto_giveback | Yes | Yes | 21.3.0 | 9.6 | |
| na_ontap_storage_failover | Yes | Yes | 21.3.0 | 9.6 | |
| na_ontap_support_config_backup | No | Yes | 22.8.0 | 9.6 | This module supports REST only |
| na_ontap_svm | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_svm_options | Yes | No | Module is deprecated for REST | ||
| na_ontap_ucadapter | Yes | Yes | 21.23.0 | 9.6 | |
| na_ontap_unix_group | Yes | Yes | 21.21.0 | 9.9 | |
| na_ontap_unix_user | Yes | Yes | 21.21.0 | 9.9 | |
| na_ontap_user | Yes | Yes | 20.6.0 | 9.6 | |
| na_ontap_user_role | Yes | Yes | 21.23.0 | 9.7 | Query requires 9.11.1 |
| na_ontap_volume | Yes | Yes | 21.14.0 | 9.6 | Requires use_rest: always |
| na_ontap_volume_autosize | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_volume_clone | Yes | Yes | 21.16.0 | 9.6 | |
| na_ontap_volume_efficiency | Yes | Yes | 21.2.0 | 9.6 | |
| na_ontap_volume_snaplock | Yes | No | na_ontap_volume supports SnapLock options for REST. | ||
| na_ontap_vscan | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_vscan_on_access_policy | Yes | Yes | 21.20.0 | 9.6 | |
| na_ontap_vscan_on_demand_task | Yes | Yes | 21.20.0 | 9.6 | |
| na_ontap_vscan_scanner_pool | Yes | Yes | 19.10.0 | 9.6 | |
| na_ontap_vserver_audit | No | Yes | 22.3.0 | 9.6 | This module supports REST only. |
| na_ontap_vserver_cifs_security | Yes | No | ZAPI only, use na_ontap_cifs_server for REST. | ||
| na_ontap_vserver_peer | Yes | Yes | 21.14.0 | 9.6 | |
| na_ontap_vserver_peer_permissions | No | Yes | 22.3.0 | 9.6 | This module supports REST only. |
| na_ontap_wait_for_condition | Yes | Yes | 21.22.0 | 9.6 | |
| na_ontap_wwpn_alias | No | Yes | 20.4.0 | 9.6 | |
| na_ontap_zapit | Yes | No | ZAPI only. See na_ontap_restit |
Need Help? Join Netapp.Io Discord Channel #ansible