16 Commits

Author SHA1 Message Date
c6dbce8f90 Update README.md
Clarify that this agent is meant to run with Net SNMPd.
2023-08-26 11:58:36 +02:00
aa38c5503f Update README.md
Add a few hints based on previous issues filed in this repo.
Clarify that linux-cp must be used, the API/Stats socket must be accessible, and that no backwards compatibility is given.
2023-08-26 11:55:22 +02:00
43551958f8 Typo fix 2023-01-10 17:13:27 +01:00
b6864530eb Update README.md 2023-01-08 23:11:55 +01:00
72e9cf3503 Update README.md 2022-12-23 16:01:02 +01:00
a56840d849 Update README.md 2022-12-23 10:20:11 +01:00
cde5d4df94 Update README.md 2022-12-23 10:09:06 +01:00
b024a3e96b Move the YAML config to be compatible with vppcfg's config file 2022-07-10 09:47:33 +00:00
a9c9e15828 typo fix 2022-02-27 23:01:19 +00:00
f97f50bf30 Update README 2022-02-27 22:59:55 +00:00
c319ef576d Add an optional configuration file
A simple convenience configfile can provide a mapping between VPP
interface names, Linux Control Plane interface names, and descriptions.
An example:

```
interfaces:
  "TenGigabitEthernet6/0/0":
    description: "Infra: xsw0.chrma0:2"
    lcp: "xe1-0"
  "TenGigabitEthernet6/0/0.3102":
    description: "Infra: QinQ to Solnet for Daedalean"
    lcp: "xe1-0.3102"
  "TenGigabitEthernet6/0/0.310211":
    description: "Cust: Daedalean IP Transit"
    lcp: "xe1-0.3102.11"
```

This configuration file is completely optional. If the `-c` flag is
empty, or it's set but the file does not exist, the Agent will simply
enumerate all interfaces, and set the `ifAlias` OID to the same value
as the `ifName`. However, if the config file is read, it will change
the behavior as follows:

*  Any `tapNN` interface names from VPP will be matched to their PHY by
   looking up their Linux Control Plane interface. The `ifName` field
   will be rewritten to the _LIP_ `host-if`. For example, `tap3` above
   will become `xe1-0` while `tap3.310211` will become `xe1-0.3102.11`.
*  The `ifAlias` OID for a PHY will be set to the `description` field.
*  The `ifAlias` OID for a TAP will be set to the string `LCP: `
   followed by its PHY `ifName`. For example, `xe1-0.3102.11` will
    become `LCP TenGigabitEthernet6/0/0.310211 (tap9)`
2022-02-27 22:58:03 +00:00
610d03a14b Refactor README.md 2021-09-12 16:31:13 +00:00
5051ab32ce Update README with the -h/--help argparse hint 2021-09-12 16:22:22 +00:00
96f2a3b4b3 Move to /usr/sbin instead of /usr/local/sbin 2021-09-11 12:55:28 +00:00
8256c6abfc Update README with build/run instructions 2021-09-05 15:39:26 +00:00
51eee915bf initial checkin 2021-09-05 15:13:12 +00:00