netapp.ontap.na_ontap_unix_group – NetApp ONTAP UNIX Group

Note

This plugin is part of the netapp.ontap collection (version 20.11.0).

To install it use: ansible-galaxy collection install netapp.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_unix_group.

New in version 2.8.0: of netapp.ontap

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.

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

Parameters

Parameter Choices/Defaults Comments
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
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.
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.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
id
integer
Specifies an identification number for the UNIX group.
Group ID is unique for each UNIX group.
Required for create, modifiable.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
name
string / required
Specifies UNIX group's name, unique for each group.
Non-modifiable.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
skip_name_validation
boolean
    Choices:
  • no
  • yes
Specifies if group name validation is skipped.
state
string
    Choices:
  • present ←
  • absent
Whether the specified group should exist or not.
use_rest
string
Default:
"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
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/.
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.

aliases: user
users
list / elements=string
added in 2.9.0 of netapp.ontap
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
string / 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 }}"

Authors