| 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 |
|
| 9 |
__metaclass__ = type |
| 10 |
|
| 11 |
ANSIBLE_METADATA = { |
| 12 |
'metadata_version': '1.1', |
| 13 |
'status': ['preview'], |
| 14 |
'supported_by': 'community' |
| 15 |
} |
| 16 |
|
| 17 |
DOCUMENTATION = ''' |
| 18 |
module: na_ontap_metrocluster_dr_group |
| 19 |
short_description: NetApp ONTAP manage MetroCluster DR Group |
| 20 |
extends_documentation_fragment: |
| 21 |
- netapp.ontap.netapp.na_ontap_rest |
| 22 |
version_added: 20.11.0 |
| 23 |
author: NetApp Ansible Team (@carchi8py) <[email protected]> |
| 24 |
requirements: |
| 25 |
- ONTAP >= 9.8 |
| 26 |
description: |
| 27 |
- Create/Delete MetroCluster DR Group |
| 28 |
- Create only supports MCC IP |
| 29 |
- Delete supports both MCC IP and MCC FC |
| 30 |
options: |
| 31 |
state: |
| 32 |
choices: ['present', 'absent'] |
| 33 |
description: |
| 34 |
add or remove DR groups |
| 35 |
default: present |
| 36 |
type: str |
| 37 |
dr_pairs: |
| 38 |
description: disaster recovery pairs |
| 39 |
type: list |
| 40 |
required: true |
| 41 |
elements: dict |
| 42 |
suboptions: |
| 43 |
node_name: |
| 44 |
description: |
| 45 |
- the name of the main node |
| 46 |
required: true |
| 47 |
type: str |
| 48 |
partner_node_name: |
| 49 |
description: |
| 50 |
- the name of the main partner node |
| 51 |
required: true |
| 52 |
type: str |
| 53 |
partner_cluster_name: |
| 54 |
description: |
| 55 |
- The name of the partner cluster |
| 56 |
required: true |
| 57 |
type: str |
| 58 |
''' |
| 59 |
|
| 60 |
EXAMPLES = ''' |
| 61 |
- name: Create MetroCluster DR group |
| 62 |
netapp.ontap.na_ontap_metrocluster_dr_group: |
| 63 |
dr_pairs: |
| 64 |
- partner_name: carchi_cluster3_01 |
| 65 |
node_name: carchi_cluster1_01 |
| 66 |
partner_cluster_name: carchi_cluster3 |
| 67 |
hostname: "{{ netapp_hostname }}" |
| 68 |
username: "{{ netapp_username }}" |
| 69 |
password: "{{ netapp_password }}" |
| 70 |
https: true |
| 71 |
validate_certs: false |
| 72 |
|
| 73 |
- name: Delete MetroCluster DR group |
| 74 |
netapp.ontap.na_ontap_metrocluster_dr_group: |
| 75 |
dr_pairs: |
| 76 |
- partner_name: carchi_cluster3_01 |
| 77 |
node_name: carchi_cluster1_01 |
| 78 |
state: absent |
| 79 |
partner_cluster_name: carchi_cluster3 |
| 80 |
hostname: "{{ netapp_hostname }}" |
| 81 |
username: "{{ netapp_username }}" |
| 82 |
password: "{{ netapp_password }}" |
| 83 |
https: true |
| 84 |
validate_certs: false |
| 85 |
''' |
| 86 |
|
| 87 |
RETURN = ''' |
| 88 |
''' |
| 89 |
|
| 90 |
from ansible.module_utils.basic import AnsibleModule |
| 91 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 92 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule |
| 93 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI |
| 94 |
|
| 95 |
|
| 96 |
class NetAppONTAPMetroClusterDRGroup(object): |
| 97 |
def __init__(self): |
| 98 |
self.argument_spec = netapp_utils.na_ontap_rest_only_spec() |
| 99 |
self.argument_spec.update(dict( |
| 100 |
state=dict(choices=['present', 'absent'], default='present'), |
| 101 |
dr_pairs=dict(required=True, type='list', elements='dict', options=dict( |
| 102 |
node_name=dict(required=True, type='str'), |
| 103 |
partner_node_name=dict(required=True, type='str') |
| 104 |
)), |
| 105 |
partner_cluster_name=dict(required=True, type='str') |
| 106 |
)) |
| 107 |
self.module = AnsibleModule( |
| 108 |
argument_spec=self.argument_spec, |
| 109 |
supports_check_mode=True |
| 110 |
) |
| 111 |
self.na_helper = NetAppModule() |
| 112 |
self.parameters = self.na_helper.set_parameters(self.module.params) |
| 113 |
self.rest_api = OntapRestAPI(self.module) |
| 114 |
self.use_rest = self.rest_api.is_rest() |
| 115 |
|
| 116 |
if not self.use_rest: |
| 117 |
self.module.fail_json(msg=self.rest_api.requires_ontap_version('na_ontap_metrocluster_dr_group', |
| 118 |
version='9.8')) |
| 119 |
|
| 120 |
def get_dr_group(self): |
| 121 |
return_attrs = None |
| 122 |
for pair in self.parameters['dr_pairs']: |
| 123 |
api = 'cluster/metrocluster/dr-groups' |
| 124 |
options = {'fields': '*', |
| 125 |
'dr_pairs.node.name': pair['node_name'], |
| 126 |
'dr_pairs.partner.name': pair['partner_node_name'], |
| 127 |
'partner_cluster.name': self.parameters['partner_cluster_name']} |
| 128 |
message, error = self.rest_api.get(api, options) |
| 129 |
if error: |
| 130 |
self.module.fail_json(msg=error) |
| 131 |
if 'records' in message and message['num_records'] == 0: |
| 132 |
continue |
| 133 |
elif 'records' not in message or message['num_records'] != 1: |
| 134 |
error = "Unexpected response from %s: %s" % (api, repr(message)) |
| 135 |
self.module.fail_json(msg=error) |
| 136 |
record = message['records'][0] |
| 137 |
return_attrs = { |
| 138 |
'partner_cluster_name': record['partner_cluster']['name'], |
| 139 |
'dr_pairs': [], |
| 140 |
'id': record['id'] |
| 141 |
} |
| 142 |
for dr_pair in record['dr_pairs']: |
| 143 |
return_attrs['dr_pairs'].append({'node_name': dr_pair['node']['name'], 'partner_node_name': dr_pair['partner']['name']}) |
| 144 |
# if we have an return_dr_id we don't need to loop anymore |
| 145 |
break |
| 146 |
return return_attrs |
| 147 |
|
| 148 |
def get_dr_group_ids_from_nodes(self): |
| 149 |
delete_ids = [] |
| 150 |
for pair in self.parameters['dr_pairs']: |
| 151 |
api = 'cluster/metrocluster/nodes' |
| 152 |
options = {'fields': '*', |
| 153 |
'node.name': pair['node_name']} |
| 154 |
message, error = self.rest_api.get(api, options) |
| 155 |
if error: |
| 156 |
self.module.fail_json(msg=error) |
| 157 |
if 'records' in message and message['num_records'] == 0: |
| 158 |
continue |
| 159 |
elif 'records' not in message or message['num_records'] != 1: |
| 160 |
error = "Unexpected response from %s: %s" % (api, repr(message)) |
| 161 |
self.module.fail_json(msg=error) |
| 162 |
record = message['records'][0] |
| 163 |
if int(record['dr_group_id']) not in delete_ids: |
| 164 |
delete_ids.append(int(record['dr_group_id'])) |
| 165 |
return delete_ids |
| 166 |
|
| 167 |
def create_dr_group(self): |
| 168 |
api = 'cluster/metrocluster/dr-groups' |
| 169 |
dr_pairs = [] |
| 170 |
for pair in self.parameters['dr_pairs']: |
| 171 |
dr_pairs.append({'node': {'name': pair['node_name']}, |
| 172 |
'partner': {'name': pair['partner_node_name']}}) |
| 173 |
partner_cluster = {'name': self.parameters['partner_cluster_name']} |
| 174 |
data = {'dr_pairs': dr_pairs, 'partner_cluster': partner_cluster} |
| 175 |
message, error = self.rest_api.post(api, data) |
| 176 |
if error is not None: |
| 177 |
self.module.fail_json(msg="%s" % error) |
| 178 |
message, error = self.rest_api.wait_on_job(message['job']) |
| 179 |
if error: |
| 180 |
self.module.fail_json(msg="%s" % error) |
| 181 |
|
| 182 |
def delete_dr_groups(self, dr_ids): |
| 183 |
for dr_id in dr_ids: |
| 184 |
api = 'cluster/metrocluster/dr-groups/' + str(dr_id) |
| 185 |
message, error = self.rest_api.delete(api) |
| 186 |
if error: |
| 187 |
self.module.fail_json(msg=error) |
| 188 |
message, error = self.rest_api.wait_on_job(message['job']) |
| 189 |
if error: |
| 190 |
self.module.fail_json(msg="%s" % error) |
| 191 |
|
| 192 |
def apply(self): |
| 193 |
current = self.get_dr_group() |
| 194 |
delete_ids = None |
| 195 |
cd_action = self.na_helper.get_cd_action(current, self.parameters) |
| 196 |
if cd_action is None and current is None and self.parameters['state'] == 'absent': |
| 197 |
# check if there is some FC group to delete |
| 198 |
delete_ids = self.get_dr_group_ids_from_nodes() |
| 199 |
if delete_ids: |
| 200 |
cd_action = 'delete' |
| 201 |
self.na_helper.changed = True |
| 202 |
elif cd_action == 'delete': |
| 203 |
delete_ids = [current['id']] |
| 204 |
if cd_action and not self.module.check_mode: |
| 205 |
if cd_action == 'create': |
| 206 |
self.create_dr_group() |
| 207 |
if cd_action == 'delete': |
| 208 |
self.delete_dr_groups(delete_ids) |
| 209 |
result = netapp_utils.generate_result(self.na_helper.changed, cd_action) |
| 210 |
self.module.exit_json(**result) |
| 211 |
|
| 212 |
|
| 213 |
def main(): |
| 214 |
obj = NetAppONTAPMetroClusterDRGroup() |
| 215 |
obj.apply() |
| 216 |
|
| 217 |
|
| 218 |
if __name__ == '__main__': |
| 219 |
main() |