summaryrefslogtreecommitdiff
path: root/plugins/modules/vyos_linkagg.py
blob: 4320dd3b18d1df1f8c66ca7c570270bbadd7f9f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
#!/usr/bin/python
# -*- coding: utf-8 -*-

# (c) 2017, Ansible by Red Hat, inc
#
# This file is part of Ansible by Red Hat
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
#

from __future__ import absolute_import, division, print_function

__metaclass__ = type

DOCUMENTATION = """
module: vyos_linkagg
author: Ricardo Carrillo Cruz (@rcarrillocruz)
short_description: (deprecated, removed after 2022-06-01) Manage link aggregation
  groups on VyOS network devices
description:
- This module provides declarative management of link aggregation groups on VyOS network
  devices.
version_added: 1.0.0
deprecated:
  alternative: vyos_lag_interfaces
  why: Updated modules released with more functionality.
  removed_at_date: '2022-06-01'
notes:
- Tested against VYOS 1.1.7
options:
  name:
    description:
    - Name of the link aggregation group.
    type: str
  mode:
    description:
    - Mode of the link aggregation group.
    default: "802.3ad"
    choices:
    - 802.3ad
    - active-backup
    - broadcast
    - round-robin
    - transmit-load-balance
    - adaptive-load-balance
    - xor-hash
    - "on"
    type: str
  members:
    description:
    - List of members of the link aggregation group.
    type: list
    elements: str
  aggregate:
    description: List of link aggregation definitions.
    type: list
    elements: dict
    suboptions:
      name:
        description:
        - Name of the link aggregation group.
        required: true
        type: str
      mode:
        description:
        - Mode of the link aggregation group.
        choices:
        - 802.3ad
        - active-backup
        - broadcast
        - round-robin
        - transmit-load-balance
        - adaptive-load-balance
        - xor-hash
        - "on"
        type: str
      members:
        description:
        - List of members of the link aggregation group.
        type: list
        elements: str
      state:
        description:
        - State of the link aggregation group.
        choices:
        - present
        - absent
        - up
        - down
        type: str
  state:
    description:
    - State of the link aggregation group.
    default: present
    choices:
    - present
    - absent
    - up
    - down
    type: str
extends_documentation_fragment:
- vyos.vyos.vyos


"""

EXAMPLES = """
- name: configure link aggregation group
  vyos.vyos.vyos_linkagg:
    name: bond0
    members:
    - eth0
    - eth1

- name: remove configuration
  vyos.vyos.vyos_linkagg:
    name: bond0
    state: absent

- name: Create aggregate of linkagg definitions
  vyos.vyos.vyos_linkagg:
    aggregate:
    - {name: bond0, members: [eth1]}
    - {name: bond1, members: [eth2]}

- name: Remove aggregate of linkagg definitions
  vyos.vyos.vyos_linkagg:
    aggregate:
    - name: bond0
    - name: bond1
    state: absent
"""

RETURN = """
commands:
  description: The list of configuration mode commands to send to the device
  returned: always, except for the platforms that use Netconf transport to manage the device.
  type: list
  sample:
    - set interfaces bonding bond0
    - set interfaces ethernet eth0 bond-group 'bond0'
    - set interfaces ethernet eth1 bond-group 'bond0'
"""
from copy import deepcopy

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
    remove_default_spec,
)
from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import (
    load_config,
    run_commands,
)
from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import (
    vyos_argument_spec,
)


def search_obj_in_list(name, lst):
    for o in lst:
        if o["name"] == name:
            return o

    return None


def map_obj_to_commands(updates, module):
    commands = list()
    want, have = updates

    for w in want:
        name = w["name"]
        members = w.get("members") or []
        mode = w["mode"]

        if mode == "on":
            mode = "802.3ad"

        state = w["state"]

        obj_in_have = search_obj_in_list(name, have)

        if state == "absent":
            if obj_in_have:
                for m in obj_in_have["members"]:
                    commands.append(
                        "delete interfaces ethernet " + m + " bond-group"
                    )

                commands.append("delete interfaces bonding " + name)
        else:
            if not obj_in_have:
                commands.append(
                    "set interfaces bonding " + name + " mode " + mode
                )

                for m in members:
                    commands.append(
                        "set interfaces ethernet " + m + " bond-group " + name
                    )

                if state == "down":
                    commands.append(
                        "set interfaces bonding " + name + " disable"
                    )
            else:
                if mode != obj_in_have["mode"]:
                    commands.append(
                        "set interfaces bonding " + name + " mode " + mode
                    )

                missing_members = list(
                    set(members) - set(obj_in_have["members"])
                )
                for m in missing_members:
                    commands.append(
                        "set interfaces ethernet " + m + " bond-group " + name
                    )

                if state == "down" and obj_in_have["state"] == "up":
                    commands.append(
                        "set interfaces bonding " + name + " disable"
                    )
                elif state == "up" and obj_in_have["state"] == "down":
                    commands.append(
                        "delete interfaces bonding " + name + " disable"
                    )

    return commands


def map_config_to_obj(module):
    obj = []
    output = run_commands(module, ["show interfaces bonding slaves"])
    lines = output[0].splitlines()

    if len(lines) > 1:
        for line in lines[1:]:
            splitted_line = line.split()

            name = splitted_line[0]
            mode = splitted_line[1]
            state = splitted_line[2]

            if len(splitted_line) > 4:
                members = splitted_line[4:]
            else:
                members = []

            obj.append(
                {
                    "name": name,
                    "mode": mode,
                    "members": members,
                    "state": state,
                }
            )

    return obj


def map_params_to_obj(module):
    obj = []
    aggregate = module.params.get("aggregate")
    if aggregate:
        for item in aggregate:
            for key in item:
                if item.get(key) is None:
                    item[key] = module.params[key]

            obj.append(item.copy())
    else:
        obj.append(
            {
                "name": module.params["name"],
                "mode": module.params["mode"],
                "members": module.params["members"],
                "state": module.params["state"],
            }
        )

    return obj


def main():
    """main entry point for module execution"""
    element_spec = dict(
        name=dict(),
        mode=dict(
            choices=[
                "802.3ad",
                "active-backup",
                "broadcast",
                "round-robin",
                "transmit-load-balance",
                "adaptive-load-balance",
                "xor-hash",
                "on",
            ],
            default="802.3ad",
        ),
        members=dict(type="list", elements="str"),
        state=dict(
            default="present", choices=["present", "absent", "up", "down"]
        ),
    )

    aggregate_spec = deepcopy(element_spec)
    aggregate_spec["name"] = dict(required=True)

    # remove default in aggregate spec, to handle common arguments
    remove_default_spec(aggregate_spec)

    argument_spec = dict(
        aggregate=dict(type="list", elements="dict", options=aggregate_spec),
    )

    argument_spec.update(element_spec)
    argument_spec.update(vyos_argument_spec)

    required_one_of = [["name", "aggregate"]]
    mutually_exclusive = [["name", "aggregate"]]
    module = AnsibleModule(
        argument_spec=argument_spec,
        required_one_of=required_one_of,
        mutually_exclusive=mutually_exclusive,
        supports_check_mode=True,
    )

    warnings = list()

    result = {"changed": False}

    if warnings:
        result["warnings"] = warnings

    want = map_params_to_obj(module)
    have = map_config_to_obj(module)

    commands = map_obj_to_commands((want, have), module)
    result["commands"] = commands

    if commands:
        commit = not module.check_mode
        load_config(module, commands, commit=commit)
        result["changed"] = True

    module.exit_json(**result)


if __name__ == "__main__":
    main()