Documentation

na_ontap_nfs - NetApp ONTAP NFS status

New in version 2.6.

Synopsis

  • Enable or disable NFS on ONTAP

Requirements

The below requirements are needed on the host that executes this module.

  • A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 9.3
  • Ansible 2.6
  • netapp-lib (2017.10.30). 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
required
The hostname or IP address of the ONTAP instance.
http_port
int
Override the default port (80 or 443) with this port
https
bool
    Choices:
  • no ←
  • yes
Enable and disable https
nfsv3
    Choices:
  • enabled
  • disabled
status of NFSv3.
nfsv3_fsid_change
(added in 2.7)
    Choices:
  • enabled
  • disabled
status of if NFSv3 clients see change in FSID as they traverse filesystems.
nfsv4
    Choices:
  • enabled
  • disabled
status of NFSv4.
nfsv40_acl
(added in 2.7)
    Choices:
  • enabled
  • disabled
status of NFS v4.0 ACL feature
nfsv40_read_delegation
(added in 2.7)
    Choices:
  • enabled
  • disabled
status for NFS v4.0 read delegation feature.
nfsv40_write_delegation
(added in 2.7)
    Choices:
  • enabled
  • disabled
status for NFS v4.0 write delegation feature.
nfsv41
    Choices:
  • enabled
  • disabled
status of NFSv41.

aliases: nfsv4.1
nfsv41_acl
(added in 2.7)
    Choices:
  • enabled
  • disabled
status of NFS v4.1 ACL feature
nfsv41_read_delegation
(added in 2.7)
    Choices:
  • enabled
  • disabled
status for NFS v4.1 read delegation feature.
nfsv41_write_delegation
(added in 2.7)
    Choices:
  • enabled
  • disabled
status for NFS v4.1 write delegation feature.
nfsv4_id_domain
Name of the nfsv4_id_domain to use.
password
required
Password for the specified user.

aliases: pass
service_state
    Choices:
  • started
  • stopped
Whether the specified NFS should be enabled or disabled. Creates NFS service if doesnt exist.
showmount
(added in 2.7)
    Choices:
  • enabled
  • disabled
Whether SVM allows showmount
state
    Choices:
  • present ←
  • absent
Whether NFS should exist or not.
tcp
    Choices:
  • enabled
  • disabled
Enable TCP (support from ONTAP 9.3 onward).
udp
    Choices:
  • enabled
  • disabled
Enable UDP (support from ONTAP 9.3 onward).
username
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
bool
    Choices:
  • no
  • yes ←
If set to False, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
vserver
required
Name of the vserver to use.
vstorage_state
    Choices:
  • enabled
  • disabled
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 }}"

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.