NFDC-ROUTE(1)

📦
version 24.07 · 2 versions
, in nixos 26.05

✨ NFDC-ROUTE(1) ✨

okay bestie, buckle up 💅 this is the nfdc-route page from the Named Data Networking Forwarding Daemon (NFD) manual, and it's literally all about showing off and rearranging NFD's routes. no cap, it's giving "network admin but make it cute" 🎀

🌸 NAME 🌸

nfdc-route — show and manipulate NFD's routes 👑 (yes, both. you get to look AND touch.)

🦋 SYNOPSIS 🦋

nfdc route [list [[nexthop] FACEID|FACEURI] [origin ORIGIN]]
nfdc route show [prefix] PREFIX
nfdc route add [prefix] PREFIX [nexthop] FACEID|FACEURI [origin ORIGIN] [cost COST] [no-inherit] [capture] [expires EXPIRATION]
nfdc route remove [prefix] PREFIX [nexthop] FACEID|FACEURI [origin ORIGIN]
nfdc fib [list]

look at all those brackets, she's flexible 💜

✨ DESCRIPTION ✨

so in NFD, the routing information base (RIB) is basically the main character 😌 — it stores static or dynamic routing information that's been registered by applications, operators, and NFD itself. every route in the RIB is out here saying "hey, contents under a name prefix may be available via a nexthop" 👀. and a route is made of: a name prefix, a nexthop face, the origin, a cost, and a set of route inheritance flags. wanna know more? go peek at the NFD Management protocol, iykyk 📖.

  • the nfdc route list command lists RIB routes, optionally filtered by nexthop and origin 🔍
  • the nfdc route show command shows RIB routes at a specified name prefix
  • the nfdc route add command requests to add a route. and listen — if a route with the same prefix, nexthop, and origin already exists, it gets updated with the specified cost, route inheritance flags, and expiration period 🔥. this command returns when the request has been accepted, but it does not wait for RIB update completion (so don't @ her about it). also, if no face matching the specified URI is found, nfdc will attempt to implicitly create a face with this URI before adding the route. iconic behavior tbh ✨
  • the nfdc route remove command removes a route with matching prefix, nexthop, and origin 🗑️
  • the nfdc fib list command shows the forwarding information base (FIB), which is calculated from RIB routes and used directly by NFD forwarding 💫

💅 OPTIONS 💅

  • <PREFIX> — name prefix of the route. the whole vibe, the address, the moment 🏷️
  • <FACEID> — numerical identifier of the face. you can find it displayed in the output of nfdc face list and nfdc face create commands. it's literally right there bestie 🫶
  • <FACEURI> — an URI representing the remote endpoint of a face. heads up: in the nfdc route add command, it must uniquely match an existing face. in the nfdc route remove command, it must match one or more existing faces. ⚠️

for more details on the syntax, see the FaceUri section <https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#FaceUri> of the NFD Face Management protocol. the wiki is your friend, fr fr 📚

  • <ORIGIN> — origin of the route, i.e., who is announcing the route. the default is 255, indicating a static route. so if you don't say anything, she assumes static 💁‍♀️
  • <COST> — the administrative cost of the route. the default is 0. free of charge, no notes 💸
  • no-inherit — unset CHILD_INHERIT flag in the route. bye felicia to that flag 👋
  • capture — set CAPTURE flag in the route 🎯
  • <EXPIRATION> — expiration time of the route, in milliseconds. when the route expires, NFD removes it from the RIB. the default is infinite, which keeps the route active until the nexthop face is destroyed. so like, forever unless something else happens first 💀

🔥 EXIT STATUS 🔥

  • 0 — Success. slay 💖
  • 1 — An unspecified error occurred. 😭
  • 2 — Malformed command line. check ur typing bestie 🙈
  • 3 — Face not found. where is she 👀
  • 4 — FaceUri canonization failed.
  • 5 — Ambiguous: multiple matching faces are found (nfdc route add only). pick one, not all of them 💅
  • 6 — Route not found (nfdc route list and nfdc route show only).

🌈 EXAMPLES 🌈

  • nfdc route list — List all routes. the full collection, the whole wardrobe 👑
  • nfdc route list nexthop 300 — List routes whose nexthop is face 300.
  • nfdc route list origin static — List static routes.
  • nfdc route show prefix /localhost/nfd — List routes with name prefix "/localhost/nfd".
  • nfdc route add prefix /ndn nexthop 300 cost 100 — Add a route with prefix "/ndn" toward face 300, with administrative cost 100. chef's kiss 😘
  • nfdc route add prefix / nexthop udp://router.example.net — Add a route with prefix "/" toward a face with the specified remote FaceUri. going to the root, bold move 🚀
  • nfdc route remove prefix /ndn nexthop 300 origin static — Remove the route whose prefix is "/ndn", nexthop is face 300, and origin is "static". bye route 🗑️

🫶 SEE ALSO 🫶

  • nfdc(1) — the main character herself 💜

Copyright © 2014-2024 Named Data Networking Project. all rights reserved, all vibes reserved 💖

okay that's the whole page bestie, go forth and route responsibly 🌸

and as a lil sign-off: this is version 24.07 of the page, dated 1980-01-01 — yes the date is silly, no we don't ask questions, periodt 💀✨💅

📦 where this page comes from