vlan: Fail when unknown command line parameters are being passed
[people/ms/network.git] / man / network-zone-config-pppoe-server.txt
CommitLineData
718371b5
MT
1= network-zone-config-pppoe-server(8)
2
3== NAME
4network-zone-config-pppoe-server - PPPoE Server Settings
5
6== SYNOPSIS
7[verse]
8`network zone ZONE config create pppoe-server ...`
9`network zone ZONE config pppoe-server edit ...`
10
11== DESCRIPTION
12This configuration hook enables a **PPPoE Server** on a zone.
13
14== OPTIONS
15The following options are understood:
16
17`--subnet=SUBNET`::
18 The `--subnet` option defines an IPv4 pool of which IP addresses are
19 assigned to the remote hosts. The first address of the subnet will be used
20 for the gateway which is the PPPoE server itself.
21 +
22 The subnet must at least have two IP addresses.
23
24`--mtu=MTU`::
25 Set the required MTU (Maximum Transmission Unit) for the PPP connection.
26 The default value is 1492 bytes which is a common MTU for DSL connections.
27
28`--service-name=SERVICE NAME`::
29 This option receives a string which will be used as the service name. The
30 service name is sent out to the clients and used for identification but
31 not authorisation purposes.
32 +
33 The default is an empty value.
34
35`--max-sessions=0`::
36 Limit the number of sessions that may be established by the same MAC address.
37 This must be a positive number.
38 0 permits an unlimited number of sessions per MAC address.
39
40== EXAMPLES
41
42This command creates a PPPoE server that will assign an IP address from the
43192.168.0.0/16 subnet:
44
45 network zone net0 config create pppoe-server --subnet=192.168.0.0/16
46
6b1e7474
MT
47== AUTHORS
48Michael Tremer
49
718371b5
MT
50== SEE ALSO
51link:network[8],
52link:network-zone[8],
53link:network-zone-config[8]