opnsense_list_interfaces
List firewall interfaces to translate config names (lan, wan, opt) into device names (igb0, vlan) with IP addresses and link status.
Instructions
List the firewall's interfaces with their config name, device name, addresses and link status.
This is the mapping tool for the rest of the server. Firewall rules reference the config name (lan, wan, opt1...), while diagnostics, ARP entries and counters report the device name (igb0, vlan0.30, pppoe0). Call this first whenever a question spans both worlds, for example "which rules apply to the IOT VLAN".
Args: params (ListInterfacesInput): Validated input containing: - search (str): Substring filter (default: "") - include_disabled (bool): Include down interfaces (default: True) - limit (int): Max records, 1-200 (default: 25) - offset (int): Records to skip (default: 0) - response_format (ResponseFormat): 'markdown' or 'json'
Returns: str: Markdown table, or JSON with this schema: { "total": int, "count": int, "offset": int, "has_more": bool, "next_offset": int|null, "interfaces": [ { "identifier": str, # config name, e.g. "opt2" "device": str, # device name, e.g. "vlan0.30" "description": str, # label shown in the GUI, e.g. "IOT" "status": str, # "up" / "down" / "no carrier" "ipv4_address": str, "ipv6_address": str, "macaddr": str, "enabled": bool } ] }
Examples: - Use when: "What VLANs are configured?" -> search="vlan" - Use when: "Which device is the GUEST network?" -> search="GUEST" - Don't use when: You want throughput counters (use opnsense_get_interface_statistics)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |