get_vpn_info
Retrieve VPN or VRF information from a network device, with optional filtering by VRF name and request for detailed output.
Instructions
Get VPN/VRF 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_vpn_info"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vrf_name | No | Optional specific VRF name | |
| device_name | Yes | Name of the device in the inventory | |
| include_details | No | Whether to show detailed information (default: False, returns summary only) |
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 |