diode-sdk-python/docs/examples/virtual_device_context.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
"""
VirtualDeviceContext entity examples for the Diode Python SDK.

This module demonstrates three patterns for ingesting VirtualDeviceContext entities:
- virtual_device_context_minimal: Required fields only
- virtual_device_context_extended: Common optional fields
- virtual_device_context_explicit: Fully nested objects with all fields
"""

from netboxlabs.diode.sdk import DiodeClient
from netboxlabs.diode.sdk.ingester import (
    Device,
    DeviceRole,
    DeviceType,
    Entity,
    IPAddress,
    Manufacturer,
    Owner,
    OwnerGroup,
    Site,
    Tag,
    Tenant,
    VirtualDeviceContext,
)

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


def main():
    """Main execution - demonstrates ingesting a VirtualDeviceContext 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_device_context = virtual_device_context_minimal()
        # virtual_device_context = virtual_device_context_extended()
        # virtual_device_context = virtual_device_context_explicit()

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


def virtual_device_context_minimal() -> VirtualDeviceContext:
    """Create a VirtualDeviceContext with only required fields using flat strings."""
    return VirtualDeviceContext(
        name="Example Name",
        device="Example Device",  # flat string -> Device
        status="active",
        metadata={"source": "example"},
    )


def virtual_device_context_extended() -> VirtualDeviceContext:
    """Create a VirtualDeviceContext with common optional fields."""
    return VirtualDeviceContext(
        name="Example Name",
        device="Example Device",
        status="active",
        metadata={"source": "example", "custom_key": "custom_value"},
        description="Example description",
        identifier=1,
        tenant="Example Tenant",
        comments="Example comments",
    )


def virtual_device_context_explicit() -> VirtualDeviceContext:
    """Create a VirtualDeviceContext with fully nested objects and all common fields."""
    return VirtualDeviceContext(
        name="Example Name",
        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"},
        ),
        status="active",
        metadata={
            "source": "example",
            "custom_key": "custom_value",
            "collected_at": "2024-01-15T10:30:00Z",
        },
        description="Example description",
        comments="Example comments",
        identifier=1,
        tenant=Tenant(
            name="Example Name", slug="example-slug", metadata={"source": "example"}
        ),
        primary_ip4=IPAddress(
            address="192.0.2.1/32", status="active", metadata={"source": "example"}
        ),
        primary_ip6=IPAddress(
            address="192.0.2.1/32", status="active", metadata={"source": "example"}
        ),
        owner=Owner(
            name="Example Name",
            group=OwnerGroup(name="Example Name", metadata={"source": "example"}),
            metadata={"source": "example"},
        ),
        tags=[Tag(name="production")],
    )


if __name__ == "__main__":
    main()