Bug fixes for ontap_broadcast_domain_ports.py (#44180)

This commit is contained in:
Chris Archibald 2018-08-17 14:37:03 -07:00 committed by John R Barker
commit 4abfbe06c4

View file

@ -12,24 +12,19 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = ''' DOCUMENTATION = '''
module: na_ontap_broadcast_domain_ports module: na_ontap_broadcast_domain_ports
short_description: Manage NetApp Ontap broadcast domain ports short_description: Manage NetApp ONTAP broadcast domain ports
extends_documentation_fragment: extends_documentation_fragment:
- netapp.na_ontap - netapp.na_ontap
version_added: '2.6' version_added: '2.6'
author: author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
- Chris Archibald (carchi@netapp.com), Kevin Hutton (khutton@netapp.com), Suhas Bangalore Shekar (bsuhas@netapp.com)
description: description:
- Modify Ontap broadcast domain ports - Add or remove ONTAP broadcast domain ports. Existing ports that are not listed are kept.
options: options:
state: state:
description: description:
- Whether the specified broadcast domain should exist or not. - Whether the specified broadcast domain should exist or not.
choices: ['present', 'absent'] choices: ['present', 'absent']
default: present default: present
vserver:
description:
- The name of the vserver
required: true
broadcast_domain: broadcast_domain:
description: description:
- Specify the broadcast_domain name - Specify the broadcast_domain name
@ -39,7 +34,7 @@ options:
- Specify the ipspace for the broadcast domain - Specify the ipspace for the broadcast domain
ports: ports:
description: description:
- Specify the list of ports associated with this broadcast domain. - Specify the list of ports to add to or remove from this broadcast domain.
''' '''
@ -47,7 +42,6 @@ EXAMPLES = """
- name: create broadcast domain ports - name: create broadcast domain ports
na_ontap_broadcast_domain_ports: na_ontap_broadcast_domain_ports:
state=present state=present
vserver={{ Vserver name }}
username={{ netapp_username }} username={{ netapp_username }}
password={{ netapp_password }} password={{ netapp_password }}
hostname={{ netapp_hostname }} hostname={{ netapp_hostname }}
@ -56,7 +50,6 @@ EXAMPLES = """
- name: delete broadcast domain ports - name: delete broadcast domain ports
na_ontap_broadcast_domain_ports: na_ontap_broadcast_domain_ports:
state=absent state=absent
vserver={{ Vserver name }}
username={{ netapp_username }} username={{ netapp_username }}
password={{ netapp_password }} password={{ netapp_password }}
hostname={{ netapp_hostname }} hostname={{ netapp_hostname }}
@ -88,7 +81,6 @@ class NetAppOntapBroadcastDomainPorts(object):
self.argument_spec = netapp_utils.na_ontap_host_argument_spec() self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
self.argument_spec.update(dict( self.argument_spec.update(dict(
state=dict(required=False, choices=['present', 'absent'], default='present'), state=dict(required=False, choices=['present', 'absent'], default='present'),
vserver=dict(required=False, type='str'),
broadcast_domain=dict(required=True, type='str'), broadcast_domain=dict(required=True, type='str'),
ipspace=dict(required=False, type='str', default=None), ipspace=dict(required=False, type='str', default=None),
ports=dict(required=True, type='list'), ports=dict(required=True, type='list'),
@ -98,12 +90,9 @@ class NetAppOntapBroadcastDomainPorts(object):
argument_spec=self.argument_spec, argument_spec=self.argument_spec,
supports_check_mode=True supports_check_mode=True
) )
parameters = self.module.params parameters = self.module.params
# set up state variables # set up state variables
self.state = parameters['state'] self.state = parameters['state']
self.vserver = parameters['vserver']
self.broadcast_domain = parameters['broadcast_domain'] self.broadcast_domain = parameters['broadcast_domain']
self.ipspace = parameters['ipspace'] self.ipspace = parameters['ipspace']
self.ports = parameters['ports'] self.ports = parameters['ports']
@ -135,14 +124,18 @@ class NetAppOntapBroadcastDomainPorts(object):
int(result.get_child_content('num-records')) == 1: int(result.get_child_content('num-records')) == 1:
domain_info = result.get_child_by_name('attributes-list').get_child_by_name('net-port-broadcast-domain-info') domain_info = result.get_child_by_name('attributes-list').get_child_by_name('net-port-broadcast-domain-info')
domain_name = domain_info.get_child_content('broadcast-domain') domain_name = domain_info.get_child_content('broadcast-domain')
domain_ports = domain_info.get_child_content('port-info') domain_ports = domain_info.get_child_by_name('ports')
if domain_ports is not None:
ports = [port.get_child_content('port') for port in domain_ports.get_children()]
else:
ports = []
domain_exists = { domain_exists = {
'domain-name': domain_name, 'domain-name': domain_name,
'ports': domain_ports 'ports': ports
} }
return domain_exists return domain_exists
def create_broadcast_domain_ports(self): def create_broadcast_domain_ports(self, ports):
""" """
Creates new broadcast domain ports Creates new broadcast domain ports
""" """
@ -150,24 +143,20 @@ class NetAppOntapBroadcastDomainPorts(object):
domain_obj.add_new_child("broadcast-domain", self.broadcast_domain) domain_obj.add_new_child("broadcast-domain", self.broadcast_domain)
if self.ipspace: if self.ipspace:
domain_obj.add_new_child("ipspace", self.ipspace) domain_obj.add_new_child("ipspace", self.ipspace)
if self.ports: if ports:
ports_obj = netapp_utils.zapi.NaElement('ports') ports_obj = netapp_utils.zapi.NaElement('ports')
domain_obj.add_child_elem(ports_obj) domain_obj.add_child_elem(ports_obj)
for port in self.ports: for port in ports:
ports_obj.add_new_child('net-qualified-port-name', port) ports_obj.add_new_child('net-qualified-port-name', port)
try: try:
self.server.invoke_successfully(domain_obj, True) self.server.invoke_successfully(domain_obj, True)
return True return True
except netapp_utils.zapi.NaApiError as error: except netapp_utils.zapi.NaApiError as error:
# Error 18605 denotes port already being used. self.module.fail_json(msg='Error creating port for broadcast domain %s: %s' %
if to_native(error.code) == "18605": (self.broadcast_domain, to_native(error)),
return False exception=traceback.format_exc())
else:
self.module.fail_json(msg='Error creating port for broadcast domain %s: %s' %
(self.broadcast_domain, to_native(error)),
exception=traceback.format_exc())
def delete_broadcast_domain_ports(self): def delete_broadcast_domain_ports(self, ports):
""" """
Deletes broadcast domain ports Deletes broadcast domain ports
""" """
@ -175,22 +164,18 @@ class NetAppOntapBroadcastDomainPorts(object):
domain_obj.add_new_child("broadcast-domain", self.broadcast_domain) domain_obj.add_new_child("broadcast-domain", self.broadcast_domain)
if self.ipspace: if self.ipspace:
domain_obj.add_new_child("ipspace", self.ipspace) domain_obj.add_new_child("ipspace", self.ipspace)
if self.ports: if ports:
ports_obj = netapp_utils.zapi.NaElement('ports') ports_obj = netapp_utils.zapi.NaElement('ports')
domain_obj.add_child_elem(ports_obj) domain_obj.add_child_elem(ports_obj)
for port in self.ports: for port in ports:
ports_obj.add_new_child('net-qualified-port-name', port) ports_obj.add_new_child('net-qualified-port-name', port)
try: try:
self.server.invoke_successfully(domain_obj, True) self.server.invoke_successfully(domain_obj, True)
return True return True
except netapp_utils.zapi.NaApiError as error: except netapp_utils.zapi.NaApiError as error:
# Error 13001 denotes port already not being used. self.module.fail_json(msg='Error deleting port for broadcast domain %s: %s' %
if to_native(error.code) == "13001": (self.broadcast_domain, to_native(error)),
return False exception=traceback.format_exc())
else:
self.module.fail_json(msg='Error deleting port for broadcast domain %s: %s' %
(self.broadcast_domain, to_native(error)),
exception=traceback.format_exc())
def apply(self): def apply(self):
""" """
@ -198,27 +183,23 @@ class NetAppOntapBroadcastDomainPorts(object):
""" """
changed = False changed = False
broadcast_domain_details = self.get_broadcast_domain_ports() broadcast_domain_details = self.get_broadcast_domain_ports()
broadcast_domain_exists = False
results = netapp_utils.get_cserver(self.server) results = netapp_utils.get_cserver(self.server)
cserver = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=results) cserver = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=results)
netapp_utils.ems_log_event("na_ontap_broadcast_domain_ports", cserver) netapp_utils.ems_log_event("na_ontap_broadcast_domain_ports", cserver)
if broadcast_domain_details: if broadcast_domain_details is None:
broadcast_domain_exists = True self.module.fail_json(msg='Error broadcast domain not found: %s' % self.broadcast_domain)
if self.state == 'absent': # delete if self.module.check_mode:
changed = True
elif self.state == 'present': # create
changed = True
else:
pass pass
if changed: else:
if self.module.check_mode: if self.state == 'present': # execute create
pass ports_to_add = [port for port in self.ports if port not in broadcast_domain_details['ports']]
else: if len(ports_to_add) > 0:
if broadcast_domain_exists: changed = self.create_broadcast_domain_ports(ports_to_add)
if self.state == 'present': # execute create elif self.state == 'absent': # execute delete
changed = self.create_broadcast_domain_ports() ports_to_delete = [port for port in self.ports if port in broadcast_domain_details['ports']]
elif self.state == 'absent': # execute delete if len(ports_to_delete) > 0:
changed = self.delete_broadcast_domain_ports() changed = self.delete_broadcast_domain_ports(ports_to_delete)
self.module.exit_json(changed=changed) self.module.exit_json(changed=changed)