projects / people / ms / network.git / blame
| Commit | Line | Data |
|---|---|---|
| 44d5ffe9 MT |
1 | network(8) |
| 2 | ========== | |
| 3 | ||
| 4 | NAME | |
| 5 | ---- | |
| 6 | network - IPFire Network Configuration Program | |
| 7 | ||
| 8 | SYNOPSIS | |
| 9 | -------- | |
| 10 | [verse] | |
| 11 | 'network' [<options>] <command> ... | |
| 12 | ||
| 13 | DESCRIPTION | |
| 14 | ----------- | |
| 15 | The 'network' command is a tool which configures the network on every IPFire | |
| 16 | system. It is a fast and versatile way to create, edit and remove configurations, | |
| 17 | review the status of the network and it is working in the background of the | |
| 18 | system make sure that things are running smoothly. | |
| 19 | ||
| 20 | OPTIONS | |
| 21 | ------- | |
| 22 | -d:: | |
| 23 | --debug:: | |
| 24 | Enabled debugging mode. | |
| 25 | In this mode, there wll be debug output on the console and written to | |
| 26 | the log. | |
| 27 | The debugging mode can be permanently enabled by setting 'DEBUG=1'. | |
| 28 | ||
| 29 | COMMANDS | |
| 30 | -------- | |
| 31 | The following commands are understood: | |
| 32 | ||
| 33 | 'start' [ZONE]:: | |
| 34 | Starts a zone. That means the zone is being created and brought up. | |
| 35 | If one or more zones are passed to the command, only these will be | |
| 36 | started. | |
| 37 | ||
| 38 | 'stop' [ZONE]:: | |
| 39 | Stops a zone. This is the inverse of the 'start' command. | |
| 40 | ||
| 41 | 'restart' [ZONE]:: | |
| 42 | Restarts a zone. | |
| 43 | ||
| 44 | 'status' [ZONE]:: | |
| 45 | Shows an overview of the status of the zone. | |
| 46 | ||
| 47 | 'zone' ...:: | |
| 48 | Commands to configure zones. See link:network-zone[8] for details. | |
| 49 | ||
| 50 | 'port' ...:: | |
| 51 | Commands to configure ports. See link:network-port[8] for details. | |
| 52 | ||
| 53 | 'device' ...:: | |
| 54 | See the status or execute commands to network devices. | |
| 55 | See link:network-device[8] for details. | |
| 56 | ||
| 57 | 'hostname' [HOSTNAME]:: | |
| 58 | Without the optional 'HOSTNAME' argument, this command will print | |
| 59 | the configured hostname. | |
| 60 | Passing 'HOSTNAME' will set it as the new hostname. | |
| 61 | ||
| 62 | 'settings' ...:: | |
| 63 | Shows and alters global configuration parameters. | |
| 64 | See link:network-settings[8] for details. | |
| 65 | ||
| 66 | 'dns-server' ...:: | |
| 67 | This command allows to configure DNS servers. | |
| 68 | See link::network-dns-server[8] for details. | |
| 69 | ||
| 70 | 'route' ...:: | |
| 71 | This command allows managing static routes. | |
| 72 | See link:network-route[8] for details. | |
| 73 | ||
| 74 | 'vpn' ...:: | |
| 75 | The command allows managing VPN connections. | |
| 76 | See link:network-vpn[8] for details. | |
| 77 | ||
| 78 | 'reset':: | |
| 79 | This command will reset all network configuration. | |
| 80 | All zones, ports and other settings will be removed. | |
| 81 | ||
| 82 | 'help' ...:: | |
| 83 | Shows this man page. | |
| 84 | ||
| 85 | EXIT CODES | |
| 86 | ---------- | |
| 87 | The 'network' command will normally exit with code zero. | |
| 88 | If there has been aproblem and the requested action could not be performed, | |
| 89 | the exit code is unequal to zero. | |
| 90 | ||
| 91 | BUGS | |
| 92 | ---- | |
| 93 | Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/. | |
| 94 | ||
| 95 | AUTHORS | |
| 96 | ------- | |
| 97 | Michael Tremer | |
| 98 | ||
| 99 | SEE ALSO | |
| 100 | -------- | |
| 101 | link:network-settings[8] | |
| 102 | link:network-device[8] | |
| 103 | link:network-dns-server[8] | |
| 104 | link:network-performance-tuning[8] | |
| 105 | link:network-port[8] | |
| 106 | link:network-quick-start[8] | |
| 107 | link:network-zone[8] |