GetZoneDevices
frontend / types/graphql/GetZoneDevices
types/graphql/GetZoneDevices
Type Aliases
DeviceEdge
DeviceEdge =
object
Defined in: types/graphql/GetZoneDevices.ts:50
Properties
node
node:
DeviceNode
Defined in: types/graphql/GetZoneDevices.ts:51
DeviceNode
DeviceNode =
object
Defined in: types/graphql/GetZoneDevices.ts:38
Properties
hostname
hostname:
string
Defined in: types/graphql/GetZoneDevices.ts:45
id
id:
string
Defined in: types/graphql/GetZoneDevices.ts:40
idxDevice
idxDevice:
number
Defined in: types/graphql/GetZoneDevices.ts:41
l1interfaces
l1interfaces:
L1Interfaces
Defined in: types/graphql/GetZoneDevices.ts:46
lastPolled
lastPolled:
number|null
Defined in: types/graphql/GetZoneDevices.ts:47
sysDescription
sysDescription:
string
Defined in: types/graphql/GetZoneDevices.ts:39
sysName
sysName:
string
Defined in: types/graphql/GetZoneDevices.ts:44
sysObjectid
sysObjectid:
string
Defined in: types/graphql/GetZoneDevices.ts:42
sysUptime
sysUptime:
number
Defined in: types/graphql/GetZoneDevices.ts:43
Devices
Devices =
object
Defined in: types/graphql/GetZoneDevices.ts:61
Properties
edges
edges:
DeviceEdge[]
Defined in: types/graphql/GetZoneDevices.ts:62
GetZoneDevicesData
GetZoneDevicesData =
object
Defined in: types/graphql/GetZoneDevices.ts:74
Properties
data
data:
object
Defined in: types/graphql/GetZoneDevices.ts:75
zone
zone:
Zone
errors?
optionalerrors:object[]
Defined in: types/graphql/GetZoneDevices.ts:78
message
message:
string
GetZoneDevicesVars
GetZoneDevicesVars =
object
Defined in: types/graphql/GetZoneDevices.ts:81
Properties
id
id:
string
Defined in: types/graphql/GetZoneDevices.ts:82
InterfaceEdge
InterfaceEdge =
object
Defined in: types/graphql/GetZoneDevices.ts:30
This file defines the types used in the GraphQL query for fetching devices in a zone.
It includes types for devices, interfaces, and their relationships.
These types are used to ensure type safety when working with the data returned from the API.
The DeviceNode type represents a device with various properties, including its description, ID
and interfaces.
The InterfaceNode type represents a device interface with various properties,
including its name, status, speed, and associated MAC addresses.
The InterfaceEdge type represents an edge in the list of interfaces,
and the L1Interfaces type represents a collection of these edges.
The DeviceEdge type represents an edge in the list of devices,
and the Devices type represents a collection of these edges.
The ZoneNode type represents a zone containing devices,
and the ZoneEdge type represents an edge in the list of zones.
The Zones type represents a collection of zones.
The GetZoneDevicesData type represents the overall structure of the data returned
from the GraphQL query for zone devices, including any potential errors.
The GetZoneDevicesVars type defines the variables required for the GraphQL query,
specifically the zone ID.
Remarks
This file is part of the Switchmap-NG project, a modern network monitoring and analysis tool. It is designed to provide a type-safe interface for working with GraphQL data in TypeScript. The types defined here are used throughout the application to ensure that the data structures are consistent and correctly typed, reducing the risk of runtime errors and improving developer experience.
See
InterfaceNode for the structure of a device interface.
Properties
node
node:
InterfaceNode
Defined in: types/graphql/GetZoneDevices.ts:31
L1Interfaces
L1Interfaces =
object
Defined in: types/graphql/GetZoneDevices.ts:34
Properties
edges
edges:
InterfaceEdge[]
Defined in: types/graphql/GetZoneDevices.ts:35
Zone
Zone =
object
Defined in: types/graphql/GetZoneDevices.ts:69
Properties
devices
devices:
Devices
Defined in: types/graphql/GetZoneDevices.ts:70
ZoneEdge
ZoneEdge =
object
Defined in: types/graphql/GetZoneDevices.ts:57
Properties
node
node:
ZoneNode
Defined in: types/graphql/GetZoneDevices.ts:58
ZoneNode
ZoneNode =
object
Defined in: types/graphql/GetZoneDevices.ts:53
Properties
devices
devices:
Devices
Defined in: types/graphql/GetZoneDevices.ts:54
Zones
Zones =
object
Defined in: types/graphql/GetZoneDevices.ts:65
Properties
edges
edges:
ZoneEdge[]
Defined in: types/graphql/GetZoneDevices.ts:66