From: Suzanne Goldlust Date: Thu, 31 Jan 2019 19:49:20 +0000 (-0500) Subject: Update netconf.xml X-Git-Tag: 481-remote-subnet4-set-inconsistent-work-when-id-subnet-is-duplicated_base~23 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8a74ecc9fb3212b9478172963a8dcf7743a6721b;p=thirdparty%2Fkea.git Update netconf.xml --- diff --git a/doc/guide/netconf.xml b/doc/guide/netconf.xml index bd0a368c5d..85f4a6a11f 100644 --- a/doc/guide/netconf.xml +++ b/doc/guide/netconf.xml @@ -23,8 +23,8 @@
Installing NETCONF - Note that to get its NETCONF capabilities Kea uses Sysrepo - software, which has many dependencies. Unfortunately, some of them + Note that to get its NETCONF capabilities, Kea uses Sysrepo, + which has many dependencies. Unfortunately, some of them are not available as packages and need to be compiled manually. @@ -316,7 +316,7 @@ done in dependency order and reverse dependency order accordingly. The validate-changes command controls how Kea monitors - the changes in Sysrepo configuration. Sysrepo offers two + changes in the Sysrepo configuration. Sysrepo offers two stages where Kea could interact: validation and application. At the validation (or SR_EV_VERIFY event, in the Sysrepo naming convention) stage, @@ -422,7 +422,7 @@ done in dependency order and reverse dependency order accordingly. The first case is handled by Sysrepo. The second and third cases - are handled by NETCONF in the validation phase (if not disabled + are handled by kea-netconf in the validation phase (if not disabled by setting validate-changes to true). The last case causes the application phase to fail without a sensible report to Sysrepo. @@ -509,16 +509,16 @@ done in dependency order and reverse dependency order accordingly. Hooks libraries can be loaded by the NETCONF agent just as with - other servers or agents. However, Kea currently supports no hook point. + other servers or agents; however, currently no hook points are defined. The hooks-libraries list - contains the list of hooks libraries that should be loaded by NETCONF, + contains the list of hooks libraries that should be loaded by kea-netconf, along with their configuration information specified with parameters. Please consult for the details on how to - configure logging. The NETCONF root logger's name is + configure logging. The NETCONF agent's root logger's name is kea-netconf, as given in the example above.
@@ -528,11 +528,11 @@ done in dependency order and reverse dependency order accordingly. The following example demonstrates the basic NETCONF configuration. More examples are available in the doc/examples/netconf - directory in Kea sources. + directory in the Kea sources. -// This is a simple example of a configuration for NETCONF. +// This is a simple example of a configuration for the NETCONF agent. // This server provides a YANG interface for all Kea servers and the agent. { "Netconf": @@ -550,13 +550,13 @@ done in dependency order and reverse dependency order accordingly. // // Currently three control channel types are supported: // "stdout" which outputs the configuration on the standard output, - // "unix" which uses the local control channel supported by + // "unix" which uses the local control channel supported by the // "dhcp4" and "dhcp6" servers ("d2" support is not yet available), // and "http" which uses the Control agent "ca" to manage itself or // to forward commands to "dhcp4" or "dhcp6". "managed-servers": { - // This is how NETCONF can communicate with the DHCPv4 server. + // This is how kea-netconf can communicate with the DHCPv4 server. "dhcp4": { "comment": "DHCP4 server", @@ -580,7 +580,7 @@ done in dependency order and reverse dependency order accordingly. }, // Currently the DHCP-DDNS (nicknamed D2) server does not support - // command channel. + // a command channel. "d2": { "model": "kea-dhcp-ddns", @@ -603,11 +603,11 @@ done in dependency order and reverse dependency order accordingly. } }, - // NETCONF is able to load hook libraries that augment its operation. + // kea-netconf is able to load hooks libraries that augment its operation. // Currently there are no hook points defined in kea-netconf // processing. "hooks-libraries": [ - // The hook libraries list may contain more than one library. + // The hooks libraries list may contain more than one library. { // The only necessary parameter is the library filename. "library": "/opt/local/netconf-commands.so", @@ -623,7 +623,7 @@ done in dependency order and reverse dependency order accordingly. }, - // Similar to other Kea components, NETCONF also uses logging. + // Similar to other Kea components, kea-netconf also uses logging. "Logging": { "loggers": [ @@ -659,7 +659,7 @@ done in dependency order and reverse dependency order accordingly. Starting and Stopping the NETCONF Agent - NETCONF accepts the following command-line switches: + kea-netconf accepts the following command-line switches: @@ -697,14 +697,14 @@ done in dependency order and reverse dependency order accordingly. - -v - displays the Kea version and exits. + -v - displays the version of kea-netconf and exits. - -V - displays the Kea extended version - with additional parameters and exits. The listing includes + -V - displays the extended version information for + kea-netconf and exits. The listing includes the versions of the libraries dynamically linked to Kea. @@ -722,7 +722,7 @@ done in dependency order and reverse dependency order accordingly.
- Step-by-Step NETCONF Operation Example + Step-by-Step NETCONF Agent Operation Example Copies of example configurations presented within this section can be found in the Kea source code, under doc/examples/netconf/kea-dhcp6-operations. @@ -730,7 +730,7 @@ done in dependency order and reverse dependency order accordingly.
- Setup of NETCONF Operation Example + Setup of NETCONF Agent Operation Example The test box has an Ethernet interface named eth1. On some systems it is possible to rename interfaces,