diff --git a/initializers/cables.yml b/initializers/cables.yml new file mode 100644 index 0000000..30e9869 --- /dev/null +++ b/initializers/cables.yml @@ -0,0 +1,53 @@ +## Required parameters for termination X ('a' or 'b'): +## termination_X_name - name of interface +## termination_X_device - name of the device interface belongs to +## termination_X_class - required if different than Interface which is the default +## Supported termination classes: Interface, ConsolePort, ConsoleServerPort, FrontPort, RearPort +## +## If termination is a circuit then the required parameter is termination_x_circuit. +## Required parameters for a circuit termination: +## termination_x_circuit: +## term_side - termination side of a circuit. Must be A or B +## cid - circuit ID value +## site OR provider_network - name of Site or ProviderNetwork respectively. If both provided, Site takes precedence +## +## Any other Cable parameters supported by Netbox are supported as the top level keys, e.g. 'type', 'status', etc. +## +## - termination_a_name: console +## termination_a_device: spine +## termination_a_class: ConsolePort +## termination_b_name: tty9 +## termination_b_device: console-server +## termination_b_class: ConsoleServerPort +## type: cat6 +## +# - termination_a_name: to-server02 +# termination_a_device: server01 +# termination_b_name: to-server01 +# termination_b_device: server02 +# status: planned +# type: mmf + +# - termination_a_name: eth0 +# termination_a_device: server02 +# termination_b_circuit: +# term_side: A +# cid: Circuit_ID-1 +# site: AMS 1 +# type: cat6 + +# - termination_a_name: psu0 +# termination_a_device: server04 +# termination_a_class: PowerPort +# termination_b_feed: +# name: power feed 1 +# power_panel: +# name: power panel AMS 1 +# site: AMS 1 + +# - termination_a_name: outlet1 +# termination_a_device: server04 +# termination_a_class: PowerOutlet +# termination_b_name: psu1 +# termination_b_device: server04 +# termination_b_class: PowerPort diff --git a/initializers/dcim_interfaces.yml b/initializers/dcim_interfaces.yml index 4030530..ef1ea8c 100644 --- a/initializers/dcim_interfaces.yml +++ b/initializers/dcim_interfaces.yml @@ -10,9 +10,13 @@ # - device: server01 # enabled: true -# type: virtual +# type: 1000base-x-sfp # name: to-server02 # - device: server02 # enabled: true -# type: virtual +# type: 1000base-x-sfp # name: to-server01 +# - device: server02 +# enabled: true +# type: 1000base-t +# name: eth0 diff --git a/startup_scripts/460_cables.py b/startup_scripts/460_cables.py new file mode 100644 index 0000000..b39d40a --- /dev/null +++ b/startup_scripts/460_cables.py @@ -0,0 +1,233 @@ +import sys +from typing import Tuple + +from circuits.models import Circuit, CircuitTermination, ProviderNetwork +from dcim.models import ( + Cable, + ConsolePort, + ConsoleServerPort, + FrontPort, + Interface, + PowerFeed, + PowerOutlet, + PowerPanel, + PowerPort, + RearPort, + Site, +) +from django.contrib.contenttypes.models import ContentType +from django.db.models import Q +from startup_script_utils import load_yaml + +CONSOLE_PORT_TERMINATION = ContentType.objects.get_for_model(ConsolePort) +CONSOLE_SERVER_PORT_TERMINATION = ContentType.objects.get_for_model(ConsoleServerPort) +FRONT_PORT_TERMINATION = ContentType.objects.get_for_model(FrontPort) +REAR_PORT_TERMINATION = ContentType.objects.get_for_model(Interface) +FRONT_AND_REAR = [FRONT_PORT_TERMINATION, REAR_PORT_TERMINATION] +POWER_PORT_TERMINATION = ContentType.objects.get_for_model(PowerPort) +POWER_OUTLET_TERMINATION = ContentType.objects.get_for_model(PowerOutlet) +POWER_FEED_TERMINATION = ContentType.objects.get_for_model(PowerFeed) +POWER_TERMINATIONS = [POWER_PORT_TERMINATION, POWER_OUTLET_TERMINATION, POWER_FEED_TERMINATION] + +VIRTUAL_INTERFACES = ["bridge", "lag", "virtual"] + + +def get_termination_object(params: dict, side: str): + klass = params.pop(f"termination_{side}_class") + name = params.pop(f"termination_{side}_name", None) + device = params.pop(f"termination_{side}_device", None) + feed_params = params.pop(f"termination_{side}_feed", None) + circuit_params = params.pop(f"termination_{side}_circuit", {}) + + if name and device: + termination = klass.objects.get(name=name, device__name=device) + return termination + elif feed_params: + q = {"name": feed_params["power_panel"]["name"], "site__name": feed_params["power_panel"]["site"]} + power_panel = PowerPanel.objects.get(**q) + termination = PowerFeed.objects.get(name=feed_params["name"], power_panel=power_panel) + return termination + elif circuit_params: + circuit = Circuit.objects.get(cid=circuit_params.pop("cid")) + term_side = circuit_params.pop("term_side").upper() + + site_name = circuit_params.pop("site", None) + provider_network = circuit_params.pop("provider_network", None) + + if site_name: + circuit_params["site"] = Site.objects.get(name=site_name) + elif provider_network: + circuit_params["provider_network"] = ProviderNetwork.objects.get(name=provider_network) + else: + raise ValueError( + f"⚠️ Missing one of required parameters: 'site' or 'provider_network' " + f"for side {term_side} of circuit {circuit}" + ) + + termination, created = CircuitTermination.objects.get_or_create( + circuit=circuit, term_side=term_side, defaults=circuit_params + ) + if created: + print(f"⚡ Created new CircuitTermination {termination}") + + return termination + + raise ValueError( + f"⚠️ Missing parameters for termination_{side}. " + "Need termination_{side}_name AND termination_{side}_device OR termination_{side}_circuit" + ) + + +def get_termination_class(port_class: str): + if not port_class: + return Interface + + klass = globals()[port_class] + if klass not in [ + Interface, + FrontPort, + RearPort, + CircuitTermination, + ConsolePort, + ConsoleServerPort, + PowerPort, + PowerOutlet, + PowerFeed, + ]: + raise Exception(f"⚠️ Requested {port_class} is not supported as a cable termination!") + + return klass + + +def cable_in_cables(term_a: tuple, term_b: tuple) -> bool: + """Check if cable exist for given terminations. + Each tuple should consist termination object and termination type + """ + + cable = Cable.objects.filter( + Q( + termination_a_id=term_a[0].id, + termination_a_type=term_a[1], + termination_b_id=term_b[0].id, + termination_b_type=term_b[1], + ) + | Q( + termination_a_id=term_b[0].id, + termination_a_type=term_b[1], + termination_b_id=term_a[0].id, + termination_b_type=term_a[1], + ) + ) + return cable.exists() + + +def check_termination_types(type_a, type_b) -> Tuple[bool, str]: + if type_a in POWER_TERMINATIONS and type_b in POWER_TERMINATIONS: + if type_a == type_b: + return False, "Can't connect the same power terminations together" + elif ( + type_a == POWER_OUTLET_TERMINATION + and type_b == POWER_FEED_TERMINATION + or type_a == POWER_FEED_TERMINATION + and type_b == POWER_OUTLET_TERMINATION + ): + return False, "PowerOutlet can't be connected with PowerFeed" + elif type_a in POWER_TERMINATIONS or type_b in POWER_TERMINATIONS: + return False, "Can't mix power terminations with port terminations" + elif type_a in FRONT_AND_REAR or type_b in FRONT_AND_REAR: + return True, "" + elif ( + type_a == CONSOLE_PORT_TERMINATION + and type_b != CONSOLE_SERVER_PORT_TERMINATION + or type_b == CONSOLE_PORT_TERMINATION + and type_a != CONSOLE_SERVER_PORT_TERMINATION + ): + return False, "ConsolePorts can only be connected to ConsoleServerPorts or Front/Rear ports" + return True, "" + + +def get_cable_name(termination_a: tuple, termination_b: tuple) -> str: + """Returns name of a cable in format: + device_a interface_a <---> interface_b device_b + or for circuits: + circuit_a termination_a <---> termination_b circuit_b + """ + cable_name = [] + + for is_side_b, termination in enumerate([termination_a, termination_b]): + try: + power_panel_id = getattr(termination[0], "power_panel_id", None) + if power_panel_id: + power_feed = PowerPanel.objects.get(id=power_panel_id) + segment = [f"{power_feed}", f"{termination[0]}"] + else: + segment = [f"{termination[0].device}", f"{termination[0]}"] + except AttributeError: + segment = [f"{termination[0].circuit.cid}", f"{termination[0]}"] + + if is_side_b: + segment.reverse() + + cable_name.append(" ".join(segment)) + + return " <---> ".join(cable_name) + + +def check_interface_types(*args): + for termination in args: + try: + if termination.type in VIRTUAL_INTERFACES: + raise Exception( + f"⚠️ Virtual interfaces are not supported for cabling. " + f"Termination {termination.device} {termination} {termination.type}" + ) + except AttributeError: + # CircuitTermination dosn't have a type field + pass + +def check_terminations_are_free(*args): + any_failed = False + for termination in args: + if termination.cable_id: + any_failed = True + print(f"⚠️ Termination {termination} is already occupied with cable #{termination.cable_id}") + if any_failed: + raise Exception(f"⚠️ At least one end of the cable is already occupied.") + +cables = load_yaml("/opt/netbox/initializers/cables.yml") + +if cables is None: + sys.exit() + +for params in cables: + params["termination_a_class"] = get_termination_class(params.get("termination_a_class")) + params["termination_b_class"] = get_termination_class(params.get("termination_b_class")) + + term_a = get_termination_object(params, side="a") + term_b = get_termination_object(params, side="b") + + check_interface_types(term_a, term_b) + + term_a_ct = ContentType.objects.get_for_model(term_a) + term_b_ct = ContentType.objects.get_for_model(term_b) + + types_ok, msg = check_termination_types(term_a_ct, term_b_ct) + cable_name = get_cable_name((term_a, term_a_ct), (term_b, term_b_ct)) + + if not types_ok: + print(f"⚠️ Invalid termination types for {cable_name}. {msg}") + continue + + if cable_in_cables((term_a, term_a_ct), (term_b, term_b_ct)): + continue + + check_terminations_are_free(term_a, term_b) + + params["termination_a_id"] = term_a.id + params["termination_b_id"] = term_b.id + params["termination_a_type"] = term_a_ct + params["termination_b_type"] = term_b_ct + + cable = Cable.objects.create(**params) + + print(f"🧷 Created cable {cable} {cable_name}")