| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 1 | nlsrc |
| 2 | ===== |
| 3 | |
| 4 | Usage |
| 5 | ----- |
| 6 | |
| 7 | :: |
| 8 | |
| 9 | nlsrc [-h] [-V] COMMAND [<Command Options>] |
| 10 | |
| 11 | |
| 12 | Description |
| 13 | ----------- |
| 14 | |
| 15 | ``nlsrc`` is a tool to retrieve link-state database (LSDB) status information from NLSR and |
| 16 | announce/withdraw Name prefixes advertised by NLSR. |
| 17 | |
| 18 | Options |
| 19 | ------- |
| 20 | |
| 21 | ``-h`` |
| 22 | Print usage information |
| 23 | |
| 24 | ``-V`` |
| 25 | Show NLSRC version information |
| 26 | |
| 27 | ``COMMAND`` |
| 28 | |
| laqinfan | 3573185 | 2017-08-08 06:17:39 -0500 | [diff] [blame] | 29 | ``lsdb`` |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 30 | Retrieve LSDB status information |
| 31 | |
| laqinfan | 3573185 | 2017-08-08 06:17:39 -0500 | [diff] [blame] | 32 | ``routing`` |
| 33 | Retrieve routing table status information |
| 34 | |
| 35 | ``status`` |
| 36 | Retrieve LSDB status and routing table status information |
| 37 | |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 38 | ``advertise`` |
| 39 | Add a Name prefix to be advertised by NLSR |
| 40 | |
| 41 | ``advertise <name>`` |
| 42 | |
| 43 | ``name`` |
| 44 | The Name prefix to be advertised |
| 45 | |
| Saurab Dulal | 7526cee | 2018-01-31 18:14:10 +0000 | [diff] [blame] | 46 | ``advertise <name> save`` |
| 47 | |
| 48 | ``save`` |
| dulalsaurab | 82a34c2 | 2019-02-04 17:31:21 +0000 | [diff] [blame^] | 49 | 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] | 50 | |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 51 | ``withdraw`` |
| 52 | Remove a Name prefix advertised through NLSR |
| 53 | |
| 54 | ``withdraw <name>`` |
| 55 | |
| 56 | ``name`` |
| 57 | The Name prefix to be withdrawn |
| 58 | |
| Saurab Dulal | 7526cee | 2018-01-31 18:14:10 +0000 | [diff] [blame] | 59 | ``withdraw <name> delete`` |
| 60 | |
| 61 | ``delete`` |
| dulalsaurab | 82a34c2 | 2019-02-04 17:31:21 +0000 | [diff] [blame^] | 62 | 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] | 63 | |
| dmcoomes | c2c3ae0 | 2017-04-19 10:25:58 -0500 | [diff] [blame] | 64 | Notes |
| 65 | ----- |
| 66 | |
| 67 | When security is enabled, NLSR will not be allowed to successfully |
| 68 | advertise/withdraw names without first setting a default identity of operator. |
| 69 | If default identity is not set as operator, the user will be presented with the |
| 70 | error message: “Name prefix update error (code: 403)”. To remedy this |
| 71 | issue, use command 'ndn-sec-default'. |
| 72 | |
| 73 | Example: |
| 74 | |
| 75 | ndnsec-set-default /ndn/a-site/%C1.Operator/op |
| 76 | |
| Vince Lehman | c439d66 | 2015-04-27 10:56:00 -0500 | [diff] [blame] | 77 | Exit Status |
| 78 | ----------- |
| 79 | |
| 80 | nlsrc exits with one of the following values: |
| 81 | :: |
| 82 | |
| 83 | 0 nlsrc exited successfully |
| 84 | >0 An error occurred |