| 1 |
#!/usr/bin/python |
| 2 |
|
| 3 |
# (c) 2018-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 |
|
| 10 |
DOCUMENTATION = ''' |
| 11 |
--- |
| 12 |
|
| 13 |
module: na_ontap_ucadapter |
| 14 |
short_description: NetApp ONTAP UC adapter configuration |
| 15 |
extends_documentation_fragment: |
| 16 |
- netapp.ontap.netapp.na_ontap |
| 17 |
version_added: 2.6.0 |
| 18 |
author: NetApp Ansible Team (@carchi8py) <[email protected]> |
| 19 |
|
| 20 |
description: |
| 21 |
- modify the UC adapter mode and type taking pending type and mode into account. |
| 22 |
|
| 23 |
options: |
| 24 |
state: |
| 25 |
description: |
| 26 |
- Whether the specified adapter should exist. |
| 27 |
required: false |
| 28 |
choices: ['present'] |
| 29 |
default: 'present' |
| 30 |
type: str |
| 31 |
|
| 32 |
adapter_name: |
| 33 |
description: |
| 34 |
- Specifies the adapter name. |
| 35 |
required: true |
| 36 |
type: str |
| 37 |
|
| 38 |
node_name: |
| 39 |
description: |
| 40 |
- Specifies the adapter home node. |
| 41 |
required: true |
| 42 |
type: str |
| 43 |
|
| 44 |
mode: |
| 45 |
description: |
| 46 |
- Specifies the mode of the adapter. |
| 47 |
type: str |
| 48 |
|
| 49 |
type: |
| 50 |
description: |
| 51 |
- Specifies the fc4 type of the adapter. |
| 52 |
type: str |
| 53 |
|
| 54 |
pair_adapters: |
| 55 |
description: |
| 56 |
- Specifies the list of adapters which also need to be offline along with the current adapter during modifying. |
| 57 |
- If specified adapter works in a group or pair, the other adapters might also need to offline before modify the specified adapter. |
| 58 |
- The mode of pair_adapters are modified along with the adapter, the type of the pair_adapters are not modified. |
| 59 |
type: list |
| 60 |
elements: str |
| 61 |
version_added: '20.6.0' |
| 62 |
|
| 63 |
''' |
| 64 |
|
| 65 |
EXAMPLES = ''' |
| 66 |
- name: Modify adapter |
| 67 |
netapp.ontap.na_ontap_adapter: |
| 68 |
state: present |
| 69 |
adapter_name: 0e |
| 70 |
pair_adapters: 0f |
| 71 |
node_name: laurentn-vsim1 |
| 72 |
mode: fc |
| 73 |
type: target |
| 74 |
hostname: "{{ netapp_hostname }}" |
| 75 |
username: "{{ netapp_username }}" |
| 76 |
password: "{{ netapp_password }}" |
| 77 |
''' |
| 78 |
|
| 79 |
RETURN = ''' |
| 80 |
''' |
| 81 |
|
| 82 |
import traceback |
| 83 |
|
| 84 |
from ansible.module_utils.basic import AnsibleModule |
| 85 |
from ansible.module_utils._text import to_native |
| 86 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 87 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule |
| 88 |
from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic |
| 89 |
|
| 90 |
|
| 91 |
class NetAppOntapadapter: |
| 92 |
''' object to describe adapter info ''' |
| 93 |
|
| 94 |
def __init__(self): |
| 95 |
|
| 96 |
self.argument_spec = netapp_utils.na_ontap_host_argument_spec() |
| 97 |
self.argument_spec.update(dict( |
| 98 |
state=dict(required=False, choices=['present'], default='present', type='str'), |
| 99 |
adapter_name=dict(required=True, type='str'), |
| 100 |
node_name=dict(required=True, type='str'), |
| 101 |
mode=dict(required=False, type='str'), |
| 102 |
type=dict(required=False, type='str'), |
| 103 |
pair_adapters=dict(required=False, type='list', elements='str') |
| 104 |
)) |
| 105 |
|
| 106 |
self.module = AnsibleModule( |
| 107 |
argument_spec=self.argument_spec, |
| 108 |
supports_check_mode=True |
| 109 |
) |
| 110 |
self.adapters_uuids = {} |
| 111 |
self.na_helper = NetAppModule() |
| 112 |
self.parameters = self.na_helper.set_parameters(self.module.params) |
| 113 |
# Set up Rest API |
| 114 |
self.rest_api = netapp_utils.OntapRestAPI(self.module) |
| 115 |
self.use_rest = self.rest_api.is_rest() |
| 116 |
|
| 117 |
if not self.use_rest: |
| 118 |
if not netapp_utils.has_netapp_lib(): |
| 119 |
self.module.fail_json(msg=netapp_utils.netapp_lib_is_required()) |
| 120 |
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module) |
| 121 |
|
| 122 |
def get_adapter(self): |
| 123 |
""" |
| 124 |
Return details about the adapter |
| 125 |
:param: |
| 126 |
name : Name of the name of the adapter |
| 127 |
|
| 128 |
:return: Details about the adapter. None if not found. |
| 129 |
:rtype: dict |
| 130 |
""" |
| 131 |
if self.use_rest: |
| 132 |
return self.get_adapter_rest() |
| 133 |
adapter_info = netapp_utils.zapi.NaElement('ucm-adapter-get') |
| 134 |
adapter_info.add_new_child('adapter-name', self.parameters['adapter_name']) |
| 135 |
adapter_info.add_new_child('node-name', self.parameters['node_name']) |
| 136 |
try: |
| 137 |
result = self.server.invoke_successfully(adapter_info, True) |
| 138 |
except netapp_utils.zapi.NaApiError as error: |
| 139 |
self.module.fail_json(msg='Error fetching ucadapter details: %s: %s' |
| 140 |
% (self.parameters['node_name'], to_native(error)), |
| 141 |
exception=traceback.format_exc()) |
| 142 |
if result.get_child_by_name('attributes'): |
| 143 |
adapter_attributes = result.get_child_by_name('attributes').\ |
| 144 |
get_child_by_name('uc-adapter-info') |
| 145 |
return_value = { |
| 146 |
'mode': adapter_attributes.get_child_content('mode'), |
| 147 |
'pending-mode': adapter_attributes.get_child_content('pending-mode'), |
| 148 |
'type': adapter_attributes.get_child_content('fc4-type'), |
| 149 |
'pending-type': adapter_attributes.get_child_content('pending-fc4-type'), |
| 150 |
'status': adapter_attributes.get_child_content('status'), |
| 151 |
} |
| 152 |
return return_value |
| 153 |
return None |
| 154 |
|
| 155 |
def modify_adapter(self): |
| 156 |
""" |
| 157 |
Modify the adapter. |
| 158 |
""" |
| 159 |
if self.use_rest: |
| 160 |
return self.modify_adapter_rest() |
| 161 |
params = {'adapter-name': self.parameters['adapter_name'], |
| 162 |
'node-name': self.parameters['node_name']} |
| 163 |
if self.parameters.get('type') is not None: |
| 164 |
params['fc4-type'] = self.parameters['type'] |
| 165 |
if self.parameters.get('mode') is not None: |
| 166 |
params['mode'] = self.parameters['mode'] |
| 167 |
adapter_modify = netapp_utils.zapi.NaElement.create_node_with_children( |
| 168 |
'ucm-adapter-modify', ** params) |
| 169 |
try: |
| 170 |
self.server.invoke_successfully(adapter_modify, |
| 171 |
enable_tunneling=True) |
| 172 |
except netapp_utils.zapi.NaApiError as e: |
| 173 |
self.module.fail_json(msg='Error modifying adapter %s: %s' % (self.parameters['adapter_name'], to_native(e)), |
| 174 |
exception=traceback.format_exc()) |
| 175 |
|
| 176 |
def online_or_offline_adapter(self, status, adapter_name): |
| 177 |
""" |
| 178 |
Bring a Fibre Channel target adapter offline/online. |
| 179 |
""" |
| 180 |
if self.use_rest: |
| 181 |
return self.online_or_offline_adapter_rest(status, adapter_name) |
| 182 |
if status == 'down': |
| 183 |
adapter = netapp_utils.zapi.NaElement('fcp-adapter-config-down') |
| 184 |
elif status == 'up': |
| 185 |
adapter = netapp_utils.zapi.NaElement('fcp-adapter-config-up') |
| 186 |
adapter.add_new_child('fcp-adapter', adapter_name) |
| 187 |
adapter.add_new_child('node', self.parameters['node_name']) |
| 188 |
try: |
| 189 |
self.server.invoke_successfully(adapter, |
| 190 |
enable_tunneling=True) |
| 191 |
except netapp_utils.zapi.NaApiError as e: |
| 192 |
self.module.fail_json(msg='Error trying to %s fc-adapter %s: %s' % (status, adapter_name, to_native(e)), |
| 193 |
exception=traceback.format_exc()) |
| 194 |
|
| 195 |
def get_adapters_uuids(self): |
| 196 |
missing_adapters = [] |
| 197 |
adapters = [self.parameters['adapter_name']] + self.parameters.get('pair_adapters', []) |
| 198 |
for adapter in adapters: |
| 199 |
adapter_uuid = self.get_adapter_uuid(adapter) |
| 200 |
if adapter_uuid is None: |
| 201 |
missing_adapters.append(adapter) |
| 202 |
else: |
| 203 |
self.adapters_uuids[adapter] = adapter_uuid |
| 204 |
if missing_adapters: |
| 205 |
self.module.fail_json(msg="Error: Adapter(s) %s not exist" % (', ').join(missing_adapters)) |
| 206 |
|
| 207 |
def get_adapter_uuid(self, adapter): |
| 208 |
api = 'network/fc/ports' |
| 209 |
params = { |
| 210 |
'name': adapter, |
| 211 |
'node.name': self.parameters['node_name'], |
| 212 |
'fields': 'uuid' |
| 213 |
} |
| 214 |
record, error = rest_generic.get_one_record(self.rest_api, api, params) |
| 215 |
if error: |
| 216 |
self.module.fail_json(msg="Error fetching adapter %s uuid" % adapter) |
| 217 |
return record['uuid'] if record else None |
| 218 |
|
| 219 |
def get_adapter_rest(self): |
| 220 |
api = 'private/cli/ucadmin' |
| 221 |
params = { |
| 222 |
'node': self.parameters['node_name'], |
| 223 |
'adapter': self.parameters['adapter_name'], |
| 224 |
'fields': 'pending_mode,pending_type,current_mode,current_type,status_admin' |
| 225 |
} |
| 226 |
record, error = rest_generic.get_one_record(self.rest_api, api, params) |
| 227 |
if error: |
| 228 |
self.module.fail_json(msg='Error fetching ucadapter details: %s: %s' |
| 229 |
% (self.parameters['node_name'], to_native(error))) |
| 230 |
if record: |
| 231 |
return { |
| 232 |
'mode': self.na_helper.safe_get(record, ['current_mode']), |
| 233 |
'pending-mode': self.na_helper.safe_get(record, ['pending_mode']), |
| 234 |
'type': self.na_helper.safe_get(record, ['current_type']), |
| 235 |
'pending-type': self.na_helper.safe_get(record, ['pending_type']), |
| 236 |
'status': self.na_helper.safe_get(record, ['status_admin']) |
| 237 |
} |
| 238 |
return None |
| 239 |
|
| 240 |
def modify_adapter_rest(self): |
| 241 |
api = 'private/cli/ucadmin' |
| 242 |
query = { |
| 243 |
'node': self.parameters['node_name'], |
| 244 |
'adapter': self.parameters['adapter_name'] |
| 245 |
} |
| 246 |
body = {} |
| 247 |
if self.parameters.get('type') is not None: |
| 248 |
body['type'] = self.parameters['type'] |
| 249 |
if self.parameters.get('mode') is not None: |
| 250 |
body['mode'] = self.parameters['mode'] |
| 251 |
dummy, error = rest_generic.patch_async(self.rest_api, api, None, body, query) |
| 252 |
if error: |
| 253 |
self.module.fail_json(msg='Error modifying adapter %s: %s' % (self.parameters['adapter_name'], to_native(error))) |
| 254 |
|
| 255 |
def online_or_offline_adapter_rest(self, status, adapter_name): |
| 256 |
api = 'network/fc/ports' |
| 257 |
body = {'enabled': True if status == 'up' else False} |
| 258 |
dummy, error = rest_generic.patch_async(self.rest_api, api, self.adapters_uuids[adapter_name], body) |
| 259 |
if error: |
| 260 |
self.module.fail_json(msg='Error trying to %s fc-adapter %s: %s' % (status, adapter_name, to_native(error))) |
| 261 |
|
| 262 |
def apply(self): |
| 263 |
''' calling all adapter features ''' |
| 264 |
changed = False |
| 265 |
current = self.get_adapter() |
| 266 |
|
| 267 |
def need_to_change(expected, pending, current): |
| 268 |
if expected is None: |
| 269 |
return False |
| 270 |
elif pending is not None: |
| 271 |
return pending != expected |
| 272 |
elif current is not None: |
| 273 |
return current != expected |
| 274 |
return False |
| 275 |
|
| 276 |
if current: |
| 277 |
if self.parameters.get('type') is not None: |
| 278 |
changed = need_to_change(self.parameters['type'], current['pending-type'], current['type']) |
| 279 |
changed = changed or need_to_change(self.parameters.get('mode'), current['pending-mode'], current['mode']) |
| 280 |
if changed and self.use_rest: |
| 281 |
self.get_adapters_uuids() |
| 282 |
if changed and not self.module.check_mode: |
| 283 |
self.online_or_offline_adapter('down', self.parameters['adapter_name']) |
| 284 |
if self.parameters.get('pair_adapters') is not None: |
| 285 |
for adapter in self.parameters['pair_adapters']: |
| 286 |
self.online_or_offline_adapter('down', adapter) |
| 287 |
self.modify_adapter() |
| 288 |
self.online_or_offline_adapter('up', self.parameters['adapter_name']) |
| 289 |
if self.parameters.get('pair_adapters') is not None: |
| 290 |
for adapter in self.parameters['pair_adapters']: |
| 291 |
self.online_or_offline_adapter('up', adapter) |
| 292 |
|
| 293 |
self.module.exit_json(changed=changed) |
| 294 |
|
| 295 |
|
| 296 |
def main(): |
| 297 |
adapter = NetAppOntapadapter() |
| 298 |
adapter.apply() |
| 299 |
|
| 300 |
|
| 301 |
if __name__ == '__main__': |
| 302 |
main() |