action netboxdemo_dcim_connected_device_list { label: "dcim_connected-device_list" description: "This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer\ninterface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors\nvia a protocol such as LLDP. Two query parameters must be included in the request:\n\n* `peer_device`: The name of the peer device\n* `peer_interface`: The name of the peer interface" provider: netboxdemo method: GET path: "/dcim/connected-device/" encoding: json input: { type: "object" properties: { peer_device: { type: "string" } peer_interface: { type: "string" } } required: ["peer_device", "peer_interface"] additionalProperties: false } output: { type: "object" required: ["device_role", "device_type", "site"] properties: { asset_tag: { type: "string" description: "A unique tag used to identify this device" } cluster: { type: "object" required: ["name"] properties: { id: { type: "integer" } name: { type: "string" } url: { type: "string" format: "uri" } virtualmachine_count: { type: "integer" } } } comments: { type: "string" } created: { type: "string" format: "date" } custom_fields: { type: "object" } device_role: { type: "object" required: ["name", "slug"] properties: { device_count: { type: "integer" } id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } virtualmachine_count: { type: "integer" } } } device_type: { type: "object" required: ["model", "slug"] properties: { device_count: { type: "integer" } display_name: { type: "string" } id: { type: "integer" } manufacturer: { type: "object" required: ["name", "slug"] properties: { devicetype_count: { type: "integer" } id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } model: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } display_name: { type: "string" } face: { type: "object" required: ["label", "value"] properties: { label: { type: "string" enum: ["Front", "Rear"] } value: { type: "string" enum: ["front", "rear"] } } } id: { type: "integer" } last_updated: { type: "string" format: "date-time" } local_context_data: { type: "string" } name: { type: "string" } parent_device: { type: "object" properties: { display_name: { type: "string" } id: { type: "integer" } name: { type: "string" } url: { type: "string" format: "uri" } } } platform: { type: "object" required: ["name", "slug"] properties: { device_count: { type: "integer" } id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } virtualmachine_count: { type: "integer" } } } position: { type: "integer" description: "The lowest-numbered unit occupied by the device" } primary_ip: { type: "object" required: ["address"] properties: { address: { type: "string" description: "IPv4 or IPv6 address (with mask)" } family: { type: "string" } id: { type: "integer" } url: { type: "string" format: "uri" } } } primary_ip4: { type: "object" additionalProperties: true } primary_ip6: { type: "object" additionalProperties: true } rack: { type: "object" required: ["name"] properties: { device_count: { type: "integer" } display_name: { type: "string" } id: { type: "integer" } name: { type: "string" } url: { type: "string" format: "uri" } } } serial: { type: "string" } site: { type: "object" required: ["name", "slug"] properties: { id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } status: { type: "object" required: ["label", "value"] properties: { label: { type: "string" enum: ["Offline", "Active", "Planned", "Staged", "Failed", "Inventory", "Decommissioning"] } value: { type: "string" enum: ["offline", "active", "planned", "staged", "failed", "inventory", "decommissioning"] } } } tags: { type: "array" items: { type: "string" } } tenant: { type: "object" required: ["name", "slug"] properties: { id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } vc_position: { type: "integer" } vc_priority: { type: "integer" } virtual_chassis: { type: "object" required: ["master"] properties: { id: { type: "integer" } master: { type: "object" additionalProperties: true } member_count: { type: "integer" } url: { type: "string" format: "uri" } } } } } }