diff options
| author | Andrei Pavel <andrei@isc.org> | 2023-04-19 16:58:06 +0200 |
|---|---|---|
| committer | Andrei Pavel <andrei@isc.org> | 2023-04-19 16:58:06 +0200 |
| commit | ab2388767215762edb8df0c592ae6c2182799879 (patch) | |
| tree | e732e420558cc3e32e72d4c46104ee84a2ac198f /doc/examples | |
| parent | [#2804] Text edits in comments (diff) | |
| download | kea-ab2388767215762edb8df0c592ae6c2182799879.tar.xz kea-ab2388767215762edb8df0c592ae6c2182799879.zip | |
[#2804] make text edits consistent across the ARM
Diffstat (limited to 'doc/examples')
54 files changed, 735 insertions, 743 deletions
diff --git a/doc/examples/agent/simple.json b/doc/examples/agent/simple.json index f48a5ecca4..a7227de04f 100644 --- a/doc/examples/agent/simple.json +++ b/doc/examples/agent/simple.json @@ -115,7 +115,7 @@ // Some libraries may support parameters. Make sure you // type this section carefully, as the CA does not validate - // it (because the format is library specific). + // it (because the format is library-specific). "parameters": { "param1": "foo" } @@ -132,7 +132,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/ddns/all-keys-netconf.json b/doc/examples/ddns/all-keys-netconf.json index 27299a8847..2ea6fad859 100644 --- a/doc/examples/ddns/all-keys-netconf.json +++ b/doc/examples/ddns/all-keys-netconf.json @@ -3,7 +3,7 @@ // it may contain mutually exclusive configuration parameters. // // The primary purpose of the example file is to provide a comprehensive -// list of parameters supported by Kea DHCP-DDNS server along with the +// list of parameters supported by the Kea DHCP-DDNS server along with the // brief description of each parameter. // // This stable version is used for YANG as we do not want to update code @@ -37,7 +37,7 @@ // Command control socket configuration parameters for Kea DHCP-DDNS server. "control-socket": { - // Location of the unix domain socket file the DHCP-DDNS server uses + // Location of the UNIX domain socket file the DHCP-DDNS server uses // to receive control commands from the Kea Control Agent or the // local server administrator. "socket-name": "/tmp/kea-ddns-ctrl-socket", @@ -47,14 +47,14 @@ "socket-type": "unix" }, - // List of hooks libraries and their specific configuration parameters + // List of hook libraries and their specific configuration parameters // to be loaded by Kea DHCP-DDNS server. "hooks-libraries": [ { - // Location of the hooks library to be loaded. + // Location of the hook library to be loaded. "library": "/opt/local/ddns-server-commands.so", - // Hook library specific configuration parameters. + // Hook library-specific configuration parameters. "parameters": { } } ], @@ -145,7 +145,7 @@ "loggers": [ { // Debug level, a value between 0..99. The greater the value - // the more detailed debug log. + // the more detailed the debug log. "debuglevel": 99, // Name of the logger. @@ -154,16 +154,16 @@ // Configures how the log should be output. "output_options": [ { - // Determines whether the log should flushed to a file. + // Determines whether the log should be flushed to a file. "flush": true, - // Specifies maximum filesize before the file is being rotated. + // Specifies maximum filesize before the file is rotated. "maxsize": 10240000, - // Specifies the maximum number of rotated files being kept. + // Specifies the maximum number of rotated files to be kept. "maxver": 1, - // Specifies logging destination. + // Specifies the logging destination. "output": "stdout", // Specifies log entry content diff --git a/doc/examples/ddns/all-keys.json b/doc/examples/ddns/all-keys.json index 7de1703e32..674c9860cf 100644 --- a/doc/examples/ddns/all-keys.json +++ b/doc/examples/ddns/all-keys.json @@ -3,11 +3,11 @@ // it may contain mutually exclusive configuration parameters. // // The primary purpose of the example file is to provide a comprehensive -// list of parameters supported by Kea DHCP-DDNS server along with the +// list of parameters supported by the Kea DHCP-DDNS server along with the // brief description of each parameter. // // This current version should be up to date, i.e. new keywords should be -// added in this file at the same time than in the syntax. +// added in this file at the same time as in the parser specification. { // Kea DHCP-DDNS server configuration begins here. "DhcpDdns": { @@ -37,7 +37,7 @@ // Command control socket configuration parameters for Kea DHCP-DDNS server. "control-socket": { - // Location of the unix domain socket file the DHCP-DDNS server uses + // Location of the UNIX domain socket file the DHCP-DDNS server uses // to receive control commands from the Kea Control Agent or the // local server administrator. "socket-name": "/tmp/kea-ddns-ctrl-socket", @@ -47,14 +47,14 @@ "socket-type": "unix" }, - // List of hooks libraries and their specific configuration parameters + // List of hook libraries and their specific configuration parameters // to be loaded by Kea DHCP-DDNS server. "hooks-libraries": [ { - // Location of the hooks library to be loaded. + // Location of the hook library to be loaded. "library": "/opt/local/ddns-server-commands.so", - // Hook library specific configuration parameters. + // Hook library-specific configuration parameters. "parameters": { } } ], @@ -145,7 +145,7 @@ "loggers": [ { // Debug level, a value between 0..99. The greater the value - // the more detailed debug log. + // the more detailed the debug log. "debuglevel": 99, // Name of the logger. @@ -154,16 +154,16 @@ // Configures how the log should be output. "output_options": [ { - // Determines whether the log should flushed to a file. + // Determines whether the log should be flushed to a file. "flush": true, - // Specifies maximum filesize before the file is being rotated. + // Specifies maximum filesize before the file is rotated. "maxsize": 10240000, - // Specifies the maximum number of rotated files being kept. + // Specifies the maximum number of rotated files to be kept. "maxver": 1, - // Specifies logging destination. + // Specifies the logging destination. "output": "stdout", // Specifies log entry content diff --git a/doc/examples/ddns/sample1.json b/doc/examples/ddns/sample1.json index 382c4a92fb..d15486e0ec 100644 --- a/doc/examples/ddns/sample1.json +++ b/doc/examples/ddns/sample1.json @@ -11,7 +11,7 @@ // -------------- Global Parameters ---------------- // // D2 will listen for update requests for Kea DHCP servers at 127.0.0.1 -// on port 53001. Maximum time to we will wait for a DNS server to +// on port 53001. Maximum time to we will wait for a DNS server to // respond to us is 1000 ms. "ip-address": "127.0.0.1", @@ -52,7 +52,7 @@ // Some libraries may support parameters. Make sure you // type this section carefully, as the CA does not validate - // it (because the format is library specific). + // it (because the format is library-specific). "parameters": { "param1": "foo" @@ -66,7 +66,7 @@ // 1. Zone - "four.example.com. // It uses TSIG, key name is "d2.md5.key" // It is served by one DNS server which listens for DDNS requests at -// 172.16.1.1 on the default port 53 (standard DNS port) +// 172.16.1.1 on the default port 53 (standard DNS port) // // 2. Zone - "six.example.com." // It does not use TSIG. @@ -167,7 +167,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/kea4/advanced.json b/doc/examples/kea4/advanced.json index 4b25f46cee..81d182a00f 100644 --- a/doc/examples/kea4/advanced.json +++ b/doc/examples/kea4/advanced.json @@ -35,7 +35,7 @@ // interface the query came in. This is the default ("same-as-inbound"). // However, sometimes it is useful to have the ability to send the // packet as plain UDP packet and let the kernel and the routing tables - // determine the right interface ("use-routing"). This option only works + // determine the right interface ("use-routing"). This option only works // for "dhcp-socket-type" set to "udp" and is ignored otherwise. "outbound-interface": "use-routing", @@ -75,7 +75,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. - // We'll use memfile because it doesn't require any prior set up. + // We'll use memfile because it doesn't require any prior set up. // For memfile, it's important to always specify lfc-interval, so // the lease file would not grow without bounds and be sanitized // once per hour. @@ -186,7 +186,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/kea4/all-keys-netconf.json b/doc/examples/kea4/all-keys-netconf.json index d23c2a8fff..2f63bf6943 100644 --- a/doc/examples/kea4/all-keys-netconf.json +++ b/doc/examples/kea4/all-keys-netconf.json @@ -87,7 +87,7 @@ // Third class name. "name": "late", - // Boolean flag indicating that the class expression is only evaluated + // Boolean flag indicating whether the class expression is only evaluated // when the class is required, e.g. the selected address pool configuration // includes this class name in its "require-client-classes" list. The // default value false means that the class test expression must @@ -118,7 +118,7 @@ "ignore-rai-link-selection": false, // Parse options more leniently where fields can be deduced - // deterministically even if against RFC or common practice. + // deterministically, even if against RFC or common practice. "lenient-option-parsing": true }, @@ -138,30 +138,30 @@ // It may be specified at the global, shared-network, and subnet levels. "ddns-generated-prefix": "myhost", - // Boolean flag indicating that the server should ignore DHCP client + // Boolean flag indicating whether the server should ignore DHCP client // wishes to update DNS on its own. With that flag set to true, // the server will send DNS updates for both forward and // reverse DNS data. The default value is false, which indicates - // that the server will delegate DNS update to the client when + // that the server will delegate a DNS update to the client when // requested. It may be specified at the global, shared-network, // and subnet levels. "ddns-override-client-update": false, - // Boolean flag indicating that the server should override the DHCP + // Boolean flag indicating whether the server should override the DHCP // client's wish to not update the DNS. With this parameter - // set to true, the server will send DNS update even when + // set to true, the server will send a DNS update even when // the client requested no update. It may be specified at the // global, shared-network, and subnet levels. "ddns-override-no-update": false, // Suffix appended to the partial name sent to the DNS. The - // default value is an empty string which indicates that no + // default value is an empty string, which indicates that no // suffix is appended. It may be specified at the global, // shared-network, and subnet levels. "ddns-qualifying-suffix": "", // Enumeration specifying whether the server should honor - // hostname or Client FQDN sent by the client, or replace + // the hostname or Client FQDN sent by the client or replace // this name. The acceptable values are: "never" (use the // name the client sent), "always" (replace the name the // client sent), "when-present" (replace the name the client @@ -186,8 +186,8 @@ // may be specified at the global, shared-network, and subnet levels. "ddns-update-on-renew": true, - // Boolean flag, which is passed to kea-dhcp-ddns with each DDNS - // update request to indicate whether DNS update conflict + // Boolean flag which is passed to kea-dhcp-ddns with each DDNS + // update request, to indicate whether DNS update conflict // resolution as described in RFC 4703 should be employed for the // given update request. The default value for this flag is true. // It may be specified at the global, shared-network, and subnet levels. @@ -197,11 +197,11 @@ // excluded from DHCP assignments. The default value is 86400 (24 hours). "decline-probation-period": 86400, - // Name Change Request forwarding configuration for Kea DHCPv4 server. + // Name Change Request forwarding configuration for the Kea DHCPv4 server. // NCRs are sent to the Kea D2 module to update DNS upon allocation of // DHCP leases. "dhcp-ddns": { - // Boolean flag indicating if Kea DHCPv4 server should connect to + // Boolean flag indicating whether Kea DHCPv4 server should connect to // kea-dhcp-ddns. This must be true for NCRs to be created and // sent to kea-dhcp-ddns. By default, NCRs are not generated. "enable-updates": false, @@ -218,12 +218,12 @@ // only UDP is supported. "ncr-protocol": "UDP", - // IP address that Kea DHCPv4 server should use to send + // IP address that the Kea DHCPv4 server should use to send // NCRs to D2. The default value of zero indicates that Kea // should pick a suitable address. "sender-ip": "0.0.0.0", - // Port number that Kea DHCPv4 server should use to send + // Port number that the Kea DHCPv4 server should use to send // NCRs to D2. The default value of zero indicates that Kea // should pick a suitable port. "sender-port": 0, @@ -254,7 +254,7 @@ "dhcp4o6-port": 6767, // Boolean flag indicating whether the Kea DHCPv4 server - // should send back Client Identifier option in its responses. + // should send back the Client Identifier option in its responses. // The default value is true, which indicates that the option // must be sent back if the client included it. The false // value instructs the server to not send this option for @@ -265,11 +265,11 @@ // Collection of Kea DHCPv4 server parameters configuring how // the server should process expired DHCP leases. "expired-leases-processing": { - // Specifies the number of seconds since last removal of - // the expired leases, when next removal should occur. + // Specifies the number of seconds since the last removal of + // the expired leases, when the next removal should occur. // If both "flush-reclaimed-timer-wait-time" and // "hold-reclaimed-time" are not 0, when the client sends a release - // message the lease is expired instead of being deleted from the + // message the lease is expired instead of being deleted from // lease storage. "flush-reclaimed-timer-wait-time": 25, @@ -277,30 +277,28 @@ // leases in the lease database (lease affinity). // If both "flush-reclaimed-timer-wait-time" and // "hold-reclaimed-time" are not 0, when the client sends a release - // message the lease is expired instead of being deleted from the + // message the lease is expired instead of being deleted from // lease storage. "hold-reclaimed-time": 3600, // Specifies the maximum number of expired leases that can be - // processed in a single attempt to clean up the expired - // leases from the lease database. If there are more + // processed in a single attempt to clean up expired leases + // from the lease database. If there are more // expired leases, they will be processed during the next // cleanup attempt. "max-reclaim-leases": 100, - // Specifies the maximum time in milliseconds that a single - // attempt to cleanup the lease database from the expired - // leases may take. + // Specifies the maximum time in milliseconds that a single attempt + // to clean up expired leases from the lease database may take. "max-reclaim-time": 250, - // Specifies the time period in seconds since the last attempt + // Specifies the length of time in seconds since the last attempt // to process expired leases before initiating the next attempt. "reclaim-timer-wait-time": 10, - // Specifies the maximum number of expired lease-processing - // cycles which didn't result in full cleanup of expired leases - // from the lease database, after which a - // warning message is issued. + // Specifies the maximum number of expired lease-processing cycles + // which didn't result in full cleanup of exired leases from the + // lease database, after which a warning message is issued. "unwarned-reclaim-cycles": 5 }, @@ -375,7 +373,7 @@ // Connection reconnect wait time. // This parameter governs how long Kea waits before attempting - // to reconnect, expressed in milliseconds. The default is 0 + // to reconnect. Expressed in milliseconds. The default is 0 // (disabled) for MySQL and PostgreSQL. "reconnect-wait-time": 3000, @@ -387,7 +385,7 @@ // serve-retry-continue "on-fail": "stop-retry-exit", - // Connection connect timeout. + // Connection connect timeout in seconds. "connect-timeout": 100 } ], @@ -397,7 +395,7 @@ // DHCP clients. All identifiers are used by default, which // means that the server will issue multiple queries to the // database to find if there is a reservation for a particular - // client. If the particular deployment uses only a subset, e.g. + // client. If a particular deployment uses only a subset, e.g. // one identifier type, this identifier should be only listed // here to prevent unnecessary queries to the database. "host-reservation-identifiers": [ @@ -412,7 +410,7 @@ // server is listening to the DHCP queries. "interfaces-config": { // Specifies whether the server should use "udp" sockets or - // "raw" sockets to listen to the DHCP traffic. The "raw" + // "raw" sockets to listen to DHCP traffic. The "raw" // sockets are useful when direct DHCP traffic is being // received. "dhcp-socket-type": "udp", @@ -424,7 +422,7 @@ ], // Enumeration which indicates what interface should be used - // to send DHCP response to the client. The default value is + // to send DHCP responses to the client. The default value is // "same-as-inbound", which indicates that the response should // be sent via the interface on which the client's query // was received. The "use-routing" value indicates that the @@ -432,7 +430,7 @@ // suitable interface. "outbound-interface": "same-as-inbound", - // Boolean flag indicating if the available interfaces should + // Boolean flag indicating whether the available interfaces should // be re-detected upon server reconfiguration. The default value // is true, which means that the interfaces are always // re-detected. @@ -516,9 +514,9 @@ "type": "memfile" }, - // Boolean value indicating whether the Kea DHCPv4 server should use client + // Boolean value indicating whether the Kea DHCPv4 server should use the client // identifier value sent by the client or ignore it. The default value - // is true, which indicates that the server should use a client identifier + // is true, which indicates that the server should use the client identifier // and that it takes precedence over the client's MAC address. In deployments // where MAC address should take precedence, this value can be set to // false, in which case the clients will be identified by MAC address. @@ -542,7 +540,7 @@ // kea-dhcp4 from building an insurmountable backlog of updates. "parked-packet-limit": 128, - // List of global DHCP options that Kea DHCPv4 server assigns to the + // List of global DHCP options that the Kea DHCPv4 server assigns to // clients. "option-data": [ { @@ -618,7 +616,7 @@ ], // Global value for the rebind timer, i.e. the time after which the - // DHCP client enters rebind state if it fails to renew the lease. + // DHCP client enters the rebind state if it fails to renew the lease. "rebind-timer": 40, // Global value for the renew timer, i.e. the time after which the @@ -675,8 +673,8 @@ // whether to upgrade from the old format. The following values // are supported: "none" (don't attempt to correct or upgrade // the extended info), "fix" (fix common inconsistencies and - // upgrade from old format; this is the default), "strict" - // (fix inconsistencies with an impact on Lease Query), + // upgrade from the old format; this is the default), "strict" + // (fix inconsistencies with an impact on Leasequery), // "pedantic" (enforce full Kea code format). "extended-info-checks": "fix" }, @@ -685,10 +683,10 @@ // networks group subnets together. "shared-networks": [ { - // Shared network-level authoritative flag. + // Shared-network level authoritative flag. "authoritative": false, - // Shared network-level bootfile name. + // Shared-network level bootfile name. "boot-file-name": "/dev/null", // Restricts this shared network to allow only clients @@ -696,48 +694,48 @@ // empty string is provided, no restriction is applied. "client-class": "", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-generated-prefix": "myhost", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-override-client-update": false, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-override-no-update": false, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-qualifying-suffix": "", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-replace-client-name": "never", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-send-updates": true, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-update-on-renew": true, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-use-conflict-resolution": true, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "hostname-char-replacement": "x", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "hostname-char-set": "[^A-Za-z0-9.-]", // Specifies that this shared network is selected for // requests received on a particular interface. "interface": "eth0", - // Shared network-level flag specifying whether the client + // Shared-network level flag specifying whether the client // identifier should be used for identifying clients. "match-client-id": true, // Shared network name. "name": "my-secret-network", - // Shared network-level specification of the next server + // Shared-network level specification of the next server // to be sent in 'siaddr'. "next-server": "192.0.2.123", @@ -750,13 +748,13 @@ "ip-addresses": [] }, - // Shared network-level rebind timer. + // Shared-network level rebind timer. "rebind-timer": 41, - // Shared network-level renew timer. + // Shared-network level renew timer. "renew-timer": 31, - // Shared network-level compute T1 and T2 timers. + // Shared-network level compute T1 and T2 timers. "calculate-tee-times": true, // T1 = valid lifetime * .5. @@ -780,13 +778,13 @@ // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should look up global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should look up in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "subnet4" levels. @@ -800,7 +798,7 @@ // information) with each lease for this shared network. "store-extended-info": false, - // Shared network-level server hostname set in 'sname' field. + // Shared-network level server hostname set in 'sname' field. "server-hostname": "", // List of IPv4 subnets belonging to this shared network. @@ -879,16 +877,16 @@ // Subnet-level list of DHCP options. "option-data": [ { - // Boolean flag indicating if the particular option + // Boolean flag indicating whether the particular option // should be always sent or sent only when requested. "always-send": false, // Option code. "code": 3, - // Boolean flag indicating if the option value specified - // in "data" is a string of hexadecimal values or a - // human-readable CSV value. + // Boolean flag indicating whether the option value specified + // in "data" is a string of hexadecimal values or human-readable + // CSV value. "csv-format": true, // Option data to be included in the option payload. @@ -897,7 +895,7 @@ // Option name. "name": "routers", - // Boolean flag indicating if the given option is never + // Boolean flag indicating whether the given option is never // sent in response. "never-send": false, @@ -962,13 +960,13 @@ // "reservations-in-subnet", and // "reservations-out-of-pool" parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved + // Specify whether the server can assume that all reserved // addresses are out-of-pool. // Ignored when reservations-in-subnet is false. "reservations-out-of-pool": false, @@ -1036,7 +1034,7 @@ } ], - // Shared network-level (default) valid lifetime. + // Shared-network level (default) valid lifetime. "valid-lifetime": 6001, // Subnet-level min valid lifetime. @@ -1053,7 +1051,7 @@ // List of IPv4 subnets which don't belong to any shared network. "subnet4": [], - // Global valid (default) lifetime value. + // Global valid lifetime value. "valid-lifetime": 6000, // Global min valid lifetime value. @@ -1078,7 +1076,7 @@ "type": "mysql" } ], - // Intervals between attempts to fetch configuration updates + // Interval between attempts to fetch configuration updates // via the configuration backends used. "config-fetch-wait-time": 30 }, @@ -1103,13 +1101,13 @@ // It is replaced by the "reservations-global", // "reservations-in-subnet", and "reservations-out-of-pool" parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "shared-networks" and diff --git a/doc/examples/kea4/all-keys.json b/doc/examples/kea4/all-keys.json index 42af2ee149..98dc9a431b 100644 --- a/doc/examples/kea4/all-keys.json +++ b/doc/examples/kea4/all-keys.json @@ -3,15 +3,14 @@ // mutually exclusive configuration parameters. // // The primary purpose of the example file is to provide a comprehensive -// list of parameters supported by the Kea DHCPv4 server, along with the brief +// list of parameters supported by the Kea DHCPv4 server, along with a brief // description of each parameter. // -// This current version should be up-to-date, i.e. new keywords should be -// added in this file at the same time as in the syntax. +// This current version should be up to date, i.e. new keywords should be +// added in this file at the same time as in the parser specification. { // Kea DHCPv4 server configuration begins here. "Dhcp4": { - // Global flag selecting an IP address allocation strategy for all // subnets. Use "random" for a random allocation strategy. "allocator": "iterative", @@ -61,7 +60,7 @@ "max-valid-lifetime": 8000, // If greater than zero, it is the lifetime of leases temporarily allocated - // on DISCOVER. When zero (the default), leases are not allocated on DISCOVER. + // on DISCOVER. When zero (the default), leases are not allocated on DISCOVER. "offer-lifetime" : 65 }, { @@ -95,7 +94,7 @@ // Third class name. "name": "late", - // Boolean flag indicating that the class expression is only evaluated + // Boolean flag indicating whether the class expression is only evaluated // when the class is required, e.g. the selected address pool configuration // includes this class name in its "require-client-classes" list. The // default value false means that the class test expression must @@ -143,7 +142,7 @@ "exclude-first-last-24": false }, - // Command control socket configuration parameters for Kea DHCPv4 server. + // Command control socket configuration parameters for the Kea DHCPv4 server. "control-socket": { // Location of the UNIX domain socket file the DHCPv4 server uses // to receive control commands from the Kea Control Agent or the @@ -159,18 +158,18 @@ // It may be specified at the global, shared-network, and subnet levels. "ddns-generated-prefix": "myhost", - // Boolean flag indicating that the server should ignore DHCP client + // Boolean flag indicating whether the server should ignore DHCP client // wishes to update DNS on its own. With that flag set to true, // the server will send DNS updates for both forward and // reverse DNS data. The default value is false, which indicates - // that the server will delegate DNS updates to the client when + // that the server will delegate a DNS update to the client when // requested. It may be specified at the global, shared-network, // and subnet levels. "ddns-override-client-update": false, - // Boolean flag indicating that the server should override a DHCP + // Boolean flag indicating whether the server should override the DHCP // client's wish to not update the DNS. With this parameter - // set to true, the server will send DNS updates even when + // set to true, the server will send a DNS update even when // the client requested no update. It may be specified at the // global, shared-network, and subnet levels. "ddns-override-no-update": false, @@ -200,7 +199,7 @@ // to kea-dhcp-ddns. "ddns-send-updates": true, - // Boolean flag which when true instructs the server to always + // Boolean flag, which when true instructs the server to always // update DNS when leases are renewed, even if the DNS information // has not changed. The server's default behavior (i.e. flag is false) // is to only update DNS if the DNS information has changed. It @@ -223,11 +222,11 @@ "decline-probation-period": 86400, // Name Change Request forwarding configuration for the Kea DHCPv4 server. - // NCRs are sent to the Kea D2 module to update DNS upon allocation of the + // NCRs are sent to the Kea D2 module to update DNS upon allocation of // DHCP leases. "dhcp-ddns": { - // Boolean flag indicating if Kea DHCPv4 server should connect to - // kea-dhcp-ddns. This must be true for NCRs to be created and + // Boolean flag indicating whether Kea DHCPv4 server should connect to + // kea-dhcp-ddns. This must be true for NCRs to be created and // sent to kea-dhcp-ddns. By default, NCRs are not generated. "enable-updates": false, @@ -243,12 +242,12 @@ // only UDP is supported. "ncr-protocol": "UDP", - // IP address that Kea DHCPv4 server should use to send + // IP address that the Kea DHCPv4 server should use to send // NCRs to D2. The default value of zero indicates that Kea // should pick a suitable address. "sender-ip": "0.0.0.0", - // Port number that Kea DHCPv4 server should use to send + // Port number that the Kea DHCPv4 server should use to send // NCRs to D2. The default value of zero indicates that Kea // should pick a suitable port. "sender-port": 0, @@ -259,7 +258,7 @@ // Port number on which D2 listens for NCRs. "server-port": 53001, - // The follow parameters are DEPRECATED. They have been + // The following parameters are DEPRECATED. They have been // replaced with parameters that may be set at the global, // shared-network, and subnet4 scopes. They are listed here // as configuration parsing still accepts them. Eventually @@ -291,7 +290,7 @@ // the server should process expired DHCP leases. "expired-leases-processing": { // Specifies the number of seconds since the last removal of - // the expired leases when the next removal should occur. + // the expired leases, when the next removal should occur. // If both "flush-reclaimed-timer-wait-time" and // "hold-reclaimed-time" are not 0, when the client sends a release // message the lease is expired instead of being deleted from @@ -313,19 +312,17 @@ // cleanup attempt. "max-reclaim-leases": 100, - // Specifies the maximum time in milliseconds that a single - // attempt to clean up expired leases from the lease - // database may take. + // Specifies the maximum time in milliseconds that a single attempt + // to clean up expired leases from the lease database may take. "max-reclaim-time": 250, - // Specifies the time period in seconds since the last attempt + // Specifies the length of time in seconds since the last attempt // to process expired leases before initiating the next attempt. "reclaim-timer-wait-time": 10, - // Specifies the maximum number of expired lease-processing - // cycles which didn't result in full cleanup of expired leases - // from the lease database, after which a - // warning message is issued. + // Specifies the maximum number of expired lease-processing cycles + // which didn't result in full cleanup of exired leases from the + // lease database, after which a warning message is issued. "unwarned-reclaim-cycles": 5 }, @@ -420,7 +417,7 @@ // Connection reconnect wait time. // This parameter governs how long Kea waits before attempting - // to reconnect, expressed in milliseconds. The default is 0 + // to reconnect. Expressed in milliseconds. The default is 0 // (disabled) for MySQL and PostgreSQL. "reconnect-wait-time": 3000, @@ -435,10 +432,10 @@ // Connection connect timeout in seconds. "connect-timeout": 100, - // Data-read from the database timeout in seconds. + // Timeout of database read operations in seconds. "read-timeout": 120, - // Data-write to the database timeout in seconds. + // Timeout of database write operations in seconds. "write-timeout": 180 } ], @@ -469,7 +466,7 @@ "dhcp-socket-type": "udp", // Specifies a list of interfaces on which the Kea DHCPv4 - // server should listen to the DHCP requests. + // server should listen to DHCP requests. "interfaces": [ "eth0" ], @@ -619,7 +616,7 @@ // provided. "name": "domain-name-servers", - // Boolean flag indicating whether the given option is never + // Boolean flag indicating whether the given option is never // sent in response. The default value of false indicates // that it is sent when it should be. When true, the option // is not sent despite any other setting, i.e. it is @@ -726,8 +723,8 @@ // whether to upgrade from the old format. The following values // are supported: "none" (don't attempt to correct or upgrade // the extended info), "fix" (fix common inconsistencies and - // upgrade from old format; this is the default), "strict" - // (fix inconsistencies with an impact on Lease Query), + // upgrade from the old format; this is the default), "strict" + // (fix inconsistencies with an impact on Leasequery), // "pedantic" (enforce full Kea code format). "extended-info-checks": "fix" }, @@ -740,10 +737,10 @@ // subnets in this shared network. "allocator": "random", - // Shared network-level authoritative flag. + // Shared-network level authoritative flag. "authoritative": false, - // Shared network-level bootfile name. + // Shared-network level bootfile name. "boot-file-name": "/dev/null", // Restricts this shared network to allow only clients @@ -751,56 +748,56 @@ // empty string is provided, no restriction is applied. "client-class": "", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-generated-prefix": "myhost", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-override-client-update": false, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-override-no-update": false, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-qualifying-suffix": "", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-replace-client-name": "never", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-send-updates": true, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-update-on-renew": true, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-use-conflict-resolution": true, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-ttl-percent": 0.65, - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "hostname-char-replacement": "x", - // Shared network-level value. See description at the global level. + // Shared-network level value. See description at the global level. "hostname-char-set": "[^A-Za-z0-9.-]", // Specifies that this shared network is selected for // requests received on a particular interface. "interface": "eth0", - // Shared network-level flag specifying whether the client + // Shared-network level flag specifying whether the client // identifier should be used for identifying clients. "match-client-id": true, // Shared network name. "name": "my-secret-network", - // Shared network-level specification of the next server + // Shared-network level specification of the next server // to be sent in 'siaddr'. "next-server": "192.0.2.123", // If greater than zero, it is the lifetime of leases temporarily allocated - // on DISCOVER. When zero (the default), leases are not allocated on DISCOVER. + // on DISCOVER. When zero (the default), leases are not allocated on DISCOVER. "offer-lifetime" : 60, // List of shared network-specific DHCP options. @@ -812,13 +809,13 @@ "ip-addresses": [] }, - // Shared network-level rebind timer. + // Shared-network level rebind timer. "rebind-timer": 41, - // Shared network-level renew timer. + // Shared-network level renew timer. "renew-timer": 31, - // Shared network-level compute T1 and T2 timers. + // Shared-network level compute T1 and T2 timers. "calculate-tee-times": true, // T1 = valid lifetime * .5. @@ -830,7 +827,7 @@ // Cache threshold = valid lifetime * .25. "cache-threshold": .25, - // Cache maximum: when the client last transmission time + // Cache maximum: when the client last-transmission time // is close enough, the lease is not renewed and the current // lease is returned as it was "cached". "cache-max-age": 1000, @@ -842,13 +839,13 @@ // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should look up global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should look up in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "subnet4" levels. @@ -862,7 +859,7 @@ // information) with each lease for this shared network. "store-extended-info": false, - // Shared network-level server hostname set in 'sname' field. + // Shared-network level server hostname set in 'sname' field. "server-hostname": "", // List of IPv4 subnets belonging to this shared network. @@ -942,7 +939,7 @@ "next-server": "0.0.0.0", // If greater than zero, it is the lifetime of leases temporarily allocated - // on DISCOVER. When zero (the default), leases are not allocated on DISCOVER. + // on DISCOVER. When zero (the default), leases are not allocated on DISCOVER. "offer-lifetime" : 60, // Turn on storage of extended information (e.g. relay agent @@ -952,16 +949,16 @@ // Subnet-level list of DHCP options. "option-data": [ { - // Boolean flag indicating if the particular option + // Boolean flag indicating whether the particular option // should be always sent or sent only when requested. "always-send": false, // Option code. "code": 3, - // Boolean flag indicating if the option value specified - // in "data" is a string of hexadecimal values or a - // human-readable CSV value. + // Boolean flag indicating whether the option value specified + // in "data" is a string of hexadecimal values or human-readable + // CSV value. "csv-format": true, // Option data to be included in the option payload. @@ -970,7 +967,7 @@ // Option name. "name": "routers", - // Boolean flag indicating if the given option is never + // Boolean flag indicating whether the given option is never // sent in response. "never-send": false, @@ -1017,8 +1014,7 @@ // Subnet-level value of the rebind timer. "rebind-timer": 40, - // List of IPv4 relay addresses for which this subnet is - // selected. + // List of IPv4 relay addresses for which this subnet is selected. "relay": { "ip-addresses": [ "192.168.56.1" @@ -1035,13 +1031,13 @@ // "reservations-in-subnet", and // "reservations-out-of-pool" parameters. - // Specify if server should look up global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should look up in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved + // Specify whether the server can assume that all reserved // addresses are out-of-pool. // Ignored when reservations-in-subnet is false. "reservations-out-of-pool": false, @@ -1109,13 +1105,13 @@ } ], - // Shared network-level (default) valid lifetime. + // Shared-network level (default) valid lifetime. "valid-lifetime": 6001, - // Subnet-level min valid lifetime. + // Shared-network level min valid lifetime. "min-valid-lifetime": 4001, - // Subnet-level max valid lifetime. + // Shared-network level max valid lifetime. "max-valid-lifetime": 8001 } ], @@ -1126,7 +1122,7 @@ // List of IPv4 subnets which don't belong to any shared network. "subnet4": [], - // Global valid (default) lifetime value. + // Global valid lifetime value. "valid-lifetime": 6000, // Global min valid lifetime value. @@ -1176,13 +1172,13 @@ // It is replaced by the "reservations-global", // "reservations-in-subnet", and "reservations-out-of-pool" parameters. - // Specify if server should look up global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should look up in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "shared-networks" and @@ -1236,7 +1232,7 @@ // Specifies the maximum number of rotated files to be kept. "maxver": 1, - // Specifies logging destination. + // Specifies the logging destination. "output": "stdout", // Specifies log entry content diff --git a/doc/examples/kea4/config-backend.json b/doc/examples/kea4/config-backend.json index aae0f34436..208a3d3eb7 100644 --- a/doc/examples/kea4/config-backend.json +++ b/doc/examples/kea4/config-backend.json @@ -1,7 +1,7 @@ // This is an example configuration file for the DHCPv4 server in Kea. // It demonstrates how to enable Kea Configuration Backend using MySQL. // It requires that libdhcp_mysql_cb.so library is available and -// optionally libdhcp_cb_cmds.so hooks library. +// optionally libdhcp_cb_cmds.so hook library. { "Dhcp4": @@ -24,7 +24,7 @@ // This parameter controls how the server accesses the configuration // database. Currently only one database type is available - "mysql". - // It requires that libdhcp_mysql_cb.so hooks library is loaded. + // It requires that the libdhcp_mysql_cb.so hook library is loaded. "config-control": { // A list of database backends to connect to. Currently, it is limited // to a single backend. diff --git a/doc/examples/kea4/global-reservations.json b/doc/examples/kea4/global-reservations.json index d25200c38e..0e8be68fbb 100644 --- a/doc/examples/kea4/global-reservations.json +++ b/doc/examples/kea4/global-reservations.json @@ -52,16 +52,16 @@ // This directive tells Kea that reservations are global. Note that this // can also be specified at shared network and/or subnet level. // "reservation-mode": "global", -// It is replaced by the "reservations-global", "reservations-in-subnet" and +// It is replaced by the "reservations-global", "reservations-in-subnet", and // "reservations-out-of-pool" parameters. -// Specify if server should lookup global reservations. +// Specify whether the server should look up global reservations. "reservations-global": true, -// Specify if server should lookup in-subnet reservations. +// Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": false, -// Specify if server can assume that all reserved addresses +// Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "shared-networks" and "subnet4" levels. diff --git a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json index e6f2f6d066..3f22ccee75 100644 --- a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json +++ b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json @@ -1,5 +1,5 @@ // This is an example configuration of the Kea DHCPv4 server. It uses High -// Availability hooks library and Lease Commands hooks library to enable +// Availability hook library and Lease Commands hook library to enable // High Availability function for the DHCP server. Note that almost exactly // the same configuration must be used on the second server (partner). // The only difference is that "this-server-name" must be set to "server2" @@ -69,7 +69,7 @@ }, // Some phones will be handled by server1. Whether the HA_server1 // or HA_server2 is assigned for the client is a matter of load - // balancing performed by the HA hooks library. + // balancing performed by the HA hook library. { "name": "phones_server1", "test": "member('phones') and member('HA_server1')" @@ -91,7 +91,7 @@ } ], - // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and + // HA requires two hook libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. "hooks-libraries": [ @@ -103,7 +103,7 @@ "parameters": { } }, { - // The HA hooks library should be loaded. + // The HA hook library should be loaded. "library": "/opt/lib/kea/hooks/libdhcp_ha.so", "parameters": { // High Availability configuration is specified for the HA hook library. @@ -264,7 +264,7 @@ "debuglevel": 0 }, { - // This section specifies configuration of the HA hooks library specific + // This section specifies configuration of the HA hook library-specific // logger. "name": "kea-dhcp4.ha-hooks", "output_options": [ diff --git a/doc/examples/kea4/ha-load-balancing-server2-mt.json b/doc/examples/kea4/ha-load-balancing-server2-mt.json index 51be49a82c..040d43e9dd 100644 --- a/doc/examples/kea4/ha-load-balancing-server2-mt.json +++ b/doc/examples/kea4/ha-load-balancing-server2-mt.json @@ -1,5 +1,5 @@ // This is an example configuration of the Kea DHCPv4 server. It uses High -// Availability hooks library and Lease Commands hooks library to enable +// Availability hook library and Lease Commands hook library to enable // High Availability function for the DHCP server. Note that almost exactly // the same configuration must be used on the second server (partner). // The only difference is that "this-server-name" must be set to "server1" @@ -68,7 +68,7 @@ }, // Some phones will be handled by server1. Whether the HA_server1 // or HA_server2 is assigned for the client is a matter of load - // balancing performed by the HA hooks library. + // balancing performed by the HA hook library. { "name": "phones_server1", "test": "member('phones') and member('HA_server1')" @@ -90,7 +90,7 @@ } ], - // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and + // HA requires two hook libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. "hooks-libraries": [ @@ -102,7 +102,7 @@ "parameters": { } }, { - // The HA hooks library should be loaded. + // The HA hook library should be loaded. "library": "/opt/lib/kea/hooks/libdhcp_ha.so", "parameters": { // High Availability configuration is specified for the HA hook library. @@ -247,7 +247,7 @@ "debuglevel": 0 }, { - // This section specifies configuration of the HA hooks library specific + // This section specifies configuration of the HA hook library-specific // logger. "name": "kea-dhcp4.ha-hooks", "output_options": [ diff --git a/doc/examples/kea4/hooks-radius.json b/doc/examples/kea4/hooks-radius.json index f00190e1e9..164e6f8577 100644 --- a/doc/examples/kea4/hooks-radius.json +++ b/doc/examples/kea4/hooks-radius.json @@ -1,5 +1,5 @@ // This is an example configuration file for the DHCPv4 server in Kea -// illustrating the configuration of the RADIUS and Host Cache hooks libraries. +// illustrating the configuration of the RADIUS and Host Cache hook libraries. // // It is not intended to be used as is. It tries to showcase some of the // parameters available. @@ -121,7 +121,7 @@ ] } ], - // Set up the hooks libraries. + // Set up the hook libraries. "hooks-libraries": [ { // Load the flex-id hook library. diff --git a/doc/examples/kea4/hooks.json b/doc/examples/kea4/hooks.json index 0d6e29bbec..3b96d621ed 100644 --- a/doc/examples/kea4/hooks.json +++ b/doc/examples/kea4/hooks.json @@ -1,5 +1,5 @@ // This is an example configuration file for the DHCPv4 server in Kea -// illustrating the configuration of hooks libraries. It uses a basic scenario +// illustrating the configuration of hook libraries. It uses a basic scenario // of one IPv4 subnet configured with the default values for all parameters. {"Dhcp4": @@ -26,7 +26,7 @@ } ], -// Set up the hooks libraries. For this example, we assume that two libraries +// Set up the hook libraries. For this example, we assume that two libraries // are loaded, called "security" and "charging". Note that order is important: // "security" is specified first so if both libraries supply a hook function // for a given hook, the function in "security" will be called before that in diff --git a/doc/examples/kea4/leases-expiration.json b/doc/examples/kea4/leases-expiration.json index f2f4332eef..ce73a57a3b 100644 --- a/doc/examples/kea4/leases-expiration.json +++ b/doc/examples/kea4/leases-expiration.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. // Note, we're setting the maximum number of row read errors to 100, // (defaults to 0, meaning unlimited). "lease-database": { @@ -33,7 +33,7 @@ // unreclaimed leases after 10 attempts, a warning message is issued. // If both "flush-reclaimed-timer-wait-time" and "hold-reclaimed-time" are not // 0, when the client sends a release message the lease is expired instead of -// being deleted from the lease storage. +// being deleted from lease storage. "expired-leases-processing": { "reclaim-timer-wait-time": 5, "hold-reclaimed-time": 1800, diff --git a/doc/examples/kea4/multiple-options.json b/doc/examples/kea4/multiple-options.json index 949889127f..cded883116 100644 --- a/doc/examples/kea4/multiple-options.json +++ b/doc/examples/kea4/multiple-options.json @@ -12,7 +12,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile" }, diff --git a/doc/examples/kea4/mysql-reservations.json b/doc/examples/kea4/mysql-reservations.json index 57429857be..c44c463542 100644 --- a/doc/examples/kea4/mysql-reservations.json +++ b/doc/examples/kea4/mysql-reservations.json @@ -14,7 +14,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 diff --git a/doc/examples/kea4/pgsql-reservations.json b/doc/examples/kea4/pgsql-reservations.json index 9f6d30141e..7d9bd669ba 100644 --- a/doc/examples/kea4/pgsql-reservations.json +++ b/doc/examples/kea4/pgsql-reservations.json @@ -14,7 +14,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile" }, diff --git a/doc/examples/kea4/reservations.json b/doc/examples/kea4/reservations.json index c00a8e9c0c..b316740ead 100644 --- a/doc/examples/kea4/reservations.json +++ b/doc/examples/kea4/reservations.json @@ -72,13 +72,13 @@ // It is replaced by the "reservations-global", "reservations-in-subnet" // and "reservations-out-of-pool" parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "shared-networks" and diff --git a/doc/examples/kea4/several-subnets.json b/doc/examples/kea4/several-subnets.json index 5fb0511264..9bad6a20ef 100644 --- a/doc/examples/kea4/several-subnets.json +++ b/doc/examples/kea4/several-subnets.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile" }, diff --git a/doc/examples/kea4/shared-network.json b/doc/examples/kea4/shared-network.json index 9f38ee8c87..0452132b96 100644 --- a/doc/examples/kea4/shared-network.json +++ b/doc/examples/kea4/shared-network.json @@ -67,16 +67,16 @@ // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" + // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "subnet4" levels. @@ -104,13 +104,13 @@ "renew-timer": 10, // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" + // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. "reservations-out-of-pool": false, @@ -129,13 +129,13 @@ "renew-timer": 10, // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" + // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. "reservations-out-of-pool": false, diff --git a/doc/examples/kea4/single-subnet.json b/doc/examples/kea4/single-subnet.json index 3fa6dfb1ee..701fc56be3 100644 --- a/doc/examples/kea4/single-subnet.json +++ b/doc/examples/kea4/single-subnet.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 diff --git a/doc/examples/kea4/vendor-specific.json b/doc/examples/kea4/vendor-specific.json index 431c04ec29..b48c2d0824 100644 --- a/doc/examples/kea4/vendor-specific.json +++ b/doc/examples/kea4/vendor-specific.json @@ -49,7 +49,7 @@ "option-data": [ { // vendor-encapsulated-options and defined option on global level should -// be also configured with proper "data" parameters in "option-data" list. +// be also configured with proper "data" parameters in "option-data" list. // Because Kea will send only option that client ask for, and there is no way // to ask for suboptions, parameter "always-send" with value set // to true has also be included in all custom suboptions diff --git a/doc/examples/kea4/with-ddns.json b/doc/examples/kea4/with-ddns.json index ba607c8cae..70072f5be2 100644 --- a/doc/examples/kea4/with-ddns.json +++ b/doc/examples/kea4/with-ddns.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 diff --git a/doc/examples/kea6/advanced.json b/doc/examples/kea6/advanced.json index 7704f8df2b..61b6a42b5e 100644 --- a/doc/examples/kea6/advanced.json +++ b/doc/examples/kea6/advanced.json @@ -26,7 +26,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. - // We will use memfile because it doesn't require any prior set up. + // We will use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 @@ -169,7 +169,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/kea6/all-keys-netconf.json b/doc/examples/kea6/all-keys-netconf.json index 148b6ec99e..646253064b 100644 --- a/doc/examples/kea6/all-keys-netconf.json +++ b/doc/examples/kea6/all-keys-netconf.json @@ -3,7 +3,7 @@ // mutually exclusive configuration parameters. // // The primary purpose of the example file is to provide a comprehensive -// list of parameters supported by Kea DHCPv6 server along with the brief +// list of parameters supported by the Kea DHCPv6 server along with the brief // description of each parameter. // // This stable version is used for YANG as we do not want to update code @@ -17,7 +17,7 @@ // Class name. "name": "phones_server1", - // Class specific DHCPv6 options list. + // Class-specific DHCPv6 options list. "option-data": [], // Class selection expression. The DHCP packet is assigned to this @@ -46,7 +46,7 @@ // Second class name. "name": "phones_server2", - // Class specific DHCPv6 options list. + // Class-specific DHCPv6 options list. "option-data": [], // Class selection expression. The DHCP packet is assigned to this @@ -57,8 +57,8 @@ // Third class name. "name": "late", - // Boolean flag indicating that the class expression is only evaluated - // when the class is required, e.g. selected address pool configuration + // Boolean flag indicating whether the class expression is only evaluated + // when the class is required, e.g. the selected address pool configuration // includes this class name in its "require-client-classes" list. The // default value false means that the class test expression must // always be evaluated. @@ -78,16 +78,16 @@ ], // Parameters for triggering behaviors compatible with broken or - // non-compliant clients, relays or other agents + // non-compliant clients, relays, or other agents "compatibility": { // Parse options more leniently where fields can be deduced - // deterministically even if against RFC or common practice. + // deterministically, even if against RFC or common practice. "lenient-option-parsing": true }, - // Command control socket configuration parameters for Kea DHCPv6 server. + // Command control socket configuration parameters for the Kea DHCPv6 server. "control-socket": { - // Location of the unix domain socket file the DHCPv6 server uses + // Location of the UNIX domain socket file the DHCPv6 server uses // to receive control commands from the Kea Control Agent or the // local server administrator. "socket-name": "/tmp/kea6-ctrl-socket", @@ -98,82 +98,82 @@ }, // Specifies a prefix to be prepended to the generated Client FQDN. - // It may be specified at the global, shared-network and subnet levels. + // It may be specified at the global, shared-network, and subnet levels. "ddns-generated-prefix": "myhost", - // Boolean flag indicating that server should ignore DHCP client - // wishes to update DNS on its own. With that flag set to true + // Boolean flag indicating whether the server should ignore DHCP client + // wishes to update DNS on its own. With that flag set to true, // the server will send DNS updates for both forward and // reverse DNS data. The default value is false, which indicates - // that the server will delegate DNS update to the client when - // requested. It may be specified at the global, shared-network + // that the server will delegate a DNS update to the client when + // requested. It may be specified at the global, shared-network, // and subnet levels. "ddns-override-client-update": false, - // Boolean flag indicating that the server should override DHCP + // Boolean flag indicating whether the server should override the DHCP // client's wish to not update the DNS. With this parameter - // set to true the server will send DNS update even when - // the client requested no update. It may be specified at the - // global, shared-network and subnet levels. + // set to true, the server will send a DNS update even when + // the client requested no update. It may be specified at the + // global, shared-network, and subnet levels. "ddns-override-no-update": false, // Suffix appended to the partial name sent to the DNS. The - // default value is an empty string which indicates that no - // suffix is appended. It may be specified at the global, - // shared-network and subnet levels. + // default value is an empty string, which indicates that no + // suffix is appended. It may be specified at the global, + // shared-network, and subnet levels. "ddns-qualifying-suffix": "", // Enumeration specifying whether the server should honor - // hostname or Client FQDN sent by the client or replace + // the hostname or Client FQDN sent by the client or replace // this name. The acceptable values are: "never" (use the // name the client sent), "always" (replace the name the // client sent), "when-present" (replace the name the client - // sent, but do not generate one when the client didn't sent + // sent, but do not generate one when the client didn't send // the name), "when-not-present" (generate the name when // client didn't send one, otherwise leave the name the - // client sent). The default value is "never". It may be - // specified at the global, shared-network and subnet levels. + // client sent). The default value is "never". It may be + // specified at the global, shared-network, and subnet levels. "ddns-replace-client-name": "never", - // Boolean flag which enables or disables the DDNS updating. It - // defaults to true. It may be specified at the global, shared- - // network and subnet levels. It works in conjunction with - // dhcp-ddns:enable-updates which must be true to enable connectivity + // Boolean flag which enables or disables DDNS updating. It + // defaults to true. It may be specified at the global, shared- + // network, and subnet levels. It works in conjunction with + // dhcp-ddns:enable-updates, which must be true to enable connectivity // to kea-dhcp-ddns. "ddns-send-updates": true, // Boolean flag, which when true instructs the server to always // update DNS when leases are renewed, even if the DNS information - // has not changed. The server's default behavior (i.e. flag is false) - // is to only update DNS if the DNS information has changed. It - // may be specified at the global, shared-network and subnet levels. + // has not changed. The server's default behavior (i.e. flag is false) + // is to only update DNS if the DNS information has changed. It + // may be specified at the global, shared-network, and subnet levels. "ddns-update-on-renew": true, - // Boolean flag, which is passed to kea-dhcp-ddns with each DDNS - // update request to indicate whether or not DNS update conflict + // Boolean flag which is passed to kea-dhcp-ddns with each DDNS + // update request, to indicate whether DNS update conflict // resolution as described in RFC 4703 should be employed for the - // given update request. The default value for this flag is true. - // It may be specified at the global, shared-network and subnet levels. + // given update request. The default value for this flag is true. + // It may be specified at the global, shared-network, and subnet levels. "ddns-use-conflict-resolution": true, // Time in seconds specifying how long a declined lease should be // excluded from DHCP assignments. The default value is 24 hours. "decline-probation-period": 86400, - // Name Change Requests forwarding configuration for Kea DHCPv6 server. - // NCRs are sent to Kea D2 module to update DNS upon allocation of the + // Name Change Request forwarding configuration for the Kea DHCPv6 server. + // NCRs are sent to the Kea D2 module to update DNS upon allocation of // DHCP leases. "dhcp-ddns": { - // Boolean flag indicating if Kea DHCPv6 server should connect to - // kea-dhcp-ddns. This must be true for NCRs to be created and - // sent to kea-dhcp-ddns. By default NCRs are not generated. + // Boolean flag indicating whether Kea DHCPv6 server should connect to + // kea-dhcp-ddns. This must be true for NCRs to be created and + // sent to kea-dhcp-ddns. By default, NCRs are not generated. "enable-updates": false, // Specifies maximum number of NCRs to queue waiting to be sent - // to Kea D2 server. + // to the Kea D2 server. "max-queue-size": 1024, - // Packet format to use when sending NCRs to Kea D2 server. + // Packet format to use when sending NCRs to the Kea D2 server. // Currently, only JSON format is supported. "ncr-format": "JSON", @@ -181,14 +181,14 @@ // only UDP is supported. "ncr-protocol": "UDP", - // IP address that Kea DHCPv6 server should use to send - // NCRs to D2. Default value of zero indicates that Kea - // should pick suitable address. + // IP address that the Kea DHCPv6 server should use to send + // NCRs to D2. The default value of zero indicates that Kea + // should pick a suitable address. "sender-ip": "::1", - // Port number that Kea DHCPv6 server should use to send - // NCRs to D2. Default value of zero indicates that Kea - // should pick suitable port. + // Port number that the Kea DHCPv6 server should use to send + // NCRs to D2. The default value of zero indicates that Kea + // should pick a suitable port. "sender-port": 0, // IP address on which D2 listens for NCRs. @@ -197,10 +197,10 @@ // Port number on which D2 listens for NCRs. "server-port": 53001, - // The follow parameters are DEPRECATED. They have been + // The following parameters are DEPRECATED. They have been // replaced with parameters that may be set at the global, - // shared-network, and subnet6 scopes. They are listed here - // as configuration parsing still accepts them. Eventually + // shared-network, and subnet6 scopes. They are listed here + // as configuration parsing still accepts them. Eventually // support for them will be removed. "generated-prefix": "myhost", "hostname-char-replacement": "x", @@ -219,53 +219,51 @@ // Collection of Kea DHCPv6 server parameters configuring how // the server should process expired DHCP leases. "expired-leases-processing": { - // Specifies the number of seconds since last removal of - // the expired leases when next removal should occur. + // Specifies the number of seconds since the last removal of + // the expired leases, when the next removal should occur. // If both "flush-reclaimed-timer-wait-time" and // "hold-reclaimed-time" are not 0, when the client sends a release - // message the lease is expired instead of being deleted from the + // message the lease is expired instead of being deleted from // lease storage. "flush-reclaimed-timer-wait-time": 25, - // Specifies the time period in seconds to keep expired + // Specifies the length of time in seconds to keep expired // leases in the lease database (lease affinity). // If both "flush-reclaimed-timer-wait-time" and // "hold-reclaimed-time" are not 0, when the client sends a release - // message the lease is expired instead of being deleted from the + // message the lease is expired instead of being deleted from // lease storage. "hold-reclaimed-time": 3600, // Specifies the maximum number of expired leases that can be - // processed in a single attempt to clean up the lease - // database from the expired leases. If there are more + // processed in a single attempt to clean up expired leases + // from the lease database. If there are more // expired leases, they will be processed during the next // cleanup attempt. "max-reclaim-leases": 100, - // Specifies the maximum time in milliseconds that the single - // attempt to cleanup the lease database from the expired - // leases may take. + // Specifies the maximum time in milliseconds that a single attempt + // to clean up expired leases from the lease database may take. "max-reclaim-time": 250, - // Specifies the time period in seconds since last attempt - // to process expired leases to initiate the next attempt. + // Specifies the length of time in seconds since the last attempt + // to process expired leases before initiating the next attempt. "reclaim-timer-wait-time": 10, - // Specifies the maximum number of expired leases processing - // cycles which didn't result in full cleanup of the lease - // database from the expired leases, after which a - // warning message is issued. + // Specifies the maximum number of expired lease-processing cycles + // which didn't result in full cleanup of exired leases from the + // lease database, after which a warning message is issued. "unwarned-reclaim-cycles": 5 }, - // List of hooks libraries and their specific configuration parameters + // List of hook libraries and their specific configuration parameters // to be loaded by Kea DHCPv4 server. "hooks-libraries": [ { - // Location of the hooks library to be loaded. + // Location of the hook library to be loaded. "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", - // Hook library specific configuration parameters. + // Hook library-specific configuration parameters. "parameters": { } } ], @@ -285,16 +283,17 @@ // Port on which the database is available. "port": 3306, - // Type of the database, e.g. "mysql", "postgresql". + // Type of database, e.g. "mysql", "postgresql". "type": "mysql", - // User name to be used to access the database. + // Username to be used to access the database. "user": "keatest", - // Read only mode. + // Read-only mode. "readonly": false, - // Next entries are for the OpenSSL support in MySQL. + // The next entries are for OpenSSL support in MySQL. + // Trust anchor aka certificate authority file or directory. "trust-anchor": "my-ca", @@ -320,10 +319,10 @@ // Port on which the database is available. "port": 5432, - // Type of the database, e.g. "mysql", "postgresql". + // Type of database, e.g. "mysql", "postgresql". "type": "postgresql", - // User name to be used to access the database. + // Username to be used to access the database. "user": "keatest", // Connection reconnect wait time. @@ -340,18 +339,18 @@ // serve-retry-continue "on-fail": "stop-retry-exit", - // Connection connect timeout. + // Connection connect timeout in seconds. "connect-timeout": 100 } ], // List of host reservation identifier types to be used by the - // Kea DHCPv6 server to fetch static reservations for the + // Kea DHCPv6 server to fetch static reservations for // DHCP clients. All identifiers are used by default, which // means that the server will issue multiple queries to the - // database to find if there is a reservation for the particular - // client. If the particular deployment uses only subset, e.g. - // one, identifier type, this identifier should be only listed + // database to find if there is a reservation for a particular + // client. If a particular deployment uses only a subset, e.g. + // one identifier type, this identifier should be only listed // here to prevent unnecessary queries to the database. "host-reservation-identifiers": [ "hw-address", @@ -363,27 +362,27 @@ // server is listening to the DHCP queries. "interfaces-config": { // Specifies a list of interfaces on which the Kea DHCPv6 - // server should listen to the DHCP requests. + // server should listen to DHCP requests. "interfaces": [ "eth0" ], - // Boolean flag indicating if the available interfaces should + // Boolean flag indicating whether the available interfaces should // be re-detected upon server reconfiguration. The default value - // is true which means that the interfaces are always + // is true, which means that the interfaces are always // re-detected. "re-detect": true, - // Kea tries to bind the service sockets during initialization. It may - // fail due to a port being already opened or misconfiguration. Kea can - // suppress these errors and only logs them. This flag prevents starting + // Kea tries to bind the service sockets during initialization, but it may + // fail due to a port being already opened or a misconfiguration. Kea can + // suppress these errors and only log them. This flag prevents starting // the DHCP server without binding all sockets. If unspecified, it // defaults to false. "service-sockets-require-all": true, // Kea tries to bind the service sockets during initialization. This // option specifies how many times binding to interface will be retried. - // The default value is 0 which means that the operation will not be + // The default value is 0, which means that the operation will not be // repeated. "service-sockets-max-retries": 5, @@ -400,7 +399,7 @@ // decision table indexed by reservation identifiers. "early-global-reservations-lookup": true, - // Boolean parameter which controls DHCP server's behavior with respect + // Boolean parameter which controls the DHCP server's behavior with respect // to creating host reservations for the same IP address or delegated // prefix. By default this flag is set to true in which case the server // prevents creation of multiple host reservations for the same IP address @@ -421,31 +420,31 @@ /// should be performed before lease lookup. This parameter has effect /// only when multi-threading is disabled. When multi-threading is /// enabled, host reservations lookup is always performed first to avoid - /// lease lookup resource locking. + /// lease-lookup resource locking. "reservations-lookup-first": true, // Specifies credentials to access lease database. "lease-database": { - // memfile backend specific parameter specifying the interval - // in seconds at which lease file should be cleaned up (outdated - // lease entries are removed to prevent lease file from growing + // memfile backend-specific parameter specifying the interval + // in seconds at which the lease file should be cleaned up (outdated + // lease entries are removed to prevent the lease file from growing // infinitely). "lfc-interval": 3600, - // Maximum number of lease file read errors allowed before - // loading the file is abandoned. Defaults to 0 (no limit). + // Maximum number of lease-file read errors allowed before + // loading the file is abandoned. Defaults to 0 (no limit). "max-row-errors": 100, - // Name of the lease file. In case of database it specifies the + // Name of the lease file. In the case of a database it specifies the // database name. "name": "/tmp/kea-dhcp6.csv", - // memfile specific parameter indicating whether leases should + // memfile-specific parameter indicating whether leases should // be saved on persistent storage (disk) or not. The true value - // is the default and it indicates that leases are stored in the + // is the default and it indicates that leases are stored in // persistent storage. This setting must be used in production. // The false value should only be used for testing purposes - // because non stored leases will be lost upon Kea server restart. + // because non-stored leases will be lost upon Kea server restart. "persist": true, // Lease database backend type, i.e. "memfile", "mysql" or @@ -458,11 +457,11 @@ // Kea Administrator Reference Manual. "mac-sources": [ "duid" ], - // List of global DHCP options that Kea DHCPv6 server assigns to the + // List of global DHCP options that the Kea DHCPv6 server assigns to // clients. "option-data": [ { - // Boolean flag indicating if the given option is always + // Boolean flag indicating whether the given option is always // sent in response or only when requested. The default // value of false indicates that it is only sent when // requested. @@ -474,25 +473,25 @@ // Boolean value indicating whether the option data specified // in the "data" field is specified as a string of hexadecimal - // digits or in human readable CSV format. + // digits or in human-readable CSV format. "csv-format": true, // Option data to be stored in the option payload. "data": "2001:db8:2::45, 2001:db8:2::100", - // Option name. It is not required of the option code is + // Option name. It is not required if the option code is // provided. "name": "dns-servers", - // Boolean flag indicating if the given option is never + // Boolean flag indicating whether the given option is never // sent in response. The default value of false indicates - // that it is sent when it should. When true the option - // is not sent despite of any other setting, i.e. it is + // that it is sent when it should be. When true, the option + // is not sent despite any other setting, i.e. it is // a final flag. "never-send": false, // Option space. The default is the "dhcp6" option space which - // groups top level DHCPv6 options. + // groups top-level DHCPv6 options. "space": "dhcp6" } ], @@ -501,8 +500,8 @@ // Kea DHCPv6 server is using. "option-def": [ { - // Boolean flag indicating if the option definition comprises - // an array of values of some type, e.g. array of IPv6 addresses. + // Boolean flag indicating whether the option definition comprises + // an array of values of some type, e.g. an array of IPv6 addresses. // The default value of false means that the option does not // comprise an array of values. "array": false, @@ -512,7 +511,7 @@ // Holds a name of the option space encapsulated by this option. // All options that belong to this option space will be sent - // as sub-options of this option. Empty string means that this + // as sub-options of this option. An empty string means that this // option doesn't encapsulate any option. "encapsulate": "", @@ -520,7 +519,7 @@ "name": "my-option", // Specifies the types of fields within the option if the option - // is said to be a "record" (see "type"). in this particular example + // is said to be a "record" (see "type"). In this particular example // this option comprises two fields, 1 byte and 2 bytes long. "record-types": "uint8, uint16", @@ -536,7 +535,7 @@ // Global value which limits the number of client packets (e.g. // REQUESTs,RENEWs...) that may be parked while waiting for // hook library work to complete, prior to a response (e.g. REPLY) - // being sent back to the client. A typical example is when kea-dhcp6 + // being sent back to the client. A typical example is when kea-dhcp6 // parks a REQUEST while it sends the lease update(s) to its // HA peer(s). The packet is unparked once the update(s) have been // acknowledged. This value limits the number of packets that can @@ -555,13 +554,13 @@ "max-preferred-lifetime": 60, // Global value for the rebind timer, i.e. the time after which the - // DHCP client enters rebind state if it fails to renew the lease. + // DHCP client enters the rebind state if it fails to renew the lease. "rebind-timer": 40, // List of relay supplied option codes. See RFC 6422. "relay-supplied-options": [ "110", "120", "130" ], - // Global value for the renew timer, i.e. the timer after which the + // Global value for the renew timer, i.e. the time after which the // DHCP client renews the lease. "renew-timer": 30, @@ -571,7 +570,7 @@ // Statistics keep some samples per observation point. // There are two default values: maximum count and maximum age. - // Set the maximum count to zero disables it. + // Setting the maximum count to zero disables it. "statistic-default-sample-count": 0, // When the maximum count is 0 the maximum age (in seconds) applies. @@ -586,7 +585,7 @@ // When multi-threading is enabled, Kea will process packets on a // number of multiple threads configurable through this option. The - // value must be a positive integer (0 means auto detect). + // value must be a positive integer (0 means auto-detect). "thread-pool-size": 0, // When multi-threading is enabled, Kea will read packets from the @@ -596,12 +595,12 @@ "packet-queue-size": 0 }, - // Governs how the Kea DHCPv6 server should deal with the invalid + // Governs how the Kea DHCPv6 server should deal with invalid // data received from the client. "sanity-checks": { // Specifies how the Kea DHCPv6 server should behave when invalid // data is read for a lease from the lease file. The following - // values are supported "none" (don't attempt to correct the + // values are supported: "none" (don't attempt to correct the // lease information), "warn" (print a warning for subnet-id // related inconsistencies), "fix" (correct the subnet id by // trying to find the suitable subnet), "fix-del" (similar @@ -612,11 +611,11 @@ // Specifies how Kea DHCPv4 server should behave when invalid // extended info is read for a lease from the lease file, or - // whether to upgrade from old format. The following values - // are supported "none" (don't attempt to correct or upgrade + // whether to upgrade from the old format. The following values + // are supported: "none" (don't attempt to correct or upgrade // the extended info), "fix" (fix common inconsistencies and - // upgrade from old format, this is the default), "strict" - // (fix inconsistencies with an impact on Lease Query), + // upgrade from the old format; this is the default), "strict" + // (fix inconsistencies with an impact on Leasequery), // "pedantic" (enforce full Kea code format). "extended-info-checks": "fix" }, @@ -632,52 +631,52 @@ // Identifier part of the DUID. "identifier": "0123456789", - // Boolean flag indicating if the DUID should be persisted on + // Boolean flag indicating whether the DUID should be persisted on // disk. "persist": false }, - // List of shared networks used by Kea DHCPv6 server. The shared + // List of shared networks used by the Kea DHCPv6 server. The shared // networks group subnets together. "shared-networks": [ { // Restricts this shared network to allow only clients - // that belong to the particular client class. If an + // that belong to a particular client class. If an // empty string is provided, no restriction is applied. "client-class": "", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-generated-prefix": "myhost", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-override-client-update": false, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-override-no-update": false, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-qualifying-suffix": "", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-replace-client-name": "never", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-send-updates": true, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-update-on-renew": true, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-use-conflict-resolution": true, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "hostname-char-replacement": "x", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "hostname-char-set": "[^A-Za-z0-9.-]", - // Specifies that this shared network is selected for the - // requests received on the particular interface. + // Specifies that this shared network is selected for + // requests received on a particular interface. "interface": "eth0", // Specifies the content of the interface-id option used @@ -688,19 +687,19 @@ // Shared network name. "name": "my-secret-network", - // List of shared network specific DHCP options. + // List of shared network-specific DHCP options. "option-data": [], - // Shared network specific (default) preferred lifetime. + // Shared network-specific (default) preferred lifetime. "preferred-lifetime": 2000, - // Shared network specific min preferred lifetime. + // Shared network-specific min preferred lifetime. "min-preferred-lifetime": 1500, - // Shared network specific ma xpreferred lifetime. + // Shared network-specific ma xpreferred lifetime. "max-preferred-lifetime": 2500, - // Boolean flag indicating if the server can respond to + // Boolean flag indicating whether the server can respond to // a Solicit message including a Rapid Commit option with // the Reply message (See DHCPv6 rapid commit). "rapid-commit": false, @@ -711,13 +710,13 @@ "ip-addresses": [] }, - // Shared network level rebind timer. + // Shared-network level rebind timer. "rebind-timer": 41, - // Shared network level renew timer. + // Shared-network level renew timer. "renew-timer": 31, - // Shared network level compute T1 and T2 timers. + // Shared-network level compute T1 and T2 timers. "calculate-tee-times": true, // T1 = valid lifetime * .5. @@ -729,25 +728,25 @@ // Cache threshold = valid lifetime * .25. "cache-threshold": .25, - // Cache maximum: when the client last transmission time - // is close enough the lease is not renewed and current + // Cache maximum: when the client last-transmission time + // is close enough, the lease is not renewed and the current // lease is returned as it was "cached". - "cache-max-age": 10, + "cache-max-age": 1000, - // Enumeration specifying server's mode of operation when it + // Enumeration specifying the server's mode of operation when it // fetches host reservations. // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" + // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "subnet6" levels. @@ -758,52 +757,52 @@ "require-client-classes": [ "late" ], // Turn off storage of extended information (e.g. relay agent - // information) with each lease for this shared-network. + // information) with each lease for this shared network. "store-extended-info": false, // List of IPv6 subnets belonging to this shared network. "subnet6": [ { // Restricts this subnet to allow only clients that belong - // to the particular client class. If an empty string is + // to a particular client class. If an empty string is // provided, no restriction is applied. "client-class": "", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-generated-prefix": "myhost", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-override-client-update": false, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-override-no-update": false, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-qualifying-suffix": "", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-replace-client-name": "never", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-send-updates": true, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-update-on-renew": true, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-use-conflict-resolution": true, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "hostname-char-replacement": "x", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "hostname-char-set": "[^A-Za-z0-9.-]", // Subnet unique identifier. "id": 1, - // Specifies that this subnet is selected for the requests - // received on the particular interface. + // Specifies that this subnet is selected for requests + // received on a particular interface. "interface": "eth0", // Specifies the content of the interface-id option used @@ -815,19 +814,19 @@ // information) with each lease for this subnet. "store-extended-info": true, - // Subnet level list of DHCP options. + // Subnet-level list of DHCP options. "option-data": [ { - // Boolean flag indicating if the particular option + // Boolean flag indicating whether the particular option // should be always sent or sent only when requested. "always-send": false, // Option code. "code": 7, - // Boolean flag indicating if the option value specified - // in "data" is a string of hexadecimal values or human - // readable CSV value. + // Boolean flag indicating whether the option value specified + // in "data" is a string of hexadecimal values or human-readable + // CSV value. "csv-format": false, // Option data to be included in the option payload. @@ -836,7 +835,7 @@ // Option name. "name": "preference", - // Boolean flag indicating if the given option is never + // Boolean flag indicating whether the given option is never // sent in response. "never-send": false, @@ -880,11 +879,11 @@ "pools": [ { - // Restricts this pool to be only used for the client + // Restricts this pool to only be used for client // requests belonging to a particular client class. "client-class": "phones_server1", - // Pool level list of DHCP options. + // Pool-level list of DHCP options. "option-data": [], // Address range used for client assignments. @@ -895,11 +894,11 @@ "require-client-classes": [ "late" ] }, { - // Restricts this pool to be only used for the client + // Restricts this pool to only be used for client // requests belonging to a particular client class. "client-class": "phones_server2", - // Pool level list of DHCP options. + // Pool-level list of DHCP options. "option-data": [], // Address range used for client assignments. @@ -920,12 +919,12 @@ // Subnet specific max referred lifetime. "max-preferred-lifetime": 2500, - // Boolean flag indicating if the server can respond to + // Boolean flag indicating whether the server can respond to // a Solicit message including a Rapid Commit option with // the Reply message (See DHCPv6 rapid commit). "rapid-commit": false, - // Subnet level rebind timer. + // Subnet-level rebind timer. "rebind-timer": 40, // List of IPv4 relay addresses for which this subnet @@ -936,28 +935,28 @@ ] }, - // Subnet level renew timer. + // Subnet-level renew timer. "renew-timer": 30, - // Enumeration specifying server's mode of operation when it + // Enumeration specifying the server's mode of operation when it // fetches host reservations. // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and + // "reservations-in-subnet", and // "reservations-out-of-pool" parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved + // Specify whether the server can assume that all reserved // addresses are out-of-pool. // Ignored when reservations-in-subnet is false. "reservations-out-of-pool": false, - // Subnet level compute T1 and T2 timers. + // Subnet-level compute T1 and T2 timers. "calculate-tee-times": true, // T1 = valid lifetime * .5. @@ -969,11 +968,11 @@ // Cache threshold = valid lifetime * .25. "cache-threshold": .25, - // Subnet level cache maximum. - "cache-max-age": 10, + // Subnet-level cache maximum. + "cache-max-age": 1000, - // List of static IPv6 reservations assigned to the clients belonging - // to this subnet. For detailed example see reservations.json. + // List of static IPv6 reservations assigned to clients belonging + // to this subnet. For a detailed example, see reservations.json. "reservations": [ { // Identifier used for client matching. Supported values are @@ -989,7 +988,7 @@ // Reserved hostname. "hostname": "foo.example.com", - // Reservation specific option data. + // Reservation-specific option data. "option-data": [ { // Option name. @@ -1009,24 +1008,24 @@ // Subnet prefix. "subnet": "2001:db8::/32", - // Subnet level (default) valid lifetime. + // Subnet-level (default) valid lifetime. "valid-lifetime": 6000, - // Subnet level min valid lifetime. + // Subnet-level min valid lifetime. "min-valid-lifetime": 4000, - // Subnet level max valid lifetime. + // Subnet-level max valid lifetime. "max-valid-lifetime": 8000 } ], - // Shared network level (default) valid lifetime. + // Shared-network level (default) valid lifetime. "valid-lifetime": 6001, - // Shared network level min valid lifetime. + // Shared-network level min valid lifetime. "min-valid-lifetime": 4001, - // Shared network level max valid lifetime. + // Shared-network level max valid lifetime. "max-valid-lifetime": 8001 } ], @@ -1034,7 +1033,7 @@ // List of IPv6 subnets which don't belong to any shared network. "subnet6": [], - // Global (default) valid lifetime value. + // Global valid lifetime value. "valid-lifetime": 6000, // Global min valid lifetime value. @@ -1047,19 +1046,19 @@ "reservations": [], // Configuration control (currently not used, i.e. this syntax - // is already defined but corresponding feature is not implemented). + // is already defined but the corresponding feature is not implemented). "config-control": { - // Only configuration databases entry is defined. + // Only the configuration databases entry is defined. "config-databases": [ { // Name of the database to connect to. "name": "config", - // Type of the database, e.g. "mysql", "postgresql". + // Type of database, e.g. "mysql", "postgresql". "type": "mysql" } ], - // Intervals between attempts to fetch configuration updates + // Interval between attempts to fetch configuration updates // via the configuration backends used. "config-fetch-wait-time": 30 }, @@ -1067,12 +1066,12 @@ // Server tag. "server-tag": "my DHCPv6 server", - // DHCP queue control parameters. + // DHCP queue-control parameters. "dhcp-queue-control": { // Enable queue is mandatory. "enable-queue": true, - // Queue type was mandatory. + // Queue type is mandatory. "queue-type": "kea-ring6", // Capacity is optional. @@ -1082,15 +1081,15 @@ // Fetches host reservations. // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" parameters. + // "reservations-in-subnet", and "reservations-out-of-pool" parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "shared-networks" and @@ -1113,11 +1112,11 @@ "cache-threshold": .25, // Global cache maximum. - "cache-max-age": 10, + "cache-max-age": 1000, // String of zero or more characters with which to replace each // invalid character in the Client FQDN. The default - // value is an empty string which will cause invalid characters + // value is an empty string, which will cause invalid characters // to be omitted rather than replaced. "hostname-char-replacement": "x", @@ -1129,7 +1128,7 @@ "loggers": [ { // Debug level, a value between 0..99. The greater the value - // the more detailed debug log. + // the more detailed the debug log. "debuglevel": 99, // Name of the logger. @@ -1138,16 +1137,16 @@ // Configures how the log should be output. "output_options": [ { - // Determines whether the log should flushed to a file. + // Determines whether the log should be flushed to a file. "flush": true, - // Specifies maximum filesize before the file is being rotated. + // Specifies maximum filesize before the file is rotated. "maxsize": 10240000, - // Specifies the maximum number of rotated files being kept. + // Specifies the maximum number of rotated files to be kept. "maxver": 1, - // Specifies logging destination. + // Specifies the logging destination. "output": "stdout", // Specifies log entry content @@ -1160,7 +1159,7 @@ } ], - // Look at advanced example for the use of user-contexts. + // Look at advanced examples for the use of user-contexts. "user-context": { } } } diff --git a/doc/examples/kea6/all-keys.json b/doc/examples/kea6/all-keys.json index 83c2449f7c..5863e2d6f0 100644 --- a/doc/examples/kea6/all-keys.json +++ b/doc/examples/kea6/all-keys.json @@ -3,11 +3,11 @@ // mutually exclusive configuration parameters. // // The primary purpose of the example file is to provide a comprehensive -// list of parameters supported by Kea DHCPv6 server along with the brief +// list of parameters supported by the Kea DHCPv6 server along with the brief // description of each parameter. // // This current version should be up to date, i.e. new keywords should be -// added in this file at the same time than in the syntax. +// added in this file at the same time as in the parser specification. { // Kea DHCPv6 server configuration begins here. "Dhcp6": { @@ -25,7 +25,7 @@ // Class name. "name": "phones_server1", - // Class specific DHCPv6 options list. + // Class-specific DHCPv6 options list. "option-data": [], // Class selection expression. The DHCP packet is assigned to this @@ -54,7 +54,7 @@ // Second class name. "name": "phones_server2", - // Class specific DHCPv6 options list. + // Class-specific DHCPv6 options list. "option-data": [], // Class selection expression. The DHCP packet is assigned to this @@ -65,8 +65,8 @@ // Third class name. "name": "late", - // Boolean flag indicating that the class expression is only evaluated - // when the class is required, e.g. selected address pool configuration + // Boolean flag indicating whether the class expression is only evaluated + // when the class is required, e.g. the selected address pool configuration // includes this class name in its "require-client-classes" list. The // default value false means that the class test expression must // always be evaluated. @@ -86,16 +86,16 @@ ], // Parameters for triggering behaviors compatible with broken or - // non-compliant clients, relays or other agents + // non-compliant clients, relays, or other agents "compatibility": { // Parse options more leniently where fields can be deduced - // deterministically even if against RFC or common practice. + // deterministically, even if against RFC or common practice. "lenient-option-parsing": true }, - // Command control socket configuration parameters for Kea DHCPv6 server. + // Command control socket configuration parameters for the Kea DHCPv6 server. "control-socket": { - // Location of the unix domain socket file the DHCPv6 server uses + // Location of the UNIX domain socket file the DHCPv6 server uses // to receive control commands from the Kea Control Agent or the // local server administrator. "socket-name": "/tmp/kea6-ctrl-socket", @@ -106,62 +106,62 @@ }, // Specifies a prefix to be prepended to the generated Client FQDN. - // It may be specified at the global, shared-network and subnet levels. + // It may be specified at the global, shared-network, and subnet levels. "ddns-generated-prefix": "myhost", - // Boolean flag indicating that server should ignore DHCP client - // wishes to update DNS on its own. With that flag set to true + // Boolean flag indicating whether the server should ignore DHCP client + // wishes to update DNS on its own. With that flag set to true, // the server will send DNS updates for both forward and // reverse DNS data. The default value is false, which indicates - // that the server will delegate DNS update to the client when - // requested. It may be specified at the global, shared-network + // that the server will delegate a DNS update to the client when + // requested. It may be specified at the global, shared-network, // and subnet levels. "ddns-override-client-update": false, - // Boolean flag indicating that the server should override DHCP + // Boolean flag indicating whether the server should override the DHCP // client's wish to not update the DNS. With this parameter - // set to true the server will send DNS update even when - // the client requested no update. It may be specified at the - // global, shared-network and subnet levels. + // set to true, the server will send a DNS update even when + // the client requested no update. It may be specified at the + // global, shared-network, and subnet levels. "ddns-override-no-update": false, // Suffix appended to the partial name sent to the DNS. The - // default value is an empty string which indicates that no - // suffix is appended. It may be specified at the global, - // shared-network and subnet levels. + // default value is an empty string, which indicates that no + // suffix is appended. It may be specified at the global, + // shared-network, and subnet levels. "ddns-qualifying-suffix": "", // Enumeration specifying whether the server should honor - // hostname or Client FQDN sent by the client or replace + // the hostname or Client FQDN sent by the client or replace // this name. The acceptable values are: "never" (use the // name the client sent), "always" (replace the name the // client sent), "when-present" (replace the name the client - // sent, but do not generate one when the client didn't sent + // sent, but do not generate one when the client didn't send // the name), "when-not-present" (generate the name when // client didn't send one, otherwise leave the name the - // client sent). The default value is "never". It may be - // specified at the global, shared-network and subnet levels. + // client sent). The default value is "never". It may be + // specified at the global, shared-network, and subnet levels. "ddns-replace-client-name": "never", - // Boolean flag which enables or disables the DDNS updating. It - // defaults to true. It may be specified at the global, shared- - // network and subnet levels. It works in conjunction with - // dhcp-ddns:enable-updates which must be true to enable connectivity + // Boolean flag which enables or disables DDNS updating. It + // defaults to true. It may be specified at the global, shared- + // network, and subnet levels. It works in conjunction with + // dhcp-ddns:enable-updates, which must be true to enable connectivity // to kea-dhcp-ddns. "ddns-send-updates": true, // Boolean flag, which when true instructs the server to always // update DNS when leases are renewed, even if the DNS information - // has not changed. The server's default behavior (i.e. flag is false) - // is to only update DNS if the DNS information has changed. It - // may be specified at the global, shared-network and subnet levels. + // has not changed. The server's default behavior (i.e. flag is false) + // is to only update DNS if the DNS information has changed. It + // may be specified at the global, shared-network, and subnet levels. "ddns-update-on-renew": true, - // Boolean flag, which is passed to kea-dhcp-ddns with each DDNS - // update request to indicate whether or not DNS update conflict + // Boolean flag which is passed to kea-dhcp-ddns with each DDNS + // update request, to indicate whether DNS update conflict // resolution as described in RFC 4703 should be employed for the - // given update request. The default value for this flag is true. - // It may be specified at the global, shared-network and subnet levels. + // given update request. The default value for this flag is true. + // It may be specified at the global, shared-network, and subnet levels. "ddns-use-conflict-resolution": true, // When greater than 0.0, it is the percent of the lease's lifetime @@ -172,20 +172,20 @@ // excluded from DHCP assignments. The default value is 24 hours. "decline-probation-period": 86400, - // Name Change Requests forwarding configuration for Kea DHCPv6 server. - // NCRs are sent to Kea D2 module to update DNS upon allocation of the + // Name Change Request forwarding configuration for the Kea DHCPv6 server. + // NCRs are sent to the Kea D2 module to update DNS upon allocation of // DHCP leases. "dhcp-ddns": { - // Boolean flag indicating if Kea DHCPv6 server should connect to - // kea-dhcp-ddns. This must be true for NCRs to be created and - // sent to kea-dhcp-ddns. By default NCRs are not generated. + // Boolean flag indicating whether Kea DHCPv6 server should connect to + // kea-dhcp-ddns. This must be true for NCRs to be created and + // sent to kea-dhcp-ddns. By default, NCRs are not generated. "enable-updates": false, // Specifies maximum number of NCRs to queue waiting to be sent - // to Kea D2 server. + // to the Kea D2 server. "max-queue-size": 1024, - // Packet format to use when sending NCRs to Kea D2 server. + // Packet format to use when sending NCRs to the Kea D2 server. // Currently, only JSON format is supported. "ncr-format": "JSON", @@ -193,14 +193,14 @@ // only UDP is supported. "ncr-protocol": "UDP", - // IP address that Kea DHCPv6 server should use to send - // NCRs to D2. Default value of zero indicates that Kea - // should pick suitable address. + // IP address that the Kea DHCPv6 server should use to send + // NCRs to D2. The default value of zero indicates that Kea + // should pick a suitable address. "sender-ip": "::1", - // Port number that Kea DHCPv6 server should use to send - // NCRs to D2. Default value of zero indicates that Kea - // should pick suitable port. + // Port number that the Kea DHCPv6 server should use to send + // NCRs to D2. The default value of zero indicates that Kea + // should pick a suitable port. "sender-port": 0, // IP address on which D2 listens for NCRs. @@ -209,10 +209,10 @@ // Port number on which D2 listens for NCRs. "server-port": 53001, - // The follow parameters are DEPRECATED. They have been + // The following parameters are DEPRECATED. They have been // replaced with parameters that may be set at the global, - // shared-network, and subnet6 scopes. They are listed here - // as configuration parsing still accepts them. Eventually + // shared-network, and subnet6 scopes. They are listed here + // as configuration parsing still accepts them. Eventually // support for them will be removed. "generated-prefix": "myhost", "hostname-char-replacement": "x", @@ -231,53 +231,51 @@ // Collection of Kea DHCPv6 server parameters configuring how // the server should process expired DHCP leases. "expired-leases-processing": { - // Specifies the number of seconds since last removal of - // the expired leases when next removal should occur. + // Specifies the number of seconds since the last removal of + // the expired leases, when the next removal should occur. // If both "flush-reclaimed-timer-wait-time" and // "hold-reclaimed-time" are not 0, when the client sends a release - // message the lease is expired instead of being deleted from the + // message the lease is expired instead of being deleted from // lease storage. "flush-reclaimed-timer-wait-time": 25, - // Specifies the time period in seconds to keep expired + // Specifies the length of time in seconds to keep expired // leases in the lease database (lease affinity). // If both "flush-reclaimed-timer-wait-time" and // "hold-reclaimed-time" are not 0, when the client sends a release - // message the lease is expired instead of being deleted from the + // message the lease is expired instead of being deleted from // lease storage. "hold-reclaimed-time": 3600, // Specifies the maximum number of expired leases that can be - // processed in a single attempt to clean up the lease - // database from the expired leases. If there are more + // processed in a single attempt to clean up expired leases + // from the lease database. If there are more // expired leases, they will be processed during the next // cleanup attempt. "max-reclaim-leases": 100, - // Specifies the maximum time in milliseconds that the single - // attempt to cleanup the lease database from the expired - // leases may take. + // Specifies the maximum time in milliseconds that a single attempt + // to clean up expired leases from the lease database may take. "max-reclaim-time": 250, - // Specifies the time period in seconds since last attempt - // to process expired leases to initiate the next attempt. + // Specifies the length of time in seconds since the last attempt + // to process expired leases before initiating the next attempt. "reclaim-timer-wait-time": 10, - // Specifies the maximum number of expired leases processing - // cycles which didn't result in full cleanup of the lease - // database from the expired leases, after which a - // warning message is issued. + // Specifies the maximum number of expired lease-processing cycles + // which didn't result in full cleanup of exired leases from the + // lease database, after which a warning message is issued. "unwarned-reclaim-cycles": 5 }, - // List of hooks libraries and their specific configuration parameters + // List of hook libraries and their specific configuration parameters // to be loaded by Kea DHCPv4 server. "hooks-libraries": [ { - // Location of the hooks library to be loaded. + // Location of the hook library to be loaded. "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", - // Hook library specific configuration parameters. + // Hook library-specific configuration parameters. "parameters": { } } ], @@ -297,16 +295,17 @@ // Port on which the database is available. "port": 3306, - // Type of the database, e.g. "mysql", "postgresql". + // Type of database, e.g. "mysql", "postgresql". "type": "mysql", - // User name to be used to access the database. + // Username to be used to access the database. "user": "keatest", - // Read only mode. + // Read-only mode. "readonly": false, - // Next entries are for the OpenSSL support in MySQL. + // The next entries are for OpenSSL support in MySQL. + // Trust anchor aka certificate authority file or directory. "trust-anchor": "my-ca", @@ -332,10 +331,10 @@ // Port on which the database is available. "port": 5432, - // Type of the database, e.g. "mysql", "postgresql". + // Type of database, e.g. "mysql", "postgresql". "type": "postgresql", - // User name to be used to access the database. + // Username to be used to access the database. "user": "keatest", // TCP user timeout while communicating with the database. @@ -352,10 +351,10 @@ // Port on which the database is available. "port": 9042, - // Type of the database, e.g. "mysql", "postgresql". + // Type of database, e.g. "mysql", "postgresql". "type": "mysql", - // User name to be used to access the database. + // Username to be used to access the database. "user": "keatest", // Connection reconnect wait time. @@ -375,21 +374,21 @@ // Connection connect timeout in seconds. "connect-timeout": 100, - // Data read from the database timeout in seconds. + // Timeout of database read operations in seconds. "read-timeout": 120, - // Data write to the database timeout in seconds. + // Timeout of database write operations in seconds. "write-timeout": 180 } ], // List of host reservation identifier types to be used by the - // Kea DHCPv6 server to fetch static reservations for the + // Kea DHCPv6 server to fetch static reservations for // DHCP clients. All identifiers are used by default, which // means that the server will issue multiple queries to the - // database to find if there is a reservation for the particular - // client. If the particular deployment uses only subset, e.g. - // one, identifier type, this identifier should be only listed + // database to find if there is a reservation for a particular + // client. If a particular deployment uses only a subset, e.g. + // one identifier type, this identifier should be only listed // here to prevent unnecessary queries to the database. "host-reservation-identifiers": [ "hw-address", @@ -401,27 +400,27 @@ // server is listening to the DHCP queries. "interfaces-config": { // Specifies a list of interfaces on which the Kea DHCPv6 - // server should listen to the DHCP requests. + // server should listen to DHCP requests. "interfaces": [ "eth0" ], - // Boolean flag indicating if the available interfaces should + // Boolean flag indicating whether the available interfaces should // be re-detected upon server reconfiguration. The default value - // is true which means that the interfaces are always + // is true, which means that the interfaces are always // re-detected. "re-detect": true, - // Kea tries to bind the service sockets during initialization. It may - // fail due to a port being already opened or misconfiguration. Kea can - // suppress these errors and only logs them. This flag prevents starting + // Kea tries to bind the service sockets during initialization, but it may + // fail due to a port being already opened or a misconfiguration. Kea can + // suppress these errors and only log them. This flag prevents starting // the DHCP server without binding all sockets. If unspecified, it // defaults to false. "service-sockets-require-all": true, // Kea tries to bind the service sockets during initialization. This // option specifies how many times binding to interface will be retried. - // The default value is 0 which means that the operation will not be + // The default value is 0, which means that the operation will not be // repeated. "service-sockets-max-retries": 5, @@ -438,7 +437,7 @@ // decision table indexed by reservation identifiers. "early-global-reservations-lookup": true, - // Boolean parameter which controls DHCP server's behavior with respect + // Boolean parameter which controls the DHCP server's behavior with respect // to creating host reservations for the same IP address or delegated // prefix. By default this flag is set to true in which case the server // prevents creation of multiple host reservations for the same IP address @@ -459,31 +458,31 @@ /// should be performed before lease lookup. This parameter has effect /// only when multi-threading is disabled. When multi-threading is /// enabled, host reservations lookup is always performed first to avoid - /// lease lookup resource locking. + /// lease-lookup resource locking. "reservations-lookup-first": true, // Specifies credentials to access lease database. "lease-database": { - // memfile backend specific parameter specifying the interval - // in seconds at which lease file should be cleaned up (outdated - // lease entries are removed to prevent lease file from growing + // memfile backend-specific parameter specifying the interval + // in seconds at which the lease file should be cleaned up (outdated + // lease entries are removed to prevent the lease file from growing // infinitely). "lfc-interval": 3600, - // Maximum number of lease file read errors allowed before - // loading the file is abandoned. Defaults to 0 (no limit). + // Maximum number of lease-file read errors allowed before + // loading the file is abandoned. Defaults to 0 (no limit). "max-row-errors": 100, - // Name of the lease file. In case of database it specifies the + // Name of the lease file. In the case of a database it specifies the // database name. "name": "/tmp/kea-dhcp6.csv", - // memfile specific parameter indicating whether leases should + // memfile-specific parameter indicating whether leases should // be saved on persistent storage (disk) or not. The true value - // is the default and it indicates that leases are stored in the + // is the default and it indicates that leases are stored in // persistent storage. This setting must be used in production. // The false value should only be used for testing purposes - // because non stored leases will be lost upon Kea server restart. + // because non-stored leases will be lost upon Kea server restart. "persist": true, // Lease database backend type, i.e. "memfile", "mysql" or @@ -496,11 +495,11 @@ // Kea Administrator Reference Manual. "mac-sources": [ "duid" ], - // List of global DHCP options that Kea DHCPv6 server assigns to the + // List of global DHCP options that the Kea DHCPv6 server assigns to // clients. "option-data": [ { - // Boolean flag indicating if the given option is always + // Boolean flag indicating whether the given option is always // sent in response or only when requested. The default // value of false indicates that it is only sent when // requested. @@ -512,25 +511,25 @@ // Boolean value indicating whether the option data specified // in the "data" field is specified as a string of hexadecimal - // digits or in human readable CSV format. + // digits or in human-readable CSV format. "csv-format": true, // Option data to be stored in the option payload. "data": "2001:db8:2::45, 2001:db8:2::100", - // Option name. It is not required of the option code is + // Option name. It is not required if the option code is // provided. "name": "dns-servers", - // Boolean flag indicating if the given option is never + // Boolean flag indicating whether the given option is never // sent in response. The default value of false indicates - // that it is sent when it should. When true the option - // is not sent despite of any other setting, i.e. it is + // that it is sent when it should be. When true, the option + // is not sent despite any other setting, i.e. it is // a final flag. "never-send": false, // Option space. The default is the "dhcp6" option space which - // groups top level DHCPv6 options. + // groups top-level DHCPv6 options. "space": "dhcp6" } ], @@ -539,8 +538,8 @@ // Kea DHCPv6 server is using. "option-def": [ { - // Boolean flag indicating if the option definition comprises - // an array of values of some type, e.g. array of IPv6 addresses. + // Boolean flag indicating whether the option definition comprises + // an array of values of some type, e.g. an array of IPv6 addresses. // The default value of false means that the option does not // comprise an array of values. "array": false, @@ -550,7 +549,7 @@ // Holds a name of the option space encapsulated by this option. // All options that belong to this option space will be sent - // as sub-options of this option. Empty string means that this + // as sub-options of this option. An empty string means that this // option doesn't encapsulate any option. "encapsulate": "", @@ -558,7 +557,7 @@ "name": "my-option", // Specifies the types of fields within the option if the option - // is said to be a "record" (see "type"). in this particular example + // is said to be a "record" (see "type"). In this particular example // this option comprises two fields, 1 byte and 2 bytes long. "record-types": "uint8, uint16", @@ -574,7 +573,7 @@ // Global value which limits the number of client packets (e.g. // REQUESTs,RENEWs...) that may be parked while waiting for // hook library work to complete, prior to a response (e.g. REPLY) - // being sent back to the client. A typical example is when kea-dhcp6 + // being sent back to the client. A typical example is when kea-dhcp6 // parks a REQUEST while it sends the lease update(s) to its // HA peer(s). The packet is unparked once the update(s) have been // acknowledged. This value limits the number of packets that can @@ -593,13 +592,13 @@ "max-preferred-lifetime": 60, // Global value for the rebind timer, i.e. the time after which the - // DHCP client enters rebind state if it fails to renew the lease. + // DHCP client enters the rebind state if it fails to renew the lease. "rebind-timer": 40, // List of relay supplied option codes. See RFC 6422. "relay-supplied-options": [ "110", "120", "130" ], - // Global value for the renew timer, i.e. the timer after which the + // Global value for the renew timer, i.e. the time after which the // DHCP client renews the lease. "renew-timer": 30, @@ -609,7 +608,7 @@ // Statistics keep some samples per observation point. // There are two default values: maximum count and maximum age. - // Set the maximum count to zero disables it. + // Setting the maximum count to zero disables it. "statistic-default-sample-count": 0, // When the maximum count is 0 the maximum age (in seconds) applies. @@ -624,7 +623,7 @@ // When multi-threading is enabled, Kea will process packets on a // number of multiple threads configurable through this option. The - // value must be a positive integer (0 means auto detect). + // value must be a positive integer (0 means auto-detect). "thread-pool-size": 0, // When multi-threading is enabled, Kea will read packets from the @@ -634,12 +633,12 @@ "packet-queue-size": 0 }, - // Governs how the Kea DHCPv6 server should deal with the invalid + // Governs how the Kea DHCPv6 server should deal with invalid // data received from the client. "sanity-checks": { // Specifies how the Kea DHCPv6 server should behave when invalid // data is read for a lease from the lease file. The following - // values are supported "none" (don't attempt to correct the + // values are supported: "none" (don't attempt to correct the // lease information), "warn" (print a warning for subnet-id // related inconsistencies), "fix" (correct the subnet id by // trying to find the suitable subnet), "fix-del" (similar @@ -650,11 +649,11 @@ // Specifies how Kea DHCPv4 server should behave when invalid // extended info is read for a lease from the lease file, or - // whether to upgrade from old format. The following values - // are supported "none" (don't attempt to correct or upgrade + // whether to upgrade from the old format. The following values + // are supported: "none" (don't attempt to correct or upgrade // the extended info), "fix" (fix common inconsistencies and - // upgrade from old format, this is the default), "strict" - // (fix inconsistencies with an impact on Lease Query), + // upgrade from the old format; this is the default), "strict" + // (fix inconsistencies with an impact on Leasequery), // "pedantic" (enforce full Kea code format). "extended-info-checks": "fix" }, @@ -670,12 +669,12 @@ // Identifier part of the DUID. "identifier": "0123456789", - // Boolean flag indicating if the DUID should be persisted on + // Boolean flag indicating whether the DUID should be persisted on // disk. "persist": false }, - // List of shared networks used by Kea DHCPv6 server. The shared + // List of shared networks used by the Kea DHCPv6 server. The shared // networks group subnets together. "shared-networks": [ { @@ -688,45 +687,45 @@ "pd-allocator": "iterative", // Restricts this shared network to allow only clients - // that belong to the particular client class. If an + // that belong to a particular client class. If an // empty string is provided, no restriction is applied. "client-class": "", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-generated-prefix": "myhost", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-override-client-update": false, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-override-no-update": false, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-qualifying-suffix": "", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-replace-client-name": "never", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-send-updates": true, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-update-on-renew": true, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-use-conflict-resolution": true, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "ddns-ttl-percent": 0.65, - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "hostname-char-replacement": "x", - // Shared network level value. See description at the global level. + // Shared-network level value. See description at the global level. "hostname-char-set": "[^A-Za-z0-9.-]", - // Specifies that this shared network is selected for the - // requests received on the particular interface. + // Specifies that this shared network is selected for + // requests received on a particular interface. "interface": "eth0", // Specifies the content of the interface-id option used @@ -737,19 +736,19 @@ // Shared network name. "name": "my-secret-network", - // List of shared network specific DHCP options. + // List of shared network-specific DHCP options. "option-data": [], - // Shared network specific (default) preferred lifetime. + // Shared network-specific (default) preferred lifetime. "preferred-lifetime": 2000, - // Shared network specific min preferred lifetime. + // Shared network-specific min preferred lifetime. "min-preferred-lifetime": 1500, - // Shared network specific ma xpreferred lifetime. + // Shared network-specific ma xpreferred lifetime. "max-preferred-lifetime": 2500, - // Boolean flag indicating if the server can respond to + // Boolean flag indicating whether the server can respond to // a Solicit message including a Rapid Commit option with // the Reply message (See DHCPv6 rapid commit). "rapid-commit": false, @@ -760,13 +759,13 @@ "ip-addresses": [] }, - // Shared network level rebind timer. + // Shared-network level rebind timer. "rebind-timer": 41, - // Shared network level renew timer. + // Shared-network level renew timer. "renew-timer": 31, - // Shared network level compute T1 and T2 timers. + // Shared-network level compute T1 and T2 timers. "calculate-tee-times": true, // T1 = valid lifetime * .5. @@ -778,25 +777,25 @@ // Cache threshold = valid lifetime * .25. "cache-threshold": .25, - // Cache maximum: when the client last transmission time - // is close enough the lease is not renewed and current + // Cache maximum: when the client last-transmission time + // is close enough, the lease is not renewed and the current // lease is returned as it was "cached". - "cache-max-age": 10, + "cache-max-age": 1000, - // Enumeration specifying server's mode of operation when it + // Enumeration specifying the server's mode of operation when it // fetches host reservations. // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" + // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "subnet6" levels. @@ -807,7 +806,7 @@ "require-client-classes": [ "late" ], // Turn off storage of extended information (e.g. relay agent - // information) with each lease for this shared-network. + // information) with each lease for this shared network. "store-extended-info": false, // List of IPv6 subnets belonging to this shared network. @@ -822,48 +821,48 @@ "pd-allocator": "iterative", // Restricts this subnet to allow only clients that belong - // to the particular client class. If an empty string is + // to a particular client class. If an empty string is // provided, no restriction is applied. "client-class": "", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-generated-prefix": "myhost", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-override-client-update": false, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-override-no-update": false, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-qualifying-suffix": "", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-replace-client-name": "never", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-send-updates": true, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-update-on-renew": true, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-use-conflict-resolution": true, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "ddns-ttl-percent": 0.55, - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "hostname-char-replacement": "x", - // Subnet level value. See description at the global level. + // Subnet-level value. See description at the global level. "hostname-char-set": "[^A-Za-z0-9.-]", // Subnet unique identifier. "id": 1, - // Specifies that this subnet is selected for the requests - // received on the particular interface. + // Specifies that this subnet is selected for requests + // received on a particular interface. "interface": "eth0", // Specifies the content of the interface-id option used @@ -875,19 +874,19 @@ // information) with each lease for this subnet. "store-extended-info": true, - // Subnet level list of DHCP options. + // Subnet-level list of DHCP options. "option-data": [ { - // Boolean flag indicating if the particular option + // Boolean flag indicating whether the particular option // should be always sent or sent only when requested. "always-send": false, // Option code. "code": 7, - // Boolean flag indicating if the option value specified - // in "data" is a string of hexadecimal values or human - // readable CSV value. + // Boolean flag indicating whether the option value specified + // in "data" is a string of hexadecimal values or human-readable + // CSV value. "csv-format": false, // Option data to be included in the option payload. @@ -896,7 +895,7 @@ // Option name. "name": "preference", - // Boolean flag indicating if the given option is never + // Boolean flag indicating whether the given option is never // sent in response. "never-send": false, @@ -938,13 +937,14 @@ } ], + // List of IP address pools belonging to the subnet. "pools": [ { - // Restricts this pool to be only used for the client + // Restricts this pool to only be used for client // requests belonging to a particular client class. "client-class": "phones_server1", - // Pool level list of DHCP options. + // Pool-level list of DHCP options. "option-data": [], // Address range used for client assignments. @@ -955,11 +955,11 @@ "require-client-classes": [ "late" ] }, { - // Restricts this pool to be only used for the client + // Restricts this pool to only be used for client // requests belonging to a particular client class. "client-class": "phones_server2", - // Pool level list of DHCP options. + // Pool-level list of DHCP options. "option-data": [], // Address range used for client assignments. @@ -980,44 +980,43 @@ // Subnet specific max referred lifetime. "max-preferred-lifetime": 2500, - // Boolean flag indicating if the server can respond to + // Boolean flag indicating whether the server can respond to // a Solicit message including a Rapid Commit option with // the Reply message (See DHCPv6 rapid commit). "rapid-commit": false, - // Subnet level rebind timer. + // Subnet-level value of the rebind timer. "rebind-timer": 40, - // List of IPv4 relay addresses for which this subnet - // is selected. + // List of IPv6 relay addresses for which this subnet is selected. "relay": { "ip-addresses": [ "2001:db8:0:f::1" ] }, - // Subnet level renew timer. + // Subnet-level renew timer. "renew-timer": 30, - // Enumeration specifying server's mode of operation when it + // Enumeration specifying the server's mode of operation when it // fetches host reservations. // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and + // "reservations-in-subnet", and // "reservations-out-of-pool" parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved + // Specify whether the server can assume that all reserved // addresses are out-of-pool. // Ignored when reservations-in-subnet is false. "reservations-out-of-pool": false, - // Subnet level compute T1 and T2 timers. + // Subnet-level compute T1 and T2 timers. "calculate-tee-times": true, // T1 = valid lifetime * .5. @@ -1029,11 +1028,11 @@ // Cache threshold = valid lifetime * .25. "cache-threshold": .25, - // Subnet level cache maximum. - "cache-max-age": 10, + // Subnet-level cache maximum. + "cache-max-age": 1000, - // List of static IPv6 reservations assigned to the clients belonging - // to this subnet. For detailed example see reservations.json. + // List of static IPv6 reservations assigned to clients belonging + // to this subnet. For a detailed example, see reservations.json. "reservations": [ { // Identifier used for client matching. Supported values are @@ -1049,7 +1048,7 @@ // Reserved hostname. "hostname": "foo.example.com", - // Reservation specific option data. + // Reservation-specific option data. "option-data": [ { // Option name. @@ -1069,24 +1068,24 @@ // Subnet prefix. "subnet": "2001:db8::/32", - // Subnet level (default) valid lifetime. + // Subnet-level (default) valid lifetime. "valid-lifetime": 6000, - // Subnet level min valid lifetime. + // Subnet-level min valid lifetime. "min-valid-lifetime": 4000, - // Subnet level max valid lifetime. + // Subnet-level max valid lifetime. "max-valid-lifetime": 8000 } ], - // Shared network level (default) valid lifetime. + // Shared-network level (default) valid lifetime. "valid-lifetime": 6001, - // Shared network level min valid lifetime. + // Shared-network level min valid lifetime. "min-valid-lifetime": 4001, - // Shared network level max valid lifetime. + // Shared-network level max valid lifetime. "max-valid-lifetime": 8001 } ], @@ -1094,7 +1093,7 @@ // List of IPv6 subnets which don't belong to any shared network. "subnet6": [], - // Global (default) valid lifetime value. + // Global valid lifetime value. "valid-lifetime": 6000, // Global min valid lifetime value. @@ -1107,19 +1106,19 @@ "reservations": [], // Configuration control (currently not used, i.e. this syntax - // is already defined but corresponding feature is not implemented). + // is already defined but the corresponding feature is not implemented). "config-control": { - // Only configuration databases entry is defined. + // Only the configuration databases entry is defined. "config-databases": [ { // Name of the database to connect to. "name": "config", - // Type of the database, e.g. "mysql", "postgresql". + // Type of database, e.g. "mysql", "postgresql". "type": "mysql" } ], - // Intervals between attempts to fetch configuration updates + // Interval between attempts to fetch configuration updates // via the configuration backends used. "config-fetch-wait-time": 30 }, @@ -1127,12 +1126,12 @@ // Server tag. "server-tag": "my DHCPv6 server", - // DHCP queue control parameters. + // DHCP queue-control parameters. "dhcp-queue-control": { // Enable queue is mandatory. "enable-queue": true, - // Queue type was mandatory. + // Queue type is mandatory. "queue-type": "kea-ring6", // Capacity is optional. @@ -1142,15 +1141,15 @@ // Fetches host reservations. // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" parameters. + // "reservations-in-subnet", and "reservations-out-of-pool" parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "shared-networks" and @@ -1173,11 +1172,11 @@ "cache-threshold": .25, // Global cache maximum. - "cache-max-age": 10, + "cache-max-age": 1000, // String of zero or more characters with which to replace each // invalid character in the Client FQDN. The default - // value is an empty string which will cause invalid characters + // value is an empty string, which will cause invalid characters // to be omitted rather than replaced. "hostname-char-replacement": "x", @@ -1189,7 +1188,7 @@ "loggers": [ { // Debug level, a value between 0..99. The greater the value - // the more detailed debug log. + // the more detailed the debug log. "debuglevel": 99, // Name of the logger. @@ -1198,16 +1197,16 @@ // Configures how the log should be output. "output_options": [ { - // Determines whether the log should flushed to a file. + // Determines whether the log should be flushed to a file. "flush": true, - // Specifies maximum filesize before the file is being rotated. + // Specifies maximum filesize before the file is rotated. "maxsize": 10240000, - // Specifies the maximum number of rotated files being kept. + // Specifies the maximum number of rotated files to be kept. "maxver": 1, - // Specifies logging destination. + // Specifies the logging destination. "output": "stdout", // Specifies log entry content @@ -1220,7 +1219,7 @@ } ], - // Look at advanced example for the use of user-contexts. + // Look at advanced examples for the use of user-contexts. "user-context": { } } } diff --git a/doc/examples/kea6/config-backend.json b/doc/examples/kea6/config-backend.json index eca306d924..ffdae1e5b0 100644 --- a/doc/examples/kea6/config-backend.json +++ b/doc/examples/kea6/config-backend.json @@ -1,7 +1,7 @@ // This is an example configuration file for the DHCPv4 server in Kea. // It demonstrates how to enable Kea Configuration Backend using MySQL. // It requires that libdhcp_mysql_cb.so library is available and -// optionally libdhcp_cb_cmds.so hooks library. +// optionally libdhcp_cb_cmds.so hook library. { "Dhcp6": @@ -24,7 +24,7 @@ // This parameter controls how the server accesses the configuration // database. Currently only one database type is available - "mysql". - // It requires that libdhcp_mysql_cb.so hooks library is loaded. + // It requires that libdhcp_mysql_cb.so hook library is loaded. "config-control": { // A list of database backends to connect to. Currently, it is limited // to a single backend. diff --git a/doc/examples/kea6/duid.json b/doc/examples/kea6/duid.json index 0c00c74e94..49f1874cce 100644 --- a/doc/examples/kea6/duid.json +++ b/doc/examples/kea6/duid.json @@ -33,7 +33,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 diff --git a/doc/examples/kea6/global-reservations.json b/doc/examples/kea6/global-reservations.json index 872a0e2ce5..c7fac51943 100644 --- a/doc/examples/kea6/global-reservations.json +++ b/doc/examples/kea6/global-reservations.json @@ -17,7 +17,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 @@ -41,16 +41,16 @@ // This directive tells Kea that reservations are global. Note that this // can also be specified at shared network and/or subnet level. // "reservation-mode": "global", -// It is replaced by the "reservations-global", "reservations-in-subnet" and +// It is replaced by the "reservations-global", "reservations-in-subnet", and // "reservations-out-of-pool" parameters. -// Specify if server should lookup global reservations. +// Specify whether the server should look up global reservations. "reservations-global": true, -// Specify if server should lookup in-subnet reservations. +// Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": false, -// Specify if server can assume that all reserved addresses +// Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "shared-networks" and "subnet6" levels. diff --git a/doc/examples/kea6/ha-hot-standby-server1-with-tls.json b/doc/examples/kea6/ha-hot-standby-server1-with-tls.json index bd57d06365..f9c604be3b 100644 --- a/doc/examples/kea6/ha-hot-standby-server1-with-tls.json +++ b/doc/examples/kea6/ha-hot-standby-server1-with-tls.json @@ -1,5 +1,5 @@ // This is an example configuration of the Kea DHCPv6 server. It uses High -// Availability hooks library and Lease Commands hooks library to enable +// Availability hook library and Lease Commands hook library to enable // High Availability function for the DHCP server. Note that almost exactly // the same configuration must be used on the second server (partner). // The only difference is that "this-server-name" must be set to "server2" @@ -38,7 +38,7 @@ "type": "memfile" }, - // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and + // HA requires two hook libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. "hooks-libraries": [ @@ -50,7 +50,7 @@ "parameters": { } }, { - // The HA hooks library should be loaded. + // The HA hook library should be loaded. "library": "/opt/lib/kea/hooks/libdhcp_ha.so", "parameters": { // High Availability configuration is specified for the HA hook library. @@ -151,7 +151,7 @@ "debuglevel": 0 }, { - // This section specifies configuration of the HA hooks library specific + // This section specifies configuration of the HA hook library-specific // logger. "name": "kea-dhcp6.ha-hooks", "output_options": [ diff --git a/doc/examples/kea6/ha-hot-standby-server2.json b/doc/examples/kea6/ha-hot-standby-server2.json index cd9de933ff..bb1604e50d 100644 --- a/doc/examples/kea6/ha-hot-standby-server2.json +++ b/doc/examples/kea6/ha-hot-standby-server2.json @@ -1,5 +1,5 @@ // This is an example configuration of the Kea DHCPv6 server. It uses High -// Availability hooks library and Lease Commands hooks library to enable +// Availability hook library and Lease Commands hook library to enable // High Availability function for the DHCP server. Note that almost exactly // the same configuration must be used on the second server (partner). // The only difference is that "this-server-name" must be set to "server1" @@ -37,7 +37,7 @@ "type": "memfile" }, - // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and + // HA requires two hook libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. "hooks-libraries": [ @@ -49,7 +49,7 @@ "parameters": { } }, { - // The HA hooks library should be loaded. + // The HA hook library should be loaded. "library": "/opt/lib/kea/hooks/libdhcp_ha.so", "parameters": { // High Availability configuration is specified for the HA hook library. @@ -142,7 +142,7 @@ "debuglevel": 0 }, { - // This section specifies configuration of the HA hooks library specific + // This section specifies configuration of the HA hook library-specific // logger. "name": "kea-dhcp6.ha-hooks", "output_options": [ diff --git a/doc/examples/kea6/hooks.json b/doc/examples/kea6/hooks.json index 60fc898235..73a7d0708d 100644 --- a/doc/examples/kea6/hooks.json +++ b/doc/examples/kea6/hooks.json @@ -1,5 +1,5 @@ // This is an example configuration file for the DHCPv6 server in Kea -// illustrating the configuration of hooks libraries. It uses a basic scenario +// illustrating the configuration of hook libraries. It uses a basic scenario // of one IPv6 subnet configured with the default values for all parameters. {"Dhcp6": @@ -34,7 +34,7 @@ } ], -// Set up the hooks libraries. For this example, we assume that two libraries +// Set up the hook libraries. For this example, we assume that two libraries // are loaded, called "security" and "charging". Note that order is important: // "security" is specified first so if both libraries supply a hook function // for a given hook, the function in "security" will be called before that in diff --git a/doc/examples/kea6/leases-expiration.json b/doc/examples/kea6/leases-expiration.json index c5320ff7ed..8c2c1759c1 100644 --- a/doc/examples/kea6/leases-expiration.json +++ b/doc/examples/kea6/leases-expiration.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. // Note, we're setting the maximum number of row read errors to 100, // (defaults to 0, meaning unlimited). "lease-database": { @@ -33,7 +33,7 @@ // leases after 10 attempts, a warning message is issued. // If both "flush-reclaimed-timer-wait-time" and "hold-reclaimed-time" are not // 0, when the client sends a release message the lease is expired instead of -// being deleted from the lease storage. +// being deleted from lease storage. "expired-leases-processing": { "reclaim-timer-wait-time": 5, "hold-reclaimed-time": 1800, diff --git a/doc/examples/kea6/multiple-options.json b/doc/examples/kea6/multiple-options.json index b6d8be857c..2d4defe0ee 100644 --- a/doc/examples/kea6/multiple-options.json +++ b/doc/examples/kea6/multiple-options.json @@ -12,7 +12,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile" }, diff --git a/doc/examples/kea6/mysql-reservations.json b/doc/examples/kea6/mysql-reservations.json index 769c111a71..74beb2c631 100644 --- a/doc/examples/kea6/mysql-reservations.json +++ b/doc/examples/kea6/mysql-reservations.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 diff --git a/doc/examples/kea6/pgsql-reservations.json b/doc/examples/kea6/pgsql-reservations.json index c7e204c390..6c61019650 100644 --- a/doc/examples/kea6/pgsql-reservations.json +++ b/doc/examples/kea6/pgsql-reservations.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile" }, diff --git a/doc/examples/kea6/reservations.json b/doc/examples/kea6/reservations.json index f18ba62961..d6452a2778 100644 --- a/doc/examples/kea6/reservations.json +++ b/doc/examples/kea6/reservations.json @@ -15,7 +15,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 @@ -52,13 +52,13 @@ // It is replaced by the "reservations-global", "reservations-in-subnet" // and "reservations-out-of-pool" parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "shared-networks" and diff --git a/doc/examples/kea6/several-subnets.json b/doc/examples/kea6/several-subnets.json index 78bb066b80..8ef391674d 100644 --- a/doc/examples/kea6/several-subnets.json +++ b/doc/examples/kea6/several-subnets.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile" }, diff --git a/doc/examples/kea6/shared-network.json b/doc/examples/kea6/shared-network.json index 5666e014a5..9655f73b7b 100644 --- a/doc/examples/kea6/shared-network.json +++ b/doc/examples/kea6/shared-network.json @@ -72,16 +72,16 @@ // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" + // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. // If specified, it is inherited by "subnet6" levels. @@ -103,13 +103,13 @@ "renew-timer": 10, // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" + // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. "reservations-out-of-pool": false, @@ -130,13 +130,13 @@ "renew-timer": 10, // "reservation-mode": "all", // It is replaced by the "reservations-global", - // "reservations-in-subnet" and "reservations-out-of-pool" + // "reservations-in-subnet", and "reservations-out-of-pool" // parameters. - // Specify if server should lookup global reservations. + // Specify whether the server should look up global reservations. "reservations-global": false, - // Specify if server should lookup in-subnet reservations. + // Specify whether the server should look up in-subnet reservations. "reservations-in-subnet": true, - // Specify if server can assume that all reserved addresses + // Specify whether the server can assume that all reserved addresses // are out-of-pool. // Ignored when reservations-in-subnet is false. "reservations-out-of-pool": false, diff --git a/doc/examples/kea6/simple.json b/doc/examples/kea6/simple.json index acd3499b65..342c035320 100644 --- a/doc/examples/kea6/simple.json +++ b/doc/examples/kea6/simple.json @@ -14,7 +14,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 diff --git a/doc/examples/kea6/tee-times.json b/doc/examples/kea6/tee-times.json index e6a21af256..0a0e8605f6 100644 --- a/doc/examples/kea6/tee-times.json +++ b/doc/examples/kea6/tee-times.json @@ -13,7 +13,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile" }, diff --git a/doc/examples/kea6/with-ddns.json b/doc/examples/kea6/with-ddns.json index 078a64feeb..660213bba0 100644 --- a/doc/examples/kea6/with-ddns.json +++ b/doc/examples/kea6/with-ddns.json @@ -14,7 +14,7 @@ // We need to specify the database used to store leases. As of // June 2022, three database backends are supported: MySQL, // PostgreSQL and the in-memory database, Memfile. -// We'll use memfile because it doesn't require any prior set up. +// We'll use memfile because it doesn't require any prior set up. "lease-database": { "type": "memfile", "lfc-interval": 3600 diff --git a/doc/examples/netconf/simple-dhcp4.json b/doc/examples/netconf/simple-dhcp4.json index 3e2105e2af..c942fa4cb6 100644 --- a/doc/examples/netconf/simple-dhcp4.json +++ b/doc/examples/netconf/simple-dhcp4.json @@ -79,7 +79,7 @@ // // // Some libraries may support parameters. Make sure you // // type this section carefully, as the CA does not validate - // // it (because the format is library specific). + // // it (because the format is library-specific). // "parameters": { // "param1": "foo" // } @@ -97,7 +97,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/netconf/simple-dhcp6.json b/doc/examples/netconf/simple-dhcp6.json index 4393f67606..6fb0554ed4 100644 --- a/doc/examples/netconf/simple-dhcp6.json +++ b/doc/examples/netconf/simple-dhcp6.json @@ -80,7 +80,7 @@ // // // Some libraries may support parameters. Make sure you // // type this section carefully, as the CA does not validate - // // it (because the format is library specific). + // // it (because the format is library-specific). // "parameters": { // "param1": "foo" // } @@ -98,7 +98,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/template-ha-mt-tls/info.md b/doc/examples/template-ha-mt-tls/info.md index f52f250875..f551220340 100644 --- a/doc/examples/template-ha-mt-tls/info.md +++ b/doc/examples/template-ha-mt-tls/info.md @@ -5,7 +5,7 @@ Below are some templates to assist in configuring a secure Kea DHCP server with multi-threading. These templates make the following assumptions: - The administrator wants to set up High Availability (HA) with multi-threading. -- The machines running Kea with multi-threading have at least four CPUs. +- The machines running Kea with multi-threading have at least four CPU cores. - The connection to the peer is secured using TLS. The logical setup consists of two hosts, each running a Kea DHCPv4 server and a Control Agent (CA). diff --git a/doc/examples/template-ha-mt-tls/kea-ca-1.conf b/doc/examples/template-ha-mt-tls/kea-ca-1.conf index 38aed10613..cec984bff5 100644 --- a/doc/examples/template-ha-mt-tls/kea-ca-1.conf +++ b/doc/examples/template-ha-mt-tls/kea-ca-1.conf @@ -72,7 +72,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/template-ha-mt-tls/kea-ca-2.conf b/doc/examples/template-ha-mt-tls/kea-ca-2.conf index 1f08beaffe..3835a49f48 100644 --- a/doc/examples/template-ha-mt-tls/kea-ca-2.conf +++ b/doc/examples/template-ha-mt-tls/kea-ca-2.conf @@ -72,7 +72,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf index e50d548322..5db639670d 100644 --- a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf +++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf @@ -1,6 +1,6 @@ // This is an example configuration of the Kea DHCPv4 server 1: // -// - uses High Availability hooks library and Lease Commands hooks library +// - uses High Availability hook library and Lease Commands hook library // to enable High Availability function for the DHCP server. This config // file is for the primary (the active) server. // - uses memfile, which stores lease data in a local CSV file @@ -43,7 +43,7 @@ // When multi-threading is enabled, Kea will process packets on a // number of multiple threads configurable through this option. The - // value must be a positive integer (0 means auto detect). + // value must be a positive integer (0 means auto-detect). "thread-pool-size": 4, // When multi-threading is enabled, Kea will read packets from the @@ -78,7 +78,7 @@ // use host reservation. // If both "flush-reclaimed-timer-wait-time" and "hold-reclaimed-time" are // not 0, when the client sends a release message the lease is expired - // instead of being deleted from the lease storage. + // instead of being deleted from lease storage. "expired-leases-processing": { "reclaim-timer-wait-time": 3600, "hold-reclaimed-time": 172800, @@ -86,7 +86,7 @@ "max-reclaim-time": 0 }, - // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and + // HA requires two hook libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. Note the library name // should be the same, but the path is OS specific. @@ -99,7 +99,7 @@ }, { - // The HA hooks library should be loaded. + // The HA hook library should be loaded. "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", "parameters": { // Each server should have the same HA configuration, except for the diff --git a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf index 2b17262f98..a98e6b3866 100644 --- a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf +++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf @@ -1,6 +1,6 @@ // This is an example configuration of the Kea DHCPv4 server 2: // -// - uses High Availability hooks library and Lease Commands hooks library +// - uses High Availability hook library and Lease Commands hook library // to enable High Availability function for the DHCP server. This config // file is for the secondary (the standby) server. // - uses memfile, which stores lease data in a local CSV file @@ -43,7 +43,7 @@ // When multi-threading is enabled, Kea will process packets on a // number of multiple threads configurable through this option. The - // value must be a positive integer (0 means auto detect). + // value must be a positive integer (0 means auto-detect). "thread-pool-size": 4, // When multi-threading is enabled, Kea will read packets from the @@ -78,7 +78,7 @@ // use host reservation. // If both "flush-reclaimed-timer-wait-time" and "hold-reclaimed-time" are // not 0, when the client sends a release message the lease is expired - // instead of being deleted from the lease storage. + // instead of being deleted from lease storage. "expired-leases-processing": { "reclaim-timer-wait-time": 3600, "hold-reclaimed-time": 172800, @@ -86,7 +86,7 @@ "max-reclaim-time": 0 }, - // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and + // HA requires two hook libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. Note the library name // should be the same, but the path is OS specific. @@ -99,7 +99,7 @@ }, { - // The HA hooks library should be loaded. + // The HA hook library should be loaded. "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", "parameters": { // Each server should have the same HA configuration, except for the diff --git a/doc/examples/template-power-user-home/info.md b/doc/examples/template-power-user-home/info.md index 21baa204dc..9335ff8ccc 100644 --- a/doc/examples/template-power-user-home/info.md +++ b/doc/examples/template-power-user-home/info.md @@ -60,7 +60,7 @@ The whole subnet is split into dynamic and static pools: To deploy this setup, perform the following steps: -1. Install the CA and DHCPv4 daemon on host-1, and copy the configuration files to their typical locations. +1. Install the CA and the DHCPv4 server on host-1, and copy the configuration files to their typical locations. They are usually in ``/etc/kea`` on Linux and ``/usr/local/etc/kea`` on FreeBSD, and the files are typically called ``kea-ctrl-agent.conf`` and ``kea-dhcp4.conf``. Please consult the startup scripts for any specific system. @@ -91,7 +91,7 @@ To deploy this setup, perform the following steps: 4. Verify that communication between the hosts works in the opposite direction as well (host-2 can connect to host-1), by repeating step 3 from host-2 using host-1's IP address and port. -5. Install the CA and DHCPv4 daemon on host-2, as in steps 1 and 2. The config file for the +5. Install the CA and the DHCPv4 server on host-2, as in steps 1 and 2. The config file for the standby server is very similar to the one on the primary server, other than the definition of the ``this-server-name`` field (and possibly the interface names). diff --git a/doc/examples/template-power-user-home/kea-ca-1.conf b/doc/examples/template-power-user-home/kea-ca-1.conf index 2620ea007e..04945c8a3e 100644 --- a/doc/examples/template-power-user-home/kea-ca-1.conf +++ b/doc/examples/template-power-user-home/kea-ca-1.conf @@ -48,7 +48,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/template-power-user-home/kea-ca-2.conf b/doc/examples/template-power-user-home/kea-ca-2.conf index dccf5d9d87..c876012aff 100644 --- a/doc/examples/template-power-user-home/kea-ca-2.conf +++ b/doc/examples/template-power-user-home/kea-ca-2.conf @@ -48,7 +48,7 @@ // Several additional parameters are possible in addition // to the typical output. Flush determines whether logger // flushes output to a file. Maxsize determines maximum - // filesize before the file is being rotated. maxver + // filesize before the file is rotated. maxver // specifies the maximum number of rotated files being // kept. "flush": true, diff --git a/doc/examples/template-power-user-home/kea-dhcp4-1.conf b/doc/examples/template-power-user-home/kea-dhcp4-1.conf index 8d635560ab..48b8c2eb86 100644 --- a/doc/examples/template-power-user-home/kea-dhcp4-1.conf +++ b/doc/examples/template-power-user-home/kea-dhcp4-1.conf @@ -1,6 +1,6 @@ // This is an example configuration of the Kea DHCPv4 server 1: // -// - uses High Availability hooks library and Lease Commands hooks library +// - uses High Availability hook library and Lease Commands hook library // to enable High Availability function for the DHCP server. This config // file is for the primary (the active) server. // - uses memfile, which stores lease data in a local CSV file @@ -59,7 +59,7 @@ // use host reservation. // If both "flush-reclaimed-timer-wait-time" and "hold-reclaimed-time" are // not 0, when the client sends a release message the lease is expired - // instead of being deleted from the lease storage. + // instead of being deleted from lease storage. "expired-leases-processing": { "reclaim-timer-wait-time": 3600, "hold-reclaimed-time": 172800, @@ -67,7 +67,7 @@ "max-reclaim-time": 0 }, - // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and + // HA requires two hook libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. Note the library name // should be the same, but the path is OS specific. @@ -80,7 +80,7 @@ }, { - // The HA hooks library should be loaded. + // The HA hook library should be loaded. "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", "parameters": { // Each server should have the same HA configuration, except for the diff --git a/doc/examples/template-power-user-home/kea-dhcp4-2.conf b/doc/examples/template-power-user-home/kea-dhcp4-2.conf index 731671bb1e..29d8f4ca06 100644 --- a/doc/examples/template-power-user-home/kea-dhcp4-2.conf +++ b/doc/examples/template-power-user-home/kea-dhcp4-2.conf @@ -1,6 +1,6 @@ // This is an example configuration of the Kea DHCPv4 server 2: // -// - uses High Availability hooks library and Lease Commands hooks library +// - uses High Availability hook library and Lease Commands hook library // to enable High Availability function for the DHCP server. This config // file is for the primary (the active) server. // - uses memfile, which stores lease data in a local CSV file @@ -59,7 +59,7 @@ // use host reservation. // If both "flush-reclaimed-timer-wait-time" and "hold-reclaimed-time" are // not 0, when the client sends a release message the lease is expired - // instead of being deleted from the lease storage. + // instead of being deleted from lease storage. "expired-leases-processing": { "reclaim-timer-wait-time": 3600, "hold-reclaimed-time": 172800, @@ -67,7 +67,7 @@ "max-reclaim-time": 0 }, - // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and + // HA requires two hook libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. Note the library name // should be the same, but the path is OS specific. @@ -80,7 +80,7 @@ }, { - // The HA hooks library should be loaded. + // The HA hook library should be loaded. "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", "parameters": { // Each server should have the same HA configuration, except for the |