ansible / ansible.builtin / v2.9.26 / module / na_ontap_interface NetApp ONTAP LIF configuration | "added in version" 2.6 of ansible.builtin" Authors: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com> preview | supported by certifiedansible.builtin.na_ontap_interface (v2.9.26) — module
pip
Install with pip install ansible==2.9.26
Creating / deleting and modifying the LIF.
- name: Create interface na_ontap_interface: state: present interface_name: data2 home_port: e0d home_node: laurentn-vsim1 role: data protocols: nfs admin_status: up failover_policy: local-only firewall_policy: mgmt is_auto_revert: true address: 10.10.10.10 netmask: 255.255.255.0 force_subnet_association: false dns_domain_name: test.com listen_for_dns_query: true is_dns_update_enabled: true vserver: svm1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}"
- name: Delete interface na_ontap_interface: state: absent interface_name: data2 vserver: svm1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}"
role: description: - Specifies the role of the LIF. - When setting role as "intercluster", setting protocol is not supported. - Required when C(state=present). https: default: false description: - Enable and disable https. - Ignored when using REST as only https is supported. - Ignored when using SSL certificate authentication as it requires SSL. type: bool state: choices: - present - absent default: present description: - Whether the specified interface should exist or not. ontapi: description: - The ontap api version to use type: int address: description: - Specifies the LIF's IP address. - Required when C(state=present) netmask: description: - Specifies the LIF's netmask. - Required when C(state=present). vserver: description: - The name of the vserver to use. required: true hostname: description: - The hostname or IP address of the ONTAP instance. required: true type: str password: aliases: - pass description: - Password for the specified user. type: str use_rest: choices: - Never - Always - Auto default: Auto description: - REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. - Always -- will always use the REST API - Never -- will always use the ZAPI - Auto -- will try to use the REST Api type: str username: aliases: - user description: - 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 U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/). - Two authentication methods are supported - 1. basic authentication, using username and password, - 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. - To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. type: str home_node: description: - Specifies the LIF's home node. - By default, the first node from the cluster is considered as home node home_port: description: - Specifies the LIF's home port. - Required when C(state=present) http_port: description: - Override the default port (80 or 443) with this port type: int protocols: description: - Specifies the list of data protocols configured on the LIF. By default, the values in this element are nfs, cifs and fcache. - Other supported protocols are iscsi and fcp. A LIF can be configured to not support any data protocols by specifying 'none'. - Protocol values of none, iscsi, fc-nvme or fcp can't be combined with any other data protocol(s). - address, netmask and firewall_policy parameters are not supported for 'fc-nvme' option. subnet_name: description: - Subnet where the interface address is allocated from. If the option is not used, the IP address will need to be provided by the administrator during configuration. version_added: '2.8' version_added_collection: ansible.builtin admin_status: choices: - up - down description: - Specifies the administrative status of the LIF. key_filepath: description: - path to SSL client key file. type: str version_added: 20.6.0 version_added_collection: netapp.ontap cert_filepath: description: - path to SSL client cert file (.pem). - not supported with python 2.6. type: str version_added: 20.6.0 version_added_collection: netapp.ontap feature_flags: description: - 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. type: dict version_added: 20.5.0 version_added_collection: netapp.ontap interface_name: description: - Specifies the logical interface (LIF) name. required: true is_auto_revert: description: If true, data LIF will revert to its home node under certain circumstances such as startup, and load balancing migration capability is disabled automatically type: bool validate_certs: default: true description: - If set to C(no), the SSL certificates will not be validated. - This should only set to C(False) used on personally controlled sites using self-signed certificates. type: bool dns_domain_name: description: - Specifies the unique, fully qualified domain name of the DNS zone of this LIF. type: str version_added: '2.9' version_added_collection: ansible.builtin failover_policy: choices: - disabled - system-defined - local-only - sfo-partner-only - broadcast-domain-wide description: - Specifies the failover policy for the LIF. firewall_policy: description: - Specifies the firewall policy for the LIF. listen_for_dns_query: description: - If True, this IP address will listen for DNS queries for the dnszone specified. type: bool version_added: '2.9' version_added_collection: ansible.builtin is_dns_update_enabled: description: - Specifies if DNS update is enabled for this LIF. Dynamic updates will be sent for this LIF if updates are enabled at Vserver level. type: bool version_added: '2.9' version_added_collection: ansible.builtin force_subnet_association: description: Set this to true to acquire the address from the named subnet and assign the subnet to the LIF. type: bool version_added: '2.9' version_added_collection: ansible.builtin