Debian Codegraph @

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

raw
1 #!/usr/bin/python
2 """
3 (c) 2020-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 from __future__ import absolute_import, division, print_function
8 __metaclass__ = type
9
10 ANSIBLE_METADATA = {
11 'metadata_version': '1.1',
12 'status': ['preview'],
13 'supported_by': 'community'
14 }
15
16 DOCUMENTATION = '''
17 module: na_ontap_metrocluster
18 short_description: NetApp ONTAP set up a MetroCluster
19 extends_documentation_fragment:
20 - netapp.ontap.netapp.na_ontap_rest
21 version_added: '20.9.0'
22 author: NetApp Ansible Team (@carchi8py) <[email protected]>
23 requirements:
24 - ONTAP >= 9.8
25
26 description:
27 - Configure MetroCluster.
28 options:
29 state:
30 choices: ['present']
31 description:
32 - Present to set up a MetroCluster
33 default: present
34 type: str
35 dr_pairs:
36 description: disaster recovery pair
37 type: list
38 required: true
39 elements: dict
40 suboptions:
41 node_name:
42 description:
43 - the name of the main node
44 required: true
45 type: str
46 partner_node_name:
47 description:
48 - the name of the main partner node
49 required: true
50 type: str
51 partner_cluster_name:
52 description:
53 - The name of the partner Cluster
54 required: true
55 type: str
56 '''
57
58 EXAMPLES = '''
59 - name: Create MetroCluster
60 netapp.ontap.na_ontap_metrocluster:
61 dr_pairs:
62 - partner_node_name: rha17-a2
63 node_name: rha17-b2
64 partner_cluster_name: rha2-b2b1_siteB
65 hostname: "{{ netapp_hostname }}"
66 username: "{{ netapp_username }}"
67 password: "{{ netapp_password }}"
68 https: true
69 validate_certs: false
70 '''
71
72 RETURN = '''
73 '''
74
75 from ansible.module_utils.basic import AnsibleModule
76 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
77 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
78 from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
79
80 HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
81
82
83 class NetAppONTAPMetroCluster(object):
84 ''' ONTAP metrocluster operations '''
85 def __init__(self):
86 self.argument_spec = netapp_utils.na_ontap_rest_only_spec()
87 self.argument_spec.update(dict(
88 state=dict(choices=['present'], default='present'),
89 dr_pairs=dict(required=True, type='list', elements='dict', options=dict(
90 node_name=dict(required=True, type='str'),
91 partner_node_name=dict(required=True, type='str')
92 )),
93 partner_cluster_name=dict(required=True, type='str')
94 ))
95 self.module = AnsibleModule(
96 argument_spec=self.argument_spec,
97 supports_check_mode=True
98 )
99 self.na_helper = NetAppModule()
100 self.parameters = self.na_helper.set_parameters(self.module.params)
101 self.rest_api = OntapRestAPI(self.module)
102 self.use_rest = self.rest_api.is_rest()
103
104 if not self.use_rest:
105 self.module.fail_json(msg=self.rest_api.requires_ontap_9_6('na_ontap_metrocluster'))
106
107 def get_metrocluster(self):
108 attrs = None
109 api = 'cluster/metrocluster'
110 options = {'fields': '*'}
111 message, error = self.rest_api.get(api, options)
112 if error:
113 self.module.fail_json(msg=error)
114 if message is not None:
115 local = message['local']
116 if local['configuration_state'] != "not_configured":
117 attrs = {
118 'configuration_state': local['configuration_state'],
119 'partner_cluster_reachable': local['partner_cluster_reachable'],
120 'partner_cluster_name': local['cluster']['name']
121 }
122 return attrs
123
124 def create_metrocluster(self):
125 api = 'cluster/metrocluster'
126 options = {}
127 dr_pairs = []
128 for pair in self.parameters['dr_pairs']:
129 dr_pairs.append({'node': {'name': pair['node_name']},
130 'partner': {'name': pair['partner_node_name']}})
131 partner_cluster = {'name': self.parameters['partner_cluster_name']}
132 data = {'dr_pairs': dr_pairs, 'partner_cluster': partner_cluster}
133 message, error = self.rest_api.post(api, data, options)
134 if error is not None:
135 self.module.fail_json(msg="%s" % error)
136 message, error = self.rest_api.wait_on_job(message['job'])
137 if error:
138 self.module.fail_json(msg="%s" % error)
139
140 def apply(self):
141 current = self.get_metrocluster()
142 cd_action = self.na_helper.get_cd_action(current, self.parameters)
143 if self.na_helper.changed:
144 if self.module.check_mode:
145 pass
146 else:
147 if cd_action == 'create':
148 self.create_metrocluster()
149 # Since there is no modify or delete, we will return no change
150 else:
151 self.module.fail_json(msg="Modify and Delete currently not support in API")
152 result = netapp_utils.generate_result(self.na_helper.changed, cd_action)
153 self.module.exit_json(**result)
154
155
156 def main():
157 obj = NetAppONTAPMetroCluster()
158 obj.apply()
159
160
161 if __name__ == '__main__':
162 main()