| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 1 | nlsrc |
| 2 | ===== |
| 3 | |
| 4 | Usage |
| 5 | ----- |
| 6 | |
| 7 | :: |
| 8 | |
| Junxiao Shi | a3a6397 | 2022-01-24 02:03:41 +0000 | [diff] [blame] | 9 | nlsrc [-h | -V] |
| 10 | nlsrc [-R <router prefix> [-c <nlsr.conf path> | -k]] COMMAND [<Command Options>] |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 11 | |
| 12 | |
| 13 | Description |
| 14 | ----------- |
| 15 | |
| 16 | ``nlsrc`` is a tool to retrieve link-state database (LSDB) status information from NLSR and |
| 17 | announce/withdraw Name prefixes advertised by NLSR. |
| 18 | |
| 19 | Options |
| 20 | ------- |
| 21 | |
| 22 | ``-h`` |
| 23 | Print usage information |
| 24 | |
| 25 | ``-V`` |
| 26 | Show NLSRC version information |
| 27 | |
| Junxiao Shi | a3a6397 | 2022-01-24 02:03:41 +0000 | [diff] [blame] | 28 | ``-R <router prefix>`` |
| 29 | Target a remote NLSR instance. |
| 30 | The default is the local NLSR instance ``/localhost``. |
| 31 | |
| 32 | ``-c <nlsr.conf path>`` |
| 33 | Verify remote status information with the trust schema loaded from ``security.validator`` section of specified nlsr.conf config file. |
| 34 | The default is loading from ``/etc/ndn/nlsr.conf``. |
| 35 | |
| 36 | ``-k`` |
| 37 | Insecure: do not verify signature on status information retrieved from remote router. |
| 38 | |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 39 | ``COMMAND`` |
| 40 | |
| laqinfan | 3573185 | 2017-08-08 06:17:39 -0500 | [diff] [blame] | 41 | ``lsdb`` |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 42 | Retrieve LSDB status information |
| 43 | |
| laqinfan | 3573185 | 2017-08-08 06:17:39 -0500 | [diff] [blame] | 44 | ``routing`` |
| 45 | Retrieve routing table status information |
| 46 | |
| 47 | ``status`` |
| 48 | Retrieve LSDB status and routing table status information |
| 49 | |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 50 | ``advertise`` |
| 51 | Add a Name prefix to be advertised by NLSR |
| 52 | |
| 53 | ``advertise <name>`` |
| 54 | |
| 55 | ``name`` |
| 56 | The Name prefix to be advertised |
| 57 | |
| Saurab Dulal | 7526cee | 2018-01-31 18:14:10 +0000 | [diff] [blame] | 58 | ``advertise <name> save`` |
| 59 | |
| 60 | ``save`` |
| dulalsaurab | 82a34c2 | 2019-02-04 17:31:21 +0000 | [diff] [blame] | 61 | Advertise a prefix and also save it to the nlsr.conf file residing in the state-dir for the next start of NLSR that operator may copy and use for the next start of NLSR |
| Saurab Dulal | 7526cee | 2018-01-31 18:14:10 +0000 | [diff] [blame] | 62 | |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 63 | ``withdraw`` |
| 64 | Remove a Name prefix advertised through NLSR |
| 65 | |
| 66 | ``withdraw <name>`` |
| 67 | |
| 68 | ``name`` |
| 69 | The Name prefix to be withdrawn |
| 70 | |
| Saurab Dulal | 7526cee | 2018-01-31 18:14:10 +0000 | [diff] [blame] | 71 | ``withdraw <name> delete`` |
| 72 | |
| 73 | ``delete`` |
| dulalsaurab | 82a34c2 | 2019-02-04 17:31:21 +0000 | [diff] [blame] | 74 | Withdraw a prefix and also delete it from the nlsr.conf file residing in the state-dir |
| Saurab Dulal | 7526cee | 2018-01-31 18:14:10 +0000 | [diff] [blame] | 75 | |
| dmcoomes | c2c3ae0 | 2017-04-19 10:25:58 -0500 | [diff] [blame] | 76 | Notes |
| 77 | ----- |
| 78 | |
| 79 | When security is enabled, NLSR will not be allowed to successfully |
| 80 | advertise/withdraw names without first setting a default identity of operator. |
| 81 | If default identity is not set as operator, the user will be presented with the |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 82 | error message: "Name prefix update error (code: 403)". To remedy this |
| 83 | issue, use the command ``ndnsec set-default``. Example:: |
| dmcoomes | c2c3ae0 | 2017-04-19 10:25:58 -0500 | [diff] [blame] | 84 | |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 85 | ndnsec set-default /ndn/a-site/%C1.Operator/op |
| dmcoomes | c2c3ae0 | 2017-04-19 10:25:58 -0500 | [diff] [blame] | 86 | |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 87 | Exit Status |
| 88 | ----------- |
| 89 | |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 90 | nlsrc exits with one of the following values:: |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 91 | |
| 92 | 0 nlsrc exited successfully |
| Junxiao Shi | f7ea150 | 2023-06-23 04:30:19 +0000 | [diff] [blame] | 93 | 1 generic error |
| 94 | 2 bad command line |