ansible.builtin.na_ontap_nfs (v2.9.26) — module

NetApp ONTAP NFS status

| "added in version" 2.6 of ansible.builtin"

Authors: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>

preview | supported by certified

Install Ansible via pip

Install with pip install ansible==2.9.26

Description

Enable or disable NFS on ONTAP


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - 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 }}"

Inputs

    
tcp:
    choices:
    - enabled
    - disabled
    description:
    - Enable TCP (support from ONTAP 9.3 onward).

udp:
    choices:
    - enabled
    - disabled
    description:
    - Enable UDP (support from ONTAP 9.3 onward).

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

nfsv3:
    choices:
    - enabled
    - disabled
    description:
    - status of NFSv3.

nfsv4:
    choices:
    - enabled
    - disabled
    description:
    - status of NFSv4.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether NFS should exist or not.

nfsv41:
    aliases:
    - nfsv4.1
    choices:
    - enabled
    - disabled
    description:
    - status of NFSv41.

ontapi:
    description:
    - The ontap api version to use
    type: int

vserver:
    description:
    - 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

http_port:
    description:
    - Override the default port (80 or 443) with this port
    type: int

showmount:
    choices:
    - enabled
    - disabled
    description:
    - Whether SVM allows showmount
    version_added: '2.7'
    version_added_collection: ansible.builtin

nfsv40_acl:
    choices:
    - enabled
    - disabled
    description:
    - status of NFS v4.0 ACL feature
    version_added: '2.7'
    version_added_collection: ansible.builtin

nfsv41_acl:
    choices:
    - enabled
    - disabled
    description:
    - status of NFS v4.1 ACL feature
    version_added: '2.7'
    version_added_collection: ansible.builtin

nfsv41_pnfs:
    choices:
    - enabled
    - disabled
    description:
    - status of NFSv41 pNFS.
    version_added: '2.9'
    version_added_collection: ansible.builtin

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

service_state:
    choices:
    - started
    - stopped
    description:
    - Whether the specified NFS should be enabled or disabled. Creates NFS service if
      does not exist.

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

vstorage_state:
    choices:
    - enabled
    - disabled
    description:
    - status of vstorage_state.

nfsv4_id_domain:
    description:
    - Name of the nfsv4_id_domain to use.

nfsv40_referrals:
    choices:
    - enabled
    - disabled
    description:
    - status for NFS v4.0 referrals.
    version_added: '2.9'
    version_added_collection: ansible.builtin

nfsv41_referrals:
    choices:
    - enabled
    - disabled
    description:
    - status for NFS v4.1 referrals.
    version_added: '2.9'
    version_added_collection: ansible.builtin

nfsv3_fsid_change:
    choices:
    - enabled
    - disabled
    description:
    - status of if NFSv3 clients see change in FSID as they traverse filesystems.
    version_added: '2.7'
    version_added_collection: ansible.builtin

nfsv4_fsid_change:
    choices:
    - enabled
    - disabled
    description:
    - status of if NFSv4 clients see change in FSID as they traverse filesystems.
    version_added: '2.9'
    version_added_collection: ansible.builtin

nfsv4_numeric_ids:
    choices:
    - enabled
    - disabled
    description:
    - status of NFSv4 numeric ID's.
    version_added: '2.9'
    version_added_collection: ansible.builtin

tcp_max_xfer_size:
    description:
    - TCP Maximum Transfer Size (bytes). The default value is 65536.
    type: int
    version_added: '2.8'
    version_added_collection: ansible.builtin

nfsv40_read_delegation:
    choices:
    - enabled
    - disabled
    description:
    - status for NFS v4.0 read delegation feature.
    version_added: '2.7'
    version_added_collection: ansible.builtin

nfsv41_read_delegation:
    choices:
    - enabled
    - disabled
    description:
    - status for NFS v4.1 read delegation feature.
    version_added: '2.7'
    version_added_collection: ansible.builtin

nfsv40_write_delegation:
    choices:
    - enabled
    - disabled
    description:
    - status for NFS v4.0 write delegation feature.
    version_added: '2.7'
    version_added_collection: ansible.builtin

nfsv41_write_delegation:
    choices:
    - enabled
    - disabled
    description:
    - status for NFS v4.1 write delegation feature.
    version_added: '2.7'
    version_added_collection: ansible.builtin