blob: 369252e509e36c3af38001d8bc83fb7766b06cfa [file] [log] [blame]
hilata6ee6e072014-04-20 17:10:18 -05001.. _ndn-autoconfig-server:
2
Alexander Afanasyev49272f72014-04-06 21:49:46 -07003ndn-autoconfig-server
4=====================
5
Davide Pesavento9f6a7d92020-10-06 15:21:48 -04006Synopsis
7--------
Alexander Afanasyev49272f72014-04-06 21:49:46 -07008
Davide Pesavento9f6a7d92020-10-06 15:21:48 -04009**ndn-autoconfig-server** [**-h**] [**-V**] [**-p** *PREFIX*]... *FACEURI*
Alexander Afanasyev49272f72014-04-06 21:49:46 -070010
Alexander Afanasyev49272f72014-04-06 21:49:46 -070011Description
12-----------
13
Niv Sardi5e8755c2016-12-13 14:11:53 -030014``ndn-autoconfig-server`` is a daemon that implements the server part for the stage 1 of
hilata6ee6e072014-04-20 17:10:18 -050015:ref:`NDN hub discovery procedure`.
16
17This daemon essentially waits for Interests for ``/localhop/ndn-autoconf/hub`` and
Niv Sardi5e8755c2016-12-13 14:11:53 -030018satisfies them with a Data packet that contains a TLV-encoded FaceUri block. The value of
19this block is the ``Uri`` for the HUB, preferably a UDP tunnel.
hilata6ee6e072014-04-20 17:10:18 -050020
Junxiao Shif0dfb332017-02-02 05:32:25 +000021``<FACEURI>``
hilata6ee6e072014-04-20 17:10:18 -050022 FaceUri for this NDN hub.
23
Junxiao Shif0dfb332017-02-02 05:32:25 +000024``-p <PREFIX>``
Niv Sardi5e8755c2016-12-13 14:11:53 -030025 A local prefix for which the local hub allows end applications to register prefixes
Yingdi Yu7b0e9cf2014-08-29 14:57:32 -070026 (See more details in :ref:`local-prefix-discovery`). One can supply more than one
27 prefixes. All supplied prefixes will be put into the local prefix discovery data
28 as described in :ref:`local-prefix-discovery`. If no prefix is specified,
29 auto-config-server will not serve any local prefix discovery data.
30
Davide Pesavento59769b12017-11-12 23:52:06 -050031``-h``
32 Print usage and exit.
33
34``-V``
35 Print version number and exit.
36
37Exit status
38-----------
39
400: No error.
41
421: An unspecified error occurred.
43
442: Malformed command line, e.g., invalid, missing, or unknown argument.
45
464: Insufficient privileges.
47
hilata6ee6e072014-04-20 17:10:18 -050048Examples
49--------
50
Alexander Afanasyev49272f72014-04-06 21:49:46 -070051::
52
hilata6ee6e072014-04-20 17:10:18 -050053 ndn-autoconfig-server tcp://spurs.cs.ucla.edu
Alexander Afanasyev49272f72014-04-06 21:49:46 -070054
Yingdi Yu7b0e9cf2014-08-29 14:57:32 -070055 ndn-autoconfig-server -p /ndn/edu/ucla tcp://spurs.cs.ucla.edu
56
hilata6ee6e072014-04-20 17:10:18 -050057See also
58--------
59
60:ref:`ndn-autoconfig`