Debian Codegraph @

ansible_collections/netapp/ontap/plugins/modules/na_ontap_mav_rule.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_rule
12 short_description: NetApp ONTAP multi-admin verification (MAV) rule
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) rule.
19 options:
20 state:
21 description:
22 - Specifies whether to create/modify or delete the specified rule.
23 choices: ['present', 'absent']
24 type: str
25 default: present
26
27 operation:
28 description:
29 - Specifies the command that requires one or more approvals.
30 required: true
31 type: str
32
33 query:
34 description:
35 - Specifies the query information which is applied to the subset of objects of ONTAP operation of the rule.
36 type: str
37
38 required_approvers:
39 description:
40 - Specifies the number of required approvers, excluding the user that made the request.
41 - The default and minimum number of required approvers is 1.
42 type: int
43
44 approval_groups:
45 description:
46 - Specifies the list of approval groups that are allowed to approve requests for rules that don't have approval groups.
47 type: list
48 elements: str
49
50 approval_expiry:
51 description:
52 - Specifies the time, in ISO-8601 duration format, that the approvers have after a new execution request
53 is submitted to approve or disapprove the request before the request expires.
54 - The default value is one hour (PT1H), the minimum supported value is one second (PT1S),
55 and the maximum supported value is 14 days (P14D).
56 type: str
57
58 execution_expiry:
59 description:
60 - Specifies the time, in ISO-8601 duration format, that the authorized users have after a request
61 is approved to execute the requested operation before the request expires.
62 - The default value is one hour (PT1H), the minimum supported value is one second (PT1S),
63 and the maximum supported value is 14 days (P14D).
64 type: str
65
66 auto_request_create:
67 description:
68 - When true, ONTAP automatically creates a request for any failed operation where there is no matching pending request.
69 - Defaults to True.
70 type: bool
71
72 notes:
73 - Only supported with REST and requires ONTAP 9.11.1 or later.
74 - System rules cannot be deleted or have their query modified.
75 """
76
77 EXAMPLES = """
78 - name: Create a rule
79 netapp.ontap.na_ontap_mav_rule:
80 state: present
81 auto_request_create: true
82 required_approvers: 1
83 approval_groups: ["group1", "group2"]
84 approval_expiry: "P14D"
85 execution_expiry: "P14D"
86 operation: "volume delete"
87 hostname: "{{ netapp_hostname }}"
88 username: "{{ netapp_username }}"
89 password: "{{ netapp_password }}"
90 https: true
91 validate_certs: "{{ validate_certs }}"
92 use_rest: always
93
94 - name: Update a rule
95 netapp.ontap.na_ontap_mav_rule:
96 state: present
97 query: "-vserver svm1"
98 operation: "volume delete"
99 hostname: "{{ netapp_hostname }}"
100 username: "{{ netapp_username }}"
101 password: "{{ netapp_password }}"
102 https: true
103 validate_certs: "{{ validate_certs }}"
104 use_rest: always
105
106 - name: Delete a rule
107 netapp.ontap.na_ontap_mav_rule:
108 state: absent
109 operation: "volume delete"
110 hostname: "{{ netapp_hostname }}"
111 username: "{{ netapp_username }}"
112 password: "{{ netapp_password }}"
113 https: true
114 validate_certs: "{{ validate_certs }}"
115 use_rest: always
116 """
117
118 RETURN = """
119
120 """
121
122 import traceback
123 from ansible.module_utils.basic import AnsibleModule
124 from ansible.module_utils._text import to_native
125 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
126 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
127 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
128
129
130 class NetAppOntapMAVRule:
131 def __init__(self):
132 self.argument_spec = netapp_utils.na_ontap_rest_only_spec()
133 self.argument_spec.update(dict(
134 state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
135 operation=dict(required=True, type='str'),
136 query=dict(required=False, type='str'),
137 required_approvers=dict(required=False, type='int'),
138 approval_groups=dict(required=False, type='list', elements='str'),
139 approval_expiry=dict(required=False, type='str'),
140 execution_expiry=dict(required=False, type='str'),
141 auto_request_create=dict(required=False, type='bool')
142 ))
143
144 self.module = AnsibleModule(
145 argument_spec=self.argument_spec,
146 supports_check_mode=True
147 )
148
149 self.owner_uuid = None
150 self.na_helper = NetAppModule(self.module)
151 self.parameters = self.na_helper.check_and_set_parameters(self.module)
152
153 self.rest_api = netapp_utils.OntapRestAPI(self.module)
154 self.rest_api.fail_if_not_rest_minimum_version('na_ontap_mav_rule:', 9, 11, 1)
155
156 def get_mav_rule(self):
157 """ Retrieves multi-admin-verify rule """
158 api = 'security/multi-admin-verify/rules'
159 params = {
160 'operation': self.parameters['operation'],
161 'fields': 'owner.uuid,'
162 'query,'
163 'required_approvers,'
164 'approval_groups,'
165 'approval_expiry,'
166 'execution_expiry,'
167 'auto_request_create,'
168 }
169 record, error = rest_generic.get_one_record(self.rest_api, api, params)
170 if error:
171 self.module.fail_json(msg="Error fetching multi-admin-verify rule for %s: %s" % (self.parameters['operation'], to_native(error)),
172 exception=traceback.format_exc())
173 if record:
174 self.owner_uuid = self.na_helper.safe_get(record, ['owner', 'uuid'])
175 approval_groups_list = [group['name'] for group in record.get('approval_groups', [])]
176 return {
177 'query': record.get('query'),
178 'required_approvers': record.get('required_approvers'),
179 'approval_groups': approval_groups_list,
180 'approval_expiry': record.get('approval_expiry'),
181 'execution_expiry': record.get('execution_expiry'),
182 'auto_request_create': record.get('auto_request_create')
183 }
184 return None
185
186 def create_mav_rule(self):
187 """ Create a multi-admin-verify rule """
188 api = 'security/multi-admin-verify/rules'
189 body = {
190 'operation': self.parameters['operation']
191 }
192 if 'query' in self.parameters:
193 body['query'] = self.parameters['query']
194 if 'required_approvers' in self.parameters:
195 body['required_approvers'] = self.parameters['required_approvers']
196 if 'approval_groups' in self.parameters:
197 body['approval_groups'] = self.parameters['approval_groups']
198 if 'approval_expiry' in self.parameters:
199 body['approval_expiry'] = self.parameters['approval_expiry']
200 if 'execution_expiry' in self.parameters:
201 body['execution_expiry'] = self.parameters['execution_expiry']
202 if 'auto_request_create' in self.parameters:
203 body['auto_request_create'] = self.parameters['auto_request_create']
204 dummy, error = rest_generic.post_async(self.rest_api, api, body)
205 if error:
206 self.module.fail_json(msg="Error creating multi-admin-verify rule for %s: %s" % (self.parameters['operation'], to_native(error)),
207 exception=traceback.format_exc())
208
209 def modify_mav_rule(self, modify):
210 """ Updates a multi-admin-verify rule """
211 api = 'security/multi-admin-verify/rules'
212 query = {'operation': self.parameters['operation'], 'owner.uuid': self.owner_uuid}
213 dummy, error = rest_generic.patch_async(self.rest_api, api, uuid_or_name=None, body=modify, query=query)
214 if error:
215 self.module.fail_json(msg="Error modifying multi-admin-verify rule for %s: %s." % (self.parameters['operation'], to_native(error)),
216 exception=traceback.format_exc())
217
218 def delete_mav_rule(self):
219 """ Deletes a multi-admin-verify rule """
220 api = 'security/multi-admin-verify/rules'
221 query = {'operation': self.parameters['operation'], 'owner.uuid': self.owner_uuid}
222 dummy, error = rest_generic.delete_async(self.rest_api, api, uuid=None, query=query)
223 if error:
224 self.module.fail_json(msg="Error deleting multi-admin-verify rule for %s: %s." % (self.parameters['operation'], to_native(error)),
225 exception=traceback.format_exc())
226
227 def apply(self):
228 current = self.get_mav_rule()
229 modify = None
230 cd_action = self.na_helper.get_cd_action(current, self.parameters)
231 if cd_action is None and self.parameters['state'] == 'present':
232 modify = self.na_helper.get_modified_attributes(current, self.parameters)
233 if self.na_helper.changed and not self.module.check_mode:
234 if cd_action == 'create':
235 self.create_mav_rule()
236 elif cd_action == 'delete':
237 self.delete_mav_rule()
238 elif modify:
239 self.modify_mav_rule(modify)
240 result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify)
241 self.module.exit_json(**result)
242
243
244 def main():
245 mav_rule = NetAppOntapMAVRule()
246 mav_rule.apply()
247
248
249 if __name__ == '__main__':
250 main()