Skip to content

docs(examples): cable terminations example (OBS-3370, OBS-1080) #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leoparente merged 1 commit into from
Jul 3, 2026
+219 −2
Merged

docs(examples): cable terminations example (OBS-3370, OBS-1080) #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
221 changes: 219 additions & 2 deletions docs/examples/cable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,16 @@
from netboxlabs.diode.sdk.ingester import (
Cable,
CableBundle,
Device,
DeviceRole,
DeviceType,
Entity,
GenericObject,
Interface,
Manufacturer,
Owner,
OwnerGroup,
Site,
Tag,
Tenant,
)
Expand Down Expand Up @@ -50,14 +57,84 @@ def cable_minimal() -> Cable:
"""Create a Cable with only required fields using flat strings."""
return Cable(
metadata={"source": "example"},
a_terminations=[
GenericObject(
object_interface=Interface(
device=Device(
device_type=DeviceType(
manufacturer=Manufacturer(
name="Example Name",
slug="example-slug",
metadata={"source": "example"},
),
model="Model X",
slug="example-slug",
metadata={"source": "example"},
),
role=DeviceRole(
name="Example Name",
slug="example-slug",
color="0000ff",
metadata={"source": "example"},
),
site=Site(
name="Example Name",
slug="example-slug",
status="active",
metadata={"source": "example"},
),
status="active",
metadata={"source": "example"},
),
name="Example Name A",
type="1000base-t",
metadata={"source": "example"},
)
)
],
b_terminations=[
GenericObject(
object_interface=Interface(
device=Device(
device_type=DeviceType(
manufacturer=Manufacturer(
name="Example Name",
slug="example-slug",
metadata={"source": "example"},
),
model="Model X",
slug="example-slug",
metadata={"source": "example"},
),
role=DeviceRole(
name="Example Name",
slug="example-slug",
color="0000ff",
metadata={"source": "example"},
),
site=Site(
name="Example Name",
slug="example-slug",
status="active",
metadata={"source": "example"},
),
status="active",
metadata={"source": "example"},
),
name="Example Name B",
type="1000base-t",
metadata={"source": "example"},
)
)
],
)


def cable_extended() -> Cable:
"""Create a Cable with common optional fields."""
return Cable(
metadata={"source": "example", "custom_key": "custom_value"},
status="connected",
status="planned",
description="Example description",
color="0000ff",
type="aoc",
Expand All @@ -67,6 +144,76 @@ def cable_extended() -> Cable:
length_unit="cm",
comments="Example comments",
profile="breakout-1c2p-2c1p",
a_terminations=[
GenericObject(
object_interface=Interface(
device=Device(
device_type=DeviceType(
manufacturer=Manufacturer(
name="Example Name",
slug="example-slug",
metadata={"source": "example"},
),
model="Model X",
slug="example-slug",
metadata={"source": "example"},
),
role=DeviceRole(
name="Example Name",
slug="example-slug",
color="0000ff",
metadata={"source": "example"},
),
site=Site(
name="Example Name",
slug="example-slug",
status="active",
metadata={"source": "example"},
),
status="active",
metadata={"source": "example"},
),
name="Example Name A",
type="1000base-t",
metadata={"source": "example"},
)
)
],
b_terminations=[
Comment thread
leoparente marked this conversation as resolved.
GenericObject(
object_interface=Interface(
device=Device(
device_type=DeviceType(
manufacturer=Manufacturer(
name="Example Name",
slug="example-slug",
metadata={"source": "example"},
),
model="Model X",
slug="example-slug",
metadata={"source": "example"},
),
role=DeviceRole(
name="Example Name",
slug="example-slug",
color="0000ff",
metadata={"source": "example"},
),
site=Site(
name="Example Name",
slug="example-slug",
status="active",
metadata={"source": "example"},
),
status="active",
metadata={"source": "example"},
),
name="Example Name B",
type="1000base-t",
metadata={"source": "example"},
)
)
],
)


Expand All @@ -78,7 +225,7 @@ def cable_explicit() -> Cable:
"custom_key": "custom_value",
"collected_at": "2024-01-15T10:30:00Z",
},
status="connected",
status="planned",
description="Example description",
color="0000ff",
comments="Example comments",
Expand All @@ -96,6 +243,76 @@ def cable_explicit() -> Cable:
metadata={"source": "example"},
),
bundle=CableBundle(name="Example Name", metadata={"source": "example"}),
a_terminations=[
GenericObject(
object_interface=Interface(
device=Device(
device_type=DeviceType(
manufacturer=Manufacturer(
name="Example Name",
slug="example-slug",
metadata={"source": "example"},
),
model="Model X",
slug="example-slug",
metadata={"source": "example"},
),
role=DeviceRole(
name="Example Name",
slug="example-slug",
color="0000ff",
metadata={"source": "example"},
),
site=Site(
name="Example Name",
slug="example-slug",
status="active",
metadata={"source": "example"},
),
status="active",
metadata={"source": "example"},
),
name="Example Name A",
type="1000base-t",
metadata={"source": "example"},
)
)
],
b_terminations=[
GenericObject(
object_interface=Interface(
device=Device(
device_type=DeviceType(
manufacturer=Manufacturer(
name="Example Name",
slug="example-slug",
metadata={"source": "example"},
),
model="Model X",
slug="example-slug",
metadata={"source": "example"},
),
role=DeviceRole(
name="Example Name",
slug="example-slug",
color="0000ff",
metadata={"source": "example"},
),
site=Site(
name="Example Name",
slug="example-slug",
status="active",
metadata={"source": "example"},
),
status="active",
metadata={"source": "example"},
),
name="Example Name B",
type="1000base-t",
metadata={"source": "example"},
)
)
],
tags=[Tag(name="production")],
)

Expand Down
Loading