Debian Codegraph @

ansible_collections/netapp/ontap/plugins/modules/na_ontap_mav_approval_group.py

raw
1 #!/usr/bin/python
2 # -*- coding: utf-8 -*-
3
4 # Copyright: NetApp, Inc
5 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
6
7 from __future__ import absolute_import, division, print_function
8 __metaclass__ = type
9
10 DOCUMENTATION = """
11 module: na_ontap_mav_approval_group
12 short_description: NetApp ONTAP multi-admin verification (MAV) approval group
13 extends_documentation_fragment:
14 - netapp.ontap.netapp.na_ontap_rest
15 version_added: 23.0.0
16 author: NetApp Ansible Team (@carchi8py) <[email protected]>
17 description:
18 - Create/modify/delete multi-admin verification (MAV) approval group.
19 options:
20 state:
21 description:
22 - Specifies whether to create/modify or delete the specified approval group.
23 choices: ['present', 'absent']
24 type: str
25 default: present
26
27 name:
28 description:
29 - Specifies the name of an approval group.
30 required: true
31 type: str
32
33 email:
34 description:
35 - Specifies the list of email addresses that are notified when a request is created, approved, vetoed, or executed.
36 type: list
37 elements: str
38
39 approvers:
40 description:
41 - Specifies the list of ONTAP users that are part of the approval group.
42 type: list
43 elements: str
44
45 notes:
46 - Only supported with REST and requires ONTAP 9.11.1 or later.
47 """
48
49 EXAMPLES = """
50 - name: Create an approval group
51 netapp.ontap.na_ontap_mav_approval_group:
52 state: present
53 name: group1
54 email: ["[email protected]"]
55 approvers: ["admin1", "admin2"]
56 hostname: "{{ netapp_hostname }}"
57 username: "{{ netapp_username }}"
58 password: "{{ netapp_password }}"
59 https: true
60 validate_certs: "{{ validate_certs }}"
61 use_rest: always
62
63 - name: Update an approval group
64 netapp.ontap.na_ontap_mav_approval_group:
65 state: present
66 name: group1
67 approvers: ["admin1", "admin3"]
68 hostname: "{{ netapp_hostname }}"
69 username: "{{ netapp_username }}"
70 password: "{{ netapp_password }}"
71 https: true
72 validate_certs: "{{ validate_certs }}"
73 use_rest: always
74
75 - name: Delete an approval group
76 netapp.ontap.na_ontap_mav_approval_group:
77 state: absent
78 name: group1
79 hostname: "{{ netapp_hostname }}"
80 username: "{{ netapp_username }}"
81 password: "{{ netapp_password }}"
82 https: true
83 validate_certs: "{{ validate_certs }}"
84 use_rest: always
85 """
86
87 RETURN = """
88
89 """
90
91 import traceback
92 from ansible.module_utils.basic import AnsibleModule
93 from ansible.module_utils._text import to_native
94 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
95 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
96 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
97
98
99 class NetAppOntapMAVApprovalGroup:
100 def __init__(self):
101 self.argument_spec = netapp_utils.na_ontap_rest_only_spec()
102 self.argument_spec.update(dict(
103 state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
104 name=dict(required=True, type='str'),
105 email=dict(required=False, type='list', elements='str'),
106 approvers=dict(required=False, type='list', elements='str')
107 ))
108
109 self.module = AnsibleModule(
110 argument_spec=self.argument_spec,
111 required_if=[
112 ('state', 'present', ['approvers']),
113 ],
114 supports_check_mode=True
115 )
116
117 self.owner_uuid = None
118 self.na_helper = NetAppModule(self.module)
119 self.parameters = self.na_helper.check_and_set_parameters(self.module)
120
121 self.rest_api = netapp_utils.OntapRestAPI(self.module)
122 self.rest_api.fail_if_not_rest_minimum_version('na_ontap_mav_approval_group:', 9, 11, 1)
123
124 def get_approval_group(self):
125 """ Retrieves multi-admin-verify approval group """
126 api = 'security/multi-admin-verify/approval-groups'
127 fields = 'name,email,approvers,owner.uuid'
128 params = {
129 'name': self.parameters['name'],
130 'fields': fields
131 }
132 record, error = rest_generic.get_one_record(self.rest_api, api, params)
133 if error:
134 self.module.fail_json(msg="Error fetching multi-admin-verify approval group named %s: %s" % (self.parameters['name'], to_native(error)),
135 exception=traceback.format_exc())
136 if record:
137 self.owner_uuid = self.na_helper.safe_get(record, ['owner', 'uuid'])
138 return {
139 'name': record.get('name'),
140 'email': record.get('email'),
141 'approvers': record.get('approvers')
142 }
143 return None
144
145 def create_approval_group(self):
146 """ Create a multi-admin-verify approval group """
147 api = 'security/multi-admin-verify/approval-groups'
148 body = {
149 'name': self.parameters['name'],
150 'approvers': self.parameters['approvers']
151 }
152 if 'email' in self.parameters:
153 body['email'] = self.parameters['email']
154 dummy, error = rest_generic.post_async(self.rest_api, api, body)
155 if error:
156 self.module.fail_json(msg="Error creating multi-admin-verify approval group %s: %s" % (self.parameters['name'], to_native(error)),
157 exception=traceback.format_exc())
158
159 def modify_approval_group(self, modify):
160 """ Updates a multi-admin-verify approval group """
161 api = 'security/multi-admin-verify/approval-groups'
162 uuids = '%s/%s' % (self.owner_uuid, self.parameters['name'])
163 dummy, error = rest_generic.patch_async(self.rest_api, api, uuids, modify)
164 if error:
165 self.module.fail_json(msg="Error modifying multi-admin-verify approval group %s: %s." % (self.parameters['name'], to_native(error)),
166 exception=traceback.format_exc())
167
168 def delete_approval_group(self):
169 """ Deletes a multi-admin-verify approval group """
170 api = 'security/multi-admin-verify/approval-groups'
171 uuids = '%s/%s' % (self.owner_uuid, self.parameters['name'])
172 dummy, error = rest_generic.delete_async(self.rest_api, api, uuid=uuids)
173 if error:
174 self.module.fail_json(msg="Error deleting multi-admin-verify approval group %s: %s." % (self.parameters['name'], to_native(error)),
175 exception=traceback.format_exc())
176
177 def apply(self):
178 current = self.get_approval_group()
179 modify = None
180 cd_action = self.na_helper.get_cd_action(current, self.parameters)
181 if cd_action is None and self.parameters['state'] == 'present':
182 modify = self.na_helper.get_modified_attributes(current, self.parameters)
183 if self.na_helper.changed and not self.module.check_mode:
184 if cd_action == 'create':
185 self.create_approval_group()
186 elif cd_action == 'delete':
187 self.delete_approval_group()
188 elif modify:
189 self.modify_approval_group(modify)
190 result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify)
191 self.module.exit_json(**result)
192
193
194 def main():
195 approval_group = NetAppOntapMAVApprovalGroup()
196 approval_group.apply()
197
198
199 if __name__ == '__main__':
200 main()