Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2018-2026, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5 from __future__ import absolute_import, division, print_function
6 __metaclass__ = type
7
8 DOCUMENTATION = '''
9 author: NetApp Ansible Team (@carchi8py) <[email protected]>
10 description:
11 - Create/Delete cluster peer relations on ONTAP
12 - Modify remote intercluster addresses in cluster peer relation on ONTAP
13 extends_documentation_fragment:
14 - netapp.ontap.netapp.na_ontap
15 - netapp.ontap.netapp.na_ontap_peer
16 module: na_ontap_cluster_peer
17 options:
18 state:
19 choices: ['present', 'absent']
20 type: str
21 description:
22 - Whether the specified cluster peer should exist or not.
23 default: present
24 source_intercluster_lifs:
25 description:
26 - List of intercluster addresses of the source cluster.
27 - Used as peer-addresses in destination cluster.
28 - All these intercluster lifs should belong to the source cluster.
29 version_added: 2.8.0
30 type: list
31 elements: str
32 aliases:
33 - source_intercluster_lif
34 dest_intercluster_lifs:
35 description:
36 - List of intercluster addresses of the destination cluster.
37 - Used as peer-addresses in source cluster.
38 - All these intercluster lifs should belong to the destination cluster.
39 version_added: 2.8.0
40 type: list
41 elements: str
42 aliases:
43 - dest_intercluster_lif
44 passphrase:
45 description:
46 - The arbitrary passphrase that matches the one given to the peer cluster.
47 type: str
48 source_cluster_name:
49 description:
50 - The name of the source cluster name in the peer relation to be modified or deleted.
51 - Required for deleting peer relation and for modifying source_intercluster_lifs.
52 type: str
53 dest_cluster_name:
54 description:
55 - The name of the destination cluster name in the peer relation to be modified or deleted.
56 - Required for deleting peer relation and for modifying dest_intercluster_lifs.
57 type: str
58 dest_hostname:
59 description:
60 - DEPRECATED - please use C(peer_options).
61 - Destination cluster IP or hostname which needs to be peered.
62 - Required to complete the peering process at destination cluster.
63 type: str
64 dest_username:
65 description:
66 - DEPRECATED - please use C(peer_options).
67 - Destination username.
68 - Optional if this is same as source username or if a certificate is used.
69 type: str
70 dest_password:
71 description:
72 - DEPRECATED - please use C(peer_options).
73 - Destination password.
74 - Optional if this is same as source password or if a certificate is used..
75 type: str
76 ipspace:
77 description:
78 - IPspace of the local intercluster LIFs.
79 - Assumes Default IPspace if not provided.
80 type: str
81 version_added: '20.11.0'
82 encryption_protocol_proposed:
83 description:
84 - Encryption protocol to be used for inter-cluster communication.
85 - Only available on ONTAP 9.5 or later.
86 choices: ['tls_psk', 'none']
87 type: str
88 version_added: '20.5.0'
89 local_name_for_peer:
90 description:
91 - Specifies local name of the peer Cluster in the relationship.
92 - By default the system will generate the same name as cluster name.
93 type: str
94 version_added: '23.1.0'
95 local_name_for_source:
96 description:
97 - Specifies local name of the source Cluster in the relationship.
98 - By default the system will generate the same name as cluster name.
99 type: str
100 version_added: '23.1.0'
101 lambda_config:
102 description:
103 - Configuration parameters for AWS Lambda proxy functionality.
104 - These option and suboptions are only supported with REST.
105 type: dict
106 version_added: '23.4.0'
107 suboptions:
108 function_name:
109 description:
110 - The name of the AWS Lambda function to invoke.
111 type: str
112 required: true
113 aws_region:
114 description:
115 - The name of the AWS region.
116 type: str
117 required: true
118 aws_profile:
119 description:
120 - The name of the AWS profile to use for authentication.
121 type: str
122 short_description: NetApp ONTAP Manage Cluster peering
123 version_added: 2.7.0
124
125 notes:
126 - Modify remote intercluster addresses operation is supported only with REST.
127 - The options local_name_for_peer and local_name_for_source are supported only with REST.
128 - Supports AWS Lambda proxy functionality when using REST. See the README file for example usage.
129 '''
130
131 EXAMPLES = """
132 - name: Create cluster peer
133 netapp.ontap.na_ontap_cluster_peer:
134 state: present
135 source_intercluster_lifs: 1.2.3.4,1.2.3.5
136 dest_intercluster_lifs: 1.2.3.6,1.2.3.7
137 passphrase: XXXX
138 local_name_for_peer: 'dest_local_name'
139 local_name_for_source: 'sorce_local_name'
140 hostname: "{{ netapp_hostname }}"
141 username: "{{ netapp_username }}"
142 password: "{{ netapp_password }}"
143 peer_options:
144 hostname: "{{ dest_netapp_hostname }}"
145 encryption_protocol_proposed: tls_psk
146
147 - name: Delete cluster peer
148 netapp.ontap.na_ontap_cluster_peer:
149 state: absent
150 source_cluster_name: test-source-cluster
151 dest_cluster_name: test-dest-cluster
152 hostname: "{{ netapp_hostname }}"
153 username: "{{ netapp_username }}"
154 password: "{{ netapp_password }}"
155 peer_options:
156 hostname: "{{ dest_netapp_hostname }}"
157
158 - name: Create cluster peer - different credentials
159 netapp.ontap.na_ontap_cluster_peer:
160 state: present
161 source_intercluster_lifs: 1.2.3.4,1.2.3.5
162 dest_intercluster_lifs: 1.2.3.6,1.2.3.7
163 passphrase: XXXX
164 hostname: "{{ netapp_hostname }}"
165 username: "{{ netapp_username }}"
166 password: "{{ netapp_password }}"
167 peer_options:
168 hostname: "{{ dest_netapp_hostname }}"
169 cert_filepath: "{{ cert_filepath }}"
170 key_filepath: "{{ key_filepath }}"
171 encryption_protocol_proposed: tls_psk
172
173 - name: Modify cluster peer - destination intercluster addresses
174 netapp.ontap.na_ontap_cluster_peer:
175 state: present
176 source_intercluster_lifs: 1.2.3.4,1.2.3.5
177 dest_intercluster_lifs: 1.2.3.8
178 dest_cluster_name: test-dest-cluster
179 local_name_for_peer: 'dest_name'
180 local_name_for_source: 'source_name'
181 hostname: "{{ netapp_hostname }}"
182 username: "{{ netapp_username }}"
183 password: "{{ netapp_password }}"
184 peer_options:
185 hostname: "{{ dest_netapp_hostname }}"
186 """
187
188 RETURN = """
189 """
190
191 import traceback
192 from ansible.module_utils.basic import AnsibleModule
193 from ansible.module_utils._text import to_native
194 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
195 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
196 from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
197 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
198
199
200 class NetAppONTAPClusterPeer:
201 """
202 Class with cluster peer methods
203 """
204
205 def __init__(self):
206
207 self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
208 self.argument_spec.update(dict(
209 state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
210 source_intercluster_lifs=dict(required=False, type='list', elements='str', aliases=['source_intercluster_lif']),
211 dest_intercluster_lifs=dict(required=False, type='list', elements='str', aliases=['dest_intercluster_lif']),
212 passphrase=dict(required=False, type='str', no_log=True),
213 peer_options=dict(type='dict', options=netapp_utils.na_ontap_host_argument_spec_peer()),
214 dest_hostname=dict(required=False, type='str'),
215 dest_username=dict(required=False, type='str'),
216 dest_password=dict(required=False, type='str', no_log=True),
217 source_cluster_name=dict(required=False, type='str'),
218 dest_cluster_name=dict(required=False, type='str'),
219 ipspace=dict(required=False, type='str'),
220 encryption_protocol_proposed=dict(required=False, type='str', choices=['tls_psk', 'none']),
221 local_name_for_peer=dict(required=False, type='str'),
222 local_name_for_source=dict(required=False, type='str'),
223 ))
224 self.argument_spec.update(netapp_utils.na_ontap_lambda_argument_spec())
225 # Add Lambda support to peer_options
226 self.argument_spec['peer_options']['options'].update(netapp_utils.na_ontap_lambda_argument_spec())
227 self.module = AnsibleModule(
228 argument_spec=self.argument_spec,
229 mutually_exclusive=[
230 ['peer_options', 'dest_hostname'],
231 ['peer_options', 'dest_username'],
232 ['peer_options', 'dest_password']
233 ],
234 required_one_of=[['peer_options', 'dest_hostname']],
235 required_if=[
236 ('state', 'absent', ['source_cluster_name', 'dest_cluster_name']),
237 ('state', 'present', ['source_intercluster_lifs', 'dest_intercluster_lifs']),
238 ('use_lambda', True, ['lambda_config',])
239 ],
240 supports_check_mode=True
241 )
242 self.generated_passphrase = None
243 self.na_helper = NetAppModule()
244 self.parameters = self.na_helper.set_parameters(self.module.params)
245 # set peer server connection
246 if self.parameters.get('dest_hostname') is not None:
247 # if dest_hostname is present, peer_options is absent
248 self.parameters['peer_options'] = dict(
249 hostname=self.parameters.get('dest_hostname'),
250 username=self.parameters.get('dest_username'),
251 password=self.parameters.get('dest_password'),
252 )
253 netapp_utils.setup_host_options_from_module_params(
254 self.parameters['peer_options'], self.module,
255 netapp_utils.na_ontap_host_argument_spec_peer().keys())
256 self.use_rest = False
257 self.rest_api = OntapRestAPI(self.module)
258 self.src_use_rest = self.rest_api.is_rest()
259 self.dst_rest_api = OntapRestAPI(self.module, host_options=self.parameters['peer_options'])
260 self.dst_use_rest = self.dst_rest_api.is_rest()
261 self.use_rest = bool(self.src_use_rest and self.dst_use_rest)
262 if not self.use_rest:
263 if self.parameters.get('use_lambda'):
264 self.module.fail_json(msg="Error: AWS Lambda proxy for ONTAP APIs is only supported with REST.")
265 if not netapp_utils.has_netapp_lib():
266 self.module.fail_json(msg="the python NetApp-Lib module is required")
267 self.server = netapp_utils.setup_na_ontap_zapi(module=self.module)
268 self.dest_server = netapp_utils.setup_na_ontap_zapi(module=self.module, host_options=self.parameters['peer_options'])
269
270 def cluster_peer_get_iter(self, cluster):
271 """
272 Compose NaElement object to query current source cluster using peer-cluster-name and peer-addresses parameters
273 :param cluster: type of cluster (source or destination)
274 :return: NaElement object for cluster-get-iter with query
275 """
276 cluster_peer_get = netapp_utils.zapi.NaElement('cluster-peer-get-iter')
277 query = netapp_utils.zapi.NaElement('query')
278 cluster_peer_info = netapp_utils.zapi.NaElement('cluster-peer-info')
279 peer_lifs, peer_cluster = self.get_peer_lifs_cluster_keys(cluster)
280 if self.parameters.get(peer_lifs):
281 peer_addresses = netapp_utils.zapi.NaElement('peer-addresses')
282 for peer in self.parameters.get(peer_lifs):
283 peer_addresses.add_new_child('remote-inet-address', peer)
284 cluster_peer_info.add_child_elem(peer_addresses)
285 if self.parameters.get(peer_cluster):
286 cluster_peer_info.add_new_child('cluster-name', self.parameters[peer_cluster])
287 query.add_child_elem(cluster_peer_info)
288 cluster_peer_get.add_child_elem(query)
289 return cluster_peer_get
290
291 def cluster_peer_get(self, cluster):
292 """
293 Get current cluster peer info
294 :param cluster: type of cluster (source or destination)
295 :return: Dictionary of current cluster peer details if query successful, else return None
296 """
297 if self.use_rest:
298 return self.cluster_peer_get_rest(cluster)
299 cluster_peer_get_iter = self.cluster_peer_get_iter(cluster)
300 result, cluster_info = None, dict()
301 if cluster == 'source':
302 server = self.server
303 else:
304 server = self.dest_server
305 try:
306 result = server.invoke_successfully(cluster_peer_get_iter, enable_tunneling=True)
307 except netapp_utils.zapi.NaApiError as error:
308 self.module.fail_json(msg='Error fetching cluster peer %s: %s'
309 % (cluster, to_native(error)),
310 exception=traceback.format_exc())
311 # return cluster peer details
312 if result.get_child_by_name('num-records') and \
313 int(result.get_child_content('num-records')) >= 1:
314 cluster_peer_info = result.get_child_by_name('attributes-list').get_child_by_name('cluster-peer-info')
315 cluster_info['cluster_name'] = cluster_peer_info.get_child_content('cluster-name')
316 peers = cluster_peer_info.get_child_by_name('peer-addresses')
317 cluster_info['peer-addresses'] = [peer.get_content() for peer in peers.get_children()]
318 return cluster_info
319 return None
320
321 def get_peer_lifs_cluster_keys(self, cluster):
322 if cluster == 'source':
323 return 'dest_intercluster_lifs', 'dest_cluster_name'
324 return 'source_intercluster_lifs', 'source_cluster_name'
325
326 def cluster_peer_get_rest(self, cluster):
327 api = 'cluster/peers'
328 fields = 'remote,name'
329 restapi = self.rest_api if cluster == 'source' else self.dst_rest_api
330 records, error = rest_generic.get_0_or_more_records(restapi, api, None, fields)
331 if error:
332 self.module.fail_json(msg=error)
333 cluster_info = {}
334 if records is not None:
335 peer_lifs, peer_cluster = self.get_peer_lifs_cluster_keys(cluster)
336 for record in records:
337 if 'remote' in record:
338 peer_cluster_exist, peer_addresses_exist = False, False
339 # check peer lif or peer cluster present in each peer cluster data in current.
340 # if peer-lifs not present in parameters, use peer_cluster to filter desired cluster peer in current.
341 if self.parameters.get(peer_lifs) is not None:
342 peer_addresses_exist = set(self.parameters[peer_lifs]) == set(record['remote']['ip_addresses'])
343 if self.parameters.get(peer_cluster) is not None:
344 peer_cluster_exist = self.parameters[peer_cluster] == record['remote']['name']
345 if peer_addresses_exist or peer_cluster_exist:
346 cluster_info['cluster_name'] = record['remote']['name']
347 cluster_info['peer-addresses'] = record['remote']['ip_addresses']
348 cluster_info['uuid'] = record['uuid']
349 cluster_info['local_name_for_peer'] = record['name']
350 return cluster_info
351 return None
352
353 def cluster_peer_delete(self, cluster, uuid=None):
354 """
355 Delete a cluster peer on source or destination
356 For source cluster, peer cluster-name = destination cluster name and vice-versa
357 :param cluster: type of cluster (source or destination)
358 :return:
359 """
360 if self.use_rest:
361 return self.cluster_peer_delete_rest(cluster, uuid)
362 if cluster == 'source':
363 server, peer_cluster_name = self.server, self.parameters['dest_cluster_name']
364 else:
365 server, peer_cluster_name = self.dest_server, self.parameters['source_cluster_name']
366 cluster_peer_delete = netapp_utils.zapi.NaElement.create_node_with_children(
367 'cluster-peer-delete', **{'cluster-name': peer_cluster_name})
368 try:
369 server.invoke_successfully(cluster_peer_delete, enable_tunneling=True)
370 except netapp_utils.zapi.NaApiError as error:
371 self.module.fail_json(msg='Error deleting cluster peer %s: %s'
372 % (peer_cluster_name, to_native(error)),
373 exception=traceback.format_exc())
374
375 def cluster_peer_delete_rest(self, cluster, uuid):
376 server = self.rest_api if cluster == 'source' else self.dst_rest_api
377 dummy, error = rest_generic.delete_async(server, 'cluster/peers', uuid)
378 if error:
379 self.module.fail_json(msg=error)
380
381 def cluster_peer_create(self, cluster):
382 """
383 Create a cluster peer on source or destination
384 For source cluster, peer addresses = destination inter-cluster LIFs and vice-versa
385 :param cluster: type of cluster (source or destination)
386 :return: None
387 """
388 if self.use_rest:
389 return self.cluster_peer_create_rest(cluster)
390 cluster_peer_create = netapp_utils.zapi.NaElement.create_node_with_children('cluster-peer-create')
391 if self.parameters.get('passphrase') is not None:
392 cluster_peer_create.add_new_child('passphrase', self.parameters['passphrase'])
393 peer_addresses = netapp_utils.zapi.NaElement('peer-addresses')
394 server, peer_address = self.get_server_and_peer_address(cluster)
395 for each in peer_address:
396 peer_addresses.add_new_child('remote-inet-address', each)
397 cluster_peer_create.add_child_elem(peer_addresses)
398 if self.parameters.get('encryption_protocol_proposed') is not None:
399 cluster_peer_create.add_new_child('encryption-protocol-proposed', self.parameters['encryption_protocol_proposed'])
400 if self.parameters.get('ipspace') is not None:
401 cluster_peer_create.add_new_child('ipspace-name', self.parameters['ipspace'])
402
403 try:
404 server.invoke_successfully(cluster_peer_create, enable_tunneling=True)
405 except netapp_utils.zapi.NaApiError as error:
406 self.module.fail_json(msg='Error creating cluster peer %s: %s'
407 % (peer_address, to_native(error)),
408 exception=traceback.format_exc())
409
410 def get_server_and_peer_address(self, cluster):
411 if cluster == 'source':
412 server = self.rest_api if self.use_rest else self.server
413 return server, self.parameters['dest_intercluster_lifs']
414 server = self.dst_rest_api if self.use_rest else self.dest_server
415 return server, self.parameters['source_intercluster_lifs']
416
417 def cluster_peer_create_rest(self, cluster):
418 api = 'cluster/peers'
419 body = {}
420 if self.parameters.get('passphrase') is not None:
421 body['authentication.passphrase'] = self.parameters['passphrase']
422 # generate passphrase in source if passphrase not provided.
423 elif cluster == 'source':
424 body['authentication.generate_passphrase'] = True
425 if 'local_name_for_peer' in self.parameters:
426 body['name'] = self.parameters['local_name_for_peer']
427 elif cluster == 'destination':
428 body['authentication.passphrase'] = self.generated_passphrase
429 if 'local_name_for_source' in self.parameters:
430 body['name'] = self.parameters['local_name_for_source']
431 server, peer_address = self.get_server_and_peer_address(cluster)
432 body['remote.ip_addresses'] = peer_address
433 if self.parameters.get('encryption_protocol_proposed') is not None:
434 body['encryption.proposed'] = self.parameters['encryption_protocol_proposed']
435 else:
436 # Default value for encryption.proposed is tls_psk.
437 # explicitly set to none if encryption_protocol_proposed options not present in parameters.
438 body['encryption.proposed'] = 'none'
439 if self.parameters.get('ipspace') is not None:
440 body['ipspace.name'] = self.parameters['ipspace']
441 response, error = rest_generic.post_async(server, api, body)
442 if error:
443 self.module.fail_json(msg=error)
444 if response and cluster == 'source' and 'passphrase' not in self.parameters:
445 for record in response['records']:
446 self.generated_passphrase = record['authentication']['passphrase']
447
448 def cluster_peer_modify_rest(self, cluster, uuid, modified_peer_addresses=None, local_name=None, current_name=None):
449 api = 'cluster/peers'
450 body = {}
451 if modified_peer_addresses:
452 body['remote.ip_addresses'] = modified_peer_addresses
453 if local_name and local_name != current_name:
454 body['name'] = local_name
455 server = self.rest_api if cluster == 'source' else self.dst_rest_api
456 dummy, error = rest_generic.patch_async(server, api, uuid, body)
457 if error:
458 self.module.fail_json(msg=error)
459
460 def apply(self):
461 """
462 Apply action to cluster peer
463 :return: None
464 """
465 modify = {}
466 source = self.cluster_peer_get('source')
467 destination = self.cluster_peer_get('destination')
468 source_action = self.na_helper.get_cd_action(source, self.parameters)
469 destination_action = self.na_helper.get_cd_action(destination, self.parameters)
470 self.na_helper.changed = False
471
472 # create only if expected cluster peer relation is not present on both source and destination clusters
473 # will error out with appropriate message if peer relationship already exists on either cluster
474 if source_action == 'create' and destination_action == 'create':
475 if not self.module.check_mode:
476 self.cluster_peer_create('source')
477 self.cluster_peer_create('destination')
478 self.na_helper.changed = True
479 # check and modify IP addresses of the logical interfaces used in peer relation
480 # on either source or destination cluster
481 elif self.use_rest and (source_action is None or destination_action is None):
482 source_changed, destination_changed = False, False
483 if source_action is None:
484 if destination_action == 'create' and self.parameters.get('source_cluster_name') is None:
485 self.module.fail_json(msg='Following option is missing: source_cluster_name')
486 if not self.module.check_mode:
487 if source:
488 peer_address_diff = set(source.get('peer-addresses', [])) != set(self.parameters.get('dest_intercluster_lifs', []))
489 local_name_diff = (
490 self.parameters.get('local_name_for_peer') and
491 source.get('local_name_for_peer') != self.parameters.get('local_name_for_peer')
492 )
493 if peer_address_diff or local_name_diff:
494 source_changed = True
495 uuid = source['uuid']
496 modified_peer_addresses = self.parameters['dest_intercluster_lifs'] if peer_address_diff else None
497 current_name = source.get('local_name_for_peer')
498 local_name = self.parameters.get('local_name_for_peer') if local_name_diff else None
499 self.cluster_peer_modify_rest('source', uuid, modified_peer_addresses, local_name, current_name)
500 if peer_address_diff:
501 modify['dest_intercluster_lifs'] = self.parameters['dest_intercluster_lifs']
502 if local_name_diff:
503 modify['local_name_for_peer'] = self.parameters['local_name_for_peer']
504 if destination_action is None:
505 if source_action == 'create' and self.parameters.get('dest_cluster_name') is None:
506 self.module.fail_json(msg='Following option is missing: dest_cluster_name')
507 if not self.module.check_mode:
508 if destination:
509 peer_address_diff = set(destination.get('peer-addresses', [])) != set(self.parameters.get('source_intercluster_lifs', []))
510 local_name_diff = (
511 self.parameters.get('local_name_for_source') and
512 destination.get('local_name_for_peer') != self.parameters.get('local_name_for_source')
513 )
514 if peer_address_diff or local_name_diff:
515 destination_changed = True
516 uuid = destination['uuid']
517 modified_peer_addresses = self.parameters['source_intercluster_lifs'] if peer_address_diff else None
518 local_name = self.parameters.get('local_name_for_source') if local_name_diff else None
519 self.cluster_peer_modify_rest('destination', uuid, modified_peer_addresses, local_name)
520 if peer_address_diff:
521 modify['source_intercluster_lifs'] = self.parameters['source_intercluster_lifs']
522 if local_name_diff:
523 modify['local_name_for_peer'] = self.parameters['local_name_for_source']
524 self.na_helper.changed = source_changed | destination_changed
525 # delete peer relation in cluster where relation is present
526 else:
527 if source_action == 'delete':
528 if not self.module.check_mode:
529 uuid = source['uuid'] if source and self.use_rest else None
530 self.cluster_peer_delete('source', uuid)
531 self.na_helper.changed = True
532 if destination_action == 'delete':
533 if not self.module.check_mode:
534 uuid = destination['uuid'] if destination and self.use_rest else None
535 self.cluster_peer_delete('destination', uuid)
536 self.na_helper.changed = True
537
538 result = netapp_utils.generate_result(self.na_helper.changed, modify=modify, extra_responses={'source_action': source_action,
539 'destination_action': destination_action})
540 self.module.exit_json(**result)
541
542
543 def main():
544 """
545 Execute action
546 :return: None
547 """
548 cluster_peer_obj = NetAppONTAPClusterPeer()
549 cluster_peer_obj.apply()
550
551
552 if __name__ == '__main__':
553 main()