Aller au contenu

La version 0.1.0 est une première version, à l'essai. Voir ce qui n'est pas prouvé →

bogolang
EN

← Exemples

change_vlan

Ajoute un VLAN et l'autorise sur le trunk de la liaison montante, dans un bloc change avec son retour arrière. À lancer avec --dry.

Ajoute le VLAN 30 à chaque switch de devices.csv et l'autorise sur le trunk de liaison montante nommé dans la colonne trunk. Il lit d'abord show vlan brief et laisse de côté un switch qui a déjà le VLAN. Le changement est un bloc change : ses lignes rollback sont envoyées si une ligne verify est fausse, si l'équipement refuse une ligne, ou si le programme est arrêté. Un bloc change sans retour arrière est refusé avant que le programme s'exécute.

Exécutez-le avec --dry : chaque changement est affiché et rien n'est envoyé. --replay saved répond au show vlan brief en lecture seule à partir des sorties enregistrées, donc aucun équipement n'est contacté du tout.

bogo run --dry --replay saved change_vlan.bogo
bogo test change_vlan.bogo

Pour l'utiliser sur votre propre réseau :

  • Mettez vos switchs dans devices.csv, avec la liaison montante de chacun dans la colonne trunk. Un équipement qui a le rôle router est ignoré.
  • Réglez vid et name en haut de la classe.
  • Enregistrez des identifiants une fois avec bogo login default.
  • Exécutez-le d'abord avec --dry et sans --replay : il lit alors vraiment chaque switch, et affiche le changement sans l'envoyer.
  • Sans --dry et sans --replay, le changement est vraiment envoyé. Avant chaque changement, Bogolang prend une sauvegarde de la configuration courante.
  • Vérifiez les lignes par rapport à la version logicielle de vos switchs avant une vraie exécution.
change_vlan.bogo
edition 2027
"""Add a VLAN to each switch and allow it on the uplink trunk, with a rollback for every line."""


class ChangeVlan:
    """Adds VLAN 30 where it is missing. Read-only first: a switch that has it already is left alone.
    Run it with --dry first: each change is printed and nothing is sent."""

    vid: int = 30
    name: str = "CAMERAS"

    @staticmethod
    def has_vlan(vlans: list[Row], vid: int) -> bool:
        """True when the table of show vlan brief holds this VLAN."""
        return any(v.vlan_id == str(vid) for v in vlans)

    @staticmethod
    def main(args: list[str]) -> None:
        vid: int = ChangeVlan.vid
        name: str = ChangeVlan.name
        switches: list[Device] = [d for d in inventory("devices.csv") if d.role != "router"]
        for d in switches:
            with ssh(d) as s:
                vlans: list[Row] = s.show("vlan brief").table()
            if ChangeVlan.has_vlan(vlans, vid):
                print(f"{d.name}: VLAN {vid} is already there, nothing to do")
                continue
            trunk: str = d.extra["trunk"]
            change on d:
                apply:
                    vlan {vid}
                     name {name}
                    interface {trunk}
                     switchport trunk allowed vlan add {vid}
                rollback:
                    interface {trunk}
                     switchport trunk allowed vlan remove {vid}
                    no vlan {vid}
                verify:
                    name in show("vlan brief")
                    str(vid) in show(f"interfaces {trunk} trunk")
            done: str = "would be added, nothing was sent" if dry_run() else "added"
            print(f"{d.name}: VLAN {vid} {done}")


class TestChangeVlan:
    def vlans(self) -> list[Row]:
        return [
            Row({"vlan_id": "1", "vlan_name": "default", "status": "active", "interfaces": ""}),
            Row({"vlan_id": "10", "vlan_name": "USERS", "status": "active", "interfaces": ""}),
            Row({"vlan_id": "300", "vlan_name": "LAB", "status": "active", "interfaces": ""}),
        ]

    def test_vlan_present(self) -> None:
        assert ChangeVlan.has_vlan(self.vlans(), 10)

    def test_vlan_missing_is_not_matched_by_a_longer_number(self) -> None:
        assert not ChangeVlan.has_vlan(self.vlans(), 30)