mirror of
https://github.com/netbox-community/netbox-docker.git
synced 2024-11-22 16:03:10 +01:00
Merge pull request #742 from kr3ator/feature/device_type_components
Add support for DeviceType components
This commit is contained in:
commit
2c757af250
@ -21,3 +21,36 @@
|
||||
# slug: other
|
||||
# custom_field_data:
|
||||
# text_field: Description
|
||||
# interfaces:
|
||||
# - name: eth0
|
||||
# type: 1000base-t
|
||||
# mgmt_only: True
|
||||
# - name: eth1
|
||||
# type: 1000base-t
|
||||
# console_server_ports:
|
||||
# - name_template: ttyS[1-48]
|
||||
# type: rj-45
|
||||
# power_ports:
|
||||
# - name: psu0 # both non-template and template field specified; non-template field takes precedence
|
||||
# name_template: psu[0,1]
|
||||
# type: iec-60320-c14
|
||||
# maximum_draw: 35
|
||||
# allocated_draw: 35
|
||||
# front_ports:
|
||||
# - name_template: front[1,2]
|
||||
# type: 8p8c
|
||||
# rear_port_template: rear[0,1]
|
||||
# rear_port_position_template: "[1,2]"
|
||||
# rear_ports:
|
||||
# - name_template: rear[0,1]
|
||||
# type: 8p8c
|
||||
# positions_template: "[3,2]"
|
||||
# device_bays:
|
||||
# - name_template: bay[0-9]
|
||||
# label_template: test[0-5,9,6-8]
|
||||
# description: Test description
|
||||
# power_outlets:
|
||||
# - name_template: outlet[0,1]
|
||||
# type: iec-60320-c5
|
||||
# power_port: psu0
|
||||
# feed_leg: B
|
||||
|
@ -1,6 +1,17 @@
|
||||
import sys
|
||||
from typing import List
|
||||
|
||||
from dcim.models import DeviceType, Manufacturer, Region
|
||||
from dcim.models.device_component_templates import (
|
||||
ConsolePortTemplate,
|
||||
ConsoleServerPortTemplate,
|
||||
DeviceBayTemplate,
|
||||
FrontPortTemplate,
|
||||
InterfaceTemplate,
|
||||
PowerOutletTemplate,
|
||||
PowerPortTemplate,
|
||||
RearPortTemplate,
|
||||
)
|
||||
from startup_script_utils import (
|
||||
load_yaml,
|
||||
pop_custom_fields,
|
||||
@ -8,6 +19,53 @@ from startup_script_utils import (
|
||||
split_params,
|
||||
)
|
||||
from tenancy.models import Tenant
|
||||
from utilities.forms.utils import expand_alphanumeric_pattern
|
||||
|
||||
|
||||
def expand_templates(params: List[dict], device_type: DeviceType) -> List[dict]:
|
||||
templateable_fields = ["name", "label", "positions", "rear_port", "rear_port_position"]
|
||||
|
||||
expanded = []
|
||||
for param in params:
|
||||
param["device_type"] = device_type
|
||||
expanded_fields = {}
|
||||
has_plain_fields = False
|
||||
|
||||
for field in templateable_fields:
|
||||
template_value = param.pop(f"{field}_template", None)
|
||||
|
||||
if field in param:
|
||||
has_plain_fields = True
|
||||
expanded.append(param)
|
||||
elif template_value:
|
||||
expanded_fields[field] = list(expand_alphanumeric_pattern(template_value))
|
||||
|
||||
if expanded_fields and has_plain_fields:
|
||||
raise ValueError(f"Mix of plain and template keys provided for {templateable_fields}")
|
||||
|
||||
if not expanded_fields:
|
||||
continue
|
||||
|
||||
elements = list(expanded_fields.values())
|
||||
master_len = len(elements[0])
|
||||
if not all([len(elem) == master_len for elem in elements]):
|
||||
raise ValueError(
|
||||
f"Number of elements in template fields "
|
||||
f"{list(expanded_fields.keys())} must be equal"
|
||||
)
|
||||
|
||||
for idx in range(master_len):
|
||||
tmp = param.copy()
|
||||
for field, value in expanded_fields.items():
|
||||
if field in nested_assocs:
|
||||
model, match_key = nested_assocs[field]
|
||||
query = {match_key: value[idx], "device_type": device_type}
|
||||
tmp[field] = model.objects.get(**query)
|
||||
else:
|
||||
tmp[field] = value[idx]
|
||||
expanded.append(tmp)
|
||||
return expanded
|
||||
|
||||
|
||||
device_types = load_yaml("/opt/netbox/initializers/device_types.yml")
|
||||
|
||||
@ -17,9 +75,22 @@ if device_types is None:
|
||||
match_params = ["manufacturer", "model", "slug"]
|
||||
required_assocs = {"manufacturer": (Manufacturer, "name")}
|
||||
optional_assocs = {"region": (Region, "name"), "tenant": (Tenant, "name")}
|
||||
nested_assocs = {"rear_port": (RearPortTemplate, "name"), "power_port": (PowerPortTemplate, "name")}
|
||||
|
||||
supported_components = {
|
||||
"interfaces": (InterfaceTemplate, ["name"]),
|
||||
"console_ports": (ConsolePortTemplate, ["name"]),
|
||||
"console_server_ports": (ConsoleServerPortTemplate, ["name"]),
|
||||
"power_ports": (PowerPortTemplate, ["name"]),
|
||||
"power_outlets": (PowerOutletTemplate, ["name"]),
|
||||
"rear_ports": (RearPortTemplate, ["name"]),
|
||||
"front_ports": (FrontPortTemplate, ["name"]),
|
||||
"device_bays": (DeviceBayTemplate, ["name"]),
|
||||
}
|
||||
|
||||
for params in device_types:
|
||||
custom_field_data = pop_custom_fields(params)
|
||||
components = [(v[0], v[1], params.pop(k, [])) for k, v in supported_components.items()]
|
||||
|
||||
for assoc, details in required_assocs.items():
|
||||
model, field = details
|
||||
@ -41,3 +112,29 @@ for params in device_types:
|
||||
print("🔡 Created device type", device_type.manufacturer, device_type.model)
|
||||
|
||||
set_custom_fields_values(device_type, custom_field_data)
|
||||
|
||||
for component in components:
|
||||
c_model, c_match_params, c_params = component
|
||||
c_match_params.append("device_type")
|
||||
|
||||
if not c_params:
|
||||
continue
|
||||
|
||||
expanded_c_params = expand_templates(c_params, device_type)
|
||||
|
||||
for n_assoc, n_details in nested_assocs.items():
|
||||
n_model, n_field = n_details
|
||||
for c_param in expanded_c_params:
|
||||
if n_assoc in c_param:
|
||||
n_query = {n_field: c_param[n_assoc], "device_type": device_type}
|
||||
c_param[n_assoc] = n_model.objects.get(**n_query)
|
||||
|
||||
for new_param in expanded_c_params:
|
||||
new_matching_params, new_defaults = split_params(new_param, c_match_params)
|
||||
new_obj, new_obj_created = c_model.objects.get_or_create(
|
||||
**new_matching_params, defaults=new_defaults
|
||||
)
|
||||
if new_obj_created:
|
||||
print(
|
||||
f"🧷 Created {c_model._meta} {new_obj} component for device type {device_type}"
|
||||
)
|
||||
|
Loading…
Reference in New Issue
Block a user