interfaces
Interface settings across the network.
Field | Type | Description |
---|---|---|
Interface | Interface | Interface. |
Access_VLAN | Integer | VLAN number when the switchport mode is access (null otherwise). |
Active | Boolean | Whether the interface is active. |
Admin_Up | Boolean | Whether the interface is administratively enabled. |
All_Prefixes | List of Strings | All IPv4 addresses assigned to the interface. |
Allowed_VLANs | String | Allowed VLAN numbers when the switchport mode is trunk. |
Auto_State_VLAN | Boolean | For VLAN interfaces, whether the operational status depends on member switchports. |
Bandwidth | Double | Nominal bandwidth in bits/sec, used for protocol cost calculations. |
Blacklisted | Boolean | Whether the interface is considered down for maintenance. |
Channel_Group | String | Name of the aggregated interface (e.g., a port channel) to which this interface belongs. |
Channel_Group_Members | List of Strings | For aggregated interfaces (e.g., a port channel), names of constituent interfaces. |
DHCP_Relay_Addresses | List of IPs | IPv4 addresses to which incoming DHCP requests are relayed. |
Declared_Names | List of Strings | Any aliases explicitly defined for this interface. |
Description | String | Configured interface description. |
Encapsulation_VLAN | Integer | Number for VLAN encapsulation. |
HSRP_Groups | List of Strings | HSRP group identifiers. |
HSRP_Version | String | HSRP version that will be used. |
Inactive_Reason | String | Reason why interface is inactive. |
Incoming_Filter_Name | String | Name of the input IPv4 filter. |
MLAG_ID | Integer | MLAG identifier of the interface. |
MTU | Integer | Layer3 MTU of the interface. |
Native_VLAN | Integer | Native VLAN when switchport mode is trunk. |
Outgoing_Filter_Name | String | Name of the output IPv4 filter. |
PBR_Policy_Name | String | Name of policy-based routing (PBR) policy. |
Primary_Address | String | Primary IPv4 address along with the prefix length. |
Primary_Network | String | Primary IPv4 subnet, in canonical form. |
Proxy_ARP | Boolean | Whether proxy ARP is enabled. |
Rip_Enabled | Boolean | Whether RIP is enabled. |
Rip_Passive | Boolean | Whether interface is in RIP passive mode. |
Spanning_Tree_Portfast | Boolean | Whether spanning-tree portfast feature is enabled. |
Speed | Double | Link speed in bits/sec. |
Switchport | Boolean | Whether the interface is configured as switchport. |
Switchport_Mode | String | Switchport mode (ACCESS, DOT1Q_TUNNEL, DYNAMIC_AUTO, DYNAMIC_DESIRABLE, FEX_FABRIC, MONITOR, NONE, TAP, TOOL, TRUNK) for switchport interfaces. |
Switchport_Trunk_Encapsulation | String | Encapsulation type (DOT1Q, ISL, NEGOTIATE) for switchport trunk interfaces. |
VRF | String | Name of the VRF to which the interface belongs. |
VRRP_Groups | List of Integer | All VRRP groups to which the interface belongs. |
Zone_Name | String | Name of the firewall zone to which the interface belongs. |
Copyright notice
Some of these fields are passed through directly from Batfish. The descriptions shown for those fields are taken verbatim from the Batfish documentation.
Batfish is licensed under the Apache License, Version 2.0 (the "License"). See https://github.com/batfish/batfish/blob/master/LICENSE.