mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Update user roles to NetAppModule format (#50992)
* changes to clusteR * Revert "changes to clusteR" This reverts commit 33ee1b71e4bc8435fb315762a871f8c4cb6c5f80. * Rewrite of user roles * Rewrite of user roles * Fix author tag * update * fix author
This commit is contained in:
Chris Archibald
John R Barker
parent
8c74df5e67
commit
1da29c8ebe
2 changed files with 338 additions and 46 deletions
|
|
@ -1,6 +1,6 @@
|
|||
#!/usr/bin/python
|
||||
|
||||
# (c) 2018, NetApp, Inc
|
||||
# (c) 2018-2019, 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
|
||||
|
|
@ -49,6 +49,12 @@ options:
|
|||
choices: ['none', 'readonly', 'all']
|
||||
default: all
|
||||
|
||||
query:
|
||||
description:
|
||||
- A query for the role. The query must apply to the specified command or directory name.
|
||||
- Use double quotes "" for modifying a existing query to none.
|
||||
version_added: '2.8'
|
||||
|
||||
vserver:
|
||||
description:
|
||||
- The name of the vserver to use.
|
||||
|
|
@ -62,8 +68,21 @@ EXAMPLES = """
|
|||
na_ontap_user_role:
|
||||
state: present
|
||||
name: ansibleRole
|
||||
command_directory_name: DEFAULT
|
||||
command_directory_name: volume
|
||||
access_level: none
|
||||
query: show
|
||||
vserver: ansibleVServer
|
||||
hostname: "{{ netapp_hostname }}"
|
||||
username: "{{ netapp_username }}"
|
||||
password: "{{ netapp_password }}"
|
||||
|
||||
- name: Modify User Role
|
||||
na_ontap_user_role:
|
||||
state: present
|
||||
name: ansibleRole
|
||||
command_directory_name: volume
|
||||
access_level: none
|
||||
query: ""
|
||||
vserver: ansibleVServer
|
||||
hostname: "{{ netapp_hostname }}"
|
||||
username: "{{ netapp_username }}"
|
||||
|
|
@ -78,6 +97,7 @@ import traceback
|
|||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.netapp_module import NetAppModule
|
||||
import ansible.module_utils.netapp as netapp_utils
|
||||
|
||||
|
||||
|
|
@ -95,24 +115,20 @@ class NetAppOntapUserRole(object):
|
|||
access_level=dict(required=False, type='str', default='all',
|
||||
choices=['none', 'readonly', 'all']),
|
||||
vserver=dict(required=True, type='str'),
|
||||
query=dict(required=False, type='str')
|
||||
))
|
||||
|
||||
self.module = AnsibleModule(
|
||||
argument_spec=self.argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
parameters = self.module.params
|
||||
# set up state variables
|
||||
self.state = parameters['state']
|
||||
self.name = parameters['name']
|
||||
self.command_directory_name = parameters['command_directory_name']
|
||||
self.access_level = parameters['access_level']
|
||||
self.vserver = parameters['vserver']
|
||||
self.na_helper = NetAppModule()
|
||||
self.parameters = self.na_helper.set_parameters(self.module.params)
|
||||
|
||||
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)
|
||||
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.parameters['vserver'])
|
||||
|
||||
def get_role(self):
|
||||
"""
|
||||
|
|
@ -123,14 +139,14 @@ class NetAppOntapUserRole(object):
|
|||
False if role is not found
|
||||
:rtype: bool
|
||||
"""
|
||||
options = {'vserver': self.parameters['vserver'],
|
||||
'role-name': self.parameters['name'],
|
||||
'command-directory-name': self.parameters['command_directory_name']}
|
||||
|
||||
security_login_role_get_iter = netapp_utils.zapi.NaElement(
|
||||
'security-login-role-get-iter')
|
||||
query_details = netapp_utils.zapi.NaElement.create_node_with_children(
|
||||
'security-login-role-info', **{'vserver': self.vserver,
|
||||
'role-name': self.name,
|
||||
'command-directory-name':
|
||||
self.command_directory_name})
|
||||
'security-login-role-info', **options)
|
||||
query = netapp_utils.zapi.NaElement('query')
|
||||
query.add_child_elem(query_details)
|
||||
security_login_role_get_iter.add_child_elem(query)
|
||||
|
|
@ -141,68 +157,106 @@ class NetAppOntapUserRole(object):
|
|||
except netapp_utils.zapi.NaApiError as e:
|
||||
# Error 16031 denotes a role not being found.
|
||||
if to_native(e.code) == "16031":
|
||||
return False
|
||||
return None
|
||||
# Error 16039 denotes command directory not found.
|
||||
elif to_native(e.code) == "16039":
|
||||
return False
|
||||
return None
|
||||
else:
|
||||
self.module.fail_json(msg='Error getting role %s: %s' % (self.name, to_native(e)),
|
||||
exception=traceback.format_exc())
|
||||
if (result.get_child_by_name('num-records') and
|
||||
int(result.get_child_content('num-records')) >= 1):
|
||||
return True
|
||||
return False
|
||||
role_info = result.get_child_by_name('attributes-list').get_child_by_name('security-login-role-info')
|
||||
result = {
|
||||
'name': role_info['role-name'],
|
||||
'access_level': role_info['access-level'],
|
||||
'command_directory_name': role_info['command-directory-name'],
|
||||
'query': role_info['role-query']
|
||||
}
|
||||
return result
|
||||
|
||||
return None
|
||||
|
||||
def create_role(self):
|
||||
role_create = netapp_utils.zapi.NaElement.create_node_with_children(
|
||||
'security-login-role-create', **{'vserver': self.vserver,
|
||||
'role-name': self.name,
|
||||
'command-directory-name':
|
||||
self.command_directory_name,
|
||||
'access-level':
|
||||
self.access_level})
|
||||
options = {'vserver': self.parameters['vserver'],
|
||||
'role-name': self.parameters['name'],
|
||||
'command-directory-name': self.parameters['command_directory_name'],
|
||||
'access-level': self.parameters['access_level']}
|
||||
if self.parameters.get('query'):
|
||||
options['role-query'] = self.parameters['query']
|
||||
role_create = netapp_utils.zapi.NaElement.create_node_with_children('security-login-role-create', **options)
|
||||
|
||||
try:
|
||||
self.server.invoke_successfully(role_create,
|
||||
enable_tunneling=False)
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
self.module.fail_json(msg='Error creating role %s: %s' % (self.name, to_native(error)),
|
||||
self.module.fail_json(msg='Error creating role %s: %s' % (self.parameters['name'], to_native(error)),
|
||||
exception=traceback.format_exc())
|
||||
|
||||
def delete_role(self):
|
||||
role_delete = netapp_utils.zapi.NaElement.create_node_with_children(
|
||||
'security-login-role-delete', **{'vserver': self.vserver,
|
||||
'role-name': self.name,
|
||||
'security-login-role-delete', **{'vserver': self.parameters['vserver'],
|
||||
'role-name': self.parameters['name'],
|
||||
'command-directory-name':
|
||||
self.command_directory_name})
|
||||
self.parameters['command_directory_name']})
|
||||
|
||||
try:
|
||||
self.server.invoke_successfully(role_delete,
|
||||
enable_tunneling=False)
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
self.module.fail_json(msg='Error removing role %s: %s' % (self.name, to_native(error)),
|
||||
self.module.fail_json(msg='Error removing role %s: %s' % (self.parameters['name'], to_native(error)),
|
||||
exception=traceback.format_exc())
|
||||
|
||||
def modify_role(self, modify):
|
||||
options = {'vserver': self.parameters['vserver'],
|
||||
'role-name': self.parameters['name'],
|
||||
'command-directory-name': self.parameters['command_directory_name']}
|
||||
if 'access_level' in modify.keys():
|
||||
options['access-level'] = self.parameters['access_level']
|
||||
if 'query' in modify.keys():
|
||||
options['role-query'] = self.parameters['query']
|
||||
|
||||
role_modify = netapp_utils.zapi.NaElement.create_node_with_children('security-login-role-modify', **options)
|
||||
|
||||
try:
|
||||
self.server.invoke_successfully(role_modify,
|
||||
enable_tunneling=False)
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
self.module.fail_json(msg='Error modifying role %s: %s' % (self.parameters['name'], to_native(error)),
|
||||
exception=traceback.format_exc())
|
||||
|
||||
def apply(self):
|
||||
changed = False
|
||||
vserver = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.vserver)
|
||||
netapp_utils.ems_log_event("na_ontap_user_role", vserver)
|
||||
role_exists = self.get_role()
|
||||
if role_exists:
|
||||
if self.state == 'absent':
|
||||
changed = True
|
||||
else:
|
||||
if self.state == 'present':
|
||||
changed = True
|
||||
if changed:
|
||||
self.asup_log_for_cserver('na_ontap_user_role')
|
||||
current = self.get_role()
|
||||
cd_action = self.na_helper.get_cd_action(current, self.parameters)
|
||||
|
||||
# if desired state specify empty quote query and current query is None, set desired query to None.
|
||||
# otherwise na_helper.get_modified_attributes will detect a change.
|
||||
if self.parameters.get('query') == '' and current is not None:
|
||||
if current['query'] is None:
|
||||
self.parameters['query'] = None
|
||||
|
||||
modify = self.na_helper.get_modified_attributes(current, self.parameters)
|
||||
if self.na_helper.changed:
|
||||
if self.module.check_mode:
|
||||
pass
|
||||
else:
|
||||
if self.state == 'present':
|
||||
if not role_exists:
|
||||
self.create_role()
|
||||
elif self.state == 'absent':
|
||||
if cd_action == 'create':
|
||||
self.create_role()
|
||||
elif cd_action == 'delete':
|
||||
self.delete_role()
|
||||
self.module.exit_json(changed=changed)
|
||||
elif modify:
|
||||
self.modify_role(modify)
|
||||
self.module.exit_json(changed=self.na_helper.changed)
|
||||
|
||||
def asup_log_for_cserver(self, event_name):
|
||||
"""
|
||||
Fetch admin vserver for the given cluster
|
||||
Create and Autosupport log event with the given module name
|
||||
:param event_name: Name of the event log
|
||||
:return: None
|
||||
"""
|
||||
netapp_utils.ems_log_event(event_name, self.server)
|
||||
|
||||
|
||||
def main():
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue