Debian Codegraph @

ansible_collections/netapp/storagegrid/plugins/modules/na_sg_grid_info.py

raw
1 #!/usr/bin/python
2
3 # (c) 2020, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6 """ NetApp StorageGRID Grid Info using REST APIs """
7
8
9 from __future__ import absolute_import, division, print_function
10
11 __metaclass__ = type
12
13 ANSIBLE_METADATA = {'metadata_version': '1.1',
14 'status': ['preview'],
15 'supported_by': 'community'}
16
17 DOCUMENTATION = """
18 module: na_sg_grid_info
19 author: NetApp Ansible Team (@jasonl4) <[email protected]>
20 extends_documentation_fragment:
21 - netapp.storagegrid.netapp.sg
22 short_description: NetApp StorageGRID Grid information gatherer.
23 description:
24 - This module allows you to gather various information about StorageGRID Grid configuration.
25 version_added: 20.11.0
26
27 options:
28 gather_subset:
29 type: list
30 elements: str
31 description:
32 - When supplied, this argument will restrict the information collected to a given subset.
33 - Either the info name or the REST API can be given.
34 - Possible values for this argument include
35 - C(grid_accounts_info) or C(grid/accounts)
36 - C(grid_alarms_info) or C(grid/alarms)
37 - C(grid_audit_info) or C(grid/audit)
38 - C(grid_compliance_global_info) or C(grid/compliance-global)
39 - C(grid_config_info) or C(grid/config)
40 - C(grid_config_management_info) or C(grid/config/management)
41 - C(grid_config_product_version_info) or C(grid/config/product-version)
42 - C(grid_deactivated_features_info) or C(grid/deactivated-features)
43 - C(grid_dns_servers_info) or C(grid/dns-servers)
44 - C(grid_domain_names_info) or C(grid/domain-names)
45 - C(grid_ec_profiles_info) or C(grid/ec-profiles)
46 - C(grid_expansion_info) or C(grid/expansion)
47 - C(grid_expansion_nodes_info) or C(grid/expansion/nodes)
48 - C(grid_expansion_sites_info) or C(grid/expansion/sites)
49 - C(grid_firewall_blocked_ports) or C(grid/firewall-blocked-ports)
50 - C(grid_firewall_external_ports) or C(grid/firewall-external-ports)
51 - C(grid_firewall_privileged_ips) or C(grid/firewall-privileged-ips)
52 - C(grid_grid_networks_info) or C(grid/grid-networks)
53 - C(grid_groups_info) or C(grid/groups)
54 - C(grid_ha_groups_info) or C(grid/ha-groups)
55 - C(grid_health_info) or C(grid/health)
56 - C(grid_health_topology_info) or C(grid/health/topology)
57 - C(grid_identity_source_info) or C(grid/identity-source)
58 - C(grid_ilm_criteria_info) or C(grid/ilm-criteria)
59 - C(grid_ilm_grade_site_info) or C(grid/ilm-grade-site)
60 - C(grid_ilm_grades_info) or C(grid/ilm-grades)
61 - C(grid_ilm_policies_info) or C(grid/ilm-policies)
62 - C(grid_ilm_rules_info) or C(grid/ilm-rules)
63 - C(grid_ilm_storage_pools_info) or C(grid/ilm-pools)
64 - C(grid_license_info) or C(grid/license)
65 - C(grid_load_balancer_endpoints_config_info) or C(grid/gateway-configs)
66 - C(grid_management_certificate_info) or C(grid/management-certificate)
67 - C(grid_network_topology_info) or C(grid/network-topology)
68 - C(grid_ntp_servers_info) or C(grid/ntp-servers)
69 - C(grid_recovery_available_nodes_info) or C(grid/recovery/available-nodes)
70 - C(grid_recovery_info) or C(grid/recovery)
71 - C(grid_regions_info) or C(grid/regions)
72 - C(grid_schemes_info) or C(grid/schemes)
73 - C(grid_single_sign_on_info) or C(grid/single-sign-on)
74 - C(grid_snmp_info) or C(grid/snmp)
75 - C(grid_storage_api_certificate_info) or C(grid/storage-api-certificate)
76 - C(grid_untrusted_client_network_info) or C(grid/untrusted-client-network)
77 - C(grid_users_info) or C(grid/users)
78 - C(grid_users_root_info) or C(grid/users/root)
79 - C(grid_vlan_interfaces_info) or C(grid/vlan-interfaces)
80 - C(versions_info) or C(versions)
81 - Can specify a list of values to include a larger subset.
82 default: all
83 parameters:
84 description:
85 - Allows for any rest option to be passed in.
86 type: dict
87 """
88
89 EXAMPLES = """
90 - name: Gather StorageGRID Grid info
91 netapp.storagegrid.na_sg_grid_info:
92 api_url: "https://1.2.3.4/"
93 auth_token: "storagegrid-auth-token"
94 validate_certs: false
95 register: sg_grid_info
96
97 - name: Gather StorageGRID Grid info for grid/accounts and grid/config subsets
98 netapp.storagegrid.na_sg_grid_info:
99 api_url: "https://1.2.3.4/"
100 auth_token: "storagegrid-auth-token"
101 validate_certs: false
102 gather_subset:
103 - grid_accounts_info
104 - grid/config
105 register: sg_grid_info
106
107 - name: Gather StorageGRID Grid info for all subsets
108 netapp.storagegrid.na_sg_grid_info:
109 api_url: "https://1.2.3.4/"
110 auth_token: "storagegrid-auth-token"
111 validate_certs: false
112 gather_subset:
113 - all
114 register: sg_grid_info
115
116 - name: Gather StorageGRID Grid info for grid/accounts and grid/users subsets, limit to 5 results for each subset
117 netapp.storagegrid.na_sg_grid_info:
118 api_url: "https://1.2.3.4/"
119 auth_token: "storagegrid-auth-token"
120 validate_certs: false
121 gather_subset:
122 - grid/accounts
123 - grid/users
124 parameters:
125 limit: 5
126 register: sg_grid_info
127 """
128
129 RETURN = """
130 sg_info:
131 description: Returns various information about the StorageGRID Grid configuration.
132 returned: always
133 type: dict
134 sample: {
135 "grid/accounts": {...},
136 "grid/alarms": {...},
137 "grid/audit": {...},
138 "grid/compliance-global": {...},
139 "grid/config": {...},
140 "grid/config/management": {...},
141 "grid/config/product-version": {...},
142 "grid/deactivated-features": {...},
143 "grid/dns-servers": {...},
144 "grid/domain-names": {...},
145 "grid/ec-profiles": {...},
146 "grid/expansion": {...},
147 "grid/expansion/nodes": {...},
148 "grid/expansion/sites": {...},
149 "grid/firewall-blocked-ports": {...},
150 "grid/firewall-external-ports": {...},
151 "grid/firewall-privileged-ips": {...},
152 "grid/networks": {...},
153 "grid/gateway-configs": {...},
154 "grid/groups": {...},
155 "grid/ha-groups": {...},
156 "grid/health": {...},
157 "grid/health/topology": {...},
158 "grid/identity-source": {...},
159 "grid/ilm-criteria": {...},
160 "grid/ilm-grade-site": {...},
161 "grid/ilm-grades": {...},
162 "grid/ilm-policies": {...},
163 "grid/ilm-pools": {...},
164 "grid/ilm-rules": {...},
165 "grid/license": {...},
166 "grid/management-certificate": {...},
167 "grid/network-toplogy": {...},
168 "grid/ntp-servers": {...},
169 "grid/recovery/available-nodes": {...},
170 "grid/recovery": {...},
171 "grid/regions": {...},
172 "grid/schemes": {...},
173 "grid/single-sign-on": {...},
174 "grid/snmp": {...},
175 "grid/storage-api-certificate": {...},
176 "grid/untrusted-client-network": {...},
177 "grid/users": {...},
178 "grid/users/root": {...},
179 "grid/vlan-interfaces": {...},
180 "grid/versions": {...}
181 }
182 """
183
184 from ansible.module_utils.basic import AnsibleModule
185 import ansible_collections.netapp.storagegrid.plugins.module_utils.netapp as netapp_utils
186 from ansible_collections.netapp.storagegrid.plugins.module_utils.netapp_module import NetAppModule
187 from ansible_collections.netapp.storagegrid.plugins.module_utils.netapp import SGRestAPI
188
189
190 class NetAppSgGatherInfo(object):
191 """ Class with gather info methods """
192
193 def __init__(self):
194 """
195 Parse arguments, setup variables, check parameters and ensure
196 request module is installed.
197 """
198 self.argument_spec = netapp_utils.na_storagegrid_host_argument_spec()
199 self.argument_spec.update(dict(
200 gather_subset=dict(default=['all'], type='list', elements='str', required=False),
201 parameters=dict(type='dict', required=False)
202 ))
203
204 self.module = AnsibleModule(
205 argument_spec=self.argument_spec,
206 supports_check_mode=True
207 )
208
209 # set up variables
210 self.na_helper = NetAppModule()
211 self.parameters = self.na_helper.set_parameters(self.module.params)
212 self.rest_api = SGRestAPI(self.module)
213 # Get API version
214 self.rest_api.get_sg_product_version()
215 self.api_version = self.rest_api.get_api_version()
216
217 def get_subset_info(self, gather_subset_info):
218 """
219 Gather StorageGRID information for the given subset using REST APIs
220 Input for REST APIs call : (api, data)
221 return gathered_sg_info
222 """
223
224 api = gather_subset_info['api_call']
225 data = {}
226 # allow for passing in any additional rest api parameters
227 if self.parameters.get('parameters'):
228 for each in self.parameters['parameters']:
229 data[each] = self.parameters['parameters'][each]
230
231 gathered_sg_info, error = self.rest_api.get(api, data)
232
233 if error:
234 self.module.fail_json(msg=error)
235 else:
236 return gathered_sg_info
237
238 return None
239
240 def convert_subsets(self):
241 """ Convert an info to the REST API """
242 info_to_rest_mapping = {
243 'grid_accounts_info': 'grid/accounts',
244 'grid_alarms_info': 'grid/alarms',
245 'grid_audit_info': 'grid/audit',
246 'grid_compliance_global_info': 'grid/compliance-global',
247 'grid_config_info': 'grid/config',
248 'grid_config_management_info': 'grid/config/management',
249 'grid_config_product_version_info': 'grid/config/product-version',
250 'grid_deactivated_features_info': 'grid/deactivated-features',
251 'grid_dns_servers_info': 'grid/dns-servers',
252 'grid_domain_names_info': 'grid/domain-names',
253 'grid_ec_profiles_info': 'grid/ec-profiles',
254 'grid_expansion_info': 'grid/expansion',
255 'grid_expansion_nodes_info': 'grid/expansion/nodes',
256 'grid_expansion_sites_info': 'grid/expansion/sites',
257 'grid_firewall_blocked_ports': 'grid/firewall-blocked-ports',
258 'grid_firewall_external_ports': 'grid/firewall-external-ports',
259 'grid_firewall_privileged_ips': 'grid/firewall-privileged-ips',
260 'grid_grid_networks_info': 'grid/grid-networks',
261 'grid_groups_info': 'grid/groups',
262 'grid_ha_groups_info': 'grid/ha-groups',
263 'grid_health_info': 'grid/health',
264 'grid_health_topology_info': 'grid/health/topology',
265 'grid_identity_source_info': 'grid/identity-source',
266 'grid_ilm_criteria_info': 'grid/ilm-criteria',
267 'grid_ilm_grade_site_info': 'grid/ilm-grade-site',
268 'grid_ilm_grades_info': 'grid/ilm-grades',
269 'grid_ilm_policies_info': 'grid/ilm-policies',
270 'grid_ilm_storage_pools_info': 'grid/ilm-pools',
271 'grid_ilm_rules_info': 'grid/ilm-rules',
272 'grid_load_balancer_endpoints_config_info': 'grid/gateway-configs',
273 'grid_license_info': 'grid/license',
274 'grid_management_certificate_info': 'grid/management-certificate',
275 'grid_network_topology_info': 'grid/network-topology',
276 'grid_ntp_servers_info': 'grid/ntp-servers',
277 'grid_recovery_available_nodes_info': 'grid/recovery/available-nodes',
278 'grid_recovery_info': 'grid/recovery',
279 'grid_regions_info': 'grid/regions',
280 'grid_single_sign_on_info': 'grid/single-sign-on',
281 'grid_schemes_info': 'grid/schemes',
282 'grid_snmp_info': 'grid/snmp',
283 'grid_storage_api_certificate_info': 'grid/storage-api-certificate',
284 'grid_untrusted_client_network_info': 'grid/untrusted-client-network',
285 'grid_users_info': 'grid/users',
286 'grid_users_root_info': 'grid/users/root',
287 'grid_vlan_interfaces_info': 'grid/vlan-interfaces',
288 'versions_info': 'versions'
289 }
290 # Add rest API names as there info version, also make sure we don't add a duplicate.
291 subsets = []
292 for subset in self.parameters['gather_subset']:
293 if subset in info_to_rest_mapping:
294 if info_to_rest_mapping[subset] not in subsets:
295 subsets.append(info_to_rest_mapping[subset])
296 else:
297 if subset not in subsets:
298 subsets.append(subset)
299 return subsets
300
301 def apply(self):
302 """ Perform pre-checks, call functions and exit """
303
304 result_message = dict()
305
306 # Defining gather_subset and appropriate api_call.
307 get_sg_subset_info = {
308 'grid/accounts': {
309 'api_call': 'api/%s/grid/accounts' % self.api_version,
310 },
311 'grid/alarms': {
312 'api_call': 'api/%s/grid/alarms' % self.api_version,
313 },
314 'grid/audit': {
315 'api_call': 'api/%s/grid/audit' % self.api_version,
316 },
317 'grid/compliance-global': {
318 'api_call': 'api/%s/grid/compliance-global' % self.api_version,
319 },
320 'grid/config': {
321 'api_call': 'api/%s/grid/config' % self.api_version,
322 },
323 'grid/config/management': {
324 'api_call': 'api/%s/grid/config/management' % self.api_version,
325 },
326 'grid/config/product-version': {
327 'api_call': 'api/%s/grid/config/product-version' % self.api_version,
328 },
329 'grid/deactivated-features': {
330 'api_call': 'api/%s/grid/deactivated-features' % self.api_version,
331 },
332 'grid/dns-servers': {
333 'api_call': 'api/%s/grid/dns-servers' % self.api_version,
334 },
335 'grid/domain-names': {
336 'api_call': 'api/%s/grid/domain-names' % self.api_version,
337 },
338 'grid/ec-profiles': {
339 'api_call': 'api/%s/grid/ec-profiles' % self.api_version,
340 },
341 'grid/expansion': {
342 'api_call': 'api/%s/grid/expansion' % self.api_version,
343 },
344 'grid/expansion/nodes': {
345 'api_call': 'api/%s/grid/expansion/nodes' % self.api_version,
346 },
347 'grid/expansion/sites': {
348 'api_call': 'api/%s/grid/expansion/sites' % self.api_version,
349 },
350 'grid/firewall-blocked-ports': {
351 'api_call': 'api/%s/private/firewall-blocked-ports' % self.api_version
352 },
353 'grid/firewall-external-ports': {
354 'api_call': 'api/%s/private/firewall-external-ports' % self.api_version
355 },
356 'grid/firewall-privileged-ips': {
357 'api_call': 'api/%s/private/firewall-privileged-ips' % self.api_version
358 },
359 'grid/gateway-configs': {
360 'api_call': 'api/%s/private/gateway-configs' % self.api_version,
361 },
362 'grid/grid-networks': {
363 'api_call': 'api/%s/grid/grid-networks' % self.api_version,
364 },
365 'grid/groups': {
366 'api_call': 'api/%s/grid/groups' % self.api_version,
367 },
368 'grid/ha-groups': {
369 'api_call': 'api/%s/private/ha-groups' % self.api_version,
370 },
371 'grid/health': {
372 'api_call': 'api/%s/grid/health' % self.api_version,
373 },
374 'grid/health/topology': {
375 'api_call': 'api/%s/grid/health/topology' % self.api_version,
376 },
377 'grid/identity-source': {
378 'api_call': 'api/%s/grid/identity-source' % self.api_version,
379 },
380 'grid/ilm-criteria': {
381 'api_call': 'api/%s/grid/ilm-criteria' % self.api_version,
382 },
383 'grid/ilm-grade-site': {
384 'api_call': 'api/%s/private/ilm-grade-site' % self.api_version,
385 },
386 'grid/ilm-grades': {
387 'api_call': 'api/%s/private/ilm-grades' % self.api_version,
388 },
389 'grid/ilm-policies': {
390 'api_call': 'api/%s/grid/ilm-policies' % self.api_version,
391 },
392 'grid/ilm-pools': {
393 'api_call': 'api/%s/private/ilm-pools' % self.api_version,
394 },
395 'grid/ilm-rules': {
396 'api_call': 'api/%s/grid/ilm-rules' % self.api_version,
397 },
398 'grid/license': {
399 'api_call': 'api/%s/grid/license' % self.api_version,
400 },
401 'grid/management-certificate': {
402 'api_call': 'api/%s/grid/management-certificate' % self.api_version,
403 },
404 'grid/network-topology': {
405 'api_call': 'api/%s/private/network-topology' % self.api_version
406 },
407 'grid/ntp-servers': {
408 'api_call': 'api/%s/grid/ntp-servers' % self.api_version,
409 },
410 'grid/recovery/available-nodes': {
411 'api_call': 'api/%s/grid/recovery/available-nodes' % self.api_version,
412 },
413 'grid/recovery': {
414 'api_call': 'api/%s/grid/recovery' % self.api_version,
415 },
416 'grid/regions': {
417 'api_call': 'api/%s/grid/regions' % self.api_version,
418 },
419 'grid/single-sign-on': {
420 'api_call': 'api/%s/private/single-sign-on' % self.api_version
421 },
422 'grid/schemes': {
423 'api_call': 'api/%s/grid/schemes' % self.api_version,
424 },
425 'grid/snmp': {
426 'api_call': 'api/%s/grid/snmp' % self.api_version,
427 },
428 'grid/storage-api-certificate': {
429 'api_call': 'api/%s/grid/storage-api-certificate' % self.api_version,
430 },
431 'grid/untrusted-client-network': {
432 'api_call': 'api/%s/grid/untrusted-client-network' % self.api_version,
433 },
434 'grid/users': {
435 'api_call': 'api/%s/grid/users' % self.api_version,
436 },
437 'grid/users/root': {
438 'api_call': 'api/%s/grid/users/root' % self.api_version,
439 },
440 'grid/vlan-interfaces': {
441 'api_call': 'api/%s/private/vlan-interfaces' % self.api_version
442 },
443 'grid/versions': {
444 'api_call': 'api/%s/versions' % self.api_version,
445 }
446 }
447
448 if 'all' in self.parameters['gather_subset']:
449 # If all in subset list, get the information of all subsets.
450 self.parameters['gather_subset'] = sorted(get_sg_subset_info.keys())
451
452 converted_subsets = self.convert_subsets()
453
454 for subset in converted_subsets:
455 try:
456 # Verify whether the supported subset passed.
457 specified_subset = get_sg_subset_info[subset]
458 except KeyError:
459 self.module.fail_json(msg="Specified subset %s not found, supported subsets are %s" %
460 (subset, list(get_sg_subset_info.keys())))
461
462 result_message[subset] = self.get_subset_info(specified_subset)
463
464 self.module.exit_json(changed=False, sg_info=result_message)
465
466
467 def main():
468 """ Main function """
469 obj = NetAppSgGatherInfo()
470 obj.apply()
471
472
473 if __name__ == '__main__':
474 main()