| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 1 | nfdc-face |
| 2 | ========= |
| 3 | |
| 4 | SYNOPSIS |
| 5 | -------- |
| Junxiao Shi | 0d97692 | 2017-04-01 14:35:21 +0000 | [diff] [blame] | 6 | | nfdc face [list [[remote] <FACEURI>] [local <FACEURI>] [scheme <SCHEME>]] |
| Junxiao Shi | d695801 | 2017-02-20 03:34:48 +0000 | [diff] [blame] | 7 | | nfdc face show [id] <FACEID> |
| Junxiao Shi | 0d97692 | 2017-04-01 14:35:21 +0000 | [diff] [blame] | 8 | | nfdc face create [remote] <FACEURI> [[persistency] <PERSISTENCY>] [local <FACEURI>] |
| Junxiao Shi | d695801 | 2017-02-20 03:34:48 +0000 | [diff] [blame] | 9 | | nfdc face destroy [face] <FACEID|FACEURI> |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 10 | | nfdc channel [list] |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 11 | |
| 12 | DESCRIPTION |
| 13 | ----------- |
| 14 | In NFD, a face is the generalization of network interface. |
| 15 | It could be a physical network interface to communicate on a physical link, |
| 16 | an overlay communication channel between NFD and a remote node, |
| 17 | or an inter-process communication channel between NFD and a local application. |
| 18 | |
| Junxiao Shi | 0d97692 | 2017-04-01 14:35:21 +0000 | [diff] [blame] | 19 | The **nfdc face list** command shows a list of faces, their properties, and statistics, |
| 20 | optionally filtered by remote endpoint, local endpoint, and FaceUri scheme. |
| 21 | When multiple filters are specified, returned faces must satisfy all filters. |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 22 | |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame] | 23 | The **nfdc face show** command shows properties and statistics of one specific face. |
| 24 | |
| Junxiao Shi | 0d97692 | 2017-04-01 14:35:21 +0000 | [diff] [blame] | 25 | The **nfdc face create** command creates a UDP unicast, TCP, or Ethernet unicast face. |
| 26 | Local FaceUri is required for creating Ethernet unicast faces; otherwise it must be omitted. |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 27 | |
| Junxiao Shi | 05dd444 | 2017-02-06 22:50:07 +0000 | [diff] [blame] | 28 | The **nfdc face destroy** command destroys an existing face. |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 29 | |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 30 | The **nfdc channel list** command shows a list of channels. |
| 31 | Channels are listening sockets that can accept incoming connections and create new faces. |
| 32 | |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 33 | OPTIONS |
| 34 | ------- |
| Junxiao Shi | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 35 | <FACEID> |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame] | 36 | Numerical identifier of the face. |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 37 | It is displayed in the output of **nfdc face list** and **nfdc face create** commands. |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame] | 38 | |
| Junxiao Shi | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 39 | <FACEURI> |
| Junxiao Shi | 0d97692 | 2017-04-01 14:35:21 +0000 | [diff] [blame] | 40 | A URI representing the remote or local endpoint of a face. |
| 41 | Examples: |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 42 | |
| Junxiao Shi | 0d97692 | 2017-04-01 14:35:21 +0000 | [diff] [blame] | 43 | - udp4://192.0.2.1:6363 |
| 44 | - udp6://[2001:db8::1]:6363 |
| 45 | - udp://example.net |
| 46 | - tcp4://192.0.2.1:6363 |
| 47 | - tcp6://[2001:db8::1]:6363 |
| 48 | - tcp://example.net |
| 49 | - unix:///var/run/nfd.sock |
| 50 | - fd://6 |
| 51 | - ether://[08:00:27:01:01:01] |
| 52 | - dev://eth0 |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 53 | |
| 54 | When a hostname is specified, a DNS query is used to obtain the IP address. |
| 55 | |
| Junxiao Shi | 0d97692 | 2017-04-01 14:35:21 +0000 | [diff] [blame] | 56 | <SCHEME> |
| 57 | The scheme portion of either remote or local endpoint. |
| 58 | Examples: |
| 59 | |
| 60 | - udp4 |
| 61 | - unix |
| 62 | - dev |
| 63 | |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 64 | <PERSISTENCY> |
| 65 | Either "persistent" or "permanent". |
| 66 | A "persistent" face (the default) is closed when a socket error occurs. |
| 67 | A "permanent" face survives socket errors, and is closed only with a **nfdc destroy** command. |
| 68 | |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame] | 69 | EXIT CODES |
| 70 | ---------- |
| 71 | |
| 72 | 0: Success |
| 73 | |
| 74 | 1: An unspecified error occurred |
| 75 | |
| 76 | 2: Malformed command line |
| 77 | |
| Junxiao Shi | 05dd444 | 2017-02-06 22:50:07 +0000 | [diff] [blame] | 78 | 3: Face not found (**nfdc face show** and **nfdc face destroy** only) |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 79 | |
| Junxiao Shi | 05dd444 | 2017-02-06 22:50:07 +0000 | [diff] [blame] | 80 | 4: FaceUri canonization failed (**nfdc face create** and **nfdc face destroy** only) |
| 81 | |
| 82 | 5: Ambiguous: multiple matching faces are found (**nfdc face destroy** only) |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 83 | |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 84 | SEE ALSO |
| 85 | -------- |
| 86 | nfd(1), nfdc(1) |