diff options
| author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-06-22 19:29:53 -0500 |
|---|---|---|
| committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-06-22 19:29:53 -0500 |
| commit | f155e941ea2e27197b64effd7247d6bad2f7d8da (patch) | |
| tree | b419920a1edb12f0e5b023357d1eaf37db78b620 | |
| parent | 02dd56f71b294fafab3c41b6960474bd4ebb0b5e (diff) | |
| download | horizon-f155e941ea2e27197b64effd7247d6bad2f7d8da.tar.gz horizon-f155e941ea2e27197b64effd7247d6bad2f7d8da.tar.bz2 horizon-f155e941ea2e27197b64effd7247d6bad2f7d8da.tar.xz horizon-f155e941ea2e27197b64effd7247d6bad2f7d8da.zip | |
devel: script: Specify new 'pppoe' key
| -rw-r--r-- | devel/script/2_keys.xml | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/devel/script/2_keys.xml b/devel/script/2_keys.xml index 021d22b..65dac44 100644 --- a/devel/script/2_keys.xml +++ b/devel/script/2_keys.xml @@ -396,6 +396,45 @@ netaddress eth0 198.51.100.37 24 198.51.100.1 </para> </formalpara> </section> + <section id="pppoe"> + <title><literal>pppoe</literal></title> + <formalpara id="pppoe.name"> + <title>Name</title> + <para><literal>pppoe</literal></para> + </formalpara> + <formalpara id="pppoe.purpose"> + <title>Purpose</title> + <para>The <literal>pppoe</literal> key configures a PPPoE link on a specified interface.</para> + </formalpara> + <formalpara id="pppoe.format"> + <title>Format</title> + <para>The <literal>pppoe</literal> key is a space-separated list of configuration information. The first item shall be the name of the Ethernet interface used to establish the link. Each additional item must be in the form <literal><userinput>key</userinput>=<userinput>value</userinput></literal>, where <userinput>key</userinput> is one of the following: + <orderedlist id="pppoe.format.keys"> + <listitem><para><literal>mtu</literal> — The desired MTU of the interface.</para></listitem> + <listitem><para><literal>username</literal> — The username to use for authentication.</para></listitem> + <listitem><para><literal>password</literal> — The password/secret to use for authentication.</para></listitem> + <listitem><para><literal>lcp-echo-interval</literal> — The number of seconds between echo-requests to ensure the connection is still functioning.</para></listitem> + <listitem><para><literal>lcp-echo-failure</literal> — The number of failed echo-requests before the connection is determined to have a fault.</para></listitem> + </orderedlist> + </para> + </formalpara> + <formalpara id="pppoe.default"> + <title>Default</title> + <para>If the <literal>pppoe</literal> key is not specified, no PPPoE link will be established.</para> + </formalpara> + <formalpara id="pppoe.example"> + <title>Example</title> + <para> + <example> + <title>The <literal>pppoe</literal> Key</title> + <programlisting> +pppoe eth0 mtu=9120 username=awilfox password=fuzzball lcp-echo-interval=15 lcp-echo-failure=3 + </programlisting> + <para>This configures a PPPoE link on the interface <literal>eth0</literal>, with an MTU of 9120 and authentiation and LCP configuration as specified.</para> + </example> + </para> + </formalpara> + </section> <section id="nameserver"> <title><literal>nameserver</literal></title> <formalpara id="nameserver.name"> |