na_ontap_nfs – NetApp ONTAP NFS status¶
New in version 2.6.
Requirements¶
The below requirements are needed on the host that executes this module.
- A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
- Ansible 2.6
- Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
- Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
- To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Parameters¶
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| hostname 
                    string
                                             / required                     | The hostname or IP address of the ONTAP instance. | |
| http_port 
                    integer
                                                                 | Override the default port (80 or 443) with this port | |
| https 
                    boolean
                                                                 | 
 | Enable and disable https | 
| nfsv3 
                    -
                                                                 | 
 | status of NFSv3. | 
| nfsv3_fsid_change 
                    -
                                                                 added in 2.7 | 
 | status of if NFSv3 clients see change in FSID as they traverse filesystems. | 
| nfsv4 
                    -
                                                                 | 
 | status of NFSv4. | 
| nfsv40_acl 
                    -
                                                                 added in 2.7 | 
 | status of NFS v4.0 ACL feature | 
| nfsv40_read_delegation 
                    -
                                                                 added in 2.7 | 
 | status for NFS v4.0 read delegation feature. | 
| nfsv40_referrals 
                    -
                                                                 added in 2.9 | 
 | status for NFS v4.0 referrals. | 
| nfsv40_write_delegation 
                    -
                                                                 added in 2.7 | 
 | status for NFS v4.0 write delegation feature. | 
| nfsv41 
                    -
                                                                 | 
 | status of NFSv41. aliases: nfsv4.1 | 
| nfsv41_acl 
                    -
                                                                 added in 2.7 | 
 | status of NFS v4.1 ACL feature | 
| nfsv41_pnfs 
                    -
                                                                 added in 2.9 | 
 | status of NFSv41 pNFS. | 
| nfsv41_read_delegation 
                    -
                                                                 added in 2.7 | 
 | status for NFS v4.1 read delegation feature. | 
| nfsv41_referrals 
                    -
                                                                 added in 2.9 | 
 | status for NFS v4.1 referrals. | 
| nfsv41_write_delegation 
                    -
                                                                 added in 2.7 | 
 | status for NFS v4.1 write delegation feature. | 
| nfsv4_fsid_change 
                    -
                                                                 added in 2.9 | 
 | status of if NFSv4 clients see change in FSID as they traverse filesystems. | 
| nfsv4_id_domain 
                    -
                                                                 | Name of the nfsv4_id_domain to use. | |
| nfsv4_numeric_ids 
                    -
                                                                 added in 2.9 | 
 | status of NFSv4 numeric ID's. | 
| ontapi 
                    integer
                                                                 | The ontap api version to use | |
| password 
                    string
                                             / required                     | Password for the specified user. aliases: pass | |
| service_state 
                    -
                                                                 | 
 | Whether the specified NFS should be enabled or disabled. Creates NFS service if does not exist. | 
| showmount 
                    -
                                                                 added in 2.7 | 
 | Whether SVM allows showmount | 
| state 
                    -
                                                                 | 
 | Whether NFS should exist or not. | 
| tcp 
                    -
                                                                 | 
 | Enable TCP (support from ONTAP 9.3 onward). | 
| tcp_max_xfer_size 
                    integer
                                                                 added in 2.8 | TCP Maximum Transfer Size (bytes). The default value is 65536. | |
| udp 
                    -
                                                                 | 
 | Enable UDP (support from ONTAP 9.3 onward). | 
| use_rest 
                    string
                                                                 | 
 | 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 | 
| username 
                    string
                                             / required                     | 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://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. aliases: user | |
| validate_certs 
                    boolean
                                                                 | 
 | If set to  no, the SSL certificates will not be validated.This should only set to  Falseused on personally controlled sites using self-signed certificates. | 
| vserver 
                    -
                                             / required                     | Name of the vserver to use. | |
| vstorage_state 
                    -
                                                                 | 
 | status of vstorage_state. | 
Examples¶
- name: change nfs status
  na_ontap_nfs:
    state: present
    service_state: stopped
    vserver: vs_hack
    nfsv3: disabled
    nfsv4: disabled
    nfsv41: enabled
    tcp: disabled
    udp: disabled
    vstorage_state: disabled
    nfsv4_id_domain: example.com
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors¶
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
