diff options
| -rw-r--r-- | doc/network.rst | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/doc/network.rst b/doc/network.rst index 5bf9126..3c86d4f 100644 --- a/doc/network.rst +++ b/doc/network.rst @@ -108,6 +108,18 @@ A network interface has the following parameters: * ``ipv6_dad_xmit``, an integer value describing the number of DAD probes to send when configuring this network interface for IPv6 operation. +* ``ipv6_slaac_globaladdr``, a boolean value describing whether SLAAC + addresses on the network interface will be global. + +* ``ipv6_slaac_tempaddr``, a boolean value describing whether SLAAC + addresses on the network interface will be temporary. + +* ``ipv6_slaac_validlft``, an integer value describing the lifetime of + temporary SLAAC addresses on the network interface. + +* ``ipv6_slaac_preflft``, an integer value describing the preferred + lifetime of temporary SLAAC addresses on the network interface. + @@ -159,27 +171,26 @@ network interfaces. Parameters ---------- -For each parameter described in the section `Data model definition`_, -three methods exist. Where the italicised word "*parameter*" appears, -replace it with the desired parameter. +For manipulating parameters in the section `Data model definition`_, +three methods exist. -``get_`` *parameter* ``(iface)`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +``get_param(iface, parameter)`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Retrieve the parameter for the specified interface. If the parameter is not set for the specified interface, ``None`` will be returned. -``set_`` *parameter* ``(iface, value)`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +``set_param(iface, parameter, value)`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Set the parameter for the specified interface. If a transaction is not active, the parameter is immediately set on the network interface. -``unset_`` *parameter* ``(iface)`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +``unset_param(iface, parameter)`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Unset the parameter for the specified interface. If a transaction is not active, the parameter is immediately unset on the network interface. |