add capture group names to data model docs

networktocode · Jan 7, 2024 · 0b50e2a · 0b50e2a
1 parent 9046ac1
commit 0b50e2a
Showing 1 changed file with 30 additions and 24 deletions.
diff --git a/docs/dev/data_model.md b/docs/dev/data_model.md
@@ -18,27 +18,33 @@ Example: Imagine the extra programming logic needed to consume structured data w
 
 # Common Capture Groups
 
-| Capture Group      | Usage Description |
-|--------------------|:------------------|
-| `BIA`              | use this if the template already has MAC_ADDRESS in use for the active MAC address |
-| `DESCRIPTION`      | often used for port or interface descriptions |
-| `GATEWAY`          | gateway address for a subnet |
-| `INTERFACE`        | full word instead of IFACE, INTF, INTFC, etc |
-| `IP_ADDRESS`       | for a single IP address, often IPv4 |
-| `IP_ADDRESSES`     | for lists of IPv4 addresses, but in the case of some templates there may be a mix of IP protocol versions |
-| `IP_HELPER`        | for lists DHCP IP helper addresses |
-| `IP_VERSION`       | Internet Protocol (IP) version in the case of multiple versions appearing in output (use where necessary) |
-| `IPV6_ADDRESS`     | for a single IPv6 address |
-| `IPV6_ADDRESSES`   | for lists of IPv6 addresses |
-| `IPV6_GATEWAY`     | for IPv6 gateway address |
-| `LOCAL_IP_ADDRESS` | local IP address in the case of First Hop Redundancy Protocols (FHRP)
-| `MAC_ADDRESS`      | instead of MAC or MACADDR |
-| `MGMT_IP_ADDRESS`  | instead of MGMT_IP or MGMT_ADDRESS or MANAGEMENT_IP or REMOTE_MANAGEMENT_ADDRESS |
-| `NEIGHBOR_ID`      | for router IDs remote to the system being parsed |
-| `NETMASK`          | for IPv4 dotted quad masks |
-| `NETWORK`          | for network numbers or subnet address (without the mask or prefix/slash notation); in place of ROUTE |
-| `PREFIX_LENGTH`    | instead of PREFIX or CIDR for the numbers of a slash notation or CIDR mask |
-| `PROTOCOL`         | instead of PROTO |
-| `ROUTER_ID`        | for local router IDs (local to the device being parsed) |
-| `VLAN_ID`          | instead of VLAN or TAG |
-| `VLAN_NAME`        | VLAN name or description |
+| Capture Group             | Usage Description |
+|---------------------------|:------------------|
+| `BIA`                     | use this if the template already has MAC_ADDRESS in use for the active MAC address |
+| `BUNDLE_NAME`             | virtual interface name for etherchannel, LACP, LAG, or port-channel interfaces |
+| `BUNDLE_PROTOCOL`         | virtual interface protocol type (LACP, PAgP) for etherchannel or port-channel interfaces |
+| `BUNDLE_PROTOCOL_STATE`   | virtual interface protocol state for etherchannel or port-channel interfaces |
+| `BUNDLE_STATUS`           | virtual interface status for etherchannel, LACP, LAG, or port-channel interfaces |
+| `DESCRIPTION`             | often used for port or interface descriptions |
+| `GATEWAY`                 | gateway address for a subnet |
+| `INTERFACE`               | full word instead of IFACE, INTF, INTFC, etc |
+| `IP_ADDRESS`              | for a single IP address, often IPv4 |
+| `IP_ADDRESSES`            | for lists of IPv4 addresses, but in the case of some templates there may be a mix of IP protocol versions |
+| `IP_HELPER`               | for lists DHCP IP helper addresses |
+| `IP_VERSION`              | Internet Protocol (IP) version in the case of multiple versions appearing in output (use where necessary) |
+| `IPV6_ADDRESS`            | for a single IPv6 address |
+| `IPV6_ADDRESSES`          | for lists of IPv6 addresses |
+| `IPV6_GATEWAY`            | for IPv6 gateway address |
+| `LOCAL_IP_ADDRESS`        | local IP address in the case of First Hop Redundancy Protocols (FHRP)
+| `MAC_ADDRESS`             | instead of MAC or MACADDR |
+| `MEMBER_INTERFACE`        | list of physical member interface names that are bundled to make an etherchannel, LACP, LAG, or port-channel interface |
+| `MEMBER_INTERFACE_STATUS` | list of member interface statuses for an etherchannel, LACP, LAG, or port-channel interface |
+| `MGMT_IP_ADDRESS`         | instead of MGMT_IP or MGMT_ADDRESS or MANAGEMENT_IP or REMOTE_MANAGEMENT_ADDRESS |
+| `NEIGHBOR_ID`             | for router IDs remote to the system being parsed |
+| `NETMASK`                 | for IPv4 dotted quad masks |
+| `NETWORK`                 | for network numbers or subnet address (without the mask or prefix/slash notation); in place of ROUTE |
+| `PREFIX_LENGTH`           | instead of PREFIX or CIDR for the numbers of a slash notation or CIDR mask |
+| `PROTOCOL`                | instead of PROTO |
+| `ROUTER_ID`               | for local router IDs (local to the device being parsed) |
+| `VLAN_ID`                 | instead of VLAN or TAG |
+| `VLAN_NAME`               | VLAN name or description |