From: Tomek Mrugalski Date: Wed, 6 Aug 2014 17:09:27 +0000 (+0200) Subject: [3468] "true", "false" => true, false X-Git-Tag: trac3482_base~57^2~1 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1d293e72e16a03bb4d35fdf2331576d1f30dfb7e;p=thirdparty%2Fkea.git [3468] "true", "false" => true, false --- diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index 9fc19fdf17..63038f828e 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -89,7 +89,7 @@ # Next we specify the type of lease database "lease-database": { "type": "memfile", - "persist": "true", + "persist": true, "name": "/var/kea/dhcp4.leases" }, @@ -250,7 +250,7 @@ url="http://jsonviewer.stack.hu/"/>. "Dhcp4": { "lease-database": { "type": "memfile", - "persist": "true", + "persist": true, "name": "/tmp/kea-leases4.csv" } ... @@ -260,12 +260,12 @@ url="http://jsonviewer.stack.hu/"/>. The "persist" parameter controls whether the leases are written to disk. - It is strongly recommended that this parameter is set to "true" at all times - during the normal operation of the server. (Not writing leases to disk will - mean that if a server is restarted (e.g. after a power failure), it will not - know what addresses have been assigned. As a result, it may hand out addresses - to new clients that are already in use.) - + It is strongly recommended that this parameter is set to + true at all times during the normal operation of the + server. (Not writing leases to disk will mean that if a server is restarted + (e.g. after a power failure), it will not know what addresses have been + assigned. As a result, it may hand out addresses to new clients that are + already in use.)
@@ -474,7 +474,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "domain-name-servers", "code": 6, "space": "dhcp4", - "csv-format": "true", + "csv-format": true, "data": "192.0.2.1, 192.0.2.2" }, ... @@ -512,7 +512,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "domain-name-servers", "code": 6, "space": "dhcp4", - "csv-format": "false", + "csv-format": false, "data": "C0 00 03 01 C0 00 03 02" }, ... @@ -544,7 +544,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "domain-name-servers", "code": 6, "space: "dhcp4", - "csv-format": "true", + "csv-format": true, "data": "192.0.2.3" }, ... @@ -768,7 +768,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "foo", "code": 222, "type": "uint32", - "array": "false", + "array": false, "record-types": "", "space": "dhcp4", "encapsulate": "" @@ -777,17 +777,18 @@ temporarily override a list of interface names and listen on all interfaces. ... } - The "false" value of the array parameter determines that the option - does NOT comprise an array of "uint32" values but rather a single value. - Two other parameters have been left blank: record-types and encapsulate. - The former specifies the comma separated list of option data fields if the - option comprises a record of data fields. This should - be non-empty if the type is set to "record". Otherwise it must be left - blank. The latter parameter specifies the name of the option space being - encapsulated by the particular option. If the particular option does not - encapsulate any option space it should be left blank. - Note that the above set of comments define the format of the new option and do not - set its values. + The false value of the array + parameter determines that the option does NOT comprise an array of + "uint32" values but rather a single value. Two other parameters have been + left blank: record-types and + encapsulate. The former specifies the comma separated + list of option data fields if the option comprises a record of data + fields. This should be non-empty if the type is set to + "record". Otherwise it must be left blank. The latter parameter specifies + the name of the option space being encapsulated by the particular + option. If the particular option does not encapsulate any option space it + should be left blank. Note that the above set of comments define the + format of the new option and do not set its values. @@ -808,7 +809,7 @@ temporarily override a list of interface names and listen on all interfaces. name "foo", "code": 222, "space": "dhcp4", - "csv-format": "true", + "csv-format": true, "data": "12345" }, ... ], @@ -832,7 +833,7 @@ temporarily override a list of interface names and listen on all interfaces. "code": 223, "space": "dhcp4", "type": "record", - "array": "false", + "array": false, "record-types": "ipv4-address, uint16, boolean, string", "encapsulate": "" }, ... @@ -853,25 +854,25 @@ temporarily override a list of interface names and listen on all interfaces. "name": "bar", "space": "dhcp4", "code": 223, - "csv-format": "true", + "csv-format": true, "data": "192.0.2.100, 123, true, Hello World" } ], ... } - csv-format is set "true" to indicate that the data field comprises a command-separated - list of values. The values in the data must correspond to the types set in - the record-types field of the option definition. + csv-format is set true to indicate + that the data field comprises a command-separated list + of values. The values in the data must correspond to + the types set in the record-types field of the option + definition. - - It is recommended that boolean values are specified using "true" and "false" - strings. This helps to prevent errors when typing multiple comma separated - values, as it make it easier to identify the type of the value being typed, - and compare it with the order of data fields. Nevertheless, it is possible - to use integer values: "1" and "0", instead of "true" and "false". - If other integer value are used, the configuration is rejected. - + In general case, boolean values are specified as true or + false, without quotes. Some specific boolean parameters may + accept also "true", "false", + 0, 1, "0" and + "1". Future Kea versions will accept all those values + for all boolean parameters.
@@ -897,7 +898,7 @@ temporarily override a list of interface names and listen on all interfaces. "code": 1, "space": "vendor-encapsulated-options-space", "type": "record", - "array": "false", + "array": false, "record-types": "ipv4-address, uint16, string", "encapsulates": "" } @@ -914,7 +915,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "foo" "space": "vendor-encapsulated-options-space", "code": 1, - "csv-format": "true", + "csv-format": true, "data": "192.0.2.3, 123, Hello World" } ], @@ -929,7 +930,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "vendor-encapsulated-options" "space": "dhcp4", "code": 43, - "csv-format": "false", + "csv-format": false, "data": "" } ], @@ -977,7 +978,7 @@ temporarily override a list of interface names and listen on all interfaces. "space": "isc", "type": "ipv4-address". "record-types": "", - "array": "false", + "array": false, "encapsulate "" }, { @@ -986,7 +987,7 @@ temporarily override a list of interface names and listen on all interfaces. "space": "isc", "type": "string", "record-types": "", - "array": "false" + "array": false "encapsulate": "" } ], @@ -1007,7 +1008,7 @@ temporarily override a list of interface names and listen on all interfaces. "code": 222, "space": "dhcp4", "type": "empty", - "array": "false", + "array": false, "record-types": "", "encapsulate": "isc" } @@ -1028,21 +1029,21 @@ temporarily override a list of interface names and listen on all interfaces. "name": "subopt1", "space": "isc", "code": 1, - "csv-format": "true", + "csv-format": true, "data": "192.0.2.3" }, } "name": "subopt2", "space": "isc", "code": 2, - "csv-format": "true", + "csv-format": true, "data": "Hello world" }, { "name": "container", "space": "dhcp4", "code": 222, - "csv-format": "true", + "csv-format": true, "data": "" } ], @@ -1090,7 +1091,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "domain-name-servers", "code": 6, "data": "192.0.2.200,192.0.2.201", - "csv-format": "true", + "csv-format": true, "space": "dhcp4" } ] } @@ -1237,7 +1238,7 @@ temporarily override a list of interface names and listen on all interfaces. "Dhcp4": { "dhcp-ddns": { - "enable-updates": "true", + "enable-updates": true, "server-ip": "127.0.0.1", "server-port": 53001, "sender-ip": "", @@ -1245,9 +1246,9 @@ temporarily override a list of interface names and listen on all interfaces. "max-queue-size": 1024, "ncr-protocol": "UDP", "ncr-format": "JSON", - "override-no-update": "false", - "override-client-update": "false", - "replace-client-name": "false", + "override-no-update": false, + "override-client-update": false, + "replace-client-name": false, "generated-prefix": "myhost", "qualifying-suffix": "example.com" }, @@ -1436,7 +1437,7 @@ temporarily override a list of interface names and listen on all interfaces. "Dhcp4": { "dhcp-ddns": { - "override-client-update": "true", + "override-client-update": true, ... }, ... @@ -1456,7 +1457,7 @@ temporarily override a list of interface names and listen on all interfaces. "Dhcp4": { "dhcp-ddns": { - "override-no-update": "true", + "override-no-update": true, ... }, ... @@ -1508,7 +1509,7 @@ temporarily override a list of interface names and listen on all interfaces. "Dhcp4": { "dhcp-ddns": { - "replace-client-name": "true", + "replace-client-name": true, ... }, ... @@ -1612,7 +1613,7 @@ temporarily override a list of interface names and listen on all interfaces. "Dhcp4": { - "echo-client-id": "false", + "echo-client-id": false, ... } diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index a61d888e58..cbd64364c6 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -90,7 +90,7 @@ # Next we specify the type of lease database "lease-database": { "type": "memfile", - "persist": "true", + "persist": true, "name": "/var/kea/dhcp6.leases" }, @@ -259,7 +259,7 @@ JSON validator is available at . "Dhcp6": { "lease-database": { "type": "memfile", - "persist": "true", + "persist": true, "name": "/tmp/kea-leases6.csv" } ... @@ -269,7 +269,7 @@ JSON validator is available at . The "persist" parameter controls whether the leases are written to disk. - It is strongly recommended that this parameter is set to "true" at all times + It is strongly recommended that this parameter is set to true at all times during the normal operation of the server. (Not writing leases to disk will mean that if a server is restarted (e.g. after a power failure), it will not know what addresses have been assigned. As a result, it may hand out addresses @@ -568,7 +568,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "dns-servers", "code": 23, "space": "dhcp6", - "csv-format": "true", + "csv-format": true, "data": "2001:db8::cafe, 2001:db8::babe" }, ... @@ -608,7 +608,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "dns-servers", "code": 23, "space": "dhcp6", - "csv-format": "false", + "csv-format": false, "data": "2001 0DB8 0001 0000 0000 0000 0000 CAFE 2001 0DB8 0001 0000 0000 0000 0000 BABE" }, @@ -647,7 +647,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "dns-servers", "code": 23, "space: "dhcp6", - "csv-format": "true", + "csv-format": true, "data": "2001:db8:1::3" }, ... @@ -783,7 +783,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "foo", "code": 100, "type": "uint32", - "array": "false", + "array": false, "record-types": "", "space": "dhcp6", "encapsulate": "" @@ -814,7 +814,7 @@ temporarily override a list of interface names and listen on all interfaces. name "foo", "code": 100, "space": "dhcp6", - "csv-format": "true", + "csv-format": true, "data": "12345" }, ... ], @@ -840,7 +840,7 @@ temporarily override a list of interface names and listen on all interfaces. "code": 101, "space": "dhcp6", "type": "record", - "array": "false", + "array": false, "record-types": "ipv4-address, uint16, boolean, string", "encapsulate": "" }, ... @@ -861,27 +861,28 @@ temporarily override a list of interface names and listen on all interfaces. "name": "bar", "space": "dhcp6", "code": 101, - "csv-format": "true", + "csv-format": true, "data": "2001:db8:1::10, 123, false, Hello World" } ], ... } - "csv-format" is set "true" to indicate that the "data" field comprises a command-separated - list of values. The values in the "data" must correspond to the types set in + + csv-format is set true to indicate + that the data field comprises a command-separated list + of values. The values in the "data" must correspond to the types set in the "record-types" field of the option definition. + - - It is recommended that boolean values are specified using "true" and "false" - strings. This helps to prevent errors when typing multiple comma separated - values, as it make it easier to identify the type of the value being typed, - and compare it with the order of data fields. Nevertheless, it is possible - to use integer values: "1" and "0", instead of "true" and "false" - accordingly. If other integer value is specified, the configuration is - rejected. - + In general case, boolean values are specified as true or + false, without quotes. Some specific boolean parameters may + accept also "true", "false", + 0, 1, "0" and + "1". Future Kea versions will accept all those values + for all boolean parameters. +
@@ -905,7 +906,7 @@ temporarily override a list of interface names and listen on all interfaces. "code": 1, "space": "vendor-encapsulated-options-space", "type": "record", - "array": "false", + "array": false, "record-types": "ipv6-address, uint16, string", "encapsulates": "" } @@ -922,7 +923,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "foo" "space": "vendor-encapsulated-options-space", "code": 1, - "csv-format": "true", + "csv-format": true, "data": "2001:db8:1::10, 123, Hello World" }, ... @@ -939,7 +940,7 @@ temporarily override a list of interface names and listen on all interfaces. "name": "vendor-encapsulated-options" "space": "dhcp6", "code": 17, - "csv-format": "true", + "csv-format": true, "data": "12345" } ], @@ -975,7 +976,7 @@ temporarily override a list of interface names and listen on all interfaces. "space": "isc", "type": "ipv6-address". "record-types": "", - "array": "false", + "array": false, "encapsulate "" }, { @@ -984,7 +985,7 @@ temporarily override a list of interface names and listen on all interfaces. "space": "isc", "type": "string", "record-types": "", - "array": "false" + "array": false "encapsulate": "" } ], @@ -1005,7 +1006,7 @@ should include options from the isc option space: "code": 102, "space": "dhcp6", "type": "empty", - "array": "false", + "array": false, "record-types": "", "encapsulate": "isc" } @@ -1027,21 +1028,21 @@ should include options from the isc option space: "name": "subopt1", "space": "isc", "code": 1, - "csv-format": "true", + "csv-format": true, "data": "2001:db8::abcd" }, } "name": "subopt2", "space": "isc", "code": 2, - "csv-format": "true", + "csv-format": true, "data": "Hello world" }, { "name": "container", "space": "dhcp6", "code": 102, - "csv-format": "true", + "csv-format": true, "data": "" } ], @@ -1283,7 +1284,7 @@ should include options from the isc option space: "Dhcp6": { "dhcp-ddns": { - "enable-updates": "true", + "enable-updates": true, "server-ip": "127.0.0.1", "server-port": 53001, "sender-ip": "", @@ -1291,9 +1292,9 @@ should include options from the isc option space: "max-queue-size": 1024, "ncr-protocol": "UDP", "ncr-format": "JSON", - "override-no-update": "false", - "override-client-update": "false", - "replace-client-name": "false", + "override-no-update": false, + "override-client-update": false, + "replace-client-name": false, "generated-prefix": "myhost", "qualifying-suffix": "example.com" }, @@ -1485,7 +1486,7 @@ should include options from the isc option space: "Dhcp6": { "dhcp-ddns": { - "override-client-update": "true", + "override-client-update": true, ... }, ... @@ -1505,7 +1506,7 @@ should include options from the isc option space: "Dhcp6": { "dhcp-ddns": { - "override-no-update": "true", + "override-no-update": true, ... }, ... @@ -1550,7 +1551,7 @@ should include options from the isc option space: "Dhcp6": { "dhcp-ddns": { - "replace-client-name": "true", + "replace-client-name": true, ... }, ...