na_ontap_unix_group – NetApp ONTAP UNIX Group

New in version 2.8.

Synopsis

  • Create/Delete Unix user group

Requirements

The below requirements are needed on the host that executes this module.

  • A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward

  • Ansible 2.6

  • 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’

  • 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
string / required
The hostname or IP address of the ONTAP instance.
http_port
integer
Override the default port (80 or 443) with this port
https
boolean
    Choices:
  • no ←
  • yes
Enable and disable https
id
-
Specifies an identification number for the UNIX group.
Group ID is unique for each UNIX group.
Required for create, modifiable.
name
- / required
Specifies UNIX group's name, unique for each group.
Non-modifiable.
ontapi
integer
The ontap api version to use
password
string / required
Password for the specified user.

aliases: pass
skip_name_validation
boolean
    Choices:
  • no
  • yes
Specifies if group name validation is skipped.
state
-
    Choices:
  • present ←
  • absent
Whether the specified group should exist or not.
use_rest
string
    Choices:
  • Never
  • Always
  • Auto ←
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
username
string / 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
users
list
added in 2.9
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.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If set to no, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
vserver
- / required
Specifies the Vserver for the UNIX group.
Non-modifiable.

Notes

Note

  • The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- 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 }}"

- 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 }}"

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

Status

Authors

Hint

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