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

Install Ansible via pip

Install with pip install ansible==2.9.26

Description

Create/Delete Unix user group

Requirements

• A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
• REST support requires ONTAP 9.6 or later.
• Ansible 2.6
• Ansible 2.9 or later is strongly recommended as it enables the new collection delivery system.
• Python2 netapp-lib (2017.10.30) or later. Install using 'pip install netapp-lib'
• Python3 netapp-lib (2018.11.13) or later. Install using 'pip install netapp-lib'
• netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
• To enable http on the cluster you must run the following commands 'set -privilege advanced;' 'system services web modify -http-enabled true;'

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - name: Create UNIX group
      na_ontap_unix_group:
        state: present
        name: SampleGroup
        vserver: ansibleVServer
        id: 2
        users: user1,user2
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - name: Delete all users in UNIX group
      na_ontap_unix_group:
        state: present
        name: SampleGroup
        vserver: ansibleVServer
        users: ''
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - name: Delete UNIX group
      na_ontap_unix_group:
        state: absent
        name: SampleGroup
        vserver: ansibleVServer
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"

Inputs

    
id:
    description:
    - Specifies an identification number for the UNIX group.
    - Group ID is unique for each UNIX group.
    - Required for create, modifiable.

name:
    description:
    - Specifies UNIX group's name, unique for each group.
    - Non-modifiable.
    required: true

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 group should exist or not.

users:
    description:
    - Specifies the users associated with this group. Should be comma separated.
    - It represents the expected state of a list of users at any time.
    - Add a user into group if it is specified in expected state but not in current state.
    - Delete a user from group if it is specified in current state but not in expected
      state.
    - To delete all current users, use '' as value.
    type: list
    version_added: '2.9'
    version_added_collection: ansible.builtin

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

vserver:
    description:
    - Specifies the Vserver for the UNIX group.
    - Non-modifiable.
    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

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

skip_name_validation:
    description:
    - Specifies if group name validation is skipped.
    type: bool