ansible.builtin.na_ontap_cifs (v2.7.7) — module

NetApp ONTAP manage cifs-share

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

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

preview | supported by certified

Install Ansible via pip

Install with pip install ansible==2.7.7

Description

Create or destroy or modify(path) cifs-share on ONTAP


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Create CIFS share
      na_ontap_cifs:
        state: present
        share_name: cifsShareName
        path: /
        vserver: vserverName
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Delete CIFS share
      na_ontap_cifs:
        state: absent
        share_name: cifsShareName
        vserver: vserverName
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Modify path CIFS share
      na_ontap_cifs:
        state: present
        share_name: pb_test
        vserver: vserverName
        path: /
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"

Inputs

    
path:
    description: The file system path that is shared through this CIFS share. The path
      is the full, user visible path relative to the vserver root, and it might be crossing
      junction mount points. The path is in UTF8 and uses forward slash as directory separator
    required: false

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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified CIFS share should exist or not.
    required: false

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

vserver:
    description:
    - Vserver containing the CIFS share.
    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:
    default: auto
    description:
    - Whether to use REST or ZAPI.
    - always -- will always use the REST API if the module supports REST. A warning is
      issued if the module does not support REST. An error is issued if a module option
      is not supported in REST.
    - never -- will always use ZAPI if the module supports ZAPI.  An error may be issued
      if a REST option is not supported in ZAPI.
    - auto -- will try to use the REST API if the module supports REST and modules options
      are supported.  Reverts to ZAPI otherwise.
    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

share_name:
    description: The name of the CIFS share. The CIFS share name is a UTF-8 string with
      the following characters being illegal; control characters from 0x00 to 0x1F, both
      inclusive, 0x22 (double quotes)
    required: true

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

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

force_ontap_version:
    description:
    - Override the cluster ONTAP version when using REST.
    - The behavior is undefined if the version does not match the target cluster.
    - This is provided as a work-around when the cluster version cannot be read because
      of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.
    - This should be in the form 9.10 or 9.10.1 with each element being an integer number.
    - When C(use_rest) is set to auto, this may force a switch to ZAPI based on the version
      and platform capabilities.
    - Ignored with ZAPI.
    type: str
    version_added: 21.23.0
    version_added_collection: netapp.ontap