Documentation

na_ontap_export_policy_rule - NetApp ONTAP manage export policy rules

New in version 2.6.

Synopsis

  • Create or delete or modify export rules in 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
allow_suid
bool
    Choices:
  • no
  • yes
If 'true', NFS server will honor SetUID bits in SETATTR operation. Default value on creation is 'true'
client_match
List of Client Match Hostnames, IP Addresses, Netgroups, or Domains
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
password
required
Password for the specified user.

aliases: pass
policy_name
required
The name of the export rule to manage.
protocol
    Choices:
  • any ←
  • nfs
  • nfs3
  • nfs4
  • cifs
  • flexcache
Client access protocol. Default value is 'any'
ro_rule
    Choices:
  • any
  • none
  • never
  • krb5
  • krb5i
  • krb5p
  • ntlm
  • sys
Read only access specifications for the rule
rule_index
rule index of the export policy for delete and modify
rw_rule
    Choices:
  • any
  • none
  • never
  • krb5
  • krb5i
  • krb5p
  • ntlm
  • sys
Read Write access specifications for the rule
state
    Choices:
  • present ←
  • absent
Whether the specified export policy rule should exist or not.
super_user_security
    Choices:
  • any
  • none
  • never
  • krb5
  • krb5i
  • krb5p
  • ntlm
  • sys
Read Write access specifications for the rule
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.

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: Create ExportPolicyRule
  na_ontap_export_policy_rule:
    state: present
    policy_name: default123
    vserver: ci_dev
    client_match: 0.0.0.0/0
    ro_rule: any
    rw_rule: any
    protocol: any
    super_user_security: any
    allow_suid: true
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete ExportPolicyRule
  na_ontap_export_policy_rule:
    state: absent
    policy_name: default123
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify ExportPolicyRule
  na_ontap_export_policy_rule:
    state: present
    policy_name: default123
    client_match: 0.0.0.0/0
    ro_rule: any
    rw_rule: any
    super_user_security: none
    protocol: any
    allow_suid: false
    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.