| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 1 | nfd-autoreg |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 2 | =========== |
| 3 | |
| 4 | Usage |
| 5 | ----- |
| 6 | |
| 7 | :: |
| 8 | |
| 9 | nfd-autoreg --prefix=</autoreg/prefix> [--prefix=</another/prefix>] ... |
| 10 | |
| 11 | Description |
| 12 | ----------- |
| 13 | |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 14 | ``nfd-autoreg`` is a daemon application that automatically registers the specified |
| 15 | prefix(es) when new on-demand faces are created (i.e., when a new UDP face is created as |
| Niv Sardi | 5e8755c | 2016-12-13 14:11:53 -0300 | [diff] [blame] | 16 | the result of an incoming packet or when a new TCP face is created as the result of an |
| 17 | incoming connection). |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 18 | |
| 19 | Options |
| 20 | ------- |
| 21 | |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 22 | ``-i`` or ``--prefix`` |
| 23 | Prefix that should be automatically registered when a new remote face is created. |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 24 | Can be repeated multiple times to specify additional prefixes. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 25 | |
| 26 | ``-c`` or ``--cost`` |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 27 | RIB cost to be assigned to auto-registered prefixes. If not specified, default cost |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 28 | is set to 255. |
| 29 | |
| 30 | ``-w`` or ``--whitelist`` |
| 31 | Whitelisted network, e.g., 192.168.2.0/24 or ::1/128. Can be repeated multiple times |
| 32 | to specify multiple whitelisted networks. |
| 33 | |
| 34 | Prefix(es) will be auto-registered only when remote IP address is within the specified |
| 35 | range(s), except blacklist ranges. |
| 36 | |
| 37 | Default: 0.0.0.0/0 and ::/0 |
| 38 | |
| 39 | ``-b`` or ``--blacklist`` |
| 40 | Blacklisted network, e.g., 192.168.2.32/30 or ::1/128. Can be repeated multiple times |
| 41 | to specify multiple blacklisted networks. |
| 42 | |
| 43 | Prefix(es) will be auto-registered only when remote IP address in **NOT** within the |
| 44 | specified range(s), but is within the range define by the whitelist(s). |
| 45 | |
| 46 | Default: none |
| 47 | |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 48 | ``-h`` or ``--help`` |
| 49 | Print help message and exit. |
| 50 | |
| 51 | ``-V`` or ``--version`` |
| 52 | Show version information and exit. |
| 53 | |
| 54 | Exit status |
| 55 | ----------- |
| 56 | |
| 57 | 0: No error. |
| 58 | |
| 59 | 1: An unspecified error occurred. |
| 60 | |
| 61 | 2: Malformed command line, e.g., invalid, missing, or unknown argument. |
| 62 | |
| 63 | 4: Insufficient privileges. |
| 64 | |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 65 | Examples |
| 66 | -------- |
| 67 | |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 68 | Auto-register two prefixes for any newly created on-demand face, except those that has |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 69 | source IP address in ``10.0.0.0/8`` network:: |
| 70 | |
| 71 | nfd-autoreg --prefix=/app1/video --prefix=/app2/pictures -b 10.0.0.0/8 |