NFDC-FACE(1)

📦
version 24.07 · 2 versions
, in nixos 26.05

💅 nfdc-face — show and manipulate NFD's faces ✨

okay bestie, welcome to the nfdc-face page from the Named Data Networking Forwarding Daemon (NFD) manual. this one's all about faces and channels, and honestly? it's giving network-interface-glow-up. let's go 🫶

🌸 SYNOPSIS

nfdc face [list [[remote] FACEURI] [local FACEURI] [scheme SCHEME]]
nfdc face show [id] FACEID
nfdc face create [remote] FACEURI [[persistency] PERSISTENCY] [local FACEURI]
  [mtu MTU] [reliability on|off] [congestion-marking on|off]
  [congestion-marking-interval MARKING-INTERVAL]
  [default-congestion-threshold CONGESTION-THRESHOLD]
nfdc face destroy [face] FACEID|FACEURI
nfdc channel [list]

🦋 DESCRIPTION

so in NFD, a face is basically the generalization of a network interface. like, it could be:

  • a physical network interface talking over a physical link
  • an overlay communication channel between NFD and some remote node
  • an inter-process communication channel between NFD and a local application

iconic range, honestly 👑

the commands, bestie

nfdc face list — shows a list of faces, their properties, and statistics. you can optionally filter by remote endpoint, local endpoint, and FaceUri scheme. and heads up: when you specify multiple filters, the returned faces have to satisfy all of them. no partial credit, periodt.

nfdc face show — shows properties and statistics for one specific face. just the one. main character energy 🎀

nfdc face create — creates a UDP unicast, TCP, or Ethernet unicast face. if the face already exists, the args you specified get used to update its properties, if possible. some deets:

  • Local FaceUri is required for creating Ethernet unicast faces; otherwise it must be omitted. yes, that's a whole vibe check, get it right.
  • The NDNLPv2 unicast reliability feature may be explicitly enabled by specifying reliability on, or explicitly disabled by specifying reliability off. if you enable it, it must also be enabled on the other endpoint to function properly. reliability is disabled by default.
  • The send queue congestion detection and signaling feature may be explicitly enabled by specifying congestion-marking on, or explicitly disabled by specifying congestion-marking off. congestion marking is enabled by default on TCP, UDP, and Unix stream faces, and disabled by default on all other face types.
  • Parameters for this feature can be set with the congestion-marking-interval option (specified in milliseconds) and the default-congestion-threshold option (specified in bytes).
  • The effective MTUs of unicast Ethernet and UDP faces may be overridden using the mtu parameter (specified in bytes). the forwarder may limit the range of this override MTU, and will use the minimum of it and the MTU of the underlying Ethernet or UDP transport.

nfdc face destroy — destroys an existing face. bye bestie 💀

nfdc channel list — shows a list of channels. channels are listening sockets that can accept incoming connections and create new faces. little face factories fr fr.

✨ OPTIONS ✨

  • <FACEID> — the numerical identifier of the face. it's displayed in the output of nfdc face list and nfdc face create commands.
  • <FACEURI> — a URI representing the remote or local endpoint of a face. examples, served fresh:
    • udp4://192.0.2.1:6363
    • udp6://[2001:db8::1]:6363
    • udp://example.net
    • tcp4://192.0.2.1:6363
    • tcp6://[2001:db8::1]:6363
    • <tcp://example.net>
    • unix:///run/nfd/nfd.sock
    • fd://6
    • ether://[08:00:27:01:01:01]
    • dev://eth0

see the FaceUri section <https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#FaceUri> of the NFD Face Management protocol for more details on the syntax. and if a hostname is specified, nfdc will perform a DNS resolution to obtain the corresponding IP address 🔥

  • <SCHEME> — the scheme portion of either the remote or local endpoint. examples:
    • udp4
    • unix
    • dev
  • <PERSISTENCY> — either "persistent" or "permanent". a "persistent" face (the default) is closed when a socket error occurs. a "permanent" face survives socket errors, and is closed only with a nfdc destroy command. permanent face said "i'm not leaving" 💅
  • <MTU> — the MTU used to override the MTU of the underlying transport on Ethernet and UDP faces. this MTU serves as an upper bound for the MTU provided by the transport. the range of acceptable values may be limited by the forwarder. to unset this override, specify the MTU as "auto".
  • <MARKING-INTERVAL> — the initial marking interval (in milliseconds) during an incident of congestion.
  • <CONGESTION-THRESHOLD> — this value serves two purposes: it's the maximum bound of the congestion threshold for the face, and the default threshold used if the face does not support retrieving the capacity of the send queue. two jobs, one option, we love a multitasker 🌈

🎀 EXIT STATUS

  • 0 — Success. slay ✨
  • 1 — An unspecified error occurred.
  • 2 — Malformed command line.
  • 3 — Face not found (nfdc face show and nfdc face destroy only).
  • 4 — FaceUri canonization failed (nfdc face create and nfdc face destroy only).
  • 5 — Ambiguous: multiple matching faces are found (nfdc face destroy only).

🍓 EXAMPLES

nfdc face list List all faces.

nfdc face list scheme udp4 List all UDP-over-IPv4 faces.

nfdc face show id 300 Show information about the face whose FaceId is 300.

nfdc face create remote udp://router.example.net Create a face with the specified remote FaceUri, keeping all other settings at their defaults.

nfdc face create remote ether://[08:00:27:01:01:01] local dev://eth2 persistency permanent Create a face with the specified remote FaceUri, local FaceUri, and persistency.

nfdc face create remote udp://router.example.net reliability on Create a face with the specified remote FaceUri and enable NDNLP reliability.

nfdc face create remote udp://router.example.net congestion-marking-interval 100 default-congestion-threshold 65536 Create a face with the specified remote FaceUri. Set the base congestion marking interval to 100 ms and the default congestion threshold to 65536 bytes.

nfdc face create remote udp://router.example.net congestion-marking off Create a face with the specified remote FaceUri and explicitly disable congestion marking.

nfdc face create remote udp://router.example.net mtu 4000 Create a face with the specified remote FaceUri and set the override MTU to 4000 bytes.

nfdc face destroy 300 Destroy the face whose FaceId is 300.

nfdc face destroy udp4://192.0.2.1:6363 Destroy the face whose remote FaceUri is "udp4://192.0.2.1:6363".

💜 SEE ALSO

nfdc(1) — go read it, bestie, iykyk 🧚

Copyright © 2014-2024 Named Data Networking Project. no cap, all theirs.

okay that's the whole page!! this was from the NFD manual, version 24.07, dated 1980-01-01 (yes really, that date is iconic in a cursed way 😭). go forth and manage your faces, you absolute queen 👑💖

📦 where this page comes from