get_device_health
Get a combined health view for one ION element: operational state, software status, and optional interface status. Resolves by name or ID, rejecting ambiguous matches.
Instructions
Return a combined health view for one ION element.
element and site accept names or IDs. The tool resolves IDs safely,
fetches element operational state, optionally software state/status, and can
fan out to interface status. Interface fan-out is intentionally bounded.
Args:
element: Element name, serial number, hardware ID, or exact
controller ID. If it resolves to exactly one record, site can
be omitted — the element's own site is used. Ambiguous names
(e.g. a short substring matching many elements) fail instead of
guessing; pass an exact name/ID or add site to narrow it.
site: Site name or controller ID that should own element. Optional
when element already resolves uniquely on its own.
include_software: When true (default), also fetch software
state/status for the element. A failure here is reported inline
under partial_errors rather than failing the whole call.
include_interfaces: When true, also fan out to per-interface status
(bounded by interface_limit). Off by default because it adds
one API call per interface.
interface_limit: Max interfaces to fetch status for when
include_interfaces is true. Ignored otherwise. Must be between
1 and the server's fan-out ceiling (default 100).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | No | Site name or controller ID that should own `element`. Optional when `element` already resolves uniquely on its own. | |
| element | Yes | Element name, serial number, hardware ID, or exact controller ID. If it resolves to exactly one record, `site` can be omitted — the element's own site is used. Ambiguous names (e.g. a short substring matching many elements) fail instead of guessing; pass an exact name/ID or add `site` to narrow it. | |
| interface_limit | No | Max interfaces to fetch status for when `include_interfaces` is true. Ignored otherwise. Must be between 1 and the server's fan-out ceiling (default 100). | |
| include_software | No | When true (default), also fetch software state/status for the element. A failure here is reported inline under `partial_errors` rather than failing the whole call. | |
| include_interfaces | No | When true, also fan out to per-interface status (bounded by `interface_limit`). Off by default because it adds one API call per interface. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |