]>
Commit | Line | Data |
---|---|---|
39cfece8 | 1 | = network-port(8) |
06534633 | 2 | |
39cfece8 | 3 | == NAME |
06534633 MT |
4 | network-port - Controls Network Ports |
5 | ||
39cfece8 | 6 | == SYNOPSIS |
06534633 | 7 | [verse] |
39cfece8 MT |
8 | `network port new HOOK ...` |
9 | `network port destroy PORT` | |
10 | `network port PORT color set COLOR` | |
11 | `network port PORT color reset` | |
12 | `network port PORT create` | |
13 | `network port PORT description edit` | |
14 | `network port PORT description show` | |
15 | `network port PORT down` | |
16 | `network port PORT edit ...` | |
17 | `network port PORT identify` | |
18 | `network port PORT remove` | |
19 | `network port PORT status` | |
20 | `network port PORT up` | |
21 | ||
22 | == DESCRIPTION | |
06534633 MT |
23 | This command creates, deletes, changes and views the configuration |
24 | and status of ports. | |
25 | ||
26 | NOTE: A port is a physical or virtual device that is directly connected | |
27 | to an other network. It connects those and zones together. | |
28 | The 'network device' command shows status information of network devices | |
29 | and other things. | |
30 | ||
39cfece8 | 31 | == COMMANDS |
06534633 MT |
32 | The following commands are understood: |
33 | ||
39cfece8 | 34 | `new HOOK ...`:: |
06534633 MT |
35 | A new port may be created with this command. |
36 | HOOK must be a valid hook which may require more options. | |
37 | ||
39cfece8 | 38 | `destroy PORT`:: |
06534633 MT |
39 | Destroys the port PORT. |
40 | The port is removed from any zones it is attached to and shut down. | |
41 | ||
42 | For all other commands, the name of the port needs to be passed first: | |
43 | ||
d28ccf91 | 44 | include::include-color.txt[] |
06534633 | 45 | |
39cfece8 | 46 | `create`:: |
06534633 | 47 | This will create devices for the existing port PORT. |
39cfece8 | 48 | + |
06534633 MT |
49 | This does not create a new port. It will just create the (possibly |
50 | virtual) interface this port (i.e. create an interface for a WiFi | |
51 | module or a VLAN device). | |
39cfece8 MT |
52 | + |
53 | The interface is not brought up. Use the `up` command to do that. | |
06534633 MT |
54 | |
55 | include::include-description.txt[] | |
56 | ||
39cfece8 | 57 | `down`:: |
06534633 MT |
58 | Shuts down the port. |
59 | ||
39cfece8 | 60 | `edit`:: |
06534633 MT |
61 | This command can be used to alter the configuration of a port. |
62 | Consult the documentation of the port hook to find out what is supported. | |
63 | ||
39cfece8 | 64 | `identify`:: |
06534633 MT |
65 | This command will make the port flash for a few seconds |
66 | so that you can identify the correct network adapters | |
67 | in the system. | |
39cfece8 | 68 | + |
06534633 MT |
69 | This is not supported by all network adapters. |
70 | ||
39cfece8 | 71 | `remove`:: |
06534633 | 72 | This will remove an existing PORT. |
39cfece8 | 73 | + |
06534633 MT |
74 | This does not destroy the port. It inverses the operation performed |
75 | by the 'create' command. | |
76 | ||
39cfece8 | 77 | `status`:: |
06534633 MT |
78 | This will show some detailed information about the status |
79 | of the specified port. | |
80 | ||
39cfece8 | 81 | `up`:: |
06534633 MT |
82 | Brings up the port. It has to be created first. |
83 | ||
39cfece8 | 84 | == AUTHORS |
06534633 MT |
85 | Michael Tremer |
86 | ||
39cfece8 | 87 | == SEE ALSO |
06534633 MT |
88 | link:network[8], |
89 | link:network-zone[8] |