Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
# (c) 2021, NetApp, Inc
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'certified'}
DOCUMENTATION = """
module: na_ontap_cifs_local_group_member
short_description: NetApp Ontap - Add or remove CIFS local group member
extends_documentation_fragment:
- netapp.ontap.netapp.na_ontap
version_added: '21.2.0'
author: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
description:
- Add or remove CIFS local group member
options:
state:
description:
- Whether the specified member should be part of the CIFS local group
choices: ['present', 'absent']
default: present
type: str
vserver:
description:
- Specifies the vserver that owns the CIFS local group
required: true
type: str
group:
description:
- Specifies name of the CIFS local group
required: true
type: str
member:
description:
- Specifies the name of the member
required: true
type: str
"""
EXAMPLES = """
- name: Add member to CIFS local group
na_ontap_cifs_local_group_member:
state: present
vserver: svm1
group: BUILTIN\\administrators
member: DOMAIN\\Domain Admins
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
ontapi: "{{ ontap_facts.ontap_version }}"
https: true
validate_certs: false
- name: Remove member from CIFS local group
na_ontap_cifs_local_group_member:
state: absent
vserver: svm1
group: BUILTIN\\administrators
member: DOMAIN\\Domain Admins
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
ontapi: "{{ ontap_facts.ontap_version }}"
https: true
validate_certs: false
"""
RETURN = """
"""
import traceback
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_native
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
class NetAppOntapCifsLocalGroupMember(object):
"""
Add or remove CIFS local group members
"""
def __init__(self):
"""
Initialize the Ontap CifsLocalGroupMember class
"""
self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
self.argument_spec.update(dict(
state=dict(required=False, choices=['present', 'absent'], default='present'),
vserver=dict(required=True, type='str'),
group=dict(required=True, type='str'),
member=dict(required=True, type='str')
))
self.module = AnsibleModule(
argument_spec=self.argument_spec,
supports_check_mode=True
)
# set up variables
self.na_helper = NetAppModule()
self.parameters = self.na_helper.set_parameters(self.module.params)
self.rest_api = OntapRestAPI(self.module)
self.use_rest = self.rest_api.is_rest()
if not self.use_rest:
if HAS_NETAPP_LIB is False:
self.module.fail_json(msg="the python NetApp-Lib module is required")
else:
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.parameters['vserver'])
def get_cifs_local_group_member(self):
return_value = None
if self.use_rest:
api = "private/cli/vserver/cifs/users-and-groups/local-group/members"
query = {
'group-name': self.parameters['group'],
'fields': 'member',
'vserver': self.parameters['vserver'],
'member': self.parameters['member']
}
message, error = self.rest_api.get(api, query)
if error:
self.module.fail_json(msg=error)
if len(message.keys()) == 0:
return None
elif 'records' in message and len(message['records']) == 0:
return None
elif 'records' not in message:
error = "Unexpected response in get_cifs_local_group_member from %s: %s" % (api, repr(message))
self.module.fail_json(msg=error)
return_value = {
'group': message['records'][0]['group_name'],
'member': message['records'][0]['member'],
'vserver': message['records'][0]['vserver']
}
return return_value
else:
group_members_get_iter = netapp_utils.zapi.NaElement('cifs-local-group-members-get-iter')
group_members_info = netapp_utils.zapi.NaElement('cifs-local-group-members')
group_members_info.add_new_child('group-name', self.parameters['group'])
group_members_info.add_new_child('vserver', self.parameters['vserver'])
group_members_info.add_new_child('member', self.parameters['member'])
query = netapp_utils.zapi.NaElement('query')
query.add_child_elem(group_members_info)
group_members_get_iter.add_child_elem(query)
try:
result = self.server.invoke_successfully(group_members_get_iter, True)
if result.get_child_by_name('attributes-list'):
group_member_policy_attributes = result['attributes-list']['cifs-local-group-members']
return_value = {
'group': group_member_policy_attributes['group-name'],
'member': group_member_policy_attributes['member'],
'vserver': group_member_policy_attributes['vserver']
}
except netapp_utils.zapi.NaApiError as error:
self.module.fail_json(
msg='Error getting CIFS local group members for group %s on vserver %s: %s' %
(self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
)
return return_value
def add_cifs_local_group_member(self):
"""
Adds a member to a CIFS local group
"""
if self.use_rest:
api = "private/cli/vserver/cifs/users-and-groups/local-group/add-members"
body = {
"vserver": self.parameters['vserver'],
"group-name": self.parameters['group'],
"member-names": [self.parameters['member']]
}
dummy, error = self.rest_api.post(api, body)
if error:
self.module.fail_json(msg=error)
else:
group_members_obj = netapp_utils.zapi.NaElement("cifs-local-group-members-add-members")
group_members_obj.add_new_child("group-name", self.parameters['group'])
member_names = netapp_utils.zapi.NaElement("member-names")
member_names.add_new_child('cifs-name', self.parameters['member'])
group_members_obj.add_child_elem(member_names)
try:
self.server.invoke_successfully(group_members_obj, True)
except netapp_utils.zapi.NaApiError as error:
self.module.fail_json(
msg='Error adding member %s to cifs local group %s on vserver %s: %s' %
(self.parameters['member'], self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
)
def remove_cifs_local_group_member(self):
"""
Removes a member from a CIFS local group
"""
if self.use_rest:
api = "private/cli/vserver/cifs/users-and-groups/local-group/remove-members"
body = {
"vserver": self.parameters['vserver'],
"group-name": self.parameters['group'],
"member-names": [self.parameters['member']]
}
dummy, error = self.rest_api.post(api, body)
if error:
self.module.fail_json(msg=error)
else:
group_members_obj = netapp_utils.zapi.NaElement("cifs-local-group-members-remove-members")
group_members_obj.add_new_child("group-name", self.parameters['group'])
member_names = netapp_utils.zapi.NaElement("member-names")
member_names.add_new_child('cifs-name', self.parameters['member'])
group_members_obj.add_child_elem(member_names)
try:
self.server.invoke_successfully(group_members_obj, True)
except netapp_utils.zapi.NaApiError as error:
self.module.fail_json(
msg='Error removing member %s from cifs local group %s on vserver %s: %s' %
(self.parameters['member'], self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
)
def apply(self):
if not self.use_rest:
netapp_utils.ems_log_event("na_ontap_cifs_local_group_member", self.server)
current = self.get_cifs_local_group_member()
cd_action = self.na_helper.get_cd_action(current, self.parameters)
if self.na_helper.changed:
if not self.module.check_mode:
if cd_action == 'create':
self.add_cifs_local_group_member()
elif cd_action == 'delete':
self.remove_cifs_local_group_member()
self.module.exit_json(changed=self.na_helper.changed)
def main():
"""
Creates the NetApp Ontap Cifs Local Group Member object and runs the correct play task
"""
obj = NetAppOntapCifsLocalGroupMember()
obj.apply()
if __name__ == '__main__':
main()