Debian Codegraph @

ansible_collections/netapp/ontap/plugins/modules/na_ontap_broadcast_domain_ports.py

raw
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 ANSIBLE_METADATA = {'metadata_version': '1.1',
10 'status': ['preview'],
11 'supported_by': 'certified'}
12
13 DOCUMENTATION = '''
14 module: na_ontap_broadcast_domain_ports
15 short_description: NetApp ONTAP manage broadcast domain ports
16 extends_documentation_fragment:
17 - netapp.ontap.netapp.na_ontap_zapi
18 version_added: 2.6.0
19 author: NetApp Ansible Team (@carchi8py) <[email protected]>
20 description:
21 - Add or remove ONTAP broadcast domain ports. Existing ports that are not listed are kept.
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 broadcast_domain:
30 description:
31 - Specify the broadcast_domain name
32 required: true
33 type: str
34 ipspace:
35 description:
36 - Specify the ipspace for the broadcast domain
37 type: str
38 ports:
39 description:
40 - Specify the list of ports to add to or remove from this broadcast domain.
41 required: true
42 type: list
43 elements: str
44
45 '''
46
47 EXAMPLES = """
48 - name: Create broadcast-domain ports
49 netapp.ontap.na_ontap_broadcast_domain_ports:
50 state: present
51 hostname: "{{ netapp_hostname }}"
52 username: "{{ netapp_username }}"
53 password: "{{ netapp_password }}"
54 broadcast_domain: 123kevin
55 ports: khutton-vsim1:e0d-13
56
57 - name: Delete broadcast-domain ports
58 netapp.ontap.na_ontap_broadcast_domain_ports:
59 state: absent
60 hostname: "{{ netapp_hostname }}"
61 username: "{{ netapp_username }}"
62 password: "{{ netapp_password }}"
63 broadcast_domain: 123kevin
64 ports: khutton-vsim1:e0d-13
65 """
66
67 RETURN = """
68
69
70 """
71
72 import traceback
73 from ansible.module_utils.basic import AnsibleModule
74 from ansible.module_utils._text import to_native
75 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
76 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
77
78
79 HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
80
81
82 class NetAppOntapBroadcastDomainPorts(object):
83 """
84 Create and Destroys Broadcast Domain Ports
85 """
86 def __init__(self):
87 """
88 Initialize the Ontap Net Route class
89 """
90 self.argument_spec = netapp_utils.na_ontap_zapi_only_spec()
91 self.argument_spec.update(dict(
92 state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
93 broadcast_domain=dict(required=True, type='str'),
94 ipspace=dict(required=False, type='str', default=None),
95 ports=dict(required=True, type='list', elements='str'),
96 ))
97
98 self.module = AnsibleModule(
99 argument_spec=self.argument_spec,
100 supports_check_mode=True
101 )
102 parameters = self.module.params
103 self.na_helper = NetAppModule(self.module)
104 msg = 'The module only supports ZAPI; refer to netapp.ontap.na_ontap_ports module for RESTful equivalent.'
105 self.na_helper.fall_back_to_zapi(self.module, msg, parameters)
106
107 # set up state variables
108 self.state = parameters['state']
109 self.broadcast_domain = parameters['broadcast_domain']
110 self.ipspace = parameters['ipspace']
111 self.ports = parameters['ports']
112
113 if HAS_NETAPP_LIB is False:
114 self.module.fail_json(msg="the python NetApp-Lib module is required")
115 else:
116 self.server = netapp_utils.setup_na_ontap_zapi(module=self.module)
117 return
118
119 def get_broadcast_domain_ports(self):
120 """
121 Return details about the broadcast domain ports
122 :param:
123 name : broadcast domain name
124 :return: Details about the broadcast domain. None if not found.
125 :rtype: dict
126 """
127 domain_get_iter = netapp_utils.zapi.NaElement('net-port-broadcast-domain-get-iter')
128 broadcast_domain_info = netapp_utils.zapi.NaElement('net-port-broadcast-domain-info')
129 broadcast_domain_info.add_new_child('broadcast-domain', self.broadcast_domain)
130 query = netapp_utils.zapi.NaElement('query')
131 query.add_child_elem(broadcast_domain_info)
132 domain_get_iter.add_child_elem(query)
133 result = self.server.invoke_successfully(domain_get_iter, True)
134 domain_exists = None
135 # check if broadcast domain exists
136 if result.get_child_by_name('num-records') and \
137 int(result.get_child_content('num-records')) == 1:
138 domain_info = result.get_child_by_name('attributes-list').get_child_by_name('net-port-broadcast-domain-info')
139 domain_name = domain_info.get_child_content('broadcast-domain')
140 domain_ports = domain_info.get_child_by_name('ports')
141 if domain_ports is not None:
142 ports = [port.get_child_content('port') for port in domain_ports.get_children()]
143 else:
144 ports = []
145 domain_exists = {
146 'domain-name': domain_name,
147 'ports': ports
148 }
149 return domain_exists
150
151 def create_broadcast_domain_ports(self, ports):
152 """
153 Creates new broadcast domain ports
154 """
155 domain_obj = netapp_utils.zapi.NaElement('net-port-broadcast-domain-add-ports')
156 domain_obj.add_new_child("broadcast-domain", self.broadcast_domain)
157 if self.ipspace:
158 domain_obj.add_new_child("ipspace", self.ipspace)
159 if ports:
160 ports_obj = netapp_utils.zapi.NaElement('ports')
161 domain_obj.add_child_elem(ports_obj)
162 for port in ports:
163 ports_obj.add_new_child('net-qualified-port-name', port)
164 try:
165 self.server.invoke_successfully(domain_obj, True)
166 except netapp_utils.zapi.NaApiError as error:
167 self.module.fail_json(msg='Error creating port for broadcast domain %s: %s' %
168 (self.broadcast_domain, to_native(error)),
169 exception=traceback.format_exc())
170
171 def delete_broadcast_domain_ports(self, ports):
172 """
173 Deletes broadcast domain ports
174 """
175 domain_obj = netapp_utils.zapi.NaElement('net-port-broadcast-domain-remove-ports')
176 domain_obj.add_new_child("broadcast-domain", self.broadcast_domain)
177 if self.ipspace:
178 domain_obj.add_new_child("ipspace", self.ipspace)
179 if ports:
180 ports_obj = netapp_utils.zapi.NaElement('ports')
181 domain_obj.add_child_elem(ports_obj)
182 for port in ports:
183 ports_obj.add_new_child('net-qualified-port-name', port)
184 try:
185 self.server.invoke_successfully(domain_obj, True)
186 except netapp_utils.zapi.NaApiError as error:
187 self.module.fail_json(msg='Error deleting port for broadcast domain %s: %s' %
188 (self.broadcast_domain, to_native(error)),
189 exception=traceback.format_exc())
190
191 def apply(self):
192 """
193 Run Module based on play book
194 """
195 changed = False
196 broadcast_domain_details = self.get_broadcast_domain_ports()
197 if broadcast_domain_details is None:
198 self.module.fail_json(msg='Error broadcast domain not found: %s' % self.broadcast_domain)
199 if self.state == 'present': # execute create
200 ports_to_add = [port for port in self.ports if port not in broadcast_domain_details['ports']]
201 if len(ports_to_add) > 0:
202 if not self.module.check_mode:
203 self.create_broadcast_domain_ports(ports_to_add)
204 changed = True
205 elif self.state == 'absent': # execute delete
206 ports_to_delete = [port for port in self.ports if port in broadcast_domain_details['ports']]
207 if len(ports_to_delete) > 0:
208 if not self.module.check_mode:
209 self.delete_broadcast_domain_ports(ports_to_delete)
210 changed = True
211
212 self.module.exit_json(changed=changed)
213
214
215 def main():
216 """
217 Creates the NetApp Ontap Net Route object and runs the correct play task
218 """
219 obj = NetAppOntapBroadcastDomainPorts()
220 obj.apply()
221
222
223 if __name__ == '__main__':
224 main()