| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 1 | nfdc-route |
| 2 | ========== |
| 3 | |
| 4 | SYNOPSIS |
| 5 | -------- |
| 6 | | nfdc route [list] |
| 7 | | nfdc fib [list] |
| 8 | | nfdc register [-I] [-C] [-c <cost>] [-e <expiration>] [-o <origin>] <prefix> <faceId|faceUri> |
| 9 | | nfdc unregister [-o <origin>] <prefix> <faceId> |
| 10 | |
| 11 | DESCRIPTION |
| 12 | ----------- |
| 13 | In NFD, the routing information base (RIB) stores static or dynamic routing information |
| 14 | registered by applications, operators, and NFD itself. |
| 15 | Each *route* in the RIB indicates that contents under a name prefix may be available via a nexthop. |
| 16 | A route contains a name prefix, a nexthop face, the origin, a cost, and a set of route inheritance flags; |
| 17 | refer to NFD Management protocol for more information. |
| 18 | |
| 19 | The **nfdc route list** command shows a list of routes in the RIB. |
| 20 | |
| 21 | The **nfdc fib list** command shows the forwarding information base (FIB), |
| 22 | which is calculated from RIB routes and used directly by NFD forwarding. |
| 23 | |
| 24 | The **nfdc register** command adds a new route. |
| 25 | If a route with the same prefix, nexthop, and origin already exists, |
| 26 | it is updated with the specified cost, expiration, and route inheritance flags. |
| 27 | |
| 28 | The **nfdc unregister** command removes a route with matching prefix, nexthop, and origin. |
| 29 | |
| 30 | OPTIONS |
| 31 | ------- |
| 32 | -I |
| 33 | Unset CHILD_INHERIT flag in the route. |
| 34 | |
| 35 | -C |
| 36 | Set CAPTURE flag in the route. |
| 37 | |
| 38 | -c <cost> |
| 39 | The administrative cost of the route. |
| 40 | The default is 0. |
| 41 | |
| 42 | -e <expiration> |
| 43 | Expiration time of the route, in milliseconds. |
| 44 | When the route expires, NFD removes it from the RIB. |
| 45 | The default is infinite, which keeps the route active until the nexthop face is destroyed. |
| 46 | |
| 47 | -o <origin> |
| 48 | Origin of the route, i.e. who is announcing the route. |
| 49 | The default is 255, indicating a static route. |
| 50 | |
| 51 | <prefix> |
| 52 | Name prefix of the route. |
| 53 | |
| 54 | <faceUri> |
| 55 | An URI representing the remote endpoint of a face. |
| 56 | It can be used in **nfdc register** to create a new UDP or TCP face. |
| 57 | |
| 58 | <faceId> |
| 59 | A numerical identifier of the face. |
| 60 | It is displayed in the output of **nfdc face list** and **nfdc create** commands. |
| 61 | |
| 62 | SEE ALSO |
| 63 | -------- |
| 64 | nfd(1), nfdc(1) |