| 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 | |
| Davide Pesavento | 9f6a7d9 | 2020-10-06 15:21:48 -0400 | [diff] [blame] | 4 | Synopsis |
| 5 | -------- |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 6 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 7 | | **nfd-autoreg** [**-i**\|\ **\--prefix** *prefix*]... [**-a**\|\ **\--all-faces-prefix** *prefix*]... |
| 8 | | [**-b**\|\ **\--blacklist** *network*]... [**-w**\|\ **\--whitelist** *network*]... \ |
| 9 | [**-c**\|\ **\--cost** *cost*] |
| 10 | | **nfd-autoreg** **-h**\|\ **\--help** |
| 11 | | **nfd-autoreg** **-V**\|\ **\--version** |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 12 | |
| 13 | Description |
| 14 | ----------- |
| 15 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 16 | :program:`nfd-autoreg` is a daemon application that automatically registers the specified |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 17 | 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] | 18 | the result of an incoming packet or when a new TCP face is created as the result of an |
| 19 | incoming connection). |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 20 | |
| 21 | Options |
| 22 | ------- |
| 23 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 24 | .. option:: -i <prefix>, --prefix <prefix> |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 25 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 26 | Prefix that should be automatically registered when a new remote face is created. |
| 27 | Can be repeated multiple times to specify additional prefixes. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 28 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 29 | .. option:: -b <network>, --blacklist <network> |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 30 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 31 | Blacklisted network, e.g., 192.168.2.32/30 or ::1/128. Can be repeated multiple times |
| 32 | to specify multiple blacklisted networks. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 33 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 34 | The prefixes will be auto-registered only when the remote IP address is NOT inside the |
| 35 | specified range(s), but is inside the range defined by the whitelist(s), if any. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 36 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 37 | Default: none. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 38 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 39 | .. option:: -w <network>, --whitelist <network> |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 40 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 41 | Whitelisted network, e.g., 192.168.2.0/24 or ::1/128. Can be repeated multiple times |
| 42 | to specify multiple whitelisted networks. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 43 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 44 | The prefixes will be auto-registered only when the remote IP address is inside the |
| 45 | specified range(s), excluding any blacklisted range(s). |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 46 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 47 | Default: 0.0.0.0/0 and ::/0. |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 48 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 49 | .. option:: -c <cost>, --cost <cost> |
| 50 | |
| 51 | RIB cost to assign to auto-registered prefixes. If not specified, the cost is set to 255. |
| 52 | |
| 53 | .. option:: -h, --help |
| 54 | |
| 55 | Print help message and exit. |
| 56 | |
| 57 | .. option:: -V, --version |
| 58 | |
| 59 | Show version information and exit. |
| 60 | |
| 61 | Exit Status |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 62 | ----------- |
| 63 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 64 | 0 |
| 65 | No error. |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 66 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 67 | 1 |
| 68 | An unspecified error occurred. |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 69 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 70 | 2 |
| 71 | Malformed command line, e.g., invalid, missing, or unknown argument. |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 72 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 73 | 4 |
| 74 | Insufficient privileges. |
| Davide Pesavento | 59769b1 | 2017-11-12 23:52:06 -0500 | [diff] [blame] | 75 | |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 76 | Examples |
| 77 | -------- |
| 78 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame^] | 79 | ``nfd-autoreg -i /app1/video -i /app2/pictures -b 10.0.0.0/8`` |
| 80 | Auto-register two prefixes for any newly created on-demand faces, except those that |
| 81 | have their remote IP address in the 10.0.0.0/8 network. |