netapp.ontap.na_ontap_nfs – NetApp ONTAP NFS status
Note
This plugin is part of the netapp.ontap collection (version 21.12.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netapp.ontap.
To use it in a playbook, specify: netapp.ontap.na_ontap_nfs.
New in version 2.6.0: of netapp.ontap
Synopsis
- Enable or disable NFS on ONTAP
 
Requirements
The below requirements are needed on the host that executes this module.
- Ansible 2.9
 - Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
 - netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
 - A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
 - REST support requires ONTAP 9.6 or later.
 - 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 | 
|---|---|---|
|   cert_filepath    string    added in 20.6.0 of netapp.ontap    |    path to SSL client cert file (.pem).  not supported with python 2.6.   |  |
|   feature_flags    dictionary    added in 20.5.0 of netapp.ontap    |    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.   |  |
|   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.  Ignored when using REST as only https is supported.  Ignored when using SSL certificate authentication as it requires SSL.   |  
|   key_filepath    string    added in 20.6.0 of netapp.ontap    |    path to SSL client key file.   |  |
|   nfsv3    string    |   
  |    status of NFSv3.   |  
|   nfsv3_fsid_change    string    added in 2.7.0 of netapp.ontap    |   
  |    status of if NFSv3 clients see change in FSID as they traverse filesystems.   |  
|   nfsv4    string    |   
  |    status of NFSv4.   |  
|   nfsv40_acl    string    added in 2.7.0 of netapp.ontap    |   
  |    status of NFS v4.0 ACL feature   |  
|   nfsv40_read_delegation    string    added in 2.7.0 of netapp.ontap    |   
  |    status for NFS v4.0 read delegation feature.   |  
|   nfsv40_referrals    string    added in 2.9.0 of netapp.ontap    |   
  |    status for NFS v4.0 referrals.   |  
|   nfsv40_write_delegation    string    added in 2.7.0 of netapp.ontap    |   
  |    status for NFS v4.0 write delegation feature.   |  
|   nfsv41    string    |   
  |    status of NFSv41.  aliases: nfsv4.1  |  
|   nfsv41_acl    string    added in 2.7.0 of netapp.ontap    |   
  |    status of NFS v4.1 ACL feature   |  
|   nfsv41_pnfs    string    added in 2.9.0 of netapp.ontap    |   
  |    status of NFSv41 pNFS.   |  
|   nfsv41_read_delegation    string    added in 2.7.0 of netapp.ontap    |   
  |    status for NFS v4.1 read delegation feature.   |  
|   nfsv41_referrals    string    added in 2.9.0 of netapp.ontap    |   
  |    status for NFS v4.1 referrals.   |  
|   nfsv41_write_delegation    string    added in 2.7.0 of netapp.ontap    |   
  |    status for NFS v4.1 write delegation feature.   |  
|   nfsv4_fsid_change    string    added in 2.9.0 of netapp.ontap    |   
  |    status of if NFSv4 clients see change in FSID as they traverse filesystems.   |  
|   nfsv4_id_domain    string    |    Name of the nfsv4_id_domain to use.   |  |
|   nfsv4_numeric_ids    string    added in 2.9.0 of netapp.ontap    |   
  |    status of NFSv4 numeric ID's.   |  
|   ontapi    integer    |    The ontap api version to use   |  |
|   password    string    |    Password for the specified user.  aliases: pass  |  |
|   service_state    string    |   
  |    Whether the specified NFS should be enabled or disabled. Creates NFS service if doesnt exist.   |  
|   showmount    string    added in 2.7.0 of netapp.ontap    |   
  |    Whether SVM allows showmount   |  
|   state    string    |   
  |    Whether NFS should exist or not.   |  
|   tcp    string    |   
  |    Enable TCP (support from ONTAP 9.3 onward).   |  
|   tcp_max_xfer_size    integer    added in 2.8.0 of netapp.ontap    |    TCP Maximum Transfer Size (bytes). The default value is 65536.   |  |
|   udp    string    |   
  |    Enable UDP (support from ONTAP 9.3 onward).   |  
|   use_rest    string    |   Default: "auto"   |    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    |    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/.  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.  aliases: user  |  |
|   validate_certs    boolean    |   
  |    If set to   no, the SSL certificates will not be validated.This should only set to   False used on personally controlled sites using self-signed certificates. |  
|   vserver    string / required    |    Name of the vserver to use.   |  |
|   vstorage_state    string    |   
  |    status of vstorage_state.   |  
Notes
Note
- The modules prefixed with na_ontap are built to support the ONTAP storage platform.
 
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 }}"
  Authors
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
 
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_nfs_module.html