Docs4dev
Docs
ansible / 2.6 / modules / na_ontap_nfs_module.html

na_ontap_nfs - Manage 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.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled https
nfsv3
    Choices:
  • enabled
  • disabled
status of nfsv3.
nfsv4
    Choices:
  • enabled
  • disabled
status of nfsv4.
nfsv41
    Choices:
  • enabled
  • disabled
status of nfsv41.

aliases: nfsv4.1
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.
state
    Choices:
  • present ←
  • absent
Whether nfs should exist or not.
tcp
    Choices:
  • enabled
  • disabled
Enable TCP.
udp
    Choices:
  • enabled
  • disabled
Enable UDP.
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://goo.gl/BRu78Z.

aliases: user
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 community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

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

Author

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/na_ontap_nfs_module.html