| 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 |
''' |
| 7 |
na_ontap_broadcast_domain |
| 8 |
''' |
| 9 |
from __future__ import absolute_import, division, print_function |
| 10 |
__metaclass__ = type |
| 11 |
|
| 12 |
|
| 13 |
DOCUMENTATION = ''' |
| 14 |
module: na_ontap_broadcast_domain |
| 15 |
short_description: NetApp ONTAP manage broadcast domains. |
| 16 |
extends_documentation_fragment: |
| 17 |
- netapp.ontap.netapp.na_ontap |
| 18 |
version_added: 2.6.0 |
| 19 |
author: NetApp Ansible Team (@carchi8py) <[email protected]> |
| 20 |
description: |
| 21 |
- Modify a ONTAP broadcast domain. |
| 22 |
options: |
| 23 |
state: |
| 24 |
description: |
| 25 |
- Whether the specified broadcast domain should exist or not. |
| 26 |
choices: ['present', 'absent'] |
| 27 |
type: str |
| 28 |
default: present |
| 29 |
name: |
| 30 |
description: |
| 31 |
- Specify the broadcast domain name. |
| 32 |
required: true |
| 33 |
aliases: |
| 34 |
- broadcast_domain |
| 35 |
type: str |
| 36 |
from_name: |
| 37 |
description: |
| 38 |
- Specify the broadcast domain name to be split into new broadcast domain. |
| 39 |
version_added: 2.8.0 |
| 40 |
type: str |
| 41 |
mtu: |
| 42 |
description: |
| 43 |
- Specify the required mtu for the broadcast domain. |
| 44 |
type: int |
| 45 |
ipspace: |
| 46 |
description: |
| 47 |
- Specify the required ipspace for the broadcast domain. |
| 48 |
- With ZAPI, a domain ipspace cannot be modified after the domain has been created. |
| 49 |
- With REST, a domain ipspace can be modified. |
| 50 |
- This option is required while using REST. |
| 51 |
type: str |
| 52 |
from_ipspace: |
| 53 |
description: |
| 54 |
- if used with C(from_name), it will try to find broadcast domain C(from_name) in C(from_ipspace), split action either rename broadcast_domain and |
| 55 |
ipspace or create a new broadcast domain. |
| 56 |
- If not C(from_name) present, it will try to find C(name) broadcast domain in C(from_ipspace) and modify ipspace using C(ipspace). |
| 57 |
- Only supported with REST. |
| 58 |
version_added: 2.15.0 |
| 59 |
type: str |
| 60 |
ports: |
| 61 |
description: |
| 62 |
- Specify the ports associated with this broadcast domain. Should be comma separated. |
| 63 |
- It represents the expected state of a list of ports at any time. |
| 64 |
- Add a port if it is specified in expected state but not in current state. |
| 65 |
- Delete a port if it is specified in current state but not in expected state. |
| 66 |
- For split action, it represents the ports to be split from current broadcast domain and added to the new broadcast domain. |
| 67 |
- If all ports are removed or split from a broadcast domain, the broadcast domain will be deleted automatically. |
| 68 |
- With REST, if exact match of ports found with C(from_name), split action will rename the broadcast domain using C(name). |
| 69 |
- With REST, if partial match of ports with C(from_name), split action will create a new broadcast domain using C(name) and |
| 70 |
move partial matched ports from C(from_name) to C(name). |
| 71 |
- With REST, if C(ports) not in C(from_name), split action will create a new broadcast domain using C(name) with C(ports). |
| 72 |
type: list |
| 73 |
elements: str |
| 74 |
''' |
| 75 |
|
| 76 |
EXAMPLES = """ |
| 77 |
- name: Create broadcast domain |
| 78 |
netapp.ontap.na_ontap_broadcast_domain: |
| 79 |
state: present |
| 80 |
username: "{{ netapp_username }}" |
| 81 |
password: "{{ netapp_password }}" |
| 82 |
hostname: "{{ netapp_hostname }}" |
| 83 |
name: ansible_domain |
| 84 |
mtu: 1000 |
| 85 |
ipspace: Default |
| 86 |
ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13"] |
| 87 |
- name: Modify broadcast domain |
| 88 |
netapp.ontap.na_ontap_broadcast_domain: |
| 89 |
state: present |
| 90 |
username: "{{ netapp_username }}" |
| 91 |
password: "{{ netapp_password }}" |
| 92 |
hostname: "{{ netapp_hostname }}" |
| 93 |
name: ansible_domain |
| 94 |
mtu: 1100 |
| 95 |
ipspace: Default |
| 96 |
ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13"] |
| 97 |
- name: Split broadcast domain |
| 98 |
netapp.ontap.na_ontap_broadcast_domain: |
| 99 |
state: present |
| 100 |
username: "{{ netapp_username }}" |
| 101 |
password: "{{ netapp_password }}" |
| 102 |
hostname: "{{ netapp_hostname }}" |
| 103 |
from_name: ansible_domain |
| 104 |
name: new_ansible_domain |
| 105 |
mtu: 1200 |
| 106 |
ipspace: Default |
| 107 |
ports: khutton-vsim1:e0d-12 |
| 108 |
- name: Delete broadcast domain |
| 109 |
netapp.ontap.na_ontap_broadcast_domain: |
| 110 |
state: absent |
| 111 |
username: "{{ netapp_username }}" |
| 112 |
password: "{{ netapp_password }}" |
| 113 |
hostname: "{{ netapp_hostname }}" |
| 114 |
name: ansible_domain |
| 115 |
ipspace: Default |
| 116 |
- name: Create broadcast domain REST |
| 117 |
netapp.ontap.na_ontap_broadcast_domain: |
| 118 |
state: present |
| 119 |
username: "{{ netapp_username }}" |
| 120 |
password: "{{ netapp_password }}" |
| 121 |
hostname: "{{ netapp_hostname }}" |
| 122 |
name: ansible_domain |
| 123 |
mtu: 1200 |
| 124 |
ipspace: Default |
| 125 |
ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13", "khutton-vsim1:e0d-14"] |
| 126 |
- name: Rename broadcast domain if exact match of ports REST |
| 127 |
netapp.ontap.na_ontap_broadcast_domain: |
| 128 |
state: present |
| 129 |
username: "{{ netapp_username }}" |
| 130 |
password: "{{ netapp_password }}" |
| 131 |
hostname: "{{ netapp_hostname }}" |
| 132 |
from_name: ansible_domain |
| 133 |
name: new_ansible_domain |
| 134 |
mtu: 1200 |
| 135 |
ipspace: Default |
| 136 |
ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13", "khutton-vsim1:e0d-14"] |
| 137 |
- name: If partial match, remove e0d-12 from new_ansible_domain & create new domain ansible_domain with port e0d-12 REST |
| 138 |
netapp.ontap.na_ontap_broadcast_domain: |
| 139 |
state: present |
| 140 |
username: "{{ netapp_username }}" |
| 141 |
password: "{{ netapp_password }}" |
| 142 |
hostname: "{{ netapp_hostname }}" |
| 143 |
from_name: new_ansible_domain |
| 144 |
name: ansible_domain |
| 145 |
mtu: 1200 |
| 146 |
ipspace: Default |
| 147 |
ports: ["khutton-vsim1:e0d-12"] |
| 148 |
- name: Modify both broadcast domain and ipspace REST. |
| 149 |
netapp.ontap.na_ontap_broadcast_domain: |
| 150 |
state: present |
| 151 |
username: "{{ netapp_username }}" |
| 152 |
password: "{{ netapp_password }}" |
| 153 |
hostname: "{{ netapp_hostname }}" |
| 154 |
from_name: ansible_domain |
| 155 |
from_ipspace: Default |
| 156 |
name: ansible_domain_ip1 |
| 157 |
ipspace: ipspace_1 |
| 158 |
mtu: 1200 |
| 159 |
ports: ["khutton-vsim1:e0d-12"] |
| 160 |
- name: Modify ipspace only REST. |
| 161 |
netapp.ontap.na_ontap_broadcast_domain: |
| 162 |
state: present |
| 163 |
username: "{{ netapp_username }}" |
| 164 |
password: "{{ netapp_password }}" |
| 165 |
hostname: "{{ netapp_hostname }}" |
| 166 |
from_ipspace: ipspace_1 |
| 167 |
name: ansible_domain_ip1 |
| 168 |
ipspace: Default |
| 169 |
mtu: 1200 |
| 170 |
ports: ["khutton-vsim1:e0d-12"] |
| 171 |
- name: Delete broadcast domain new_ansible_domain. |
| 172 |
netapp.ontap.na_ontap_broadcast_domain: |
| 173 |
state: absent |
| 174 |
username: "{{ netapp_username }}" |
| 175 |
password: "{{ netapp_password }}" |
| 176 |
hostname: "{{ netapp_hostname }}" |
| 177 |
name: new_ansible_domain |
| 178 |
mtu: 1200 |
| 179 |
ipspace: Default |
| 180 |
ports: ["khutton-vsim1:e0d-13", "khutton-vsim1:e0d-14"] |
| 181 |
""" |
| 182 |
|
| 183 |
RETURN = """ |
| 184 |
|
| 185 |
|
| 186 |
""" |
| 187 |
import traceback |
| 188 |
|
| 189 |
from ansible.module_utils.basic import AnsibleModule |
| 190 |
from ansible.module_utils._text import to_native |
| 191 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 192 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule |
| 193 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI |
| 194 |
from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic |
| 195 |
|
| 196 |
|
| 197 |
class NetAppOntapBroadcastDomain(object): |
| 198 |
""" |
| 199 |
Create, Modifies and Destroys a Broadcast domain |
| 200 |
""" |
| 201 |
def __init__(self): |
| 202 |
""" |
| 203 |
Initialize the ONTAP Broadcast Domain class |
| 204 |
""" |
| 205 |
self.argument_spec = netapp_utils.na_ontap_host_argument_spec() |
| 206 |
self.argument_spec.update(dict( |
| 207 |
state=dict(required=False, type='str', choices=['present', 'absent'], default='present'), |
| 208 |
name=dict(required=True, type='str', aliases=["broadcast_domain"]), |
| 209 |
ipspace=dict(required=False, type='str'), |
| 210 |
mtu=dict(required=False, type='int'), |
| 211 |
ports=dict(required=False, type='list', elements='str'), |
| 212 |
from_name=dict(required=False, type='str'), |
| 213 |
from_ipspace=dict(required=False, type='str') |
| 214 |
)) |
| 215 |
|
| 216 |
self.module = AnsibleModule( |
| 217 |
argument_spec=self.argument_spec, |
| 218 |
supports_check_mode=True |
| 219 |
) |
| 220 |
self.na_helper = NetAppModule() |
| 221 |
self.parameters = self.na_helper.set_parameters(self.module.params) |
| 222 |
|
| 223 |
# Set up Rest API |
| 224 |
self.rest_api = OntapRestAPI(self.module) |
| 225 |
self.use_rest = self.rest_api.is_rest() |
| 226 |
self.desired_ports = None |
| 227 |
|
| 228 |
if self.use_rest and 'ipspace' not in self.parameters: |
| 229 |
error_msg = "Error: ipspace space is a required option with REST" |
| 230 |
self.module.fail_json(msg=error_msg) |
| 231 |
|
| 232 |
if 'ports' in self.parameters: |
| 233 |
self.parameters['ports'] = list(set([port.strip() for port in self.parameters['ports']])) |
| 234 |
if self.use_rest: |
| 235 |
self.desired_ports = self.get_ports_rest(self.parameters['ports']) |
| 236 |
|
| 237 |
if not self.use_rest: |
| 238 |
if not netapp_utils.has_netapp_lib(): |
| 239 |
self.module.fail_json(msg=netapp_utils.netapp_lib_is_required()) |
| 240 |
else: |
| 241 |
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module) |
| 242 |
if 'from_ipspace' in self.parameters: |
| 243 |
self.parameters.pop('from_ipspace') |
| 244 |
self.module.warn("from_ipspace is ignored when ZAPI is used.") |
| 245 |
|
| 246 |
def get_broadcast_domain(self, broadcast_domain=None, ipspace=None): |
| 247 |
""" |
| 248 |
Return details about the broadcast domain |
| 249 |
:param broadcast_domain: specific broadcast domain to get. |
| 250 |
:return: Details about the broadcast domain. None if not found. |
| 251 |
:rtype: dict |
| 252 |
""" |
| 253 |
if broadcast_domain is None: |
| 254 |
broadcast_domain = self.parameters['name'] |
| 255 |
if ipspace is None: |
| 256 |
# unlike rest, ipspace is not mandatory field for zapi. |
| 257 |
ipspace = self.parameters.get('ipspace') |
| 258 |
if self.use_rest: |
| 259 |
return self.get_broadcast_domain_rest(broadcast_domain, ipspace) |
| 260 |
domain_get_iter = netapp_utils.zapi.NaElement('net-port-broadcast-domain-get-iter') |
| 261 |
broadcast_domain_info = netapp_utils.zapi.NaElement('net-port-broadcast-domain-info') |
| 262 |
broadcast_domain_info.add_new_child('broadcast-domain', broadcast_domain) |
| 263 |
if ipspace: |
| 264 |
broadcast_domain_info.add_new_child('ipspace', ipspace) |
| 265 |
query = netapp_utils.zapi.NaElement('query') |
| 266 |
query.add_child_elem(broadcast_domain_info) |
| 267 |
domain_get_iter.add_child_elem(query) |
| 268 |
result = self.server.invoke_successfully(domain_get_iter, True) |
| 269 |
domain_exists = None |
| 270 |
# check if broadcast_domain exists |
| 271 |
if result.get_child_by_name('num-records') and \ |
| 272 |
int(result.get_child_content('num-records')) == 1: |
| 273 |
domain_info = result.get_child_by_name('attributes-list').\ |
| 274 |
get_child_by_name('net-port-broadcast-domain-info') |
| 275 |
domain_name = domain_info.get_child_content('broadcast-domain') |
| 276 |
domain_mtu = domain_info.get_child_content('mtu') |
| 277 |
domain_ipspace = domain_info.get_child_content('ipspace') |
| 278 |
domain_ports = domain_info.get_child_by_name('ports') |
| 279 |
if domain_ports is not None: |
| 280 |
ports = [port.get_child_content('port') for port in domain_ports.get_children()] |
| 281 |
else: |
| 282 |
ports = [] |
| 283 |
domain_exists = { |
| 284 |
'domain-name': domain_name, |
| 285 |
'mtu': int(domain_mtu), |
| 286 |
'ipspace': domain_ipspace, |
| 287 |
'ports': ports |
| 288 |
} |
| 289 |
return domain_exists |
| 290 |
|
| 291 |
def get_broadcast_domain_rest(self, broadcast_domain, ipspace): |
| 292 |
api = 'network/ethernet/broadcast-domains' |
| 293 |
query = {'name': broadcast_domain, 'ipspace.name': ipspace} |
| 294 |
fields = 'uuid,name,ipspace,ports,mtu' |
| 295 |
record, error = rest_generic.get_one_record(self.rest_api, api, query, fields) |
| 296 |
if error: |
| 297 |
self.module.fail_json(msg=error) |
| 298 |
if record: |
| 299 |
current = { |
| 300 |
'name': record['name'], |
| 301 |
'mtu': record['mtu'], |
| 302 |
'ipspace': record['ipspace']['name'], |
| 303 |
'uuid': record['uuid'], |
| 304 |
'ports': [] |
| 305 |
} |
| 306 |
if 'ports' in record: |
| 307 |
current['ports'] = ['%s:%s' % (port['node']['name'], port['name']) for port in record['ports']] |
| 308 |
return current |
| 309 |
return None |
| 310 |
|
| 311 |
def create_broadcast_domain(self, ports=None): |
| 312 |
""" |
| 313 |
Creates a new broadcast domain |
| 314 |
""" |
| 315 |
if self.use_rest: |
| 316 |
return self.create_broadcast_domain_rest(ports) |
| 317 |
domain_obj = netapp_utils.zapi.NaElement('net-port-broadcast-domain-create') |
| 318 |
domain_obj.add_new_child("broadcast-domain", self.parameters['name']) |
| 319 |
if self.parameters.get('ipspace'): |
| 320 |
domain_obj.add_new_child("ipspace", self.parameters['ipspace']) |
| 321 |
if self.parameters.get('mtu'): |
| 322 |
domain_obj.add_new_child("mtu", str(self.parameters['mtu'])) |
| 323 |
if self.parameters.get('ports'): |
| 324 |
ports_obj = netapp_utils.zapi.NaElement('ports') |
| 325 |
domain_obj.add_child_elem(ports_obj) |
| 326 |
for port in self.parameters['ports']: |
| 327 |
ports_obj.add_new_child('net-qualified-port-name', port) |
| 328 |
try: |
| 329 |
self.server.invoke_successfully(domain_obj, True) |
| 330 |
except netapp_utils.zapi.NaApiError as error: |
| 331 |
self.module.fail_json(msg='Error creating broadcast domain %s: %s' % |
| 332 |
(self.parameters['name'], to_native(error)), |
| 333 |
exception=traceback.format_exc()) |
| 334 |
|
| 335 |
def create_broadcast_domain_rest(self, ports=None): |
| 336 |
api = 'network/ethernet/broadcast-domains' |
| 337 |
body = { |
| 338 |
'name': self.parameters['name'], |
| 339 |
'mtu': self.parameters['mtu'], |
| 340 |
'ipspace': self.parameters['ipspace'] |
| 341 |
} |
| 342 |
dummy, error = rest_generic.post_async(self.rest_api, api, body) |
| 343 |
if error: |
| 344 |
self.module.fail_json(msg=error) |
| 345 |
if ports: |
| 346 |
self.add_or_move_broadcast_domain_ports_rest(ports) |
| 347 |
|
| 348 |
def delete_broadcast_domain(self, broadcast_domain=None, current=None): |
| 349 |
""" |
| 350 |
Deletes a broadcast domain |
| 351 |
""" |
| 352 |
if self.use_rest: |
| 353 |
# all ports should be removed to delete broadcast domain in rest. |
| 354 |
if 'ports' in current: |
| 355 |
self.remove_broadcast_domain_ports_rest(current['ports'], current['ipspace']) |
| 356 |
api = 'network/ethernet/broadcast-domains' |
| 357 |
dummy, error = rest_generic.delete_async(self.rest_api, api, current['uuid']) |
| 358 |
if error: |
| 359 |
self.module.fail_json(msg=error) |
| 360 |
else: |
| 361 |
if broadcast_domain is None: |
| 362 |
broadcast_domain = self.parameters['name'] |
| 363 |
domain_obj = netapp_utils.zapi.NaElement('net-port-broadcast-domain-destroy') |
| 364 |
domain_obj.add_new_child("broadcast-domain", broadcast_domain) |
| 365 |
if self.parameters.get('ipspace'): |
| 366 |
domain_obj.add_new_child("ipspace", self.parameters['ipspace']) |
| 367 |
try: |
| 368 |
self.server.invoke_successfully(domain_obj, True) |
| 369 |
except netapp_utils.zapi.NaApiError as error: |
| 370 |
self.module.fail_json(msg='Error deleting broadcast domain %s: %s' % |
| 371 |
(broadcast_domain, to_native(error)), |
| 372 |
exception=traceback.format_exc()) |
| 373 |
|
| 374 |
def modify_broadcast_domain(self): |
| 375 |
""" |
| 376 |
Modifies ipspace and mtu options of a broadcast domain |
| 377 |
""" |
| 378 |
domain_obj = netapp_utils.zapi.NaElement('net-port-broadcast-domain-modify') |
| 379 |
domain_obj.add_new_child("broadcast-domain", self.parameters['name']) |
| 380 |
if self.parameters.get('mtu'): |
| 381 |
domain_obj.add_new_child("mtu", str(self.parameters['mtu'])) |
| 382 |
if self.parameters.get('ipspace'): |
| 383 |
domain_obj.add_new_child("ipspace", self.parameters['ipspace']) |
| 384 |
try: |
| 385 |
self.server.invoke_successfully(domain_obj, True) |
| 386 |
except netapp_utils.zapi.NaApiError as error: |
| 387 |
self.module.fail_json(msg='Error modifying broadcast domain %s: %s' % |
| 388 |
(self.parameters['name'], to_native(error)), |
| 389 |
exception=traceback.format_exc()) |
| 390 |
|
| 391 |
def split_broadcast_domain(self): |
| 392 |
""" |
| 393 |
split broadcast domain |
| 394 |
""" |
| 395 |
domain_obj = netapp_utils.zapi.NaElement('net-port-broadcast-domain-split') |
| 396 |
domain_obj.add_new_child("broadcast-domain", self.parameters['from_name']) |
| 397 |
domain_obj.add_new_child("new-broadcast-domain", self.parameters['name']) |
| 398 |
if self.parameters.get('ports'): |
| 399 |
ports_obj = netapp_utils.zapi.NaElement('ports') |
| 400 |
domain_obj.add_child_elem(ports_obj) |
| 401 |
for port in self.parameters['ports']: |
| 402 |
ports_obj.add_new_child('net-qualified-port-name', port) |
| 403 |
if self.parameters.get('ipspace'): |
| 404 |
domain_obj.add_new_child("ipspace", self.parameters['ipspace']) |
| 405 |
try: |
| 406 |
self.server.invoke_successfully(domain_obj, True) |
| 407 |
except netapp_utils.zapi.NaApiError as error: |
| 408 |
self.module.fail_json(msg='Error splitting broadcast domain %s: %s' % |
| 409 |
(self.parameters['name'], to_native(error)), |
| 410 |
exception=traceback.format_exc()) |
| 411 |
if len(self.get_broadcast_domain_ports(self.parameters['from_name'])) == 0: |
| 412 |
self.delete_broadcast_domain(self.parameters['from_name']) |
| 413 |
|
| 414 |
def modify_broadcast_domain_or_ports(self, modify, current=None): |
| 415 |
""" |
| 416 |
:param modify: modify attributes. |
| 417 |
""" |
| 418 |
modify_keys = list(modify.keys()) |
| 419 |
domain_modify_options = ['mtu', 'name', 'ipspace'] |
| 420 |
if any(x in modify_keys for x in domain_modify_options): |
| 421 |
if self.use_rest: |
| 422 |
if modify.get('ports'): |
| 423 |
del modify['ports'] |
| 424 |
self.modify_broadcast_domain_rest(current['uuid'], modify) |
| 425 |
# update current ipspace as it required in modifying ports later. |
| 426 |
if modify.get('ipspace'): |
| 427 |
current['ipspace'] = modify['ipspace'] |
| 428 |
else: |
| 429 |
self.modify_broadcast_domain() |
| 430 |
if 'ports' in modify_keys: |
| 431 |
self.modify_broadcast_domain_ports(current) |
| 432 |
|
| 433 |
def get_modify_attributes(self, current, split): |
| 434 |
""" |
| 435 |
:param current: current state. |
| 436 |
:param split: True or False of split action. |
| 437 |
:return: list of modified attributes. |
| 438 |
""" |
| 439 |
modify = None |
| 440 |
if self.parameters['state'] == 'present': |
| 441 |
# split already handled ipspace and ports. |
| 442 |
if self.parameters.get('from_name'): |
| 443 |
if split: |
| 444 |
modify = self.na_helper.get_modified_attributes(current, self.parameters) |
| 445 |
if modify.get('ports'): |
| 446 |
del modify['ports'] |
| 447 |
else: |
| 448 |
modify = self.na_helper.get_modified_attributes(current, self.parameters) |
| 449 |
return modify |
| 450 |
|
| 451 |
def modify_broadcast_domain_ports(self, current=None): |
| 452 |
""" |
| 453 |
compare current and desired ports. Call add or remove ports methods if needed. |
| 454 |
:return: None. |
| 455 |
""" |
| 456 |
if self.use_rest: |
| 457 |
current_ports = current['ports'] |
| 458 |
else: |
| 459 |
current_ports = self.get_broadcast_domain_ports() |
| 460 |
expect_ports = self.parameters['ports'] |
| 461 |
# if want to remove all ports, simply delete the broadcast domain. |
| 462 |
if len(expect_ports) == 0: |
| 463 |
self.delete_broadcast_domain(current=current) |
| 464 |
return |
| 465 |
ports_to_remove = list(set(current_ports) - set(expect_ports)) |
| 466 |
ports_to_add = list(set(expect_ports) - set(current_ports)) |
| 467 |
|
| 468 |
if len(ports_to_add) > 0: |
| 469 |
if self.use_rest: |
| 470 |
ports = self.get_ports_rest(ports_to_add) |
| 471 |
if ports: |
| 472 |
self.add_or_move_broadcast_domain_ports_rest(ports) |
| 473 |
else: |
| 474 |
self.add_broadcast_domain_ports(ports_to_add) |
| 475 |
|
| 476 |
if len(ports_to_remove) > 0: |
| 477 |
if self.use_rest: |
| 478 |
self.remove_broadcast_domain_ports_rest(ports_to_remove, current['ipspace']) |
| 479 |
else: |
| 480 |
self.delete_broadcast_domain_ports(ports_to_remove) |
| 481 |
|
| 482 |
def add_broadcast_domain_ports(self, ports): |
| 483 |
""" |
| 484 |
Creates new broadcast domain ports |
| 485 |
""" |
| 486 |
domain_obj = netapp_utils.zapi.NaElement('net-port-broadcast-domain-add-ports') |
| 487 |
domain_obj.add_new_child("broadcast-domain", self.parameters['name']) |
| 488 |
if self.parameters.get('ipspace'): |
| 489 |
domain_obj.add_new_child("ipspace", self.parameters['ipspace']) |
| 490 |
if ports: |
| 491 |
ports_obj = netapp_utils.zapi.NaElement('ports') |
| 492 |
domain_obj.add_child_elem(ports_obj) |
| 493 |
for port in ports: |
| 494 |
ports_obj.add_new_child('net-qualified-port-name', port) |
| 495 |
try: |
| 496 |
self.server.invoke_successfully(domain_obj, True) |
| 497 |
return True |
| 498 |
except netapp_utils.zapi.NaApiError as error: |
| 499 |
self.module.fail_json(msg='Error creating port for broadcast domain %s: %s' % |
| 500 |
(self.parameters['name'], to_native(error)), |
| 501 |
exception=traceback.format_exc()) |
| 502 |
|
| 503 |
def delete_broadcast_domain_ports(self, ports): |
| 504 |
""" |
| 505 |
Deletes broadcast domain ports |
| 506 |
:param: ports to be deleted. |
| 507 |
""" |
| 508 |
domain_obj = netapp_utils.zapi.NaElement('net-port-broadcast-domain-remove-ports') |
| 509 |
domain_obj.add_new_child("broadcast-domain", self.parameters['name']) |
| 510 |
if self.parameters.get('ipspace'): |
| 511 |
domain_obj.add_new_child("ipspace", self.parameters['ipspace']) |
| 512 |
if ports: |
| 513 |
ports_obj = netapp_utils.zapi.NaElement('ports') |
| 514 |
domain_obj.add_child_elem(ports_obj) |
| 515 |
for port in ports: |
| 516 |
ports_obj.add_new_child('net-qualified-port-name', port) |
| 517 |
try: |
| 518 |
self.server.invoke_successfully(domain_obj, True) |
| 519 |
return True |
| 520 |
except netapp_utils.zapi.NaApiError as error: |
| 521 |
self.module.fail_json(msg='Error deleting port for broadcast domain %s: %s' % |
| 522 |
(self.parameters['name'], to_native(error)), |
| 523 |
exception=traceback.format_exc()) |
| 524 |
|
| 525 |
def get_broadcast_domain_ports(self, broadcast_domain=None): |
| 526 |
""" |
| 527 |
Return details about the broadcast domain ports. |
| 528 |
:return: Details about the broadcast domain ports. None if not found. |
| 529 |
:rtype: list |
| 530 |
""" |
| 531 |
if broadcast_domain is None: |
| 532 |
broadcast_domain = self.parameters['name'] |
| 533 |
domain_get_iter = netapp_utils.zapi.NaElement('net-port-broadcast-domain-get-iter') |
| 534 |
broadcast_domain_info = netapp_utils.zapi.NaElement('net-port-broadcast-domain-info') |
| 535 |
broadcast_domain_info.add_new_child('broadcast-domain', broadcast_domain) |
| 536 |
if self.parameters.get('ipspace'): |
| 537 |
broadcast_domain_info.add_new_child('ipspace', self.parameters['ipspace']) |
| 538 |
query = netapp_utils.zapi.NaElement('query') |
| 539 |
query.add_child_elem(broadcast_domain_info) |
| 540 |
domain_get_iter.add_child_elem(query) |
| 541 |
result = self.server.invoke_successfully(domain_get_iter, True) |
| 542 |
ports = [] |
| 543 |
if result.get_child_by_name('num-records') and \ |
| 544 |
int(result.get_child_content('num-records')) == 1: |
| 545 |
domain_info = result.get_child_by_name('attributes-list').get_child_by_name('net-port-broadcast-domain-info') |
| 546 |
domain_ports = domain_info.get_child_by_name('ports') |
| 547 |
if domain_ports is not None: |
| 548 |
ports = [port.get_child_content('port') for port in domain_ports.get_children()] |
| 549 |
return ports |
| 550 |
|
| 551 |
def modify_broadcast_domain_rest(self, uuid, modify): |
| 552 |
api = 'network/ethernet/broadcast-domains' |
| 553 |
body = {} |
| 554 |
# rename broadcast domain. |
| 555 |
if 'name' in modify: |
| 556 |
body['name'] = modify['name'] |
| 557 |
if 'ipspace' in modify: |
| 558 |
body['ipspace.name'] = modify['ipspace'] |
| 559 |
if 'mtu' in modify: |
| 560 |
body['mtu'] = modify['mtu'] |
| 561 |
dummy, error = rest_generic.patch_async(self.rest_api, api, uuid, body) |
| 562 |
if error: |
| 563 |
self.module.fail_json(msg=error) |
| 564 |
|
| 565 |
def add_or_move_broadcast_domain_ports_rest(self, ports): |
| 566 |
api = 'network/ethernet/ports' |
| 567 |
body = { |
| 568 |
'broadcast_domain': { |
| 569 |
'name': self.parameters['name'], |
| 570 |
'ipspace': {'name': self.parameters['ipspace']} |
| 571 |
} |
| 572 |
} |
| 573 |
for port in ports: |
| 574 |
dummy, error = rest_generic.patch_async(self.rest_api, api, port['uuid'], body) |
| 575 |
if error: |
| 576 |
self.module.fail_json(msg=error) |
| 577 |
|
| 578 |
def remove_broadcast_domain_ports_rest(self, ports, ipspace): |
| 579 |
body = {'ports': ports} |
| 580 |
api = "private/cli/network/port/broadcast-domain/remove-ports" |
| 581 |
query = {'broadcast-domain': self.parameters['name'], 'ipspace': ipspace} |
| 582 |
response, error = rest_generic.patch_async(self.rest_api, api, None, body, query) |
| 583 |
if error: |
| 584 |
self.module.fail_json(msg='Error removing ports: %s' % error) |
| 585 |
|
| 586 |
def get_ports_rest(self, ports): |
| 587 |
# if desired ports with uuid present then return only the ports to add or move. |
| 588 |
if self.desired_ports: |
| 589 |
return self.ports_to_add_move_from_desired(ports) |
| 590 |
# list of desired ports not present in the node. |
| 591 |
missing_ports = [] |
| 592 |
# list of uuid information of each desired port should present in broadcast domain. |
| 593 |
desired_ports = [] |
| 594 |
for port in ports: |
| 595 |
current = self.get_net_port_rest(port) |
| 596 |
if current is None: |
| 597 |
missing_ports.append(port) |
| 598 |
else: |
| 599 |
desired_ports.append(current) |
| 600 |
# Error if any of provided ports are not found. |
| 601 |
if missing_ports and self.parameters['state'] == 'present': |
| 602 |
self.module.fail_json(msg='Error: ports: %s not found' % ', '.join(missing_ports)) |
| 603 |
return desired_ports |
| 604 |
|
| 605 |
def get_net_port_rest(self, port): |
| 606 |
if ':' not in port: |
| 607 |
error_msg = "Error: Invalid value specified for port: %s, provide port name as node_name:port_name" % port |
| 608 |
self.module.fail_json(msg=error_msg) |
| 609 |
port_name = port.split(':')[1] |
| 610 |
node = port.split(':')[0] |
| 611 |
api = 'network/ethernet/ports' |
| 612 |
query = { |
| 613 |
'name': port_name, |
| 614 |
'node.name': node, |
| 615 |
} |
| 616 |
fields = 'name,uuid' |
| 617 |
record, error = rest_generic.get_one_record(self.rest_api, api, query, fields) |
| 618 |
if error: |
| 619 |
self.module.fail_json(msg=error) |
| 620 |
if record: |
| 621 |
current = {'uuid': record['uuid'], 'name': record['name'], 'node': record['node']} |
| 622 |
return current |
| 623 |
return None |
| 624 |
|
| 625 |
def ports_to_add_move_from_desired(self, ports): |
| 626 |
ports_to_add_move = [] |
| 627 |
for port in ports: |
| 628 |
for port_to_add_or_move in self.desired_ports: |
| 629 |
if port == port_to_add_or_move['node']['name'] + ':' + port_to_add_or_move['name']: |
| 630 |
ports_to_add_move.append({'uuid': port_to_add_or_move['uuid']}) |
| 631 |
return ports_to_add_move |
| 632 |
|
| 633 |
def apply(self): |
| 634 |
""" |
| 635 |
Run Module based on play book |
| 636 |
""" |
| 637 |
current = self.get_broadcast_domain() |
| 638 |
cd_action, split = None, None |
| 639 |
cd_action = self.na_helper.get_cd_action(current, self.parameters) |
| 640 |
if cd_action == 'create' and any(self.parameters.get(attr) is not None for attr in ('from_name', 'from_ipspace')): |
| 641 |
# either create new domain or split domain, also ipspace can be modified. |
| 642 |
from_name = self.parameters.get('from_name', self.parameters['name']) |
| 643 |
from_ipspace = self.parameters.get('from_ipspace', self.parameters.get('ipspace')) |
| 644 |
from_current = self.get_broadcast_domain(from_name, from_ipspace) |
| 645 |
split = self.na_helper.is_rename_action(from_current, current) |
| 646 |
if split is None: |
| 647 |
self.module.fail_json(msg='A domain cannot be split if it does not exist.', |
| 648 |
exception=traceback.format_exc()) |
| 649 |
if split: |
| 650 |
cd_action = None |
| 651 |
current = from_current |
| 652 |
if self.use_rest: |
| 653 |
split = False |
| 654 |
# check for exact match of ports only if from_name present. |
| 655 |
if self.parameters.get('from_name'): |
| 656 |
# rename with no change in ports. |
| 657 |
if 'ports' not in self.parameters: |
| 658 |
self.parameters['ports'] = from_current['ports'] |
| 659 |
partial_match = set(from_current['ports']) - set(self.parameters['ports']) |
| 660 |
# create new broadcast domain with desired ports (REST will move them over from the other domain if necessary) |
| 661 |
if partial_match: |
| 662 |
cd_action = 'create' |
| 663 |
current = None |
| 664 |
# rename with no change in ports. |
| 665 |
else: |
| 666 |
self.parameters.pop('from_name') |
| 667 |
modify = self.get_modify_attributes(current, split) if cd_action is None else {} |
| 668 |
if self.na_helper.changed and not self.module.check_mode: |
| 669 |
if split: |
| 670 |
self.split_broadcast_domain() |
| 671 |
if cd_action == 'create': |
| 672 |
self.create_broadcast_domain(self.desired_ports) |
| 673 |
elif cd_action == 'delete': |
| 674 |
self.delete_broadcast_domain(current=current) |
| 675 |
elif modify: |
| 676 |
self.modify_broadcast_domain_or_ports(modify, current) |
| 677 |
result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify) |
| 678 |
self.module.exit_json(**result) |
| 679 |
|
| 680 |
|
| 681 |
def main(): |
| 682 |
""" |
| 683 |
Creates the NetApp ONTAP Broadcast Domain Object that can be created, deleted and modified. |
| 684 |
""" |
| 685 |
obj = NetAppOntapBroadcastDomain() |
| 686 |
obj.apply() |
| 687 |
|
| 688 |
|
| 689 |
if __name__ == '__main__': |
| 690 |
main() |