blob: 4fabe2e05c36b0863411abc44202dfef90524d72 [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
Chengyu Fan3331cfa2014-07-25 17:36:31 -060056
hilata6ee6e072014-04-20 17:10:18 -050057 General NFD status:
Chengyu Fan8a53caf2014-08-01 14:08:37 -060058 nfdId=/chengyu/KEY/ksk-1405136377018/ID-CERT
Chengyu Fan3331cfa2014-07-25 17:36:31 -060059 version=2000
60 startTime=20140725T232341.374000
61 currentTime=20140725T233240
62 uptime=538 seconds
63 nNameTreeEntries=10
64 nFibEntries=3
hilata6ee6e072014-04-20 17:10:18 -050065 nPitEntries=2
66 nMeasurementsEntries=0
Chengyu Fan3331cfa2014-07-25 17:36:31 -060067 nCsEntries=56
68 nInInterests=55
69 nOutInterests=54
70 nInDatas=56
71 nOutDatas=47
Chengyu Fanee92fc72014-06-21 14:58:19 -060072 Channels:
Chengyu Fan3331cfa2014-07-25 17:36:31 -060073 ws://[::]:9696
Chengyu Fanee92fc72014-06-21 14:58:19 -060074 unix:///private/var/run/nfd.sock
75 udp6://[::]:6363
76 udp4://0.0.0.0:6363
77 tcp6://[::]:6363
78 tcp4://0.0.0.0:6363
hilata6ee6e072014-04-20 17:10:18 -050079 Faces:
Chengyu Fan3331cfa2014-07-25 17:36:31 -060080 faceid=1 remote=internal:// local=internal:// counters={in={0i 52d 0B} out={51i 0d 0B}} local
81 faceid=254 remote=contentstore:// local=contentstore:// counters={in={0i 0d 0B} out={0i 0d 0B}} local
82 faceid=255 remote=null:// local=null:// counters={in={0i 0d 0B} out={0i 0d 0B}} local
83 faceid=256 remote=udp4://224.0.23.170:56363 local=udp4://129.82.138.211:56363 counters={in={0i 0d 0B} out={0i 0d 0B}}
84 faceid=257 remote=udp4://224.0.23.170:56363 local=udp4://127.0.0.1:56363 counters={in={0i 0d 0B} out={0i 0d 0B}}
85 faceid=258 remote=ether://[01:00:5e:00:17:aa] local=dev://bridge0 counters={in={0i 0d 0B} out={0i 0d 0B}}
86 faceid=259 remote=ether://[01:00:5e:00:17:aa] local=dev://en0 counters={in={0i 0d 0B} out={0i 0d 0B}}
87 faceid=260 remote=ether://[01:00:5e:00:17:aa] local=dev://en1 counters={in={0i 0d 0B} out={0i 0d 0B}}
88 faceid=261 remote=ether://[01:00:5e:00:17:aa] local=dev://en2 counters={in={0i 0d 0B} out={0i 0d 0B}}
89 faceid=262 remote=fd://30 local=unix:///private/var/run/nfd.sock counters={in={24i 6d 4880B} out={6i 16d 8417B}} local on-demand
90 faceid=268 remote=fd://31 local=unix:///private/var/run/nfd.sock counters={in={1i 0d 410B} out={0i 1d 764B}} local on-demand
91 faceid=269 remote=fd://32 local=unix:///private/var/run/nfd.sock counters={in={3i 0d 137B} out={0i 2d 925B}} local on-demand
hilata6ee6e072014-04-20 17:10:18 -050092 FIB:
93 /localhost/nfd nexthops={faceid=1 (cost=0)}
Chengyu Fan3331cfa2014-07-25 17:36:31 -060094 /example/testApp nexthops={faceid=268 (cost=0)}
95 /localhost/nfd/rib nexthops={faceid=262 (cost=0)}
Alexander Afanasyevc2642ca2014-09-01 15:57:35 -070096 RIB:
97 /example/testApp route={faceid=268 (origin=0 cost=0 flags=1)}
Chengyu Fanee92fc72014-06-21 14:58:19 -060098 Strategy choices:
99 / strategy=/localhost/nfd/strategy/best-route