diode-sdk-python/docs/examples/virtual_circuit_termination.py at develop · netboxlabs/diode-sdk-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
"""
VirtualCircuitTermination entity examples for the Diode Python SDK.

This module demonstrates three patterns for ingesting VirtualCircuitTermination entities:
- virtual_circuit_termination_minimal: Required fields only
- virtual_circuit_termination_extended: Common optional fields
- virtual_circuit_termination_explicit: Fully nested objects with all fields
"""

from netboxlabs.diode.sdk import DiodeClient
from netboxlabs.diode.sdk.ingester import (
    Device,
    DeviceRole,
    DeviceType,
    Entity,
    Interface,
    Manufacturer,
    Provider,
    ProviderNetwork,
    Site,
    Tag,
    VirtualCircuit,
    VirtualCircuitTermination,
    VirtualCircuitType,
)

TARGET = "grpc://localhost:8080/diode"
APP_NAME = "virtual_circuit_termination-example"
APP_VERSION = "1.0.0"
CLIENT_ID = "diode"
CLIENT_SECRET = "changeme"


def main():
    """Main execution - demonstrates ingesting a VirtualCircuitTermination entity."""
    with DiodeClient(
        target=TARGET,
        app_name=APP_NAME,
        app_version=APP_VERSION,
        client_id=CLIENT_ID,
        client_secret=CLIENT_SECRET,
    ) as client:
        # Choose one of the three patterns:
        virtual_circuit_termination = virtual_circuit_termination_minimal()
        # virtual_circuit_termination = virtual_circuit_termination_extended()
        # virtual_circuit_termination = virtual_circuit_termination_explicit()

        response = client.ingest(
            entities=[Entity(virtual_circuit_termination=virtual_circuit_termination)]
        )
        if response.errors:
            print(f"Errors: {response.errors}")
        else:
            print("VirtualCircuitTermination ingested successfully")


def virtual_circuit_termination_minimal() -> VirtualCircuitTermination:
    """Create a VirtualCircuitTermination with only required fields using flat strings."""
    return VirtualCircuitTermination(
        virtual_circuit="Example Virtual Circuit",  # flat string -> VirtualCircuit
        interface="Example Interface",  # flat string -> Interface
        metadata={"source": "example"},
    )


def virtual_circuit_termination_extended() -> VirtualCircuitTermination:
    """Create a VirtualCircuitTermination with common optional fields."""
    return VirtualCircuitTermination(
        virtual_circuit="Example Virtual Circuit",
        interface="Example Interface",
        metadata={"source": "example", "custom_key": "custom_value"},
        description="Example description",
        role="hub",
    )


def virtual_circuit_termination_explicit() -> VirtualCircuitTermination:
    """Create a VirtualCircuitTermination with fully nested objects and all common fields."""
    return VirtualCircuitTermination(
        virtual_circuit=VirtualCircuit(
            cid="CID-001",
            provider_network=ProviderNetwork(
                provider=Provider(
                    name="Example Name",
                    slug="example-slug",
                    metadata={"source": "example"},
                ),
                name="Example Name",
                metadata={"source": "example"},
            ),
            type=VirtualCircuitType(
                name="Example Name",
                slug="example-slug",
                color="0000ff",
                metadata={"source": "example"},
            ),
            status="active",
            metadata={"source": "example"},
        ),
        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",
            type="1000base-t",
            metadata={"source": "example"},
        ),
        metadata={
            "source": "example",
            "custom_key": "custom_value",
            "collected_at": "2024-01-15T10:30:00Z",
        },
        description="Example description",
        role="hub",
        tags=[Tag(name="production")],
    )


if __name__ == "__main__":
    main()