blob: 217fca5354d7e8270d31e6092bed6113965aaff2 [file] [log] [blame]
hilata6ee6e072014-04-20 17:10:18 -05001nfd-status
2==========
3
4Usage
5-----
6
7::
8
9 nfd-status [options]
10
11Description
12-----------
13
14``nfd-status`` is a tool to retrieve and print out NFD version and status information.
15
16Options:
17--------
18
19``-h``
20 Print usage information.
21
22``-v``
23 Retrieve version information.
24
Chengyu Fanee92fc72014-06-21 14:58:19 -060025``-c``
26 Retrieve channel status information.
27
hilata6ee6e072014-04-20 17:10:18 -050028``-f``
29 Retrieve face status information.
30
31``-b``
32 Retrieve FIB information.
33
Chengyu Fan30aa2072014-07-20 13:52:32 -060034``-r``
35 Retrieve RIB information.
36
Chengyu Fanee92fc72014-06-21 14:58:19 -060037``-s``
38 Retrieve configured strategy choice for NDN namespaces.
39
40``-x``
41 Output NFD status information in XML format.
42
43``-V``
44 Show version information of nfd-status and exit.
45
hilata6ee6e072014-04-20 17:10:18 -050046If no options are provided, all information is retrieved.
47
Chengyu Fanee92fc72014-06-21 14:58:19 -060048If -x is provided, other options(-v, -c, etc.) are ignored, and all information is printed in XML format.
49
hilata6ee6e072014-04-20 17:10:18 -050050Examples
51--------
52
53Get all status information from NFD::
54
55 $ nfd-status
56 General NFD status:
57 version=1000
Chengyu Fanee92fc72014-06-21 14:58:19 -060058 startTime=20140621T165241.938000
59 currentTime=20140621T170712.007000
60 uptime=870 seconds
61 nNameTreeEntries=8
62 nFibEntries=2
hilata6ee6e072014-04-20 17:10:18 -050063 nPitEntries=2
64 nMeasurementsEntries=0
65 nCsEntries=24
Chengyu Fanee92fc72014-06-21 14:58:19 -060066 nInInterests=33
67 nOutInterests=31
hilata6ee6e072014-04-20 17:10:18 -050068 nInDatas=24
Chengyu Fanee92fc72014-06-21 14:58:19 -060069 nOutDatas=18
70 Channels:
71 unix:///private/var/run/nfd.sock
72 udp6://[::]:6363
73 udp4://0.0.0.0:6363
74 tcp6://[::]:6363
75 tcp4://0.0.0.0:6363
hilata6ee6e072014-04-20 17:10:18 -050076 Faces:
Chengyu Fanee92fc72014-06-21 14:58:19 -060077 faceid=1 remote=internal:// local=internal:// counters={in={0i 26d} out={34i 0d}}
78 faceid=2 remote=udp4://224.0.23.170:56363 local=udp4://192.168.1.103:56363 counters={in={0i 0d} out={0i 0d}}
hilata6ee6e072014-04-20 17:10:18 -050079 faceid=3 remote=udp4://224.0.23.170:56363 local=udp4://127.0.0.1:56363 counters={in={0i 0d} out={0i 0d}}
Chengyu Fanee92fc72014-06-21 14:58:19 -060080 faceid=4 remote=ether://[01:00:5e:00:17:aa] local=dev://bridge0 counters={in={0i 0d} out={0i 0d}}
81 faceid=5 remote=ether://[01:00:5e:00:17:aa] local=dev://en0 counters={in={0i 0d} out={0i 0d}}
82 faceid=6 remote=ether://[01:00:5e:00:17:aa] local=dev://en1 counters={in={0i 0d} out={0i 0d}}
83 faceid=7 remote=fd://27 local=unix:///private/var/run/nfd.sock counters={in={23i 0d} out={0i 8d}}
84 faceid=10 remote=fd://28 local=unix:///private/var/run/nfd.sock counters={in={3i 0d} out={0i 2d}}
hilata6ee6e072014-04-20 17:10:18 -050085 FIB:
86 /localhost/nfd nexthops={faceid=1 (cost=0)}
Chengyu Fanee92fc72014-06-21 14:58:19 -060087 /localhost/nfd/rib nexthops={faceid=7 (cost=0)}
88 Strategy choices:
89 / strategy=/localhost/nfd/strategy/best-route