netbox-docker/startup_scripts/370_ip_addresses.py

import sys

from dcim.models import Device, Interface
from django.contrib.contenttypes.models import ContentType
from django.db.models import Q
from ipam.models import VRF, IPAddress
from netaddr import IPNetwork
from startup_script_utils import (
    load_yaml,
    pop_custom_fields,
    set_custom_fields_values,
    split_params,
)
from tenancy.models import Tenant
from virtualization.models import VirtualMachine, VMInterface

ip_addresses = load_yaml("/opt/netbox/initializers/ip_addresses.yml")

if ip_addresses is None:
    sys.exit()

match_params = ["address", "vrf"]
optional_assocs = {
    "tenant": (Tenant, "name"),
    "vrf": (VRF, "name"),
    "interface": (Interface, "name"),
}

vm_interface_ct = ContentType.objects.filter(
    Q(app_label="virtualization", model="vminterface")
).first()
interface_ct = ContentType.objects.filter(Q(app_label="dcim", model="interface")).first()

for params in ip_addresses:
    custom_field_data = pop_custom_fields(params)

    vm = params.pop("virtual_machine", None)
    device = params.pop("device", None)
    params["address"] = IPNetwork(params["address"])

    if vm and device:
        print("IP Address can only specify one of the following: virtual_machine or device.")
        sys.exit()

    for assoc, details in optional_assocs.items():
        if assoc in params:
            model, field = details
            if assoc == "interface":
                if vm:
                    vm_id = VirtualMachine.objects.get(name=vm).id
                    query = {"name": params.pop(assoc), "virtual_machine_id": vm_id}
                    params["assigned_object_type"] = vm_interface_ct
                    params["assigned_object_id"] = VMInterface.objects.get(**query).id
                elif device:
                    dev_id = Device.objects.get(name=device).id
                    query = {"name": params.pop(assoc), "device_id": dev_id}
                    params["assigned_object_type"] = interface_ct
                    params["assigned_object_id"] = Interface.objects.get(**query).id
            else:
                query = {field: params.pop(assoc)}

                params[assoc] = model.objects.get(**query)

    matching_params, defaults = split_params(params, match_params)
    ip_address, created = IPAddress.objects.get_or_create(**matching_params, defaults=defaults)

    if created:
        print("🧬 Created IP Address", ip_address.address)

    set_custom_fields_values(ip_address, custom_field_data)