get_interface_info
Retrieve interface information from a network device. Get state and configuration of all interfaces or a specific interface by name.
Instructions
Get interface information from a network device.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"device_name": "<device_name>"
},
"name": "get_interface_info"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| interface | No | Optional interface name (e.g., GigabitEthernet0/0/0) When not specified, returns state of all interfaces on the device. When specified, returns detailed configuration and state of only that interface. | |
| device_name | Yes | Name of the device in the inventory |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| nos | Yes | Supported Network Operating Systems | |
| data | No | ||
| status | Yes | Enumeration for network operation status values. Provides type safety and prevents typos when setting or checking operation status in NetworkOperationResult objects. | |
| metadata | No | ||
| ip_address | Yes | ||
| device_name | Yes | ||
| error_response | No | ||
| operation_type | Yes | ||
| feature_not_found_response | No |