| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 1 | .. _ndn-autoconfig-server: |
| 2 | |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 3 | ndn-autoconfig-server |
| 4 | ===================== |
| 5 | |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 6 | Usage |
| 7 | ----- |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 8 | |
| 9 | :: |
| 10 | |
| Junxiao Shi | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 11 | ndn-autoconfig-server [-h] [-p <PREFIX>] [-p <PREFIX>] ... <FACEURI> |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 12 | |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 13 | Description |
| 14 | ----------- |
| 15 | |
| Niv Sardi | 5e8755c | 2016-12-13 14:11:53 -0300 | [diff] [blame] | 16 | ``ndn-autoconfig-server`` is a daemon that implements the server part for the stage 1 of |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 17 | :ref:`NDN hub discovery procedure`. |
| 18 | |
| 19 | This daemon essentially waits for Interests for ``/localhop/ndn-autoconf/hub`` and |
| Niv Sardi | 5e8755c | 2016-12-13 14:11:53 -0300 | [diff] [blame] | 20 | satisfies them with a Data packet that contains a TLV-encoded FaceUri block. The value of |
| 21 | this block is the ``Uri`` for the HUB, preferably a UDP tunnel. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 22 | |
| Junxiao Shi | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 23 | ``<FACEURI>`` |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 24 | FaceUri for this NDN hub. |
| 25 | |
| Junxiao Shi | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 26 | ``-p <PREFIX>`` |
| Niv Sardi | 5e8755c | 2016-12-13 14:11:53 -0300 | [diff] [blame] | 27 | A local prefix for which the local hub allows end applications to register prefixes |
| Yingdi Yu | 7b0e9cf | 2014-08-29 14:57:32 -0700 | [diff] [blame] | 28 | (See more details in :ref:`local-prefix-discovery`). One can supply more than one |
| 29 | prefixes. All supplied prefixes will be put into the local prefix discovery data |
| 30 | as described in :ref:`local-prefix-discovery`. If no prefix is specified, |
| 31 | auto-config-server will not serve any local prefix discovery data. |
| 32 | |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 33 | ``-h`` |
| 34 | Print usage and exit. |
| 35 | |
| 36 | ``-V`` |
| 37 | Print version number and exit. |
| 38 | |
| 39 | Exit status |
| 40 | ----------- |
| 41 | |
| 42 | 0: No error. |
| 43 | |
| 44 | 1: An unspecified error occurred. |
| 45 | |
| 46 | 2: Malformed command line, e.g., invalid, missing, or unknown argument. |
| 47 | |
| 48 | 4: Insufficient privileges. |
| 49 | |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 50 | Examples |
| 51 | -------- |
| 52 | |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 53 | :: |
| 54 | |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 55 | ndn-autoconfig-server tcp://spurs.cs.ucla.edu |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 56 | |
| Yingdi Yu | 7b0e9cf | 2014-08-29 14:57:32 -0700 | [diff] [blame] | 57 | ndn-autoconfig-server -p /ndn/edu/ucla tcp://spurs.cs.ucla.edu |
| 58 | |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 59 | See also |
| 60 | -------- |
| 61 | |
| 62 | :ref:`ndn-autoconfig` |