Repository URL to install this package:
|
Version:
6.0.0 ▾
|
| .. |
| changelogs |
| meta |
| playbooks |
| plugins |
| roles |
| CHANGELOG.rst |
| COPYING |
| FILES.json |
| MANIFEST.json |
| README.md |
| requirements.txt |
=============================================================
netapp.ontap
NetApp ONTAP Collection
Copyright (c) 2022 NetApp, Inc. All rights reserved. Specifications subject to change without notice.
=============================================================
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
https://docs.ansible.com/ansible/devel/collections/netapp/ontap/
Join our Slack Channel at Netapp.io
vserver when using REST if role is one of 'cluster', 'node-mgmt', 'intercluster', 'cluster-mgmt'.status_admin when creating nvme service in ZAPI.status_admin option is ignored if set to False when creating nvme service in REST.use_rest is set to auto.force for create, delete and from_name, force for rename when using REST.adaptive_qos_options for configuring adaptive policy.fixed_qos_options for configuring max/min throughput policy.owning_resource for REST info that requires an owning resource. For instance volume for a snapshotunix_symlink option in REST.symlink_properties option silently ignored for cifs share creation when using REST.tcp_max_xfer_size is not supported in earlier ONTAP versions.Extra input error with ZAPI for is-nfsv4-enabled.disk_limit and soft_disk_limit.use_python_keys is set to True so that YAML parsing works correctly.time_out value when creating/modifying/deleting volumes with REST rathar than hardcoded value.force_resize, force_remove and force_remove_fenced in ZAPI.force_remove option silently ignored in REST.absent and fix KeyError on comment.ntfs_unix_security for NTFS export UNIX security options added.max_files to increase the inode count value.disk_count is less than current disk count.partner_address not working in REST.job-schedule-cluster.start_state always being set to stopped when creating an ISCSI.oplocks not being changed during a modify in ZAPI.oplocks not warning user about not being supported in REST.dest_hostname or peer_options not present.local_name_for_peer and local_name_for_source options silently ignored in REST.use_rest: always.type for user-group-type.use_rest: always is ignored.force or workgroup are used with REST.source_intercluster_lifs and dest_intercluster_lifs are not present in creating cluster.use_python_keys.disk_class option for REST and ZAPI.disk_type values for ZAPI.logical_space_enforcement to specifies whether to perform logical space accounting on the volume.logical_space_reporting to specifies whether to report space logically on the volume.tiering_minimum_cooling_days to specify how many days must pass before inactive data in a volume using the Auto or Snapshot-Only policy is considered cold and eligible for tiering.force_remove_initiator option was ignored when removing initiators from existing igroup.intermediate_certificates option was ignored.aggregate_name and aggr_list_multiplier are not set in rest.from_ipspace added.stopped and running added.is_online if two vserver volume had the same name.ports has identical values.fields to clarify the list of fields that are return by default.efficiency_policy module will fail as efficiency_policy is not supported in ONTAP 9.6.encryption to enable encryption with ZAPI.from_lag_ports, broadcast_domain and ipspace added.wait_for_completion to support asynchronous operations and wait for job completion.storage_efficiency_mode for AFF only with 9.10.1 or later.name error with REST.description or full_name with REST.netapp_{hostname|username|password} or hostname, username and password variables.force option when deleting a node.owner and change_password.broadcast_domain, ipspace and enabled when using REST.single_node_cluster was silently ignored with REST.expiry_time required REST api, will return error if set when using ZAPI.snapmirror_label is supported with REST on ONTAP 9.7 or higher, report error if used on ONTAP 9.6.source_path and source_hostname parameters are not mandatory to delete snapmirror relationship when source cluster is unknown, if specified it will delete snapmirror at destination and release the same at source side. if not, it only deletes the snapmirror at destination and will not look for source to perform snapmirror release.none as a choice for service which is supported from 9.8 ONTAP onwards.max_volumes.allowed protocols with REST for ONTAP 9.6 and later.from_name to rename an interface.validate_after_download to run ONTAP software update validation checks.services to allow and/or enable protocol services when using REST.ignore_rest_unsupported_options to ignore older ZAPI options not available in REST.absent as a choice for state as it has no use.aggr_list: '*' when using REST.force option is supported when state is absent to ignore communication errors.gather_subset has been changed to demo which returns cluster/software, svm/svms, cluster/nodes. To return all Info must specifically list all in your playbook. Do note all is a very resource-intensive action and it is highly recommended to call just the info/APIs you need.month_offset to explictly select 0 or 1 for January.port, certificate_validation_enabled, ssl_enabled for target server.use_python_keys to replace svm/svms with svm_svms to simplify post processing.na_ontap_info that has REST equivalents have been implemented. Note that the returned structure for REST and the variable names in the structure is different from the ZAPI based na_ontap_info. Some default variables in ZAPI are no longer returned by default in REST and will need to be specified using the field optionsystem_node_info, net_interface_info, net_port_info, security_login_account_info, vserver_peer_info, cluster_image_info, cluster_log_forwarding_info, metrocluster_info, metrocluster_node_info, net_dns_info, net_interface_service_policy_info, vserver_nfs_info, clock_info, igroup_info, vscan_status_info, vscan_connection_status_all_info, storage_bridge_info, nvme_info, nvme_interface_info, nvme_subsystem_info, cluster_switch_info, export_policy_info, kerberos_realm_info,sis_info, sis_policy_info, snapmirror_info, snapmirror_destination_info, snapmirror_policy_info, sys_cluster_alerts, cifs_vserver_security_info13001:success ZAPI error. Add debug data.peer_options to use different credentials on peer.up_admin to set administrative state.expiry_time.peer_options to use different credentials on peer.anonymous_user_id type to str to accept user name and user id. (A warning is now triggered when a number is not quoted.)parent_vserver can not be given with junction_path, uid, or gidautonegotiate_admin and mtu.parameters option.nfsv3, nfsv4, nfsv41 options.comment to associate a description to a CIFS share.min_spares.exclude_aggregates for SAN application.exclude_aggregates for NAS application.application_dicts to associate multiple authentication methods to an application.application_strs to disambiguate applications.replace_existing_apps_and_methods.second_authentication_method with application_dicts option.local_name_for_source and local_name_for_peer added.initiator_objects to support initiator comments (requires ONTAP 9.9).initiator_names as a replacement for initiators (still supported as an alias).total_size.proxy_url as it makes the operation not idempotent.prepopulate option when using REST (requires ONTAP 9.8).igroups to support nested igroups (requires ONTAP 9.9).tcp_port replaces port.dr_cache when creating flexcache using NAS application template (requires ONTAP 9.9).port was incorrectly used instead of tcp_port.encrypt settings were ignored.policy updated to allow for supported '-' as a valid entry.comment.qos_adaptive_policy_group.scope to explicitly force operations on the SAN application or a single LUN.source_endpoint and destination_endpoint to group endpoint suboptions.consistency_group_volumes and ipspace to endpoint options.qos_policy_group could not be modified if a value was not provided at creation.tiering options were ignored in san_application_template.use_rest: auto.time_out to wait for cluster creation, adding and removing a node.total_size and total_size_unit when using SAN application template.create_destination to automatically create destination endpoint (ONTAP 9.7).destination_cluster to automatically create destination SVM for SVM DR (ONTAP 9.7).source_cluster to automatically set SVM peering (ONTAP 9.7).state option.state option.quota_target in quotas module.changed was set to "False" rather than boolean False.aggregate_name option is used with a FlexGroup.os_type to replace ostype (but ostype is still accepted).from_name to rename a LUN.os_type to replace ostype (but ostype is still accepted), and removed default to image.qos_policy_group to assign a qos_policy_group to a LUN.san_application_template to create LUNs without explicitly creating a volume and using REST APIs.is_shared for sharing QOS SLOs or not.auto_assign to assign quota policy to vserver.activate_quota_on_change to resize or reinitialize quotas.perform_user_mapping to perform user mapping for the user specified in quota-target.cifs_home_directory_info, cluster_software_download, event_notification_info, event_notification_destination_info, security_login_info, security_login_rest_role_infoaggr_list wildcard value(*) in create\modify idempotency.compression to enable compression on a FAS volume.inline-compression to enable inline compression on a volume.nas_application_template to create a volume using nas application REST API.size_change_threshold to ignore small changes in volume size.sizing_method to resize a FlexGroup using REST.changed.service_processor but module supports service-processor.modified if a modify action is taken.force_update option to ignore current version.modified if a modify action is taken.classic_basic_authorization feature_flag to True.show-previous-versions is used.node-id as key rather than current-version.use_exact_size to create a lun with the exact given size so that the lun is not rounded up.application_info, application_template_info, autosupport_config_info , autosupport_messages_history, ontap_system_version, storage_flexcaches_info, storage_flexcaches_origin_info, storage_ports_info, storage_qos_policies, storage_qtrees_config, storage_quota_reports, storage_quota_policy_rules, storage_shelves_config, storage_snapshot_policies, support_ems_config, support_ems_events, support_ems_filterssingle_node_cluster option was ignored.tree for quota_report_info.policy_type rather than taking no action.encrypt: false is ignored when creating a volume.node_name to set the node name when adding a node, or as an alternative to cluster_ip_address to remove a node.state can be set to absent to remove a node identified with cluster_ip_address or node_name.wait_for_completion and time_out to wait for qtree deletion when using REST.soft_disk_limit and soft_file_limit for the quota target.initiator_groups_info, san_fcp_services, san_iscsi_credentials, san_iscsi_services, san_lun_maps, storage_luns_info, storage_NVMe_namespaces.check_mode is now working properly.home_node is not required in pre-cluster mode.role is not required if service_policy is present and ONTAP version is 9.8.None is not subscriptable exception on rename operation.KeyError exception on size when reporting creation error.disk_size_with_unit option.ad_domain and preferred_ad_server options.cloud_targets_info, cluster_chassis_info, cluster_jobs_info, cluster_metrics_info, cluster_schedules, broadcast_domains_info, cluster_software_history, cluster_software_packages, network_ports_info, ip_interfaces_info, ip_routes_info, ip_service_policies, network_ipspaces_info, san_fc_logins_info, san_fc_wppn-aliases, svm_dns_config_info, svm_ldap_config_info, svm_name_mapping_config_info, svm_nis_config_info, svm_peers_info, svm_peer-permissions_info.force_delete option with a DEFAULT of true so that ZAPI behavior is aligned with REST.ignore_name_if_not_supported option to not fail if name is present since name is not supported in ONTAP 9.6 and 9.7.timeout option to give enough time for the update to complete.disk-info error when using disks option.message has changed to autosupport_message as Redhat has reserved this word. message has been alias'd to autosupport_message.common_name, type) as an alternate key since name is not supported in ONTAP 9.6 and 9.7.metrocluster_check_info, env_sensors_info and volume_move_target_aggr_info.relationship_type parameter.bool type was not properly set for scan_files_with_no_ext.policy_status enable/disable option was not supported.file_ext_to_include was not handled properly.version_added. So 2.7 becomes 2.7.0. Same thing for 2.8 and 2.9.type: and elements: information where missing.required: information.continue_on_error option to continue when a ZAPI is not supported on a vserver, or for cluster RPC errors.query option to specify which objects to return.vserver tunneling to limit output to one vserver.cluster_node_info, cluster_peer_info, disk_info, cifs_services_info, cifs_share_info.vserver:id to vserver:volume:id .applications does not contain snmp when using REST API call.reboot_sp: reboot service processor before downloading package.rename_package: rename file when downloading service processor package.replace_package: replace local file when downloading service processor package.The ONTAP Ansible modules currently require a username/password combination to authenticate with ONTAPI or REST APIs.
It is now possible to use SSL certificate authentication with ONTAPI or REST.
You will first need to install a SSL certificate in ONTAP, see for instance the first part of:
https://netapp.io/2016/11/08/certificate-based-authentication-netapp-manageability-sdk-ontap/
The applications that need to be authorized for cert are ontapi and http.
The new cert_filepath, key_filepath options enable SSL certificate authentication.
This is mutually exclusive with using username and password.
ONTAP does not support cert authentication for console, so this is not supported for na_ontap_command.
SSL certificate authentication requires python2.7 or 3.x.
disk_type option allows to assign specified type of disk.fail_on_502_error is set to true.desired_attributes advanced feature to select which fields to return.use_native_zapi_tags to disable the conversion of '_' to '-' for attribute keys.fields options to request specific fields from subset.stabilize_minutes option specifies number of minutes needed to stabilize node before update.source_snapshot for specific snapshot or uses latest.pair_adapters option allows specifying the list of adapters which also need to be offline.authentication_password option specifies password for the authentication protocol of SNMPv3 user.authentication_protocol option specifies authentication protocol fo SNMPv3 user.engine_id option specifies authoritative entity's EngineID for the SNMPv3 user.privacy_password option specifies password for the privacy protocol of SNMPv3 user.privacy_protocol option specifies privacy protocol of SNMPv3 user.remote_switch_ipaddress option specifies the IP Address of the remote switch of SNMPv3 user.check_interval option checks if a volume move has been completed and then waits this number of seconds before checking again.auto_remap_luns option controls automatic mapping of LUNs during volume rehost.force_restore option forces volume to restore even if the volume has one or more newer Snapshotcopies.force_unmap_luns option controls automatic unmapping of LUNs during volume rehost.from_vserver option allows volume rehost from one vserver to another.preserve_lun_ids option controls LUNs in the volume being restored will remain mapped and their identities preserved.snapshot_restore option specifies name of snapshot to restore from.cert_filepath, key_filepath to enable SSL certificate authentication (python 2.7 or 3.x).wait_on_completion is supported with volume moves.raid_type options supports 'raid_0' for ONTAP Select.encryption_protocol_proposed option allows specifying encryption protocol to be used for inter-cluster communication.block_size option allows specifying size in bytes of a logical block.cutover_action option allows specifying the action to be taken for cutover.http_port parameter.duration type from int to str to support '-' input.metrocluster_check_info does not trigger a traceback but adds an "error" info element if the target system is not set up for metrocluster.reset option is given.force_disruptive_update and package_url options allows to make choices for download and upgrading packages.volume_security_style option now allows modify.metrocluster_check_info has been removed as it was breaking the info module for everyone who didn't have a metrocluster set up. We are working on adding this back in a future updatenetapp_version set to 140. If you are running 9.2 or below please add the variable to your playbook and set to 120disk_count option allows adding additional disk to aggregate.max_records option specifies maximum number of records returned in a single ZAPI call.summary option specifies a boolean flag to control return all or none of the info attributes.service_policy option to identify a single service or a list of services that will use a LIF.ad_server_ip option specifies IP Address of the Active Directory Domain Controller (DC).ad_server_name option specifies Host name of the Active Directory Domain Controller (DC).relationship-info-only option allows to manage relationship information.download_only options allows to download cluster image without software update.snapshot_auto_delete option allows to manage auto delete settings of a specified volume.domain if only domain-workgroup is present.kdc_vendor case sensitivity issue.cluster_identity_infostorage_bridge_inforelationship_state is active and the current state is broken-off.snapshot_infomax_records option to set maximum number of records to return per subset.relationship_state option for breaking the snapmirror relationship.update_snapmirror option for updating the snapmirror relationship.split option to split clone volume from parent volume.snaplock_type.cifs_server_info, cifs_share_info, cifs_vserver_security_info, cluster_peer_info, clock_info, export_policy_info, export_rule_info, fcp_adapter_info, fcp_alias_info, fcp_service_info, job_schedule_cron_info, kerberos_realm_info, ldap_client, ldap_config, net_failover_group_info, net_firewall_info, net_ipspaces_info, net_port_broadcast_domain_info, net_routes_info, net_vlan_info, nfs_info, ntfs_dacl_info, ntfs_sd_info, ntp_server_info, role_info, service_processor_network_info, sis_policy_info, snapmirror_policy_info, snapshot_policy_info, vscan_info, vserver_peer_infoforce_remove to forcibly remove initiators from an igroup that is currently mapped to a LUN.failover_group to specify the failover group for the LIF. is_ipv4_link_local to specify the LIF's are to acquire a ipv4 link local address.group_id and user_id.vserver option).vscan_status_info, vscan_scanner_pool_info, vscan_connection_status_all_info, vscan_connection_extended_stats_infochangelog_threshold_percent to set the percentage at which the changelog will be processed for a threshold type of policy, tested once each hour.Changes in 19.10.0 and September collection releases compared to Ansible 2.9
vserver: to allow command to run as either cluster admin or vserver admin. To run as vserver admin you must use the vserver option.message to motd_message to avoid conflict with Ansible internal variable name.size_unit to specify size in different units.prefix: option to use for creating snapshot policy.efficiency_policy was ignoredBy default, the module will use REST if the target system supports it, and the options are supported. Otherwise, it will switch back to ZAPI. This behavior can be controlled with the use_rest option:
enable and authtype are supported with RESToplocks is not supported with REST, defaults to enable.root_volume, root_volume_aggregate, root_volume_security_style are not supported with REST.