| 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 |
from __future__ import absolute_import, division, print_function |
| 7 |
__metaclass__ = type |
| 8 |
|
| 9 |
DOCUMENTATION = """ |
| 10 |
module: na_ontap_storage_failover |
| 11 |
short_description: Enables or disables NetApp Ontap storage failover for a specified node |
| 12 |
extends_documentation_fragment: |
| 13 |
- netapp.ontap.netapp.na_ontap |
| 14 |
version_added: '21.3.0' |
| 15 |
author: NetApp Ansible Team (@carchi8py) <[email protected]> |
| 16 |
|
| 17 |
description: |
| 18 |
- Enable or disable storage failover |
| 19 |
|
| 20 |
options: |
| 21 |
|
| 22 |
state: |
| 23 |
description: |
| 24 |
- Whether storage failover should be enabled (present) or disabled (absent). |
| 25 |
choices: ['present', 'absent'] |
| 26 |
default: present |
| 27 |
type: str |
| 28 |
|
| 29 |
node_name: |
| 30 |
description: |
| 31 |
- Specifies the node name to enable or disable storage failover. |
| 32 |
required: true |
| 33 |
type: str |
| 34 |
|
| 35 |
""" |
| 36 |
|
| 37 |
EXAMPLES = """ |
| 38 |
- name: Enable storage failover |
| 39 |
netapp.ontap.na_ontap_storage_failover: |
| 40 |
state: present |
| 41 |
node_name: node1 |
| 42 |
hostname: "{{ netapp_hostname }}" |
| 43 |
username: "{{ netapp_username }}" |
| 44 |
password: "{{ netapp_password }}" |
| 45 |
|
| 46 |
- name: Disable storage failover |
| 47 |
netapp.ontap.na_ontap_storage_failover: |
| 48 |
state: absent |
| 49 |
node_name: node1 |
| 50 |
hostname: "{{ netapp_hostname }}" |
| 51 |
username: "{{ netapp_username }}" |
| 52 |
password: "{{ netapp_password }}" |
| 53 |
""" |
| 54 |
|
| 55 |
RETURN = """ |
| 56 |
""" |
| 57 |
|
| 58 |
import traceback |
| 59 |
from ansible.module_utils.basic import AnsibleModule |
| 60 |
from ansible.module_utils._text import to_native |
| 61 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 62 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule |
| 63 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI |
| 64 |
from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic |
| 65 |
|
| 66 |
|
| 67 |
class NetAppOntapStorageFailover: |
| 68 |
""" |
| 69 |
Enable or disable storage failover for a specified node |
| 70 |
""" |
| 71 |
def __init__(self): |
| 72 |
""" |
| 73 |
Initialize the Ontap Storage failover class |
| 74 |
""" |
| 75 |
|
| 76 |
self.argument_spec = netapp_utils.na_ontap_host_argument_spec() |
| 77 |
self.argument_spec.update(dict( |
| 78 |
state=dict(required=False, choices=['present', 'absent'], default='present'), |
| 79 |
node_name=dict(required=True, type='str'), |
| 80 |
)) |
| 81 |
|
| 82 |
self.module = AnsibleModule( |
| 83 |
argument_spec=self.argument_spec, |
| 84 |
supports_check_mode=True |
| 85 |
) |
| 86 |
|
| 87 |
# set up variables |
| 88 |
self.na_helper = NetAppModule() |
| 89 |
self.parameters = self.na_helper.set_parameters(self.module.params) |
| 90 |
|
| 91 |
self.parameters['is_enabled'] = self.parameters['state'] == 'present' |
| 92 |
self.rest_api = OntapRestAPI(self.module) |
| 93 |
self.use_rest = self.rest_api.is_rest() |
| 94 |
|
| 95 |
if not self.use_rest: |
| 96 |
if not netapp_utils.has_netapp_lib(): |
| 97 |
self.module.fail_json(msg=netapp_utils.netapp_lib_is_required()) |
| 98 |
else: |
| 99 |
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module) |
| 100 |
|
| 101 |
def get_node_names(self): |
| 102 |
api = "cluster/nodes" |
| 103 |
records, error = rest_generic.get_0_or_more_records(self.rest_api, api, fields='name') |
| 104 |
if records and not error: |
| 105 |
records = [record['name'] for record in records] |
| 106 |
return records, error |
| 107 |
|
| 108 |
def get_node_names_as_str(self): |
| 109 |
names, error = self.get_node_names() |
| 110 |
if error: |
| 111 |
return 'failed to get list of nodes: %s' % error |
| 112 |
if names: |
| 113 |
return 'current nodes: %s' % ', '.join(names) |
| 114 |
return 'could not get node names' |
| 115 |
|
| 116 |
def get_storage_failover(self): |
| 117 |
""" |
| 118 |
get the storage failover for a given node |
| 119 |
:return: dict of is-enabled: true if enabled is true None if not |
| 120 |
""" |
| 121 |
|
| 122 |
if self.use_rest: |
| 123 |
return_value = None |
| 124 |
api = "cluster/nodes" |
| 125 |
query = { |
| 126 |
'fields': 'uuid,ha.enabled', |
| 127 |
'name': self.parameters['node_name'] |
| 128 |
} |
| 129 |
record, error = rest_generic.get_one_record(self.rest_api, api, query) |
| 130 |
|
| 131 |
if error: |
| 132 |
self.module.fail_json(msg=error) |
| 133 |
|
| 134 |
if not record: |
| 135 |
msg = self.get_node_names_as_str() |
| 136 |
error = "REST API did not return failover details for node %s, %s" % (self.parameters['node_name'], msg) |
| 137 |
self.module.fail_json(msg=error) |
| 138 |
|
| 139 |
return_value = {'uuid': record['uuid']} |
| 140 |
if 'ha' in record: |
| 141 |
return_value['is_enabled'] = record['ha']['enabled'] |
| 142 |
|
| 143 |
else: |
| 144 |
storage_failover_get_iter = netapp_utils.zapi.NaElement('cf-status') |
| 145 |
storage_failover_get_iter.add_new_child('node', self.parameters['node_name']) |
| 146 |
|
| 147 |
try: |
| 148 |
result = self.server.invoke_successfully(storage_failover_get_iter, True) |
| 149 |
return_value = {'is_enabled': self.na_helper.get_value_for_bool(True, result.get_child_content('is-enabled'))} |
| 150 |
|
| 151 |
except netapp_utils.zapi.NaApiError as error: |
| 152 |
self.module.fail_json(msg='Error getting storage failover info for node %s: %s' % ( |
| 153 |
self.parameters['node_name'], to_native(error)), exception=traceback.format_exc()) |
| 154 |
|
| 155 |
return return_value |
| 156 |
|
| 157 |
def modify_storage_failover(self, current): |
| 158 |
""" |
| 159 |
Modifies storage failover for a specified node |
| 160 |
""" |
| 161 |
|
| 162 |
if self.use_rest: |
| 163 |
api = "cluster/nodes" |
| 164 |
body = {'ha': {'enabled': self.parameters['is_enabled']}} |
| 165 |
dummy, error = rest_generic.patch_async(self.rest_api, api, current['uuid'], body) |
| 166 |
if error: |
| 167 |
self.module.fail_json(msg=error) |
| 168 |
|
| 169 |
else: |
| 170 |
|
| 171 |
if self.parameters['state'] == 'present': |
| 172 |
cf_service = 'cf-service-enable' |
| 173 |
else: |
| 174 |
cf_service = 'cf-service-disable' |
| 175 |
|
| 176 |
storage_failover_modify = netapp_utils.zapi.NaElement(cf_service) |
| 177 |
storage_failover_modify.add_new_child('node', self.parameters['node_name']) |
| 178 |
|
| 179 |
try: |
| 180 |
self.server.invoke_successfully(storage_failover_modify, True) |
| 181 |
except netapp_utils.zapi.NaApiError as error: |
| 182 |
self.module.fail_json(msg='Error modifying storage failover for node %s: %s' % ( |
| 183 |
self.parameters['node_name'], to_native(error)), exception=traceback.format_exc()) |
| 184 |
|
| 185 |
def apply(self): |
| 186 |
current = self.get_storage_failover() |
| 187 |
self.na_helper.get_modified_attributes(current, self.parameters) |
| 188 |
if self.parameters['is_enabled'] and 'is_enabled' not in current: |
| 189 |
self.module.fail_json(msg='HA is not available on node: %s.' % self.parameters['node_name']) |
| 190 |
|
| 191 |
if self.na_helper.changed and not self.module.check_mode: |
| 192 |
self.modify_storage_failover(current) |
| 193 |
self.module.exit_json(changed=self.na_helper.changed) |
| 194 |
|
| 195 |
|
| 196 |
def main(): |
| 197 |
""" |
| 198 |
Enables or disables NetApp Ontap storage failover for a specified node |
| 199 |
""" |
| 200 |
|
| 201 |
obj = NetAppOntapStorageFailover() |
| 202 |
obj.apply() |
| 203 |
|
| 204 |
|
| 205 |
if __name__ == '__main__': |
| 206 |
main() |