Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2021-2025, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6 '''
7 na_ontap_service_policy
8 '''
9
10 from __future__ import absolute_import, division, print_function
11 __metaclass__ = type
12
13 DOCUMENTATION = '''
14
15 module: na_ontap_service_policy
16
17 short_description: NetApp ONTAP service policy configuration
18 extends_documentation_fragment:
19 - netapp.ontap.netapp.na_ontap_rest
20 version_added: 21.7.0
21 author: NetApp Ansible Team (@carchi8py) <[email protected]>
22
23 description:
24 - Add, modify, or remove service policies.
25 - This module requires ONTAP 9.8 or later, and only supports REST.
26
27 options:
28 state:
29 description:
30 - Whether the specified service policy should exist or not.
31 choices: ['present', 'absent']
32 type: str
33 default: 'present'
34 name:
35 description:
36 - The name of the service policy.
37 required: true
38 type: str
39 ipspace:
40 description:
41 - Name of the ipspace.
42 - Required for cluster-scoped service policies.
43 - Optional for SVM-scoped service policies.
44 type: str
45 services:
46 description:
47 - List of services to associate to this service policy.
48 - To remove all services, use "no_service". No other value is allowed when no_service is present.
49 - Note - not all versions of ONTAP support all values, and new ones may be added.
50 - See C(known_services) and C(additional_services) to address unknow service errors.
51 type: list
52 elements: str
53 vserver:
54 description:
55 - The name of the vserver to use.
56 - Omit this option for cluster scoped user accounts.
57 type: str
58 scope:
59 description:
60 - Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".
61 - svm is assumed if vserver is set.
62 - cluster is assumed is vserver is not set.
63 type: str
64 choices: ['cluster', 'svm']
65 known_services:
66 description:
67 - List of known services in 9.12.1
68 - An error is raised if any service in C(services) is not in this list or C(new_services).
69 - Modify this list to restrict the services you want to support if needed.
70 default: [cluster_core, intercluster_core, management_core, management_autosupport, management_bgp, management_ems, management_https, management_http,
71 management_ssh, management_portmap, data_core, data_nfs, data_cifs, data_flexcache, data_iscsi, data_s3_server, data_dns_server,
72 data_fpolicy_client, management_ntp_client, management_dns_client, management_ad_client, management_ldap_client, management_nis_client,
73 management_snmp_server, management_rsh_server, management_telnet_server, management_ntp_server, data_nvme_tcp, backup_ndmp_control,
74 management_log_forwarding]
75 type: list
76 elements: str
77 version_added: 22.0.0
78 additional_services:
79 description:
80 - As an alternative to updating the C(known_services), new services can be specified here.
81 type: list
82 elements: str
83 version_added: 22.0.0
84
85 notes:
86 - This module supports check_mode.
87 - This module does not support 'allowed-addresses' as REST does not support it. It defaults to 0.0.0.0/0.
88 '''
89
90 EXAMPLES = """
91 - name: Create service policy
92 netapp.ontap.na_ontap_service_policy:
93 state: present
94 name: "{{ service_policy_name }}"
95 services:
96 - data_core
97 - data_nfs
98 vserver: ansibleVServer
99 hostname: "{{ netapp_hostname }}"
100 username: "{{ netapp_username }}"
101 password: "{{ netapp_password }}"
102
103 - name: Delete single service policy
104 netapp.ontap.na_ontap_service_policy:
105 state: absent
106 name: "{{ service_policy_name }}"
107 vserver: ansibleVServer
108 hostname: "{{ netapp_hostname }}"
109 username: "{{ netapp_username }}"
110 password: "{{ netapp_password }}"
111
112 - name: Modify single service policy
113 netapp.ontap.na_ontap_service_policy:
114 state: present
115 name: "{{ service_policy_name }}"
116 services:
117 - data_core
118 - data_nfs
119 - data_cifs
120 vserver: ansibleVServer
121 hostname: "{{ netapp_hostname }}"
122 username: "{{ netapp_username }}"
123 password: "{{ netapp_password }}"
124
125 - name: Modify service policy, remove services
126 netapp.ontap.na_ontap_service_policy:
127 state: present
128 name: "{{ service_policy_name }}"
129 services:
130 - no_service
131 vserver: "{{ vserver }}"
132
133 - name: Modify service policy at cluster level
134 netapp.ontap.na_ontap_service_policy:
135 state: present
136 name: "{{ service_policy_name }}"
137 ipspace: ansibleIpspace
138 scope: cluster
139 services:
140 - management_core
141 - management_autosupport
142 - management_ems
143 """
144
145 RETURN = """
146 cd_action:
147 description: whether a public key is created or deleted.
148 returned: success
149 type: str
150
151 modify:
152 description: attributes that were modified if the key already exists.
153 returned: success
154 type: dict
155 """
156
157 from ansible.module_utils.basic import AnsibleModule
158 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
159 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
160 from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
161 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
162
163 HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
164
165
166 class NetAppOntapServicePolicy:
167 """
168 Common operations to manage public keys.
169 """
170
171 def __init__(self):
172 self.use_rest = False
173 argument_spec = netapp_utils.na_ontap_rest_only_spec()
174 argument_spec.update(dict(
175 state=dict(type='str', choices=['present', 'absent'], default='present'),
176 name=dict(required=True, type='str'),
177 ipspace=dict(type='str'),
178 scope=dict(type='str', choices=['cluster', 'svm']),
179 services=dict(type='list', elements='str'),
180 vserver=dict(type='str'),
181 known_services=dict(type='list', elements='str',
182 default=['cluster_core', 'intercluster_core', 'management_core', 'management_autosupport', 'management_bgp', 'management_ems',
183 'management_https', 'management_http', 'management_ssh', 'management_portmap', 'data_core', 'data_nfs', 'data_cifs',
184 'data_flexcache', 'data_iscsi', 'data_s3_server', 'data_dns_server', 'data_fpolicy_client', 'management_ntp_client',
185 'management_dns_client', 'management_ad_client', 'management_ldap_client', 'management_nis_client',
186 'management_snmp_server', 'management_rsh_server', 'management_telnet_server', 'management_ntp_server',
187 'data_nvme_tcp', 'backup_ndmp_control', 'management_log_forwarding']),
188 additional_services=dict(type='list', elements='str')
189 ))
190
191 self.module = AnsibleModule(
192 argument_spec=argument_spec,
193 required_if=[
194 ('scope', 'cluster', ['ipspace']),
195 ('scope', 'svm', ['vserver']),
196 ('vserver', None, ['ipspace']),
197 ],
198 required_one_of=[
199 ('ipspace', 'vserver')
200 ],
201 supports_check_mode=True
202 )
203
204 self.na_helper = NetAppModule()
205 self.parameters = self.na_helper.set_parameters(self.module.params)
206
207 # REST API is required
208 self.rest_api = OntapRestAPI(self.module)
209 # check version
210 self.rest_api.fail_if_not_rest_minimum_version('na_ontap_service_policy', 9, 8)
211 self.validate_inputs()
212
213 def validate_inputs(self):
214 services = self.parameters.get('services')
215 if services and 'no_service' in services:
216 if len(services) > 1:
217 self.module.fail_json(msg='Error: no other service can be present when no_service is specified. Got: %s' % services)
218 self.parameters['services'] = []
219 known_services = self.parameters.get('known_services', []) + self.parameters.get('additional_services', [])
220 unknown_services = [service for service in self.parameters.get('services', []) if service not in known_services]
221 if unknown_services:
222 plural = 's' if len(services) > 1 else ''
223 self.module.fail_json(msg='Error: unknown service%s: %s. New services may need to be added to "additional_services".'
224 % (plural, ','.join(unknown_services)))
225
226 scope = self.parameters.get('scope')
227 if scope is None:
228 self.parameters['scope'] = 'cluster' if self.parameters.get('vserver') is None else 'svm'
229 elif scope == 'cluster' and self.parameters.get('vserver') is not None:
230 self.module.fail_json(msg='Error: vserver cannot be set when "scope: cluster" is specified. Got: %s' % self.parameters.get('vserver'))
231 elif scope == 'svm' and self.parameters.get('vserver') is None:
232 self.module.fail_json(msg='Error: vserver cannot be None when "scope: svm" is specified.')
233
234 def get_service_policy(self):
235 api = 'network/ip/service-policies'
236 query = {
237 'name': self.parameters['name'],
238 'fields': 'name,uuid,ipspace,services,svm,scope'
239 }
240 if self.parameters.get('vserver') is None:
241 # vserser is empty for cluster
242 query['scope'] = 'cluster'
243 else:
244 query['svm.name'] = self.parameters['vserver']
245
246 if self.parameters.get('ipspace') is not None:
247 query['ipspace.name'] = self.parameters['ipspace']
248 record, error = rest_generic.get_one_record(self.rest_api, api, query)
249 if error:
250 msg = "Error in get_service_policy: %s" % error
251 self.module.fail_json(msg=msg)
252 if record:
253 return {
254 'uuid': record['uuid'],
255 'name': record['name'],
256 'ipspace': record['ipspace']['name'],
257 'scope': record['scope'],
258 'vserver': self.na_helper.safe_get(record, ['svm', 'name']),
259 'services': record['services']
260 }
261 return None
262
263 def create_service_policy(self):
264 api = 'network/ip/service-policies'
265 body = {
266 'name': self.parameters['name']
267 }
268 if self.parameters.get('vserver') is not None:
269 body['svm.name'] = self.parameters['vserver']
270
271 for attr in ('ipspace', 'scope', 'services'):
272 value = self.parameters.get(attr)
273 if value is not None:
274 body[attr] = value
275
276 dummy, error = rest_generic.post_async(self.rest_api, api, body)
277 if error:
278 msg = "Error in create_service_policy: %s" % error
279 self.module.fail_json(msg=msg)
280
281 def modify_service_policy(self, current, modify):
282 # sourcery skip: dict-comprehension
283 api = 'network/ip/service-policies/%s' % current['uuid']
284 modify_copy = dict(modify)
285 body = {}
286 for key in modify:
287 if key in ('services',):
288 body[key] = modify_copy.pop(key)
289 if modify_copy:
290 msg = 'Error: attributes not supported in modify: %s' % modify_copy
291 self.module.fail_json(msg=msg)
292 if not body:
293 msg = 'Error: nothing to change - modify called with: %s' % modify
294 self.module.fail_json(msg=msg)
295
296 dummy, error = rest_generic.patch_async(self.rest_api, api, None, body)
297 if error:
298 msg = "Error in modify_service_policy: %s" % error
299 self.module.fail_json(msg=msg)
300
301 def delete_service_policy(self, current):
302 api = 'network/ip/service-policies/%s' % current['uuid']
303
304 dummy, error = rest_generic.delete_async(self.rest_api, api, None, None)
305 if error:
306 msg = "Error in delete_service_policy: %s" % error
307 self.module.fail_json(msg=msg)
308
309 def get_actions(self):
310 """Determines whether a create, delete, modify action is required
311 """
312 cd_action, modify, current = None, None, None
313 current = self.get_service_policy()
314 cd_action = self.na_helper.get_cd_action(current, self.parameters)
315 if cd_action is None:
316 modify = self.na_helper.get_modified_attributes(current, self.parameters)
317 return cd_action, modify, current
318
319 def apply(self):
320 cd_action, modify, current = self.get_actions()
321
322 if self.na_helper.changed and not self.module.check_mode:
323 if cd_action == 'create':
324 self.create_service_policy()
325 elif cd_action == 'delete':
326 self.delete_service_policy(current)
327 elif modify:
328 self.modify_service_policy(current, modify)
329 result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify, extra_responses={'scope': self.module.params})
330 self.module.exit_json(**result)
331
332
333 def main():
334 obj = NetAppOntapServicePolicy()
335 obj.apply()
336
337
338 if __name__ == '__main__':
339 main()