| 1 |
#!/usr/bin/python |
| 2 |
|
| 3 |
# (c) 2024-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_bgp_peer_group |
| 11 |
short_description: NetApp ONTAP module to create, modify or delete bgp peer group. |
| 12 |
extends_documentation_fragment: |
| 13 |
- netapp.ontap.netapp.na_ontap_rest |
| 14 |
version_added: '22.0.0' |
| 15 |
author: NetApp Ansible Team (@carchi8py) <[email protected]> |
| 16 |
description: |
| 17 |
- Create, modify or delete bgp peer group. |
| 18 |
options: |
| 19 |
state: |
| 20 |
description: |
| 21 |
- Create or delete BGP peer group. |
| 22 |
choices: ['present', 'absent'] |
| 23 |
type: str |
| 24 |
default: present |
| 25 |
name: |
| 26 |
description: |
| 27 |
- Name of the BGP peer group. |
| 28 |
type: str |
| 29 |
required: true |
| 30 |
from_name: |
| 31 |
description: |
| 32 |
- Name of the existing BGP peer group to be renamed to C(name). |
| 33 |
type: str |
| 34 |
ipspace: |
| 35 |
description: |
| 36 |
- IPSpace name, cannot be modified after creation. |
| 37 |
type: str |
| 38 |
local: |
| 39 |
description: |
| 40 |
- Information describing the local interface that is being used to peer with a router using BGP. |
| 41 |
- When creating BGP peer group, an existing BGP interface is used by specifying the interface, or create a new one by specifying the port and IP address. |
| 42 |
- Cannot be modified after creation. |
| 43 |
type: dict |
| 44 |
suboptions: |
| 45 |
interface: |
| 46 |
description: |
| 47 |
- An existing BGP interface. |
| 48 |
- If interface not found, module will try to create BGP interface using C(local.ip) and C(local.port). |
| 49 |
type: dict |
| 50 |
suboptions: |
| 51 |
name: |
| 52 |
description: |
| 53 |
- BGP interface name. |
| 54 |
type: str |
| 55 |
ip: |
| 56 |
description: |
| 57 |
- IP information, requird to create a new interface. |
| 58 |
type: dict |
| 59 |
suboptions: |
| 60 |
address: |
| 61 |
description: |
| 62 |
- IPv4 or IPv6 address, example 10.10.10.7. |
| 63 |
type: str |
| 64 |
netmask: |
| 65 |
description: |
| 66 |
- Input as netmask length (16) or IPv4 mask (255.255.0.0). |
| 67 |
- For IPv6, the default value is 64 with a valid range of 1 to 127. |
| 68 |
type: str |
| 69 |
port: |
| 70 |
description: |
| 71 |
- Port and node information, required to create a new interface. |
| 72 |
type: dict |
| 73 |
suboptions: |
| 74 |
name: |
| 75 |
description: |
| 76 |
- Port name. |
| 77 |
type: str |
| 78 |
node: |
| 79 |
description: |
| 80 |
- Name of node on which the port is located. |
| 81 |
type: dict |
| 82 |
suboptions: |
| 83 |
name: |
| 84 |
description: |
| 85 |
- Node name |
| 86 |
type: str |
| 87 |
peer: |
| 88 |
description: |
| 89 |
- Information describing the router to peer with |
| 90 |
type: dict |
| 91 |
suboptions: |
| 92 |
address: |
| 93 |
description: |
| 94 |
- Peer router address. |
| 95 |
type: str |
| 96 |
asn: |
| 97 |
description: |
| 98 |
- Autonomous system number of peer. |
| 99 |
- Cannot be modified after creation. |
| 100 |
type: int |
| 101 |
use_peer_as_next_hop: |
| 102 |
description: |
| 103 |
- Specifies whether the peer group uses the peer address as a next hop route. |
| 104 |
- This field requires ONTAP version 9.9 or later. |
| 105 |
type: bool |
| 106 |
version_added: '22.12.0' |
| 107 |
""" |
| 108 |
|
| 109 |
EXAMPLES = """ |
| 110 |
- name: Create BGP peer group with existing bgp interface bgp_lif. |
| 111 |
netapp.ontap.na_ontap_bgp_peer_group: |
| 112 |
name: peer_group |
| 113 |
ipspace: Default |
| 114 |
local: |
| 115 |
interface: |
| 116 |
name: bgp_lif |
| 117 |
peer: |
| 118 |
address: 10.10.10.19 |
| 119 |
asn: 65501 |
| 120 |
hostname: "{{ netapp_hostname }}" |
| 121 |
username: "{{ netapp_username }}" |
| 122 |
password: "{{ netapp_password }}" |
| 123 |
https: true |
| 124 |
validate_certs: "{{ validate_certs }}" |
| 125 |
|
| 126 |
- name: Create new BGP interface new_bgp_lif and BGP peer group peer_group_1. |
| 127 |
netapp.ontap.na_ontap_bgp_peer_group: |
| 128 |
name: peer_group_1 |
| 129 |
ipspace: Default |
| 130 |
local: |
| 131 |
interface: |
| 132 |
name: new_bgp_lif |
| 133 |
ip: |
| 134 |
address: 10.10.10.20 |
| 135 |
netmask: 24 |
| 136 |
port: |
| 137 |
name: e0a |
| 138 |
node: |
| 139 |
name: ontap98-01 |
| 140 |
peer: |
| 141 |
address: 10.10.10.20 |
| 142 |
asn: 65500 |
| 143 |
hostname: "{{ netapp_hostname }}" |
| 144 |
username: "{{ netapp_username }}" |
| 145 |
password: "{{ netapp_password }}" |
| 146 |
https: true |
| 147 |
validate_certs: "{{ validate_certs }}" |
| 148 |
|
| 149 |
# this will create bgp interface with random name. |
| 150 |
- name: Create BGP interface without interface name and BGP peer group peer_group_2. |
| 151 |
netapp.ontap.na_ontap_bgp_peer_group: |
| 152 |
name: peer_group_2 |
| 153 |
ipspace: Default |
| 154 |
local: |
| 155 |
ip: |
| 156 |
address: 10.10.10.22 |
| 157 |
netmask: 24 |
| 158 |
port: |
| 159 |
name: e0a |
| 160 |
node: |
| 161 |
name: ontap98-01 |
| 162 |
peer: |
| 163 |
address: 10.10.10.22 |
| 164 |
asn: 65512 |
| 165 |
hostname: "{{ netapp_hostname }}" |
| 166 |
username: "{{ netapp_username }}" |
| 167 |
password: "{{ netapp_password }}" |
| 168 |
https: true |
| 169 |
validate_certs: "{{ validate_certs }}" |
| 170 |
|
| 171 |
- name: Modify peer address. |
| 172 |
netapp.ontap.na_ontap_bgp_peer_group: |
| 173 |
name: peer_group_2 |
| 174 |
ipspace: Default |
| 175 |
peer: |
| 176 |
address: 10.10.55.22 |
| 177 |
hostname: "{{ netapp_hostname }}" |
| 178 |
username: "{{ netapp_username }}" |
| 179 |
password: "{{ netapp_password }}" |
| 180 |
https: true |
| 181 |
validate_certs: "{{ validate_certs }}" |
| 182 |
|
| 183 |
- name: Rename BGP peer group name and modify peer address. |
| 184 |
netapp.ontap.na_ontap_bgp_peer_group: |
| 185 |
from_name: peer_group_2 |
| 186 |
name: new_peer_group |
| 187 |
ipspace: Default |
| 188 |
peer: |
| 189 |
address: 10.10.55.40 |
| 190 |
hostname: "{{ netapp_hostname }}" |
| 191 |
username: "{{ netapp_username }}" |
| 192 |
password: "{{ netapp_password }}" |
| 193 |
https: true |
| 194 |
validate_certs: "{{ validate_certs }}" |
| 195 |
|
| 196 |
- name: Delete BGP peer group. |
| 197 |
netapp.ontap.na_ontap_bgp_peer_group: |
| 198 |
name: new_peer_group |
| 199 |
ipspace: Default |
| 200 |
state: absent |
| 201 |
hostname: "{{ netapp_hostname }}" |
| 202 |
username: "{{ netapp_username }}" |
| 203 |
password: "{{ netapp_password }}" |
| 204 |
https: true |
| 205 |
validate_certs: "{{ validate_certs }}" |
| 206 |
""" |
| 207 |
|
| 208 |
RETURN = """ |
| 209 |
""" |
| 210 |
|
| 211 |
import traceback |
| 212 |
from ansible.module_utils.basic import AnsibleModule |
| 213 |
from ansible.module_utils._text import to_native |
| 214 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 215 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule |
| 216 |
from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic, netapp_ipaddress |
| 217 |
|
| 218 |
|
| 219 |
class NetAppOntapBgpPeerGroup: |
| 220 |
def __init__(self): |
| 221 |
self.argument_spec = netapp_utils.na_ontap_rest_only_spec() |
| 222 |
self.argument_spec.update(dict( |
| 223 |
state=dict(required=False, type='str', choices=['present', 'absent'], default='present'), |
| 224 |
name=dict(required=True, type='str'), |
| 225 |
from_name=dict(required=False, type='str'), |
| 226 |
ipspace=dict(required=False, type='str'), |
| 227 |
local=dict(required=False, type='dict', options=dict( |
| 228 |
interface=dict(required=False, type='dict', options=dict( |
| 229 |
name=dict(required=False, type='str'), |
| 230 |
)), |
| 231 |
ip=dict(required=False, type='dict', options=dict( |
| 232 |
address=dict(required=False, type='str'), |
| 233 |
netmask=dict(required=False, type='str') |
| 234 |
)), |
| 235 |
port=dict(required=False, type='dict', options=dict( |
| 236 |
name=dict(required=False, type='str'), |
| 237 |
node=dict(required=False, type='dict', options=dict( |
| 238 |
name=dict(required=False, type='str') |
| 239 |
)) |
| 240 |
)) |
| 241 |
)), |
| 242 |
peer=dict(required=False, type='dict', options=dict( |
| 243 |
address=dict(required=False, type='str'), |
| 244 |
asn=dict(required=False, type='int') |
| 245 |
)), |
| 246 |
use_peer_as_next_hop=dict(required=False, type='bool') |
| 247 |
)) |
| 248 |
|
| 249 |
self.module = AnsibleModule( |
| 250 |
argument_spec=self.argument_spec, |
| 251 |
supports_check_mode=True |
| 252 |
) |
| 253 |
self.uuid = None |
| 254 |
self.na_helper = NetAppModule(self.module) |
| 255 |
self.parameters = self.na_helper.check_and_set_parameters(self.module) |
| 256 |
if self.na_helper.safe_get(self.parameters, ['peer', 'address']): |
| 257 |
self.parameters['peer']['address'] = netapp_ipaddress.validate_and_compress_ip_address(self.parameters['peer']['address'], self.module) |
| 258 |
self.rest_api = netapp_utils.OntapRestAPI(self.module) |
| 259 |
self.rest_api.fail_if_not_rest_minimum_version('na_ontap_bgp_peer_group', 9, 7) |
| 260 |
partially_supported_rest_properties = [[('use_peer_as_next_hop'), (9, 9, 1)]] |
| 261 |
self.use_rest = self.rest_api.is_rest_supported_properties(parameters=self.parameters, |
| 262 |
partially_supported_rest_properties=partially_supported_rest_properties) |
| 263 |
self.parameters = self.na_helper.filter_out_none_entries(self.parameters) |
| 264 |
|
| 265 |
def get_bgp_peer_group(self, name=None): |
| 266 |
""" |
| 267 |
Get BGP peer group. |
| 268 |
""" |
| 269 |
if name is None: |
| 270 |
name = self.parameters['name'] |
| 271 |
api = 'network/ip/bgp/peer-groups' |
| 272 |
query = { |
| 273 |
'name': name, |
| 274 |
'fields': 'name,uuid,peer' |
| 275 |
} |
| 276 |
if 'ipspace' in self.parameters: |
| 277 |
query['ipspace.name'] = self.parameters['ipspace'] |
| 278 |
record, error = rest_generic.get_one_record(self.rest_api, api, query) |
| 279 |
if error: |
| 280 |
self.module.fail_json(msg='Error fetching BGP peer group %s: %s' % (name, to_native(error)), |
| 281 |
exception=traceback.format_exc()) |
| 282 |
if record: |
| 283 |
self.uuid = record['uuid'] |
| 284 |
return { |
| 285 |
'name': self.na_helper.safe_get(record, ['name']), |
| 286 |
'peer': { |
| 287 |
'address': self.na_helper.safe_get(record, ['peer', 'address']), |
| 288 |
'asn': self.na_helper.safe_get(record, ['peer', 'asn']) |
| 289 |
}, |
| 290 |
'use_peer_as_next_hop': self.na_helper.safe_get(record, ['peer', 'is_next_hop']) |
| 291 |
} |
| 292 |
return None |
| 293 |
|
| 294 |
def create_bgp_peer_group(self): |
| 295 |
""" |
| 296 |
Create BGP peer group. |
| 297 |
""" |
| 298 |
api = 'network/ip/bgp/peer-groups' |
| 299 |
body = { |
| 300 |
'name': self.parameters['name'], |
| 301 |
'local': self.parameters['local'], |
| 302 |
'peer': self.parameters['peer'] |
| 303 |
} |
| 304 |
if 'ipspace' in self.parameters: |
| 305 |
body['ipspace.name'] = self.parameters['ipspace'] |
| 306 |
if 'use_peer_as_next_hop' in self.parameters: |
| 307 |
body['peer.is_next_hop'] = self.parameters['use_peer_as_next_hop'] |
| 308 |
dummy, error = rest_generic.post_async(self.rest_api, api, body) |
| 309 |
if error: |
| 310 |
self.module.fail_json(msg='Error creating BGP peer group %s: %s.' % (self.parameters['name'], to_native(error)), |
| 311 |
exception=traceback.format_exc()) |
| 312 |
|
| 313 |
def modify_bgp_peer_group(self, modify): |
| 314 |
""" |
| 315 |
Modify BGP peer group. |
| 316 |
""" |
| 317 |
api = 'network/ip/bgp/peer-groups' |
| 318 |
body = {} |
| 319 |
if 'name' in modify: |
| 320 |
body['name'] = modify['name'] |
| 321 |
if 'peer' in modify: |
| 322 |
body['peer'] = modify['peer'] |
| 323 |
if 'use_peer_as_next_hop' in modify: |
| 324 |
body['peer.is_next_hop'] = modify['use_peer_as_next_hop'] |
| 325 |
dummy, error = rest_generic.patch_async(self.rest_api, api, self.uuid, body) |
| 326 |
if error: |
| 327 |
name = self.parameters['from_name'] if 'name' in modify else self.parameters['name'] |
| 328 |
self.module.fail_json(msg='Error modifying BGP peer group %s: %s.' % (name, to_native(error)), |
| 329 |
exception=traceback.format_exc()) |
| 330 |
|
| 331 |
def delete_bgp_peer_group(self): |
| 332 |
""" |
| 333 |
Delete BGP peer group. |
| 334 |
""" |
| 335 |
api = 'network/ip/bgp/peer-groups' |
| 336 |
dummy, error = rest_generic.delete_async(self.rest_api, api, self.uuid) |
| 337 |
if error: |
| 338 |
self.module.fail_json(msg='Error deleting BGP peer group %s: %s.' % (self.parameters['name'], to_native(error)), |
| 339 |
exception=traceback.format_exc()) |
| 340 |
|
| 341 |
def apply(self): |
| 342 |
current = self.get_bgp_peer_group() |
| 343 |
cd_action = self.na_helper.get_cd_action(current, self.parameters) |
| 344 |
modify = None |
| 345 |
if cd_action == 'create': |
| 346 |
if self.parameters.get('from_name'): |
| 347 |
current = self.get_bgp_peer_group(self.parameters['from_name']) |
| 348 |
if not current: |
| 349 |
self.module.fail_json(msg="Error renaming BGP peer group, %s does not exist." % self.parameters['from_name']) |
| 350 |
cd_action = None |
| 351 |
elif not self.parameters.get('local') or not self.parameters.get('peer'): |
| 352 |
self.module.fail_json(msg="Error creating BGP peer group %s, local and peer are required in create." % self.parameters['name']) |
| 353 |
if cd_action is None: |
| 354 |
modify = self.na_helper.get_modified_attributes(current, self.parameters) |
| 355 |
if self.na_helper.safe_get(modify, ['peer', 'asn']): |
| 356 |
self.module.fail_json(msg="Error: cannot modify peer asn.") |
| 357 |
if self.na_helper.changed and not self.module.check_mode: |
| 358 |
if cd_action == 'create': |
| 359 |
self.create_bgp_peer_group() |
| 360 |
elif cd_action == 'delete': |
| 361 |
self.delete_bgp_peer_group() |
| 362 |
else: |
| 363 |
self.modify_bgp_peer_group(modify) |
| 364 |
result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify) |
| 365 |
self.module.exit_json(**result) |
| 366 |
|
| 367 |
|
| 368 |
def main(): |
| 369 |
bgp_obj = NetAppOntapBgpPeerGroup() |
| 370 |
bgp_obj.apply() |
| 371 |
|
| 372 |
|
| 373 |
if __name__ == '__main__': |
| 374 |
main() |