{
- "name": "build-report",
- "brief": "Returns a list of compilation options that this particular binary was built with",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
-
- "cmd-syntax": "{
- \"command\": \"build-report\"
-}",
-
- "resp-syntax": "{
- \"result\": 0,
- \"text\": <string with build details>
-}",
- "resp-comment": ""
-}
+ "brief": [
+ "Returns a list of compilation options that this particular binary was built with"
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"build-report\"",
+ "}"
+ ],
+ "name": "build-report",
+ "resp-comment": [
+ ""
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": <string with build details>",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
{
- "name": "cache-clear",
- "brief": "This command removes all cached host reservations.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
+ "avail": "1.4.0",
+ "brief": [
+ "This command removes all cached host reservations."
+ ],
"hook": "host_cache",
- "avail": "1.4.0"
-}
+ "name": "cache-clear",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "cache-get-by-id",
- "brief": "Returns entries matching the given identifier from the host cache.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "Returns entries matching the given identifier from the host cache."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"cache-get-by-id\",",
+ " \"arguments\": {",
+ " \"hw-address\": \"01:02:03:04:05:06\"",
+ " }"
+ ],
"hook": "host_cache",
- "cmd-syntax": "{
- \"command\": \"cache-get-by-id\",
- \"arguments\": {
- \"hw-address\": \"01:02:03:04:05:06\"
- }",
- "resp-syntax": "{
- \"result\": 0
- \"text\": \"2 entries returned.\"
- \"arguments\": <list of host reservations>
-}"
-}
+ "name": "cache-get-by-id",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0",
+ " \"text\": \"2 entries returned.\"",
+ " \"arguments\": <list of host reservations>",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "cache-get",
- "brief": "Returns full content of the host cache.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "Returns full content of the host cache."
+ ],
"hook": "host_cache",
-
- "resp-syntax": "{
- \"result\": 0
- \"text\": \"123 entries returned.\"
- \"arguments\": <list of host reservations>
-}"
-}
+ "name": "cache-get",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0",
+ " \"text\": \"123 entries returned.\"",
+ " \"arguments\": <list of host reservations>",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "cache-insert",
- "brief": "This command may be used to manually insert a host into the cache.",
- "description": "See <xref linkend=\"host-reservation-v4\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "This command may be used to manually insert a host into the cache."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"cache-insert\",",
+ " \"arguments\": {",
+ " \"hw-address\": \"01:02:03:04:05:06\",",
+ " \"subnet-id4\": 4,",
+ " \"subnet-id6\": 0,",
+ " \"ip-address\": \"192.0.2.100\",",
+ " \"hostname\": \"somehost.example.org\",",
+ " \"client-classes4\": [ ],",
+ " \"client-classes6\": [ ],",
+ " \"option-data4\": [ ],",
+ " \"option-data6\": [ ],",
+ " \"next-server\": \"192.0.0.2\",",
+ " \"server-hostname\": \"server-hostname.example.org\",",
+ " \"boot-file-name\": \"bootfile.efi\",",
+ " \"host-id\": 0",
+ " }",
+ "},",
+ "{",
+ " \"command\": \"cache-insert\",",
+ " \"arguments\": {",
+ " \"hw-address\": \"01:02:03:04:05:06\",",
+ " \"subnet-id4\": 0,",
+ " \"subnet-id6\": 6,",
+ " \"ip-addresses\": [ \"2001:db8::cafe:babe\" ],",
+ " \"prefixes\": [ \"2001:db8:dead:beef::/64\" ],",
+ " \"hostname\": \"\",",
+ " \"client-classes4\": [ ],",
+ " \"client-classes6\": [ ],",
+ " \"option-data4\": [ ],",
+ " \"option-data6\": [ ],",
+ " \"next-server\": \"0.0.0.0\",",
+ " \"server-hostname\": \"\",",
+ " \"boot-file-name\": \"\",",
+ " \"host-id\": 0",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"host-reservation-v4\"/>",
"hook": "host_cache",
- "cmd-syntax": "{
- \"command\": \"cache-insert\",
- \"arguments\": {
- \"hw-address\": \"01:02:03:04:05:06\",
- \"subnet-id4\": 4,
- \"subnet-id6\": 0,
- \"ip-address\": \"192.0.2.100\",
- \"hostname\": \"somehost.example.org\",
- \"client-classes4\": [ ],
- \"client-classes6\": [ ],
- \"option-data4\": [ ],
- \"option-data6\": [ ],
- \"next-server\": \"192.0.0.2\",
- \"server-hostname\": \"server-hostname.example.org\",
- \"boot-file-name\": \"bootfile.efi\",
- \"host-id\": 0
- }
-},
-{
- \"command\": \"cache-insert\",
- \"arguments\": {
- \"hw-address\": \"01:02:03:04:05:06\",
- \"subnet-id4\": 0,
- \"subnet-id6\": 6,
- \"ip-addresses\": [ \"2001:db8::cafe:babe\" ],
- \"prefixes\": [ \"2001:db8:dead:beef::/64\" ],
- \"hostname\": \"\",
- \"client-classes4\": [ ],
- \"client-classes6\": [ ],
- \"option-data4\": [ ],
- \"option-data6\": [ ],
- \"next-server\": \"0.0.0.0\",
- \"server-hostname\": \"\",
- \"boot-file-name\": \"\",
- \"host-id\": 0
- }
-}"
-}
+ "name": "cache-insert",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "cache-load",
- "brief": "This command allows load the contents of a file on disk into an in-memory cache.",
- "description": "See <xref linkend=\"command-cache-load\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "This command allows load the contents of a file on disk into an in-memory cache."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"cache-load\",",
+ " \"arguments\": \"/tmp/kea-host-cache.json\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-cache-load\"/>",
"hook": "host_cache",
- "cmd-syntax": "{
- \"command\": \"cache-load\",
- \"arguments\": \"/tmp/kea-host-cache.json\"
-}"
-}
+ "name": "cache-load",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "cache-remove",
- "brief": "The cache-remove command works similarly to reservation-get command.",
- "description": "See <xref linkend=\"command-cache-remove\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "The cache-remove command works similarly to reservation-get command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"cache-remove\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"192.0.2.1\",",
+ " \"subnet-id\": 123",
+ " }",
+ "}",
+ "",
+ "Another example that removes IPv6 host identifier by DUID and specific subnet-id is:",
+ "{",
+ " \"command\": \"cache-remove\",",
+ " \"arguments\": {",
+ " \"duid\": \"00:01:ab:cd:f0:a1:c2:d3:e4\",",
+ " \"subnet-id\": 123",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-cache-remove\"/>",
"hook": "host_cache",
- "cmd-syntax": "{
- \"command\": \"cache-remove\",
- \"arguments\": {
- \"ip-address\": \"192.0.2.1\",
- \"subnet-id\": 123
- }
-}
-
-Another example that removes IPv6 host identifier by DUID and specific subnet-id is:
-{
- \"command\": \"cache-remove\",
- \"arguments\": {
- \"duid\": \"00:01:ab:cd:f0:a1:c2:d3:e4\",
- \"subnet-id\": 123
- }
-}"
-}
+ "name": "cache-remove",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "cache-size",
- "brief": "Returns number of entries of the host cache.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "Returns number of entries of the host cache."
+ ],
"hook": "host_cache",
-
- "resp-syntax": "{
- \"result\": 0
- \"text\": \"123 entries.\"
- \"arguments\": { \"size\": 123 }
-}"
-}
+ "name": "cache-size",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0",
+ " \"text\": \"123 entries.\"",
+ " \"arguments\": { \"size\": 123 }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "cache-write",
- "brief": "Instructs Kea to write its host cache content to disk.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "Instructs Kea to write its host cache content to disk."
+ ],
+ "cmd-comment": [
+ "The command takes one mandatory argument that specifies a filename path of a file to be written."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"cache-write\",",
+ " \"arguments\": \"/path/to/the/file.json\"",
+ "}"
+ ],
"hook": "host_cache",
-
- "cmd-syntax": "{
- \"command\": \"cache-write\",
- \"arguments\": \"/path/to/the/file.json\"
-}",
- "cmd-comment": "The command takes one mandatory argument that specifies a filename path of a file to be written."
-}
+ "name": "cache-write",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "class-add",
- "brief": "This command is used to create and add a new class to the existing
- server configuration.",
- "description": "See <xref linkend=\"command-class-add\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
+ "brief": [
+ "This command is used to create and add a new class to the existing",
+ " server configuration."
+ ],
+ "cmd-comment": [
+ "The <command>next-server</command>,",
+ " <command>server-hostname</command> and",
+ " <command>boot-file-name</command> are DHCPv4 specific. Only",
+ " one client class can be added with a single command. "
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"class-add\",",
+ " \"arguments\": {",
+ " \"client-classes\": [ {",
+ " \"name\": <name of the class>,",
+ " \"test\": <test expression to be evaluated on incoming packets>,",
+ " \"option-data\": [ <option values here> ],",
+ " \"option-def\": [ <option defintions here> ],",
+ " \"next-server\": <ipv4 address>,",
+ " \"server-hostname\": <string>,",
+ " \"boot-file-name\": <name of the boot file>",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-class-add\"/>",
"hook": "class_cmds",
- "cmd-syntax": "{
- \"command\": \"class-add\",
- \"arguments\": {
- \"client-classes\": [ {
- \"name\": <name of the class>,
- \"test\": <test expression to be evaluated on incoming packets>,
- \"option-data\": [ <option values here> ],
- \"option-def\": [ <option defintions here> ],
- \"next-server\": <ipv4 address>,
- \"server-hostname\": <string>,
- \"boot-file-name\": <name of the boot file>
- } ]
- }
-}",
- "cmd-comment": "The <command>next-server</command>,
- <command>server-hostname</command> and
- <command>boot-file-name</command> are DHCPv4 specific. Only
- one client class can be added with a single command. ",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"Class '<class-name>' added.\",
-}",
- "resp-comment": "The command will be successful (result 0), unless the
- class name is a duplicate or another error occurs (result 1)."
-}
+ "name": "class-add",
+ "resp-comment": [
+ "The command will be successful (result 0), unless the",
+ " class name is a duplicate or another error occurs (result 1)."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Class '<class-name>' added.\",",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "class-del",
- "brief": "This command is used to remove a client class from the server configuration.",
- "description": "See <xref linkend=\"command-class-del\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
+ "brief": [
+ "This command is used to remove a client class from the server configuration."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"class-del\",",
+ " \"arguments\": {",
+ " \"name\": <name of the class>",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-class-del\"/>",
"hook": "class_cmds",
- "cmd-syntax": "{
- \"command\": \"class-del\",
- \"arguments\": {
- \"name\": <name of the class>
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"Class '<class-name>' deleted.\"
-}",
- "resp-comment": "The command will return a result of 3 (empty) if the client
- class doesn't exist. If the client class exists, the retured
- result is 0 if the deletion was successful and the result is 1
- if the deletion is unsuccessful."
-
-}
+ "name": "class-del",
+ "resp-comment": [
+ "The command will return a result of 3 (empty) if the client",
+ " class doesn't exist. If the client class exists, the retured",
+ " result is 0 if the deletion was successful and the result is 1",
+ " if the deletion is unsuccessful."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Class '<class-name>' deleted.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "class-get",
- "brief": "This command is used to return detailed information about an
- existing client class.",
- "description": "See <xref linkend=\"command-class-get\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
+ "brief": [
+ "This command is used to return detailed information about an",
+ " existing client class."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"class-get\",",
+ " \"arguments\": {",
+ " \"name\": <name of the class>",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-class-get\"/>",
"hook": "class_cmds",
- "cmd-syntax": "{
- \"command\": \"class-get\",
- \"arguments\": {
- \"name\": <name of the class>
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"Class '<class-name>' definition returned\",
- \"arguments\": {
- \"client-classes\": [
- {
- \"name\": <name of the class>,
- \"only-if-required\": <only if required boolean value>,
- \"test\": <test expression to be evaluated on incoming packets>,
- \"option-data\": [ <option values here> ],
- \"option-def\": [ <option defintions here> ],
- \"next-server\": <ipv4 address>,
- \"server-hostname\": <string>,
- \"boot-file-name\": <name of the boot file>
- }
- ]
- }
-}",
- "resp-comment": "The returned information depends on the DHCP server type,
- i.e. some parameters are specific to DHCPv4 server. Also,
- some parameters may not be returned if they are not set for
- the client class. If the class with specified name doesn't
- exist a result of 3 (empty) is returned. If the client class
- is found, the result of 0 is returned. If there is an error
- while processing the command, the result of 1 is returned."
-}
+ "name": "class-get",
+ "resp-comment": [
+ "The returned information depends on the DHCP server type,",
+ " i.e. some parameters are specific to DHCPv4 server. Also,",
+ " some parameters may not be returned if they are not set for",
+ " the client class. If the class with specified name doesn't",
+ " exist a result of 3 (empty) is returned. If the client class",
+ " is found, the result of 0 is returned. If there is an error",
+ " while processing the command, the result of 1 is returned."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Class '<class-name>' definition returned\",",
+ " \"arguments\": {",
+ " \"client-classes\": [",
+ " {",
+ " \"name\": <name of the class>,",
+ " \"only-if-required\": <only if required boolean value>,",
+ " \"test\": <test expression to be evaluated on incoming packets>,",
+ " \"option-data\": [ <option values here> ],",
+ " \"option-def\": [ <option defintions here> ],",
+ " \"next-server\": <ipv4 address>,",
+ " \"server-hostname\": <string>,",
+ " \"boot-file-name\": <name of the boot file>",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "class-list",
- "brief": "This command is used to retrieve a list of all client
- classes from the server configuration.",
- "description": "See <xref linkend=\"command-class-list\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
+ "brief": [
+ "This command is used to retrieve a list of all client",
+ " classes from the server configuration."
+ ],
+ "cmd-comment": [
+ "This command includes no arguments."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"class-list\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-class-list\"/>",
"hook": "class_cmds",
- "cmd-syntax": "{
- \"command\": \"class-list\"
-}",
- "cmd-comment": "This command includes no arguments.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"<number of> classes found\",
- \"arguments\": {
- \"client-classes\": [
- {
- \"name\": <first class name>
- },
- {
- \"name\": <second class name>
- }
- ]
- }
-}",
- "resp-comment": "The returned list of classes merely contains their names.
- In order to retrieve full information about one of these
- classes use <xref linkend=\"command-class-get\"/>.
- The returned result is 3 (empty) if no classes are found.
- If the command is processed successfully and the list of
- client classes is not empty, the result of 0 is returned.
- If there is an error while processing the command, the
- result of 1 is returned."
-}
+ "name": "class-list",
+ "resp-comment": [
+ "The returned list of classes merely contains their names.",
+ " In order to retrieve full information about one of these",
+ " classes use <xref linkend=\"command-class-get\"/>.",
+ " The returned result is 3 (empty) if no classes are found.",
+ " If the command is processed successfully and the list of",
+ " client classes is not empty, the result of 0 is returned.",
+ " If there is an error while processing the command, the",
+ " result of 1 is returned."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"<number of> classes found\",",
+ " \"arguments\": {",
+ " \"client-classes\": [",
+ " {",
+ " \"name\": <first class name>",
+ " },",
+ " {",
+ " \"name\": <second class name>",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "class-update",
- "brief": "This command is used to update an existing client class in
- the server configuration.",
- "description": "See <xref linkend=\"command-class-update\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
+ "brief": [
+ "This command is used to update an existing client class in",
+ " the server configuration."
+ ],
+ "cmd-comment": [
+ "The <command>next-server</command>,",
+ " <command>server-hostname</command> and",
+ " <command>boot-file-name</command> are DHCPv4 specific. Only",
+ " one client class can be updated with a single command. "
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"class-update\",",
+ " \"arguments\": {",
+ " \"client-classes\": [ {",
+ " \"name\": <name of the class>,",
+ " \"test\": <test expression to be evaluated on incoming packets>,",
+ " \"option-data\": [ <option values here> ],",
+ " \"option-def\": [ <option defintions here> ],",
+ " \"next-server\": <ipv4 address>,",
+ " \"server-hostname\": <string>,",
+ " \"boot-file-name\": <name of the boot file>",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-class-update\"/>",
"hook": "class_cmds",
- "cmd-syntax": "{
- \"command\": \"class-update\",
- \"arguments\": {
- \"client-classes\": [ {
- \"name\": <name of the class>,
- \"test\": <test expression to be evaluated on incoming packets>,
- \"option-data\": [ <option values here> ],
- \"option-def\": [ <option defintions here> ],
- \"next-server\": <ipv4 address>,
- \"server-hostname\": <string>,
- \"boot-file-name\": <name of the boot file>
- } ]
- }
-}",
- "cmd-comment": "The <command>next-server</command>,
- <command>server-hostname</command> and
- <command>boot-file-name</command> are DHCPv4 specific. Only
- one client class can be updated with a single command. ",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"Class '<class-name>' updated.\",
-}",
- "resp-comment": "The command will return the result of 3 (empty) if the client
- class doesn't exist. If the client class exists, the retured
- result is 0 if the update was successful and the result is 1
- if the update is unsuccessful."
-}
+ "name": "class-update",
+ "resp-comment": [
+ "The command will return the result of 3 (empty) if the client",
+ " class doesn't exist. If the client class exists, the retured",
+ " result is 0 if the update was successful and the result is 1",
+ " if the update is unsuccessful."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Class '<class-name>' updated.\",",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "config-get",
- "brief": "Retrieves the current configuration used by the server. The configuration
- is roughtly equal to the configuration file, but includes additional
- changes made by other commands and due to parameters inheritance.",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
-
- "cmd-syntax": "{
- \"command\": \"config-get\"
-}",
- "cmd-comment": "This command takes no parameters.",
-
- "resp-syntax": "{
- \"result\": <integer>,
- \"arguments\": {
- <JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object>
- }
-}"
-}
+ "brief": [
+ "Retrieves the current configuration used by the server. The configuration",
+ " is roughtly equal to the configuration file, but includes additional",
+ " changes made by other commands and due to parameters inheritance."
+ ],
+ "cmd-comment": [
+ "This command takes no parameters."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"config-get\"",
+ "}"
+ ],
+ "name": "config-get",
+ "resp-syntax": [
+ "{",
+ " \"result\": <integer>,",
+ " \"arguments\": {",
+ " <JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object>",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
{
- "name": "config-reload",
- "brief": "The config-reload command instructs Kea to load again the configuration file that was used previously.",
- "description": "See <xref linkend=\"command-config-reload\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
- "cmd-syntax": "{
- \"command\": \"config-reload\"
-}"
-}
+ "brief": [
+ "The config-reload command instructs Kea to load again the configuration file that was used previously."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"config-reload\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-config-reload\"/>",
+ "name": "config-reload",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
{
- "name": "config-set",
- "brief": "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments.",
- "description": "See <xref linkend=\"command-config-set\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
- "cmd-syntax": "{
- \"command\": \"config-set\",
- \"arguments\": {
- \"<server>\": {
- }
- }
-}",
- "cmd-comment": "where <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
- "resp-syntax": " {\"result\": 0, \"text\": \"Configuration successful.\" }
-
- or
-
- {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
-}
+ "brief": [
+ "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments."
+ ],
+ "cmd-comment": [
+ "where <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"config-set\",",
+ " \"arguments\": {",
+ " \"<server>\": {",
+ " }",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-config-set\"/>",
+ "name": "config-set",
+ "resp-syntax": [
+ " {\"result\": 0, \"text\": \"Configuration successful.\" }",
+ "",
+ " or",
+ "",
+ " {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
{
- "name": "config-test",
- "brief": "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded.",
- "description": "See <xref linkend=\"command-config-test\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
- "cmd-syntax": "{
- \"command\": \"config-test\",
- \"arguments\": {
- \"<server>\": {
- }
- }
-}",
- "cmd-comment": "where >server< is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
- "resp-syntax": "{\"result\": 0, \"text\": \"Configuration seems sane...\" }
-
- or
-
- {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
-}
+ "brief": [
+ "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded."
+ ],
+ "cmd-comment": [
+ "where >server< is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"config-test\",",
+ " \"arguments\": {",
+ " \"<server>\": {",
+ " }",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-config-test\"/>",
+ "name": "config-test",
+ "resp-syntax": [
+ "{\"result\": 0, \"text\": \"Configuration seems sane...\" }",
+ "",
+ " or",
+ "",
+ " {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
{
- "name": "config-write",
- "brief": "The config-write command instructs the Kea server to write its
- current configuration to a file on disk.",
- "description": "See <xref linkend=\"command-config-write\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
- "cmd-syntax": "{
- \"command\": \"config-write\",
- \"arguments\": {
- \"filename\": \"config-modified-2017-03-15.json\"
- }
-}"
-}
+ "brief": [
+ "The config-write command instructs the Kea server to write its",
+ " current configuration to a file on disk."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"config-write\",",
+ " \"arguments\": {",
+ " \"filename\": \"config-modified-2017-03-15.json\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-config-write\"/>",
+ "name": "config-write",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
{
- "name": "dhcp-disable",
- "brief": "The dhcp-disable command globally disables the DHCP service.",
- "description": "See <xref linkend=\"command-dhcp-disable\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
- "cmd-syntax": "{
- \"command\": \"dhcp-disable\",
- \"arguments\": {
- \"max-period\": 20
- }
-}"
-}
+ "brief": [
+ "The dhcp-disable command globally disables the DHCP service."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"dhcp-disable\",",
+ " \"arguments\": {",
+ " \"max-period\": 20",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-dhcp-disable\"/>",
+ "name": "dhcp-disable",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "dhcp-enable",
- "brief": "The dhcp-enable command globally enables the DHCP service.",
- "description": "See <xref linkend=\"command-dhcp-enable\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
- "cmd-syntax": "{
- \"command\": \"dhcp-enable\"
-}"
-}
+ "brief": [
+ "The dhcp-enable command globally enables the DHCP service."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"dhcp-enable\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-dhcp-enable\"/>",
+ "name": "dhcp-enable",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "ha-continue",
- "brief": "This command is used to resume the operation of the paused HA state machine.",
- "description": "See <xref linkend=\"anchor-in-the-docs\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
- "hook": "high_availability"
-}
+ "brief": [
+ "This command is used to resume the operation of the paused HA state machine."
+ ],
+ "description": "See <xref linkend=\"anchor-in-the-docs\"/>",
+ "hook": "high_availability",
+ "name": "ha-continue",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "ha-heartbeat",
- "brief": "This command is sent internally by Kea partner when operating
- in High Availability (HA) mode. It will retrieve the server HA state and clock value.",
- "description": "See <xref linkend=\"ha-server-states\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "This command is sent internally by Kea partner when operating",
+ " in High Availability (HA) mode. It will retrieve the server HA state and clock value."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"ha-heartbeat\",",
+ " }"
+ ],
+ "description": "See <xref linkend=\"ha-server-states\"/>",
"hook": "high_availability",
- "cmd-syntax": "{
- \"command\": \"ha-heartbeat\",
- }",
- "resp-comment": "The response to this command is different from the typical command response. The response will include server state (see <xref linkend=\"ha-server-states\"/> plus the current clock value."
-}
+ "name": "ha-heartbeat",
+ "resp-comment": [
+ "The response to this command is different from the typical command response. The response will include server state (see <xref linkend=\"ha-server-states\"/> plus the current clock value."
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "ha-scopes",
- "brief": "This command modifies the scope that the server is responsible for serving when operating in High Availability (HA) mode.",
- "description": "See <xref linkend=\"command-ha-scopes\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "This command modifies the scope that the server is responsible for serving when operating in High Availability (HA) mode."
+ ],
+ "cmd-comment": [
+ "In the example given, the arguments configure the server to handle traffic from both HA_server1 and HA_server2 scopes."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"ha-scopes\",",
+ " \"service\": [ <service, typically \"dhcp4\" or \"dhcp6\"> ],",
+ " \"arguments\": {",
+ " \"scopes\": [ \"HA_server1\", \"HA_server2\" ]",
+ " }"
+ ],
+ "description": "See <xref linkend=\"command-ha-scopes\"/>",
"hook": "high_availability",
- "cmd-syntax": "{
- \"command\": \"ha-scopes\",
- \"service\": [ <service, typically \"dhcp4\" or \"dhcp6\"> ],
- \"arguments\": {
- \"scopes\": [ \"HA_server1\", \"HA_server2\" ]
- }",
- "cmd-comment": "In the example given, the arguments configure the server to handle traffic from both HA_server1 and HA_server2 scopes."
-}
+ "name": "ha-scopes",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "ha-sync",
- "brief": "The command is issued to instruct the server running in HA mode to
- synchronize its local lease database with the selected peer.",
- "description": "See <xref linkend=\"command-ha-sync\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "The command is issued to instruct the server running in HA mode to ",
+ " synchronize its local lease database with the selected peer."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"ha-sync\",",
+ " \"service\": [ <service affected: \"dhcp4\" or \"dhcp6\" ],",
+ " \"arguments\": {",
+ " \"server-name\": <name of the partner server>,",
+ " \"max-period\": <integer, in seconds>",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-ha-sync\"/>",
"hook": "high_availability",
- "cmd-syntax": "{
- \"command\": \"ha-sync\",
- \"service\": [ <service affected: \"dhcp4\" or \"dhcp6\" ],
- \"arguments\": {
- \"server-name\": <name of the partner server>,
- \"max-period\": <integer, in seconds>
- }
-}"
-}
+ "name": "ha-sync",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "lease4-add",
- "brief": "The lease4-add command adds a new IPv4 lease administratively.",
- "description": "See <xref linkend=\"idp64\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "The lease4-add command adds a new IPv4 lease administratively."
+ ],
+ "cmd-comment": [
+ "Note that Kea 1.4 requires an additional argument, subnet-ID, which is optional as of Kea 1.5. A number of other more detailed optional arguments are also supported."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-add\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"192.0.2.202\",",
+ " \"hw-address\": \"1a:1b:1c:1d:1e:1f\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp64\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease4-add\",
- \"arguments\": {
- \"ip-address\": \"192.0.2.202\",
- \"hw-address\": \"1a:1b:1c:1d:1e:1f\"
- }
-}",
- "cmd-comment": "Note that Kea 1.4 requires an additional argument, subnet-ID, which is optional as of Kea 1.5. A number of other more detailed optional arguments are also supported."
-}
+ "name": "lease4-add",
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "lease4-del",
- "brief": "lease4-del can be used to delete a lease from the lease database.",
- "description": "See <xref linkend=\"command-lease4-del\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "lease4-del can be used to delete a lease from the lease database."
+ ],
+ "cmd-comment": [
+ "Specify the lease to be deleted either by IP address, or by identifier-type and identifier value. Currently supported identifiers are \"hw-address\" and \"client-id\"."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-del\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"192.0.2.202\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-lease4-del\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease4-del\",
- \"arguments\": {
- \"ip-address\": \"192.0.2.202\"
- }
-}",
- "cmd-comment": "Specify the lease to be deleted either by IP address, or by identifier-type and identifier value. Currently supported identifiers are \"hw-address\" and \"client-id\"."
+ "name": "lease4-del",
+ "support": [
+ "kea-dhcp4"
+ ]
}
\ No newline at end of file
{
- "name": "lease4-get-all",
- "brief": "lease4-get-all is used to retrieve all IPv4 leases or all leases for the specified set of subnets.",
- "description": "See <xref linkend=\"idp59\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.4.0",
+ "brief": [
+ "lease4-get-all is used to retrieve all IPv4 leases or all leases for the specified set of subnets."
+ ],
+ "cmd-comment": [
+ "The lease4-get-all command may result in very large responses."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-get-all\"",
+ " \"arguments\": \"subnets\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp59\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease4-get-all\"
- \"arguments\": \"subnets\"
-}",
- "cmd-comment": "The lease4-get-all command may result in very large responses."
-}
+ "name": "lease4-get-all",
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "lease4-get",
- "brief": "lease4-get can be used to query the lease database and retrieve existing leases.",
- "description": "See <xref linkend=\"idp58\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "lease4-get can be used to query the lease database and retrieve existing leases."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-get\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"192.0.2.1\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp58\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease4-get\",
- \"arguments\": {
- \"ip-address\": \"192.0.2.1\"
- }
-}",
- "resp-syntax": "{
- \"arguments\": {
- \"client-id\": \"42:42:42:42:42:42:42:42\",
- \"cltt\": 12345678,
- \"fqdn-fwd\": false,
- \"fqdn-rev\": true,
- \"hostname\": \"myhost.example.com.\",
- \"hw-address\": \"08:08:08:08:08:08\",
- \"ip-address\": \"192.0.2.1\",
- \"state\": 0,
- \"subnet-id\": 44,
- \"valid-lft\": 3600
- },
- \"result\": 0,
- \"text\": \"IPv4 lease found.\"
-}",
- "resp-comment": "lease4-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
-}
+ "name": "lease4-get",
+ "resp-comment": [
+ "lease4-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"arguments\": {",
+ " \"client-id\": \"42:42:42:42:42:42:42:42\",",
+ " \"cltt\": 12345678,",
+ " \"fqdn-fwd\": false,",
+ " \"fqdn-rev\": true,",
+ " \"hostname\": \"myhost.example.com.\",",
+ " \"hw-address\": \"08:08:08:08:08:08\",",
+ " \"ip-address\": \"192.0.2.1\",",
+ " \"state\": 0,",
+ " \"subnet-id\": 44,",
+ " \"valid-lft\": 3600",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 lease found.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "lease4-update",
- "brief": "The lease4-update command can be used to update existing leases.",
- "description": "See <xref linkend=\"idp62\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "The lease4-update command can be used to update existing leases."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-update\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"192.0.2.1\",",
+ " \"hostname\": \"newhostname.example.org\",",
+ " \"hw-address\": \"1a:1b:1c:1d:1e:1f\",",
+ " \"subnet-id\": 44,",
+ " \"force-create\": true",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp62\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease4-update\",
- \"arguments\": {
- \"ip-address\": \"192.0.2.1\",
- \"hostname\": \"newhostname.example.org\",
- \"hw-address\": \"1a:1b:1c:1d:1e:1f\",
- \"subnet-id\": 44,
- \"force-create\": true
- }
-}"
-}
+ "name": "lease4-update",
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "lease4-wipe",
- "brief": "lease4-wipe is designed to remove all leases associated with a given subnet.",
- "description": "See <xref linkend=\"idp63\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "lease4-wipe is designed to remove all leases associated with a given subnet."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-wipe\",",
+ " \"arguments\": {",
+ " \"subnet-id\": 44",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp63\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease4-wipe\",
- \"arguments\": {
- \"subnet-id\": 44
- }
-}"
-}
+ "name": "lease4-wipe",
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "lease6-add",
- "brief": "The lease6-add command creates a new lease administratively.",
- "description": "See <xref linkend=\"idp64\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "The lease6-add command creates a new lease administratively."
+ ],
+ "cmd-comment": [
+ "lease6-add can be also used to add leases for IPv6 prefixes.."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-add\",",
+ " \"arguments\": {",
+ " \"subnet-id\": 66,",
+ " \"ip-address\": \"2001:db8::3\",",
+ " \"duid\": \"1a:1b:1c:1d:1e:1f:20:21:22:23:24\",",
+ " \"iaid\": 1234",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp64\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease6-add\",
- \"arguments\": {
- \"subnet-id\": 66,
- \"ip-address\": \"2001:db8::3\",
- \"duid\": \"1a:1b:1c:1d:1e:1f:20:21:22:23:24\",
- \"iaid\": 1234
- }
-}",
- "cmd-comment": "lease6-add can be also used to add leases for IPv6 prefixes..",
- "resp-syntax": "{ \"result\": 0, \"text\": \"Lease added.\" }
- { \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
-}
+ "name": "lease6-add",
+ "resp-syntax": [
+ "{ \"result\": 0, \"text\": \"Lease added.\" }",
+ " { \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "lease6-bulk-apply",
- "brief": "The lease6-bulk-apply command can be used to create, update and delete multiple IPv6 leases in a single transaction. This is used to communicate lease changes between the HA peers but may be used in all cases when it is desired to apply multiple lease updates in a single transaction.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "The lease6-bulk-apply command can be used to create, update and delete multiple IPv6 leases in a single transaction. This is used to communicate lease changes between the HA peers but may be used in all cases when it is desired to apply multiple lease updates in a single transaction."
+ ],
+ "cmd-comment": [
+ "If any of the leases is malformed, all changes are rolled back. If the leases are well formed but the operation fails for one or more leases, the these leases are listed in the response but the changes are preserved for all leases for which the operation was successful. The \"deleted-leases\" and \"leases\" are optional parameters but one of them must be specified."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-bulk-apply\",",
+ " \"arguments\": {",
+ " \"deleted-leases\": [",
+ " {",
+ " \"ip-address\": \"2001:db8:abcd::\",",
+ " \"type\": \"IA_PD\",",
+ " ...",
+ " },",
+ " {",
+ " \"ip-address\": \"2001:db8:abcd::234\",",
+ " \"type\": \"IA_NA\",",
+ " ...",
+ " }",
+ " ],",
+ " \"leases\": [",
+ " {",
+ " \"subnet-id\": 66,",
+ " \"ip-address\": \"2001:db8:cafe::\",",
+ " \"type\": \"IA_PD\",",
+ " ...",
+ " },",
+ " {",
+ " \"subnet-id\": 66,",
+ " \"ip-address\": \"2001:db8:abcd::333\",",
+ " \"type\": \"IA_NA\",",
+ " ...",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease6-bulk-apply\",
- \"arguments\": {
- \"deleted-leases\": [
- {
- \"ip-address\": \"2001:db8:abcd::\",
- \"type\": \"IA_PD\",
- ...
- },
- {
- \"ip-address\": \"2001:db8:abcd::234\",
- \"type\": \"IA_NA\",
- ...
- }
- ],
- \"leases\": [
- {
- \"subnet-id\": 66,
- \"ip-address\": \"2001:db8:cafe::\",
- \"type\": \"IA_PD\",
- ...
- },
- {
- \"subnet-id\": 66,
- \"ip-address\": \"2001:db8:abcd::333\",
- \"type\": \"IA_NA\",
- ...
- }
- ]
- }
-}",
- "cmd-comment": "If any of the leases is malformed, all changes are rolled back. If the leases are well formed but the operation fails for one or more leases, the these leases are listed in the response but the changes are preserved for all leases for which the operation was successful. The \"deleted-leases\" and \"leases\" are optional parameters but one of them must be specified.",
- "resp-syntax": " {
- {
- \"result\": 0,
- \"text\": IPv6 leases bulk apply completed.
- \"arguments\": {
- \"failed-deleted-leases\": [
- {
- \"ip-address\": \"2001:db8:abcd::\",
- \"type\": \"IA_PD\",
- \"result\": <control result>,
- \"error-message\": <error message>
- }
- ],
- \"failed-leases\": [
- {
- \"ip-address\": \"2001:db8:cafe::\",
- \"type\": \"IA_PD\",
- \"result\" <control result>,
- \"error-message\": <error message>
- }
- ]
- }
- }
-}",
- "resp-comment": "The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error while processing the lease, inserting it into the database etc. the result is set to 1. For each lease which was not deleted because the server didn't find it in the database the result of 3 is returned."
-}
+ "name": "lease6-bulk-apply",
+ "resp-comment": [
+ "The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error while processing the lease, inserting it into the database etc. the result is set to 1. For each lease which was not deleted because the server didn't find it in the database the result of 3 is returned."
+ ],
+ "resp-syntax": [
+ " {",
+ " {",
+ " \"result\": 0,",
+ " \"text\": IPv6 leases bulk apply completed.",
+ " \"arguments\": {",
+ " \"failed-deleted-leases\": [",
+ " {",
+ " \"ip-address\": \"2001:db8:abcd::\",",
+ " \"type\": \"IA_PD\",",
+ " \"result\": <control result>,",
+ " \"error-message\": <error message>",
+ " }",
+ " ],",
+ " \"failed-leases\": [",
+ " {",
+ " \"ip-address\": \"2001:db8:cafe::\",",
+ " \"type\": \"IA_PD\",",
+ " \"result\" <control result>,",
+ " \"error-message\": <error message>",
+ " }",
+ " ]",
+ " }",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "lease6-del",
- "brief": "lease6-del can be used to delete a lease from the lease database.",
- "description": "See <xref linkend=\"lease6-del\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "lease6-del can be used to delete a lease from the lease database."
+ ],
+ "cmd-comment": [
+ "lease6-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty)."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-del\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"192.0.2.202\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"lease6-del\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease6-del\",
- \"arguments\": {
- \"ip-address\": \"192.0.2.202\"
- }
-}",
- "cmd-comment": "lease6-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty)."
-}
+ "name": "lease6-del",
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "lease6-get-all",
- "brief": "lease6-get-all is used to retrieve all IPv6 leases or all leases for the specified set of subnets.",
- "description": "See <xref linkend=\"idp59\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "lease6-get-all is used to retrieve all IPv6 leases or all leases for the specified set of subnets."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-get-all\",",
+ " \"arguments\": {",
+ " \"subnets\": [ 1, 2, 3, 4 ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp59\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease6-get-all\",
- \"arguments\": {
- \"subnets\": [ 1, 2, 3, 4 ]
- }
-}",
- "resp-syntax": "{
- \"arguments\": {
- \"leases\": [
- {
- \"cltt\": 12345678,
- \"duid\": \"42:42:42:42:42:42:42:42\",
- \"fqdn-fwd\": false,
- \"fqdn-rev\": true,
- \"hostname\": \"myhost.example.com.\",
- \"hw-address\": \"08:08:08:08:08:08\",
- \"iaid\": 1,
- \"ip-address\": \"2001:db8:2::1\",
- \"preferred-lft\": 500,
- \"state\": 0,
- \"subnet-id\": 44,
- \"type\": \"IA_NA\",
- \"valid-lft\": 3600
- },
- {
- \"cltt\": 12345678,
- \"duid\": \"21:21:21:21:21:21:21:21\",
- \"fqdn-fwd\": false,
- \"fqdn-rev\": true,
- \"hostname\": \"\",
- \"iaid\": 1,
- \"ip-address\": \"2001:db8:0:0:2::\",
- \"preferred-lft\": 500,
- \"prefix-len\": 80,
- \"state\": 0,
- \"subnet-id\": 44,
- \"type\": \"IA_PD\",
- \"valid-lft\": 3600
- }
- ]
- },
- \"result\": 0,
- \"text\": \"2 IPv6 lease(s) found.\"
-}",
- "resp-comment": "The lease6-get-all command may result in very large responses."
+ "name": "lease6-get-all",
+ "resp-comment": [
+ "The lease6-get-all command may result in very large responses."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"arguments\": {",
+ " \"leases\": [",
+ " {",
+ " \"cltt\": 12345678,",
+ " \"duid\": \"42:42:42:42:42:42:42:42\",",
+ " \"fqdn-fwd\": false,",
+ " \"fqdn-rev\": true,",
+ " \"hostname\": \"myhost.example.com.\",",
+ " \"hw-address\": \"08:08:08:08:08:08\",",
+ " \"iaid\": 1,",
+ " \"ip-address\": \"2001:db8:2::1\",",
+ " \"preferred-lft\": 500,",
+ " \"state\": 0,",
+ " \"subnet-id\": 44,",
+ " \"type\": \"IA_NA\",",
+ " \"valid-lft\": 3600",
+ " },",
+ " {",
+ " \"cltt\": 12345678,",
+ " \"duid\": \"21:21:21:21:21:21:21:21\",",
+ " \"fqdn-fwd\": false,",
+ " \"fqdn-rev\": true,",
+ " \"hostname\": \"\",",
+ " \"iaid\": 1,",
+ " \"ip-address\": \"2001:db8:0:0:2::\",",
+ " \"preferred-lft\": 500,",
+ " \"prefix-len\": 80,",
+ " \"state\": 0,",
+ " \"subnet-id\": 44,",
+ " \"type\": \"IA_PD\",",
+ " \"valid-lft\": 3600",
+ " }",
+ " ]",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv6 lease(s) found.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
}
\ No newline at end of file
{
- "name": "lease6-get",
- "brief": "lease6-get can be used to query the lease database and retrieve existing leases.",
- "description": "See <xref linkend=\"idp58\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "lease6-get can be used to query the lease database and retrieve existing leases."
+ ],
+ "cmd-comment": [
+ "lease6-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-get\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"2001:db8:1234:ab::\",",
+ " \"type\": \"IA_PD\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp58\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease6-get\",
- \"arguments\": {
- \"ip-address\": \"2001:db8:1234:ab::\",
- \"type\": \"IA_PD\"
- }
-}",
- "cmd-comment": "lease6-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
+ "name": "lease6-get",
+ "support": [
+ "kea-dhcp6"
+ ]
}
\ No newline at end of file
{
- "name": "lease6-update",
- "brief": "The lease6-update command can be used to update existing leases.",
- "description": "See <xref linkend=\"idp62\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "The lease6-update command can be used to update existing leases."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-update\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"2001:db8::1\",",
+ " \"duid\": \"88:88:88:88:88:88:88:88\",",
+ " \"iaid\": 7654321,",
+ " \"hostname\": \"newhostname.example.org\",",
+ " \"subnet-id\": 66,",
+ " \"force-create\": false",
+ " }",
+ "}",
+ ""
+ ],
+ "description": "See <xref linkend=\"idp62\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease6-update\",
- \"arguments\": {
- \"ip-address\": \"2001:db8::1\",
- \"duid\": \"88:88:88:88:88:88:88:88\",
- \"iaid\": 7654321,
- \"hostname\": \"newhostname.example.org\",
- \"subnet-id\": 66,
- \"force-create\": false
- }
-}
-"
-}
+ "name": "lease6-update",
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "lease6-wipe",
- "brief": "lease6-wipe is designed to remove all leases associated with a given subnet.",
- "description": "See <xref linkend=\"idp63\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "lease6-wipe is designed to remove all leases associated with a given subnet."
+ ],
+ "cmd-comment": [
+ "Note: not all backends support this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-wipe\",",
+ " \"arguments\": {",
+ " \"subnet-id\": 66",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp63\"/>",
"hook": "lease_cmds",
- "cmd-syntax": "{
- \"command\": \"lease6-wipe\",
- \"arguments\": {
- \"subnet-id\": 66
- }
-}",
- "cmd-comment": "Note: not all backends support this command."
-}
+ "name": "lease6-wipe",
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "leases-reclaim",
- "brief": "The leases-reclaim command instructs the server to reclaim all expired leases immediately.",
- "description": "See <xref linkend=\"command-leases-reclaim\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"leases-reclaim\",
- \"arguments\": {
- \"remove\": true
- }
-}"
-}
+ "brief": [
+ "The leases-reclaim command instructs the server to reclaim all expired leases immediately."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"leases-reclaim\",",
+ " \"arguments\": {",
+ " \"remove\": true",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-leases-reclaim\"/>",
+ "name": "leases-reclaim",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "libreload",
- "brief": "The libreload command will first unload and then load all currently loaded hook libraries.",
- "description": "See <xref linkend=\"command-libreload\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.2.0",
- "cmd-syntax": "{
- \"command\": \"libreload\",
- \"arguments\": { }
-}",
- "cmd-comment": "The server will respond with a result of 0 indicating success, or 1 indicating a failure."
-}
+ "brief": [
+ "The libreload command will first unload and then load all currently loaded hook libraries."
+ ],
+ "cmd-comment": [
+ "The server will respond with a result of 0 indicating success, or 1 indicating a failure."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"libreload\",",
+ " \"arguments\": { }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-libreload\"/>",
+ "name": "libreload",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "list-commands",
- "brief": "The list-commands command retrieves a list of all commands supported by the server.",
- "description": "See <xref linkend=\"command-list-commands\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"list-commands\",
- \"arguments\": { }
-}",
- "cmd-comment": "The server will respond with a list of all supported commands."
-}
+ "brief": [
+ "The list-commands command retrieves a list of all commands supported by the server."
+ ],
+ "cmd-comment": [
+ "The server will respond with a list of all supported commands."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"list-commands\",",
+ " \"arguments\": { }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-list-commands\"/>",
+ "name": "list-commands",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
{
- "name": "network4-add",
- "brief": "The network4-add command is used to add a new shared network.",
- "description": "See <xref linkend=\"idp75\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "The network4-add command is used to add a new shared network."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-add\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [ {",
+ " \"name\": \"floor13\",",
+ " \"subnet4\": [",
+ " {",
+ " \"id\": 100,",
+ " \"pools\": [ { \"pool\": \"192.0.2.2-192.0.2.99\" } ],",
+ " \"subnet\": \"192.0.2.0/24\",",
+ " \"option-data\": [",
+ " {",
+ " \"name\": \"routers\",",
+ " \"data\": \"192.0.2.1\"",
+ " }",
+ " ]",
+ " },",
+ " {",
+ " \"id\": 101,",
+ " \"pools\": [ { \"pool\": \"192.0.3.2-192.0.3.99\" } ],",
+ " \"subnet\": \"192.0.3.0/24\",",
+ " \"option-data\": [",
+ " {",
+ " \"name\": \"routers\",",
+ " \"data\": \"192.0.3.1\"",
+ " }",
+ " ]",
+ " } ]",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp75\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-add\",
- \"arguments\": {
- \"shared-networks\": [ {
- \"name\": \"floor13\",
- \"subnet4\": [
- {
- \"id\": 100,
- \"pools\": [ { \"pool\": \"192.0.2.2-192.0.2.99\" } ],
- \"subnet\": \"192.0.2.0/24\",
- \"option-data\": [
- {
- \"name\": \"routers\",
- \"data\": \"192.0.2.1\"
- }
- ]
- },
- {
- \"id\": 101,
- \"pools\": [ { \"pool\": \"192.0.3.2-192.0.3.99\" } ],
- \"subnet\": \"192.0.3.0/24\",
- \"option-data\": [
- {
- \"name\": \"routers\",
- \"data\": \"192.0.3.1\"
- }
- ]
- } ]
- } ]
- }
-}",
- "resp-syntax": "{
- \"arguments\": {
- \"shared-networks\": [ { \"name\": \"floor13\" } ]
- },
- \"result\": 0,
- \"text\": \"A new IPv4 shared network 'floor13' added\"
-}"
-}
+ "name": "network4-add",
+ "resp-syntax": [
+ "{",
+ " \"arguments\": {",
+ " \"shared-networks\": [ { \"name\": \"floor13\" } ]",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"A new IPv4 shared network 'floor13' added\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "network4-del",
- "brief": "The network4-del command is used to delete existing shared networks.",
- "description": "See <xref linkend=\"idp76\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "The network4-del command is used to delete existing shared networks."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-del\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp76\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-del\",
- \"arguments\": {
- \"name\": \"floor13\"
- }
-}",
- "resp-syntax": "{
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": \"floor13\"
- }
- ]
- },
- \"result\": 0,
- \"text\": \"IPv4 shared network 'floor13' deleted\"
-}"
-}
+ "name": "network4-del",
+ "resp-syntax": [
+ "{",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": \"floor13\"",
+ " }",
+ " ]",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 shared network 'floor13' deleted\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "network4-get",
- "brief": "The network4-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network.",
- "description": "See <xref linkend=\"idp74\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "The network4-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-get\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp74\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-get\",
- \"arguments\": {
- \"name\": \"floor13\"
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"Info about IPv4 shared network 'floor13' returned\",
- \"arguments\": {
- \"shared-networks\": [
- {
- \"match-client-id\": true,
- \"name\": \"floor13\",
- \"option-data\": [ ],
- \"rebind-timer\": 90,
- \"relay\": {
- \"ip-address\": \"0.0.0.0\"
- },
- \"renew-timer\": 60,
- \"reservation-mode\": \"all\",
- \"subnet4\": [
- {
- \"subnet\": \"192.0.2.0/24\",
- \"id\": 5,
- // many other subnet specific details here
- },
- {
- \"id\": 6,
- \"subnet\": \"192.0.3.0/31\",
- // many other subnet specific details here
- }
- ],
- \"valid-lifetime\": 120
- }
- ]
- }
-}",
- "resp-comment": "Note that the actual response contains many additional fields that are omitted here for clarity."
-}
+ "name": "network4-get",
+ "resp-comment": [
+ "Note that the actual response contains many additional fields that are omitted here for clarity."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Info about IPv4 shared network 'floor13' returned\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"match-client-id\": true,",
+ " \"name\": \"floor13\",",
+ " \"option-data\": [ ],",
+ " \"rebind-timer\": 90,",
+ " \"relay\": {",
+ " \"ip-address\": \"0.0.0.0\"",
+ " },",
+ " \"renew-timer\": 60,",
+ " \"reservation-mode\": \"all\",",
+ " \"subnet4\": [",
+ " {",
+ " \"subnet\": \"192.0.2.0/24\",",
+ " \"id\": 5,",
+ " // many other subnet specific details here",
+ " },",
+ " {",
+ " \"id\": 6,",
+ " \"subnet\": \"192.0.3.0/31\",",
+ " // many other subnet specific details here",
+ " }",
+ " ],",
+ " \"valid-lifetime\": 120",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "network4-list",
- "brief": "The network4-list command is used to retrieve full list of currently configured shared networks.",
- "description": "See <xref linkend=\"command-networkX-list\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "The network4-list command is used to retrieve full list of currently configured shared networks."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-list\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-networkX-list\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-list\"
-}",
- "resp-syntax": "{
- \"arguments\": {
- \"shared-networks\": [
- { \"name\": \"floor1\" },
- { \"name\": \"office\" }
- ]
- },
- \"result\": 0,
- \"text\": \"2 IPv4 network(s) found\"
-}"
-}
+ "name": "network4-list",
+ "resp-syntax": [
+ "{",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " { \"name\": \"floor1\" },",
+ " { \"name\": \"office\" }",
+ " ]",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv4 network(s) found\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "network4-subnet-add",
- "brief": "The network4-subnet-add command is used to add existing subnets to existing shared networks.",
- "description": "See <xref linkend=\"idp77\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "The network4-subnet-add command is used to add existing subnets to existing shared networks."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-subnet-add\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\",",
+ " \"id\": 5",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp77\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-subnet-add\",
- \"arguments\": {
- \"name\": \"floor13\",
- \"id\": 5
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'\"
-}"
-}
+ "name": "network4-subnet-add",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "network4-subnet-del",
- "brief": "The network4-subnet-del command is used to remove a subnet that is part of an existing shared network and demote it to a plain, stand-alone subnet.",
- "description": "See <xref linkend=\"idp78\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "The network4-subnet-del command is used to remove a subnet that is part of an existing shared network and demote it to a plain, stand-alone subnet."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-subnet-del\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\",",
+ " \"id\": 5",
+ " }",
+ " }"
+ ],
+ "description": "See <xref linkend=\"idp78\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-subnet-del\",
- \"arguments\": {
- \"name\": \"floor13\",
- \"id\": 5
- }
- }",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'\"
-}"
-}
+ "name": "network4-subnet-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "network6-add",
- "brief": "The network6-add command is used to add a new shared network.",
- "description": "See <xref linkend=\"idp75\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "The network6-add command is used to add a new shared network."
+ ],
+ "cmd-comment": [
+ "The network6-add uses the same syntax for both the query and the response. However, there are some parameters that are IPv4-only (e.g. match-client-id) and some are IPv6-only (e.g. interface-id)."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-add\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [ {",
+ " \"name\": \"floor13\",",
+ " \"subnet4\": [",
+ " {",
+ " \"id\": 100,",
+ " \"pools\": [ { \"pool\": \"192.0.2.2-192.0.2.99\" } ],",
+ " \"subnet\": \"192.0.2.0/24\",",
+ " \"option-data\": [",
+ " {",
+ " \"name\": \"routers\",",
+ " \"data\": \"192.0.2.1\"",
+ " }",
+ " ]",
+ " },",
+ " {",
+ " \"id\": 101,",
+ " \"pools\": [ { \"pool\": \"192.0.3.2-192.0.3.99\" } ],",
+ " \"subnet\": \"192.0.3.0/24\",",
+ " \"option-data\": [",
+ " {",
+ " \"name\": \"routers\",",
+ " \"data\": \"192.0.3.1\"",
+ " }",
+ " ]",
+ " } ]",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp75\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-add\",
- \"arguments\": {
- \"shared-networks\": [ {
- \"name\": \"floor13\",
- \"subnet4\": [
- {
- \"id\": 100,
- \"pools\": [ { \"pool\": \"192.0.2.2-192.0.2.99\" } ],
- \"subnet\": \"192.0.2.0/24\",
- \"option-data\": [
- {
- \"name\": \"routers\",
- \"data\": \"192.0.2.1\"
- }
- ]
- },
- {
- \"id\": 101,
- \"pools\": [ { \"pool\": \"192.0.3.2-192.0.3.99\" } ],
- \"subnet\": \"192.0.3.0/24\",
- \"option-data\": [
- {
- \"name\": \"routers\",
- \"data\": \"192.0.3.1\"
- }
- ]
- } ]
- } ]
- }
-}",
- "cmd-comment": "The network6-add uses the same syntax for both the query and the response. However, there are some parameters that are IPv4-only (e.g. match-client-id) and some are IPv6-only (e.g. interface-id).",
- "resp-syntax": "{
- \"arguments\": {
- \"shared-networks\": [ { \"name\": \"floor13\" } ]
- },
- \"result\": 0,
- \"text\": \"A new IPv4 shared network 'floor13' added\"
-}"
-}
+ "name": "network6-add",
+ "resp-syntax": [
+ "{",
+ " \"arguments\": {",
+ " \"shared-networks\": [ { \"name\": \"floor13\" } ]",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"A new IPv4 shared network 'floor13' added\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "network6-del",
- "brief": "The network6-del command is used to delete existing shared networks.",
- "description": "See <xref linkend=\"command-network6-del\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "The network6-del command is used to delete existing shared networks."
+ ],
+ "cmd-comment": [
+ "The network6-del command uses exactly the same syntax for",
+ " both the command and the response."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-del\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-network6-del\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-del\",
- \"arguments\": {
- \"name\": \"floor13\"
- }
-}",
- "cmd-comment": "The network6-del command uses exactly the same syntax for
- both the command and the response.",
- "resp-syntax": "{
- \"command\": \"network4-del\",
- \"arguments\": {
- \"name\": \"floor13\",
- \"subnets-action\": \"delete\"
- }
-}"
-}
+ "name": "network6-del",
+ "resp-syntax": [
+ "{",
+ " \"command\": \"network4-del\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\",",
+ " \"subnets-action\": \"delete\"",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "network6-get",
- "brief": "The network6-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network.",
- "description": "See <xref linkend=\"idp74\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "The network6-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-get\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp74\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-get\",
- \"arguments\": {
- \"name\": \"floor13\"
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"Info about IPv4 shared network 'floor13' returned\",
- \"arguments\": {
- \"shared-networks\": [
- {
- \"match-client-id\": true,
- \"name\": \"floor13\",
- \"option-data\": [ ],
- \"rebind-timer\": 90,
- \"relay\": {
- \"ip-address\": \"0.0.0.0\"
- },
- \"renew-timer\": 60,
- \"reservation-mode\": \"all\",
- \"subnet4\": [
- {
- \"subnet\": \"192.0.2.0/24\",
- \"id\": 5,
- // many other subnet specific details here
- },
- {
- \"id\": 6,
- \"subnet\": \"192.0.3.0/31\",
- // many other subnet specific details here
- }
- ],
- \"valid-lifetime\": 120
- }
- ]
- }
-}",
- "resp-comment": "Note that the actual response contains many additional fields that are omitted here for clarity."
-}
+ "name": "network6-get",
+ "resp-comment": [
+ "Note that the actual response contains many additional fields that are omitted here for clarity."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Info about IPv4 shared network 'floor13' returned\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"match-client-id\": true,",
+ " \"name\": \"floor13\",",
+ " \"option-data\": [ ],",
+ " \"rebind-timer\": 90,",
+ " \"relay\": {",
+ " \"ip-address\": \"0.0.0.0\"",
+ " },",
+ " \"renew-timer\": 60,",
+ " \"reservation-mode\": \"all\",",
+ " \"subnet4\": [",
+ " {",
+ " \"subnet\": \"192.0.2.0/24\",",
+ " \"id\": 5,",
+ " // many other subnet specific details here",
+ " },",
+ " {",
+ " \"id\": 6,",
+ " \"subnet\": \"192.0.3.0/31\",",
+ " // many other subnet specific details here",
+ " }",
+ " ],",
+ " \"valid-lifetime\": 120",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "network6-list",
- "brief": "The network6-list command is used to retrieve full list of currently configured shared networks.",
- "description": "See <xref linkend=\"command-networkX-list\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "The network6-list command is used to retrieve full list of currently configured shared networks."
+ ],
+ "cmd-comment": [
+ "network6-list follows exactly the same syntax for both the query and the response."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-list\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-networkX-list\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-list\"
-}",
- "cmd-comment": "network6-list follows exactly the same syntax for both the query and the response.",
- "resp-syntax": "{
- \"arguments\": {
- \"shared-networks\": [
- { \"name\": \"floor1\" },
- { \"name\": \"office\" }
- ]
- },
- \"result\": 0,
- \"text\": \"2 IPv4 network(s) found\"
-}"
-}
+ "name": "network6-list",
+ "resp-syntax": [
+ "{",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " { \"name\": \"floor1\" },",
+ " { \"name\": \"office\" }",
+ " ]",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv4 network(s) found\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "network6-subnet-add",
- "brief": "The network6-subnet-add command is used to add existing subnets to existing shared networks.",
- "description": "See <xref linkend=\"idp77\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "The network6-subnet-add command is used to add existing subnets to existing shared networks."
+ ],
+ "cmd-comment": [
+ "The network6-subnet-add command uses exactly the same syntax for both the command and the response."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-subnet-add\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\",",
+ " \"id\": 5",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp77\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-subnet-add\",
- \"arguments\": {
- \"name\": \"floor13\",
- \"id\": 5
- }
-}",
- "cmd-comment": "The network6-subnet-add command uses exactly the same syntax for both the command and the response.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'\"
-}"
-}
+ "name": "network6-subnet-add",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "network6-subnet-del",
- "brief": "The network6-subnet-del command is used to remove a subnet that is part of existing shared network and demote it to a plain, stand-alone subnet.",
- "description": "See <xref linkend=\"idp78\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "The network6-subnet-del command is used to remove a subnet that is part of existing shared network and demote it to a plain, stand-alone subnet."
+ ],
+ "cmd-comment": [
+ "The network6-subnet-del command uses exactly the same syntax for both the command and the response."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-subnet-del\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\",",
+ " \"id\": 5",
+ " }",
+ " }"
+ ],
+ "description": "See <xref linkend=\"idp78\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"network4-subnet-del\",
- \"arguments\": {
- \"name\": \"floor13\",
- \"id\": 5
- }
- }",
- "cmd-comment": "The network6-subnet-del command uses exactly the same syntax for both the command and the response.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'\"
-}"
-}
+ "name": "network6-subnet-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-global-parameter4-del",
- "brief": "This command is used to delete a global DHCPv4 parameter from the configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete a global DHCPv4 parameter from the configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database."
+ ],
+ "cmd-comment": [
+ "This command carries the list including exactly one name of the parameter to be deleted. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter4-del\",",
+ " \"arguments\": {",
+ " \"parameters\": [ <parameter name as string> ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-global-parameter4-del\",
- \"arguments\": {
- \"parameters\": [ <parameter name as string> ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command carries the list including exactly one name of the parameter to be deleted. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 global parameter(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-global-parameter4-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 global parameter(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-global-parameter4-get-all",
- "brief": "This command is used to fetch all global parameters for the server from the specified database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch all global parameters for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter4-get-all\",",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-global-parameter4-get-all\",
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 global parameters found.\",
- \"arguments\": {
- \"parameters\": [
- {
- <first parameter name>: <first parameter value>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- },
- {
- <second parameter name>: <second parameter value>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the global parameters shared between all servers. It excludes server specific global parameters. If an explicit server tag is included in the command, the response contains all global parameters directly associated with the given server and the global parameters associated with all servers when server specific values are not present."
-}
+ "name": "remote-global-parameter4-get-all",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the global parameters shared between all servers. It excludes server specific global parameters. If an explicit server tag is included in the command, the response contains all global parameters directly associated with the given server and the global parameters associated with all servers when server specific values are not present."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 global parameters found.\",",
+ " \"arguments\": {",
+ " \"parameters\": [",
+ " {",
+ " <first parameter name>: <first parameter value>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " {",
+ " <second parameter name>: <second parameter value>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-global-parameter4-get",
- "brief": "This command is used to fetch selected global parameter for the server from the specified database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch selected global parameter for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "This command carries a list including exactly one name of the parameter to be fetched. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the global parameter value shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter4-get\",",
+ " \"arguments\": {",
+ " \"parameters\": [ <parameter name as string> ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-global-parameter4-get\",
- \"arguments\": {
- \"parameters\": [ <parameter name as string> ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command carries a list including exactly one name of the parameter to be fetched. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the global parameter value shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 global parameter found.\",
- \"arguments\": {
- \"parameters\": {
- <parameter name>: <parameter value>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- },
- \"count\": 1
- }
-}",
- "resp-comment": "The returned response contains a map with a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command will fetch the value associated with the given server. If the server specific value doesn't exist, it will try to fetch the value associated with all servers."
-}
+ "name": "remote-global-parameter4-get",
+ "resp-comment": [
+ "The returned response contains a map with a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command will fetch the value associated with the given server. If the server specific value doesn't exist, it will try to fetch the value associated with all servers."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 global parameter found.\",",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <parameter name>: <parameter value>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-global-parameter4-set",
- "brief": "This command is used to create or update one more global parameters in the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or update one more global parameters in the configuration database."
+ ],
+ "cmd-comment": [
+ "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because in some cases only a subset of the parameters may be successfully stored in the database and other parameters may fail to be stored. In such cases the <command>remote-global-parameter4-get-all</command> may be useful to verify the contents of the database after the update. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified parameters with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter4-set\"",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <first parameter name>: <first parameter value>,",
+ " <second parameter name>: <second parameter value>",
+ " },",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-global-parameter4-set\"
- \"arguments\": {
- \"parameters\": {
- <first parameter name>: <first parameter value>,
- <second parameter name>: <second parameter value>
- },
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because in some cases only a subset of the parameters may be successfully stored in the database and other parameters may fail to be stored. In such cases the <command>remote-global-parameter4-get-all</command> may be useful to verify the contents of the database after the update. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified parameters with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 global parameter(s) successfully set.\",
- \"arguments\": {
- \"parameters\": {
- <first parameter name>: <first parameter value>,
- <second parameter name>: <second parameter value>
- },
- \"count\": 2
- }
-}"
-}
+ "name": "remote-global-parameter4-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 global parameter(s) successfully set.\",",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <first parameter name>: <first parameter value>,",
+ " <second parameter name>: <second parameter value>",
+ " },",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-global-parameter6-del",
- "brief": "This command is used to delete a global DHCPv6 parameter from the configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete a global DHCPv6 parameter from the configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database."
+ ],
+ "cmd-comment": [
+ "This command carries the list including exactly one name of the parameter to be deleted. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter6-del\",",
+ " \"arguments\": {",
+ " \"parameters\": [ <parameter name as string> ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-global-parameter6-del\",
- \"arguments\": {
- \"parameters\": [ <parameter name as string> ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command carries the list including exactly one name of the parameter to be deleted. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 global parameter(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-global-parameter6-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 global parameter(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-global-parameter6-get-all",
- "brief": "This command is used to fetch all global parameters for the server from the specified database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch all global parameters for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter6-get-all\",",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-global-parameter6-get-all\",
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 global parameters found.\",
- \"arguments\": {
- \"parameters\": [
- {
- <first parameter name>: <first parameter value>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- },
- {
- <second parameter name>: <second parameter value>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the global parameters shared between all servers. It excludes server specific global parameters. If an explicit server tag is included in the command, the response contains all global parameters directly associated with the given server and the global parameters associated with all servers when server specific values are not present."
-}
+ "name": "remote-global-parameter6-get-all",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the global parameters shared between all servers. It excludes server specific global parameters. If an explicit server tag is included in the command, the response contains all global parameters directly associated with the given server and the global parameters associated with all servers when server specific values are not present."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 global parameters found.\",",
+ " \"arguments\": {",
+ " \"parameters\": [",
+ " {",
+ " <first parameter name>: <first parameter value>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " {",
+ " <second parameter name>: <second parameter value>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-global-parameter6-get",
- "brief": "This command is used to fetch selected global parameter for the server from the specified database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch selected global parameter for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "This command carries a list including exactly one name of the parameter to be fetched. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the global parameter value shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter6-get\",",
+ " \"arguments\": {",
+ " \"parameters\": [ <parameter name as string> ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-global-parameter6-get\",
- \"arguments\": {
- \"parameters\": [ <parameter name as string> ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command carries a list including exactly one name of the parameter to be fetched. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the global parameter value shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 global parameter found.\",
- \"arguments\": {
- \"parameters\": {
- <parameter name>: <parameter value>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- },
- \"count\": 1
- }
-}",
- "resp-comment": "The returned response contains a map with a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command will fetch the value associated with the given server. If the server specific value doesn't exist, it will try to fetch the value associated with all servers."
-}
+ "name": "remote-global-parameter6-get",
+ "resp-comment": [
+ "The returned response contains a map with a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command will fetch the value associated with the given server. If the server specific value doesn't exist, it will try to fetch the value associated with all servers."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 global parameter found.\",",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <parameter name>: <parameter value>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-global-parameter6-set",
- "brief": "This command is used to create or update one more global parameters in the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or update one more global parameters in the configuration database."
+ ],
+ "cmd-comment": [
+ "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because in some cases only a subset of the parameters may be successfully stored in the database and other parameters may fail to be stored. In such cases the <command>remote-global-parameter6-get-all</command> may be useful to verify the contents of the database after the update. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified parameters with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter6-set\"",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <first parameter name>: <first parameter value>,",
+ " <second parameter name>: <second parameter value>",
+ " },",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-global-parameter6-set\"
- \"arguments\": {
- \"parameters\": {
- <first parameter name>: <first parameter value>,
- <second parameter name>: <second parameter value>
- },
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because in some cases only a subset of the parameters may be successfully stored in the database and other parameters may fail to be stored. In such cases the <command>remote-global-parameter6-get-all</command> may be useful to verify the contents of the database after the update. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified parameters with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 global parameter(s) successfully set.\",
- \"arguments\": {
- \"parameters\": {
- <first parameter name>: <first parameter value>,
- <second parameter name>: <second parameter value>
- },
- \"count\": 2
- }
-}"
-}
+ "name": "remote-global-parameter6-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 global parameter(s) successfully set.\",",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <first parameter name>: <first parameter value>,",
+ " <second parameter name>: <second parameter value>",
+ " },",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-network4-del",
- "brief": "This command is used to delete an IPv4 shared network from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete an IPv4 shared network from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-network4-del\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": <shared network name>",
+ " }",
+ " ],",
+ " \"subnets-action\": \"keep\" | \"delete\",",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-network4-del\",
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": <shared network name>
- }
- ],
- \"subnets-action\": \"keep\" | \"delete\",
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 IPv4 shared network(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-network4-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 IPv4 shared network(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-network4-get",
- "brief": "This command is used to fetch selected IPv4 shared network for the server from the specified database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch selected IPv4 shared network for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-network4-get\"",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": <shared network name>",
+ " }",
+ " ],",
+ " \"subnets-include\": \"full\" | \"no\",",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-network4-get\"
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": <shared network name>
- }
- ],
- \"subnets-include\": \"full\" | \"no\",
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 shared network found.\",
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": <shared network name>,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- },
- <the rest of the shared network information, potentially including subnets>
- }
- ],
- \"count\": 1
- }
-}",
- "resp-comment": "If the subnets are returned with the shared network they are carried in the <command>subnet4</command> list within the shared network definition. The metadata is included in the returned shared network definition and it provides the database specific information associated with the returned object."
-}
+ "name": "remote-network4-get",
+ "resp-comment": [
+ "If the subnets are returned with the shared network they are carried in the <command>subnet4</command> list within the shared network definition. The metadata is included in the returned shared network definition and it provides the database specific information associated with the returned object."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 shared network found.\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": <shared network name>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " },",
+ " <the rest of the shared network information, potentially including subnets>",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-network4-list",
- "brief": "This command is used to fetch a list of all IPv4 shared networks from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch a list of all IPv4 shared networks from the configuration database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-network4-list\"",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-network4-list\"
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 IPv4 shared network(s) found.\",
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": <first shared network name>,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
- },
- {
- \"name\": <second shared network name>,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, ... ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use <command>remote-network4-get</command> to fetch the full information about the selected shared networks. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all shared networks which are assigned to no servers (unassigned)."
-}
+ "name": "remote-network4-list",
+ "resp-comment": [
+ "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use <command>remote-network4-get</command> to fetch the full information about the selected shared networks. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all shared networks which are assigned to no servers (unassigned)."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv4 shared network(s) found.\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": <first shared network name>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ " },",
+ " {",
+ " \"name\": <second shared network name>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, ... ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-network4-set",
- "brief": "This command is used to create or replace an IPv4 shared network in the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace an IPv4 shared network in the configuration database."
+ ],
+ "cmd-comment": [
+ "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet4\" parameter). The subnets are added to the shared network using <command>remote-subnet4-set</command> command. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the shared network with one or more user defined servers. It may include the special server tag \"all\" to associate the network with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-network4-set\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " <shared network specification excluding subnets list>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-network4-set\",
- \"arguments\": {
- \"shared-networks\": [
- {
- <shared network specification excluding subnets list>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
-}",
- "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet4\" parameter). The subnets are added to the shared network using <command>remote-subnet4-set</command> command. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the shared network with one or more user defined servers. It may include the special server tag \"all\" to associate the network with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 shared network successfully set.\"
-}"
-}
+ "name": "remote-network4-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 shared network successfully set.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-network6-del",
- "brief": "This command is used to delete an IPv6 shared network from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete an IPv6 shared network from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-network6-del\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": <shared network name>",
+ " }",
+ " ],",
+ " \"subnets-action\": \"keep\" | \"delete\",",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-network6-del\",
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": <shared network name>
- }
- ],
- \"subnets-action\": \"keep\" | \"delete\",
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 IPv6 shared network(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-network6-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 IPv6 shared network(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-network6-get",
- "brief": "This command is used to fetch selected IPv6 shared network for the server from the specified database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch selected IPv6 shared network for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-network6-get\"",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": <shared network name>",
+ " }",
+ " ],",
+ " \"subnets-include\": \"full\" | \"no\",",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-network6-get\"
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": <shared network name>
- }
- ],
- \"subnets-include\": \"full\" | \"no\",
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv6 shared network found.\",
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": <shared network name>,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- },
- <the rest of the shared network information, potentially including subnets>
- }
- ],
- \"count\": 1
- }
-}",
- "resp-comment": "If the subnets are returned with the shared network they are carried in the <command>subnet6</command> list within the shared network definition. The metadata is included in the returned shared network definition and it provides the database specific information associated with the returned object."
-}
+ "name": "remote-network6-get",
+ "resp-comment": [
+ "If the subnets are returned with the shared network they are carried in the <command>subnet6</command> list within the shared network definition. The metadata is included in the returned shared network definition and it provides the database specific information associated with the returned object."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 shared network found.\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": <shared network name>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " },",
+ " <the rest of the shared network information, potentially including subnets>",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-network6-list",
- "brief": "This command is used to fetch a list of all IPv6 shared networks from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch a list of all IPv6 shared networks from the configuration database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-network6-list\"",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-network6-list\"
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 IPv6 shared network(s) found.\",
- \"arguments\": {
- \"shared-networks\": [
- {
- \"name\": <first shared network name>,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
- },
- {
- \"name\": <second shared network name>,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, ... ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use <command>remote-network6-get</command> to fetch the full information about the selected shared networks. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all shared networks which are assigned to no servers (unassigned)."
-}
+ "name": "remote-network6-list",
+ "resp-comment": [
+ "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use <command>remote-network6-get</command> to fetch the full information about the selected shared networks. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all shared networks which are assigned to no servers (unassigned)."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv6 shared network(s) found.\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"name\": <first shared network name>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ " },",
+ " {",
+ " \"name\": <second shared network name>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, ... ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-network6-set",
- "brief": "This command is used to create or replace an IPv6 shared network in the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace an IPv6 shared network in the configuration database."
+ ],
+ "cmd-comment": [
+ "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet6\" parameter). The subnets are added to the shared network using <command>remote-subnet6-set</command> command. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the shared network with one or more user defined servers. It may include the special server tag \"all\" to associate the network with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-network6-set\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " <shared network specification excluding subnets list>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-network6-set\",
- \"arguments\": {
- \"shared-networks\": [
- {
- <shared network specification excluding subnets list>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
-}",
- "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet6\" parameter). The subnets are added to the shared network using <command>remote-subnet6-set</command> command. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the shared network with one or more user defined servers. It may include the special server tag \"all\" to associate the network with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv6 shared network successfully set.\"
-}"
-}
+ "name": "remote-network6-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 shared network successfully set.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option-def4-del",
- "brief": "This command is used to delete a DHCPv4 option definition from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete a DHCPv4 option definition from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one option definition specification comprising an option name and code. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def4-del\",",
+ " \"arguments\": {",
+ " \"option-defs\": [ {",
+ " \"code\": <option code>,",
+ " \"space\": <option space",
+ " } ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option-def4-del\",
- \"arguments\": {
- \"option-defs\": [ {
- \"code\": <option code>,
- \"space\": <option space
- } ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 DHCPv4 option definition(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-option-def4-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 DHCPv4 option definition(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option-def4-get-all",
- "brief": "This command is used to fetch all DHCPv4 option definitions from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch all DHCPv4 option definitions from the configuration database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the option definitions shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def4-get-all\"",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option-def4-get-all\"
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the option definitions shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 DHCPv4 option definition(s) found.\",
- \"arguments\": {
- \"option-defs\": [
- {
- <first option definition>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- },
- {
- <second option definition>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present."
-}
+ "name": "remote-option-def4-get-all",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 DHCPv4 option definition(s) found.\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " <first option definition>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " {",
+ " <second option definition>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option-def4-get",
- "brief": "This command is used to fetch a DHCPv4 option definition from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch a DHCPv4 option definition from the configuration database."
+ ],
+ "cmd-comment": [
+ "The desired option definition is identified by the pair of the option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the option definition instance shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def4-get\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " \"code\": <option code>,",
+ " \"space\": <option space>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option-def4-get\",
- \"arguments\": {
- \"option-defs\": [
- {
- \"code\": <option code>,
- \"space\": <option space>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The desired option definition is identified by the pair of the option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the option definition instance shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 option definition found.\",
- \"arguments\": {
- \"option-defs\": [
- {
- <option definition>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ],
- \"count\": 1
- }
-}",
- "resp-comment": "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition associated with all servers."
-}
+ "name": "remote-option-def4-get",
+ "resp-comment": [
+ "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition associated with all servers."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 option definition found.\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " <option definition>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option-def4-set",
- "brief": "This command is used to create or replace DHCPv4 option definition in the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace DHCPv4 option definition in the configuration database."
+ ],
+ "cmd-comment": [
+ "The provided list must contain exactly one option definition specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option definition with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def4-set\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " <option definition specification>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option-def4-set\",
- \"arguments\": {
- \"option-defs\": [
- {
- <option definition specification>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The provided list must contain exactly one option definition specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option definition with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 option definition set.\"
-}"
-}
+ "name": "remote-option-def4-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 option definition set.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option-def6-del",
- "brief": "This command is used to delete a DHCPv6 option definition from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete a DHCPv6 option definition from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one option definition specification comprising an option name and code. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def6-del\",",
+ " \"arguments\": {",
+ " \"option-defs\": [ {",
+ " \"code\": <option code>,",
+ " \"space\": <option space",
+ " } ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option-def6-del\",
- \"arguments\": {
- \"option-defs\": [ {
- \"code\": <option code>,
- \"space\": <option space
- } ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 DHCPv6 option definition(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-option-def6-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 DHCPv6 option definition(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option-def6-get-all",
- "brief": "This command is used to fetch all DHCPv6 option definitions from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch all DHCPv6 option definitions from the configuration database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the option definitions shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def6-get-all\"",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option-def6-get-all\"
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the option definitions shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 DHCPv6 option definition(s) found.\",
- \"arguments\": {
- \"option-defs\": [
- {
- <first option definition>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- },
- {
- <second option definition>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present."
-}
+ "name": "remote-option-def6-get-all",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 DHCPv6 option definition(s) found.\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " <first option definition>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " {",
+ " <second option definition>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option-def6-get",
- "brief": "This command is used to fetch a DHCPv6 option definition from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch a DHCPv6 option definition from the configuration database."
+ ],
+ "cmd-comment": [
+ "The desired option definition is identified by the pair of the option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the option definition instance shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def6-get\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " \"code\": <option code>,",
+ " \"space\": <option space>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option-def6-get\",
- \"arguments\": {
- \"option-defs\": [
- {
- \"code\": <option code>,
- \"space\": <option space>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The desired option definition is identified by the pair of the option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the option definition instance shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 option definition found.\",
- \"arguments\": {
- \"option-defs\": [
- {
- <option definition>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ],
- \"count\": 1
- }
-}",
- "resp-comment": "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition associated with all servers."
-}
+ "name": "remote-option-def6-get",
+ "resp-comment": [
+ "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition associated with all servers."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 option definition found.\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " <option definition>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option-def6-set",
- "brief": "This command is used to create or replace DHCPv6 option definition in the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace DHCPv6 option definition in the configuration database."
+ ],
+ "cmd-comment": [
+ "The provided list must contain exactly one option definition specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option definition with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def6-set\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " <option definition specification>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option-def6-set\",
- \"arguments\": {
- \"option-defs\": [
- {
- <option definition specification>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The provided list must contain exactly one option definition specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option definition with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 option definition set.\"
-}"
-}
+ "name": "remote-option-def6-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 option definition set.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option4-global-del",
- "brief": "This command is used to delete a DHCPv4 global option from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete a DHCPv4 global option from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one option specification comprising an option name and code. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option4-global-del\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " \"code\": <option code>",
+ " \"space\": <option space>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option4-global-del\",
- \"arguments\": {
- \"options\": [
- {
- \"code\": <option code>
- \"space\": <option space>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command includes a list with exactly one option specification comprising an option name and code. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 DHCPv4 option(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-option4-global-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 DHCPv4 option(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option4-global-get-all",
- "brief": "This command is used to fetch all DHCPv4 global options for the server from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch all DHCPv4 global options for the server from the configuration database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global options shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option4-global-get-all\",",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option4-global-get-all\",
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global options shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 DHCPv4 option(s) found.\",
- \"arguments\": {
- \"options\": [
- {
- <first option specification>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- },
- {
- <second option specification>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present."
-}
+ "name": "remote-option4-global-get-all",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 DHCPv4 option(s) found.\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " <first option specification>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " {",
+ " <second option specification>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option4-global-get",
- "brief": "This command is used to fetch a global DHCPv4 option for the server from the specified database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch a global DHCPv4 option for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "The option is identified by the pair of option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the global option instance shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option4-global-get\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " \"code\": <option code>,",
+ " \"space\": <option space>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option4-global-get\",
- \"arguments\": {
- \"options\": [
- {
- \"code\": <option code>,
- \"space\": <option space>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
-}",
- "cmd-comment": "The option is identified by the pair of option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the global option instance shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 option in found.\",
- \"arguments\": {
- \"options\": [
- {
- <option information>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ]
- }
-}",
- "resp-comment": "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers."
-}
+ "name": "remote-option4-global-get",
+ "resp-comment": [
+ "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 option in found.\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " <option information>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option4-global-set",
- "brief": "This command is used to create or replace a DHCPv4 global option in the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace a DHCPv4 global option in the configuration database."
+ ],
+ "cmd-comment": [
+ "The provided list must cotain exactly one option specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option4-global-set\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " <global option specification>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option4-global-set\",
- \"arguments\": {
- \"options\": [
- {
- <global option specification>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The provided list must cotain exactly one option specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 option set.\",
- \"arguments\": {
- \"options\": [
- {
- \"code\": <option code>,
- \"space\": <option space>
- }
- ]
- }
-}"
-}
+ "name": "remote-option4-global-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 option set.\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " \"code\": <option code>,",
+ " \"space\": <option space>",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option6-global-del",
- "brief": "This command is used to delete a DHCPv6 global option from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete a DHCPv6 global option from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one option specification comprising an option name and code. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option6-global-del\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " \"code\": <option code>",
+ " \"space\": <option space>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option6-global-del\",
- \"arguments\": {
- \"options\": [
- {
- \"code\": <option code>
- \"space\": <option space>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "This command includes a list with exactly one option specification comprising an option name and code. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 DHCPv6 option(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-option6-global-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 DHCPv6 option(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option6-global-get-all",
- "brief": "This command is used to fetch all DHCPv6 global options for the server from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch all DHCPv6 global options for the server from the configuration database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global options shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option6-global-get-all\",",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option6-global-get-all\",
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global options shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 DHCPv6 option(s) found.\",
- \"arguments\": {
- \"options\": [
- {
- <first option specification>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- },
- {
- <second option specification>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present."
-}
+ "name": "remote-option6-global-get-all",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 DHCPv6 option(s) found.\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " <first option specification>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " {",
+ " <second option specification>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option6-global-get",
- "brief": "This command is used to fetch a global DHCPv6 option for the server from the specified database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch a global DHCPv6 option for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "The option is identified by the pair of option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the global option instance shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option6-global-get\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " \"code\": <option code>,",
+ " \"space\": <option space>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option6-global-get\",
- \"arguments\": {
- \"options\": [
- {
- \"code\": <option code>,
- \"space\": <option space>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
-}",
- "cmd-comment": "The option is identified by the pair of option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the global option instance shared by all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 option in found.\",
- \"arguments\": {
- \"options\": [
- {
- <option information>,
- \"metadata\": {
- \"server-tags\": [ <server tag> ]
- }
- }
- ]
- }
-}",
- "resp-comment": "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers."
-}
+ "name": "remote-option6-global-get",
+ "resp-comment": [
+ "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 option in found.\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " <option information>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-option6-global-set",
- "brief": "This command is used to create or replace a DHCPv6 global option in the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace a DHCPv6 global option in the configuration database."
+ ],
+ "cmd-comment": [
+ "The provided list must cotain exactly one option specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option6-global-set\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " <global option specification>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-option6-global-set\",
- \"arguments\": {
- \"options\": [
- {
- <global option specification>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <single server tag as string> ]
- }
-}",
- "cmd-comment": "The provided list must cotain exactly one option specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 option set.\",
- \"arguments\": {
- \"options\": [
- {
- \"code\": <option code>,
- \"space\": <option space>
- }
- ]
- }
-}"
-}
+ "name": "remote-option6-global-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 option set.\",",
+ " \"arguments\": {",
+ " \"options\": [",
+ " {",
+ " \"code\": <option code>,",
+ " \"space\": <option space>",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-server4-del",
- "brief": "This command is used to delete information about a DHCPv4 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete information about a DHCPv4 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers."
+ ],
+ "cmd-comment": [
+ "This command carries the list including exactly one map with the tag of the server to be deleted."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server4-del\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server name>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-server4-del\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server name>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command carries the list including exactly one map with the tag of the server to be deleted.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 DHCPv4 server(s) deleted.\"
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-server4-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 DHCPv4 server(s) deleted.\"",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-server4-get-all",
- "brief": "This command is used to fetch information about all DHCPv4 servers specified by the user.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch information about all DHCPv4 servers specified by the user."
+ ],
+ "cmd-comment": [
+ "This command contains no arguments besides the optional <command>remote</command>."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server4-get-all\",",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-server4-get-all\",
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 servers found.\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <first server tag>,
- \"description\": <first server description>
- },
- {
- \"server-tag\": <second server tag>,
- \"description\": <second server description>
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server4-get-all</command>. Only the user defined servers are returned."
-}
+ "name": "remote-server4-get-all",
+ "resp-comment": [
+ "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server4-get-all</command>. Only the user defined servers are returned."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 servers found.\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <first server tag>,",
+ " \"description\": <first server description>",
+ " },",
+ " {",
+ " \"server-tag\": <second server tag>,",
+ " \"description\": <second server description>",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-server4-get",
- "brief": "This command is used to fetch the information about the DHCPv4 server, such as server tag and description.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch the information about the DHCPv4 server, such as server tag and description."
+ ],
+ "cmd-comment": [
+ "This command carries the list including exactly one map with the tag of the server to be fetched."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server4-get\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server tag>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-server4-get\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server tag>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command carries the list including exactly one map with the tag of the server to be fetched.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCP server <server tag> found.\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server tag>,
- \"description\": <server description>
- }
- ],
- \"count\": 1
- }
-}",
- "resp-comment": "The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information."
-}
+ "name": "remote-server4-get",
+ "resp-comment": [
+ "The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCP server <server tag> found.\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server tag>,",
+ " \"description\": <server description>",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-server4-set",
- "brief": "This command is used to create or replace information about the DHCPv4 server in the database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace information about the DHCPv4 server in the database."
+ ],
+ "cmd-comment": [
+ "The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server4-set\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server tag>,",
+ " \"description\": <server description>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-server4-set\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server tag>,
- \"description\": <server description>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv4 server successfully set.\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server tag>,
- \"description\": <server description>
- }
- ]
- }
-}"
-}
+ "name": "remote-server4-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 server successfully set.\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server tag>,",
+ " \"description\": <server description>",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-server6-del",
- "brief": "This command is used to delete information about a DHCPv6 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete information about a DHCPv6 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers."
+ ],
+ "cmd-comment": [
+ "This command carries the list including exactly one map with the tag of the server to be deleted."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server6-del\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server name>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-server6-del\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server name>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command carries the list including exactly one map with the tag of the server to be deleted.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 DHCPv6 server(s) deleted.\"
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-server6-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 DHCPv6 server(s) deleted.\"",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-server6-get-all",
- "brief": "This command is used to fetch information about all DHCPv6 servers specified by the user.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch information about all DHCPv6 servers specified by the user."
+ ],
+ "cmd-comment": [
+ "This command contains no arguments besides the optional <command>remote</command>."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server6-get-all\",",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-server6-get-all\",
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 servers found.\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <first server tag>,
- \"description\": <first server description>
- },
- {
- \"server-tag\": <second server tag>,
- \"description\": <second server description>
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server6-get-all</command>. Only the user defined servers are returned."
-}
+ "name": "remote-server6-get-all",
+ "resp-comment": [
+ "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server6-get-all</command>. Only the user defined servers are returned."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 servers found.\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <first server tag>,",
+ " \"description\": <first server description>",
+ " },",
+ " {",
+ " \"server-tag\": <second server tag>,",
+ " \"description\": <second server description>",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-server6-get",
- "brief": "This command is used to fetch the information about the DHCPv6 server, such as server tag and description.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch the information about the DHCPv6 server, such as server tag and description."
+ ],
+ "cmd-comment": [
+ "This command carries the list including exactly one map with the tag of the server to be fetched."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server6-get\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server tag>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-server6-get\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server tag>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command carries the list including exactly one map with the tag of the server to be fetched.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCP server <server tag> found.\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server tag>,
- \"description\": <server description>
- }
- ],
- \"count\": 1
- }
-}",
- "resp-comment": "The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information."
-}
+ "name": "remote-server6-get",
+ "resp-comment": [
+ "The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCP server <server tag> found.\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server tag>,",
+ " \"description\": <server description>",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-server6-set",
- "brief": "This command is used to create or replace information about the DHCPv6 server in the database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace information about the DHCPv6 server in the database."
+ ],
+ "cmd-comment": [
+ "The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server6-set\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server tag>,",
+ " \"description\": <server description>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-server6-set\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server tag>,
- \"description\": <server description>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"DHCPv6 server successfully set.\",
- \"arguments\": {
- \"servers\": [
- {
- \"server-tag\": <server tag>,
- \"description\": <server description>
- }
- ]
- }
-}"
-}
+ "name": "remote-server6-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv6 server successfully set.\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server tag>,",
+ " \"description\": <server description>",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet4-del-by-id",
- "brief": "This command is used to delete an IPv4 subnet by ID from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete an IPv4 subnet by ID from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one id of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet4-del-by-id\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet4-del-by-id\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <subnet identifier>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one id of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 IPv4 subnet(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-subnet4-del-by-id",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 IPv4 subnet(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet4-del-by-prefix",
- "brief": "This command is used to delete an IPv4 subnet by prefix from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete an IPv4 subnet by prefix from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one prefix of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet4-del-by-prefix\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"subnet\": <subnet prefix>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet4-del-by-prefix\",
- \"arguments\": {
- \"subnets\": [
- {
- \"subnet\": <subnet prefix>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 IPv4 subnet(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-subnet4-del-by-prefix",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 IPv4 subnet(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet4-get-by-id",
- "brief": "This command is used to fetch selected IPv4 subnet by ID for the server from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch selected IPv4 subnet by ID for the server from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one id of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet4-get-by-id\"",
+ " \"arguments\": {",
+ " \"subnets\": [ {",
+ " \"id\": <subnet identifier>",
+ " } ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet4-get-by-id\"
- \"arguments\": {
- \"subnets\": [ {
- \"id\": <subnet identifier>
- } ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one id of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet found.\",
- \"arguments\": {
- \"subnets\": [ {
- \"id\": <subnet identifier>,
- \"subnet\": <subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- },
- <the rest of the subnet specification here>
- } ],
- \"count\": 1
- }
-}",
- "resp-comment": "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
-}
+ "name": "remote-subnet4-get-by-id",
+ "resp-comment": [
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet found.\",",
+ " \"arguments\": {",
+ " \"subnets\": [ {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " },",
+ " <the rest of the subnet specification here>",
+ " } ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet4-get-by-prefix",
- "brief": "This command is used to fetch selected IPv4 subnet by prefix from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch selected IPv4 subnet by prefix from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one prefix of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet4-get-by-prefix\"",
+ " \"arguments\": {",
+ " \"subnets\": [ {",
+ " \"subnet\": <subnet prefix>",
+ " } ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet4-get-by-prefix\"
- \"arguments\": {
- \"subnets\": [ {
- \"subnet\": <subnet prefix>
- } ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet found.\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <subnet identifier>,
- \"subnet\": <subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- },
- <the rest of the subnet specification here>
- }
- ],
- \"count\": 1
- }
-}",
- "resp-comment": "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
-}
+ "name": "remote-subnet4-get-by-prefix",
+ "resp-comment": [
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet found.\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " },",
+ " <the rest of the subnet specification here>",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet4-list",
- "brief": "This command is used to fetch a list of all IPv4 subnets from the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch a list of all IPv4 subnets from the configuration database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet4-list\"",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet4-list\"
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 IPv4 subnets found.\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <first subnet identifier>,
- \"subnet\": <first subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
- },
- {
- \"id\": <second subnet identifier>,
- \"subnet\": <second subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, ... ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use <command>remote-subnet4-get</command> to fetch the full information about the selected subnets. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all subnets which are associated with any of the specified tags. A subnet is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all subnets which are assigned to no servers (unassigned)."
-}
+ "name": "remote-subnet4-list",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use <command>remote-subnet4-get</command> to fetch the full information about the selected subnets. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all subnets which are associated with any of the specified tags. A subnet is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all subnets which are assigned to no servers (unassigned)."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv4 subnets found.\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <first subnet identifier>,",
+ " \"subnet\": <first subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ " },",
+ " {",
+ " \"id\": <second subnet identifier>,",
+ " \"subnet\": <second subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, ... ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet4-set",
- "brief": "This command is used to create or replace an IPv4 subnet the configuration database.",
- "support": [ "kea-dhcp4" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace an IPv4 subnet the configuration database."
+ ],
+ "cmd-comment": [
+ "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the <command>null</command> value must be specified for the shared network name. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the subnet with one or more user defined servers. It may include the special server tag \"all\" to associate the subnet with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet4-set\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " <the rest of the subnet specification here>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet4-set\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <subnet identifier>,
- \"subnet\": <subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- <the rest of the subnet specification here>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
-}",
- "cmd-comment": "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the <command>null</command> value must be specified for the shared network name. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the subnet with one or more user defined servers. It may include the special server tag \"all\" to associate the subnet with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet successfully set.\",
- \"arguments\": {
- \"id\": <subnet identifier>,
- \"subnet\": <subnet prefix>
- }
-}"
-}
+ "name": "remote-subnet4-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet successfully set.\",",
+ " \"arguments\": {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet6-del-by-id",
- "brief": "This command is used to delete an IPv6 subnet by ID from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete an IPv6 subnet by ID from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one id of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet6-del-by-id\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet6-del-by-id\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <subnet identifier>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one id of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 IPv6 subnet(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-subnet6-del-by-id",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 IPv6 subnet(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet6-del-by-prefix",
- "brief": "This command is used to delete an IPv6 subnet by prefix from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to delete an IPv6 subnet by prefix from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one prefix of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet6-del-by-prefix\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"subnet\": <subnet prefix>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet6-del-by-prefix\",
- \"arguments\": {
- \"subnets\": [
- {
- \"subnet\": <subnet prefix>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"1 IPv6 subnet(s) deleted.\",
- \"arguments\": {
- \"count\": 1
- }
-}"
-}
+ "name": "remote-subnet6-del-by-prefix",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 IPv6 subnet(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet6-get-by-id",
- "brief": "This command is used to fetch selected IPv6 subnet by ID for the server from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch selected IPv6 subnet by ID for the server from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one id of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet6-get-by-id\"",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet6-get-by-id\"
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <subnet identifier>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one id of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv6 subnet found.\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <subnet identifier>,
- \"subnet\": <subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- },
- <the rest of the subnet specification here>
- }
- ],
- \"count\": 1
- }
-}",
- "resp-comment": "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
-}
+ "name": "remote-subnet6-get-by-id",
+ "resp-comment": [
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 subnet found.\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " },",
+ " <the rest of the subnet specification here>",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet6-get-by-prefix",
- "brief": "This command is used to fetch selected IPv6 subnet by prefix from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch selected IPv6 subnet by prefix from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one prefix of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet4-get-by-prefix\"",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"subnet\": <subnet prefix>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet4-get-by-prefix\"
- \"arguments\": {
- \"subnets\": [
- {
- \"subnet\": <subnet prefix>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- }
- }
-}",
- "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv6 subnet found.\",
- \"arguments\": {
- \"subnets\": [ {
- \"id\": <subnet identifier>,
- \"subnet\": <subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- },
- <the rest of the subnet specification here>
- } ],
- \"count\": 1
- }
-}",
- "resp-comment": "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
-}
+ "name": "remote-subnet6-get-by-prefix",
+ "resp-comment": [
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 subnet found.\",",
+ " \"arguments\": {",
+ " \"subnets\": [ {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " },",
+ " <the rest of the subnet specification here>",
+ " } ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet6-list",
- "brief": "This command is used to fetch a list of all IPv6 subnets from the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to fetch a list of all IPv6 subnets from the configuration database."
+ ],
+ "cmd-comment": [
+ "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet6-list\"",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet6-list\"
- \"arguments\": {
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
-}",
- "cmd-comment": "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 IPv6 subnets found.\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <first subnet identifier>,
- \"subnet\": <first subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
- },
- {
- \"id\": <second subnet identifier>,
- \"subnet\": <second subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- \"metadata\": {
- \"server-tags\": [ <first server tag>, ... ]
- }
- }
- ],
- \"count\": 2
- }
-}",
- "resp-comment": "The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use <command>remote-subnet6-get</command> to fetch the full information about the selected subnets. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all subnets which are associated with any of the specified tags. A subnet is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all subnets which are assigned to no servers (unassigned)."
-}
+ "name": "remote-subnet6-list",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use <command>remote-subnet6-get</command> to fetch the full information about the selected subnets. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all subnets which are associated with any of the specified tags. A subnet is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all subnets which are assigned to no servers (unassigned)."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv6 subnets found.\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <first subnet identifier>,",
+ " \"subnet\": <first subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ " },",
+ " {",
+ " \"id\": <second subnet identifier>,",
+ " \"subnet\": <second subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, ... ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "remote-subnet6-set",
- "brief": "This command is used to create or replace an IPv6 subnet the configuration database.",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to create or replace an IPv6 subnet the configuration database."
+ ],
+ "cmd-comment": [
+ "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the <command>null</command> value must be specified for the shared network name. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the subnet with one or more user defined servers. It may include the special server tag \"all\" to associate the subnet with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet6-set\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " <the rest of the subnet specification here>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
"hook": "cb_cmds",
- "cmd-syntax": "{
- \"command\": \"remote-subnet6-set\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": <subnet identifier>,
- \"subnet\": <subnet prefix>,
- \"shared-network-name\": <shared network name> | null,
- <the rest of the subnet specification here>
- }
- ],
- \"remote\": {
- <specification of the database to connect to>
- },
- \"server-tags\": [ <first server tag>, <second server tag>, ... ]
- }
-}",
- "cmd-comment": "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the <command>null</command> value must be specified for the shared network name. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the subnet with one or more user defined servers. It may include the special server tag \"all\" to associate the subnet with all servers.",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv6 subnet successfully set.\",
- \"arguments\": {
- \"id\": <subnet identifier>,
- \"subnet\": <subnet prefix>
- }
-}"
-}
+ "name": "remote-subnet6-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 subnet successfully set.\",",
+ " \"arguments\": {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "reservation-add",
- "brief": "adds a new host reservation. The reservation may include IPv4 address,
- IPv6 addresses, IPv6 prefixes, various identifiers, a class
- the client will be assigned to, DHCPv4 and DHCPv6 options and
- more.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
- "hook": "host_cmds",
"avail": "1.2.0",
+ "brief": [
+ "adds a new host reservation. The reservation may include IPv4 address,",
+ " IPv6 addresses, IPv6 prefixes, various identifiers, a class",
+ " the client will be assigned to, DHCPv4 and DHCPv6 options and",
+ " more."
+ ],
+ "cmd-comment": [
+ "Note the ip-address, client-id, next-server, server-hostname and",
+ "boot-file-name are IPv4 specific. duid, ip-addresses and prefixes are",
+ "IPv6 specific."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"reservation-add\",",
+ " \"arguments\": {",
+ " \"reservation\": {",
+ " \"boot-file-name\": <string>,",
+ " \"comment\": <string>",
+ " \"client-id\": <string>,",
+ " \"circuit-id\": <string>,",
+ " \"duid\": <string>,",
+ " \"flex-id\": <string>,",
+ " \"ip-address\": <string (IPv4 address)>,",
+ " \"ip-addresses\": [ <comma separated strings> ],",
+ " \"hw-address\": <string>,",
+ " \"hostname\": <string>,",
+ " \"next-server\": <string (IPv4 address)>,",
+ " \"option-data-list\": [ <comma separated structures defining options> ],",
+ " \"prefixes\": [ <comma separated IPv6 prefixes> ],",
+ " \"reservation-client-classes\": [ <comma separated strings> ],",
+ " \"server-hostname\": <string>,",
+ " \"subnet-id\": <integer>,",
+ " \"user-context\": <any valid JSON>,",
+ " }",
+ " }",
+ "}"
+ ],
"description": "See <xref linkend=\"cmd-reservation-add\"/>",
-
- "cmd-syntax": "{
- \"command\": \"reservation-add\",
- \"arguments\": {
- \"reservation\": {
- \"boot-file-name\": <string>,
- \"comment\": <string>
- \"client-id\": <string>,
- \"circuit-id\": <string>,
- \"duid\": <string>,
- \"flex-id\": <string>,
- \"ip-address\": <string (IPv4 address)>,
- \"ip-addresses\": [ <comma separated strings> ],
- \"hw-address\": <string>,
- \"hostname\": <string>,
- \"next-server\": <string (IPv4 address)>,
- \"option-data-list\": [ <comma separated structures defining options> ],
- \"prefixes\": [ <comma separated IPv6 prefixes> ],
- \"reservation-client-classes\": [ <comma separated strings> ],
- \"server-hostname\": <string>,
- \"subnet-id\": <integer>,
- \"user-context\": <any valid JSON>,
- }
- }
-}",
- "cmd-comment": "Note the ip-address, client-id, next-server, server-hostname and
-boot-file-name are IPv4 specific. duid, ip-addresses and prefixes are
-IPv6 specific.",
-
- "resp-syntax": "
-{
- \"result\": <integer>,
- \"text\": <string>
-}"
-}
-
+ "hook": "host_cmds",
+ "name": "reservation-add",
+ "resp-syntax": [
+ "",
+ "{",
+ " \"result\": <integer>,",
+ " \"text\": <string>",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "reservation-del",
- "brief": "Deletes an existing host reservation.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
- "hook": "host_cmds",
"avail": "1.2.0",
-
- "cmd-syntax": "{
- \"command\": \"reservation-del\",
- \"arguments\": {
- \"subnet-id\": <integer>,
- \"ip-address\": <string>,
- \"identifier-type\": <one of \"hw-address\", \"duid\", \"circuit-id\", \"client-id\" and \"flex-id\">,
- \"identifier\": <string>
- }
-}",
- "cmd-comment": "The host reservation can be identified by either (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
-}
+ "brief": [
+ "Deletes an existing host reservation."
+ ],
+ "cmd-comment": [
+ "The host reservation can be identified by either (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"reservation-del\",",
+ " \"arguments\": {",
+ " \"subnet-id\": <integer>,",
+ " \"ip-address\": <string>,",
+ " \"identifier-type\": <one of \"hw-address\", \"duid\", \"circuit-id\", \"client-id\" and \"flex-id\">,",
+ " \"identifier\": <string>",
+ " }",
+ "}"
+ ],
+ "hook": "host_cmds",
+ "name": "reservation-del",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "reservation-get-all",
- "brief": "Retrieve all host reservations for a specified subnet.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
- "hook": "host_cmds",
"avail": "1.6.0",
-
- "cmd-syntax": "{
- \"command\": \"reservation-get-all\",
- \"arguments\": {
- \"subnet-id\": <integer>
-}",
- "resp-comment": "reservation-get-all command may result in very large responses."
-}
+ "brief": [
+ "Retrieve all host reservations for a specified subnet."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"reservation-get-all\",",
+ " \"arguments\": {",
+ " \"subnet-id\": <integer>",
+ "}"
+ ],
+ "hook": "host_cmds",
+ "name": "reservation-get-all",
+ "resp-comment": [
+ "reservation-get-all command may result in very large responses."
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "reservation-get-page",
- "brief": "Retrieve host reservations for a specified subnet by page.",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
- "hook": "host_cmds",
"avail": "1.6.0",
-
- "cmd-syntax": "{
- \"command\": \"reservation-get-page\",
- \"arguments\": {
- \"subnet-id\": <integer>,
- \"limit\": <integer>,
- \"source-index\": <integer>,
- \"from\": <integer>
- }
-}",
- "cmd-comment": "the subnet id and the page size limit are mandatory. The source index and from host id are optional and default to 0. Values to use to next the next page are returned in responses in a next map."
-}
+ "brief": [
+ "Retrieve host reservations for a specified subnet by page."
+ ],
+ "cmd-comment": [
+ "the subnet id and the page size limit are mandatory. The source index and from host id are optional and default to 0. Values to use to next the next page are returned in responses in a next map."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"reservation-get-page\",",
+ " \"arguments\": {",
+ " \"subnet-id\": <integer>,",
+ " \"limit\": <integer>,",
+ " \"source-index\": <integer>,",
+ " \"from\": <integer>",
+ " }",
+ "}"
+ ],
+ "hook": "host_cmds",
+ "name": "reservation-get-page",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "reservation-get",
- "brief": "Attempts to retrieve an existing host reservation",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
- "hook": "host_cmds",
"avail": "1.2.0",
-
- "cmd-syntax": "{
- \"command\": \"reservation-get\",
- \"arguments\": {
- \"subnet-id\": <integer>,
- \"identifier-type\": <string with one value out of: hw-address|duid|circuit-id|client-id|flex-id>,
- \"identifier\": <string>;
- }
-}",
-
- "cmd-comment": "The host reservation can be identified by either (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier).",
-
- "resp-syntax": "{
- \"result\": <integer>,
- \"text\": <string>,
- \"arguments\": {
- \"boot-file-name\": <string>,
- \"comment\": <string>
- \"client-id\": <string>,
- \"circuit-id\": <string>,
- \"duid\": <string>,
- \"flex-id\": <string>,
- \"ip-address\": <string (IPv4 address)>,
- \"ip-addresses\": [ <comma separated strings> ],
- \"hw-address\": <string>,
- \"hostname\": <string>,
- \"next-server\": <string (IPv4 address)>,
- \"option-data-list\": [ <comma separated structures defining options> ],
- \"prefixes\": [ <comma separated IPv6 prefixes> ],
- \"reservation-client-classes\": [ <comma separated strings> ],
- \"server-hostname\": <string>,
- \"subnet-id\": <integer>,
- \"user-context\": <any valid JSON>,
- }
-}",
-
- "resp-comment": "Arguments object appear only if a host is found. Many fields in the arguments
-object appear only if specific field is set."
-}
+ "brief": [
+ "Attempts to retrieve an existing host reservation"
+ ],
+ "cmd-comment": [
+ "The host reservation can be identified by either (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"reservation-get\",",
+ " \"arguments\": {",
+ " \"subnet-id\": <integer>,",
+ " \"identifier-type\": <string with one value out of: hw-address|duid|circuit-id|client-id|flex-id>,",
+ " \"identifier\": <string>;",
+ " }",
+ "}"
+ ],
+ "hook": "host_cmds",
+ "name": "reservation-get",
+ "resp-comment": [
+ "Arguments object appear only if a host is found. Many fields in the arguments",
+ "object appear only if specific field is set."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": <integer>,",
+ " \"text\": <string>,",
+ " \"arguments\": {",
+ " \"boot-file-name\": <string>,",
+ " \"comment\": <string>",
+ " \"client-id\": <string>,",
+ " \"circuit-id\": <string>,",
+ " \"duid\": <string>,",
+ " \"flex-id\": <string>,",
+ " \"ip-address\": <string (IPv4 address)>,",
+ " \"ip-addresses\": [ <comma separated strings> ],",
+ " \"hw-address\": <string>,",
+ " \"hostname\": <string>,",
+ " \"next-server\": <string (IPv4 address)>,",
+ " \"option-data-list\": [ <comma separated structures defining options> ],",
+ " \"prefixes\": [ <comma separated IPv6 prefixes> ],",
+ " \"reservation-client-classes\": [ <comma separated strings> ],",
+ " \"server-hostname\": <string>,",
+ " \"subnet-id\": <integer>,",
+ " \"user-context\": <any valid JSON>,",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "server-tag-get",
- "brief": "The server-tag-get command returns the server tag.",
- "description": "See <xref linkend=\"command-server-tag-get\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.6.0",
- "cmd-syntax": "{
- \"command\": \"server-tag-get\"
-}"
-}
+ "brief": [
+ "The server-tag-get command returns the server tag."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"server-tag-get\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-server-tag-get\"/>",
+ "name": "server-tag-get",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "shutdown",
- "brief": "The shutdown command instructs the server to initiate its shutdown procedure.",
- "description": "See <xref linkend=\"command-shutdown\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"shutdown\"
-}",
- "cmd-comment": "The server will respond with a confirmation that the shutdown
- procedure has been initiated."
-}
+ "brief": [
+ "The shutdown command instructs the server to initiate its shutdown procedure."
+ ],
+ "cmd-comment": [
+ "The server will respond with a confirmation that the shutdown",
+ " procedure has been initiated."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"shutdown\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-shutdown\"/>",
+ "name": "shutdown",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
{
- "name": "stat-lease4-get",
- "brief": "The stat-lease4-get command fetches lease statistics for a range
- of known IPv4 subnets.",
- "description": "See <xref linkend=\"command-stat-lease4-get\"/>",
- "support": [ "kea-dhcp4" ],
"avail": "1.4.0",
+ "brief": [
+ "The stat-lease4-get command fetches lease statistics for a range",
+ " of known IPv4 subnets."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"stat-lease4-get\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-stat-lease4-get\"/>",
"hook": "stat_cmds",
- "cmd-syntax": "{
- \"command\": \"stat-lease4-get\"
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"stat-lease4-get: 2 rows found\",
- \"arguments\": {
- \"result-set\": {
- \"columns\": [ \"subnet-id\",
- \"total-addresses\",
- \"assigned-addresses\",
- \"declined-addresses\" ]
- \"rows\": [
- [ 10, 256, 111, 0 ],
- [ 20, 4098, 2034, 4 ]
- ],
- \"timestamp\": \"2018-05-04 15:03:37.000000\"
- }
- }
- }"
-}
+ "name": "stat-lease4-get",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"stat-lease4-get: 2 rows found\",",
+ " \"arguments\": {",
+ " \"result-set\": {",
+ " \"columns\": [ \"subnet-id\",",
+ " \"total-addresses\",",
+ " \"assigned-addresses\",",
+ " \"declined-addresses\" ]",
+ " \"rows\": [",
+ " [ 10, 256, 111, 0 ],",
+ " [ 20, 4098, 2034, 4 ]",
+ " ],",
+ " \"timestamp\": \"2018-05-04 15:03:37.000000\"",
+ " }",
+ " }",
+ " }"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "stat-lease6-get",
- "brief": "The stat-lease6-get command fetches lease statistics for a range
- of known IPv6 subnets.",
- "description": "See <xref linkend=\"command-stat-lease6-get\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.4.0",
+ "brief": [
+ "The stat-lease6-get command fetches lease statistics for a range",
+ " of known IPv6 subnets."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"stat-lease6-get\",",
+ " \"arguments\": {",
+ " \"subnet-id\" : 10",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-stat-lease6-get\"/>",
"hook": "stat_cmds",
- "cmd-syntax": "{
- \"command\": \"stat-lease6-get\",
- \"arguments\": {
- \"subnet-id\" : 10
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"stat-lease6-get: 2 rows found\",
- \"arguments\": {
- \"result-set\": {
- \"columns\": [ \"subnet-id\", \"total-nas\", \"assigned-nas\", \"declined-nas\", \"total-pds\", \"assigned-pds\" ]
- \"rows\": [
- [ 10, 4096, 2400, 3, 0, 0],
- [ 20, 0, 0, 0, 1048, 233 ]
- [ 30, 256, 60, 0, 1048, 15 ]
- ],
- \"timestamp\": \"2018-05-04 15:03:37.000000\"
- }
- }
- }"
-}
+ "name": "stat-lease6-get",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"stat-lease6-get: 2 rows found\",",
+ " \"arguments\": {",
+ " \"result-set\": {",
+ " \"columns\": [ \"subnet-id\", \"total-nas\", \"assigned-nas\", \"declined-nas\", \"total-pds\", \"assigned-pds\" ]",
+ " \"rows\": [",
+ " [ 10, 4096, 2400, 3, 0, 0],",
+ " [ 20, 0, 0, 0, 1048, 233 ]",
+ " [ 30, 256, 60, 0, 1048, 15 ]",
+ " ],",
+ " \"timestamp\": \"2018-05-04 15:03:37.000000\"",
+ " }",
+ " }",
+ " }"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-get-all",
- "brief": "The statistic-get-all command retrieves all statistics recorded.",
- "description": "See <xref linkend=\"command-statistic-get-all\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"statistic-get-all\",
- \"arguments\": { }
-}",
- "cmd-comment": "The server will respond with details of all recorded statistics, with result set to 0 indicating that it iterated over all statistics (even when the total number of statistics is zero)."
-}
+ "brief": [
+ "The statistic-get-all command retrieves all statistics recorded."
+ ],
+ "cmd-comment": [
+ "The server will respond with details of all recorded statistics, with result set to 0 indicating that it iterated over all statistics (even when the total number of statistics is zero)."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-get-all\",",
+ " \"arguments\": { }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-get-all\"/>",
+ "name": "statistic-get-all",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-get",
- "brief": "The statistic-get command retrieves a single statistic. It takes a single string parameter called name that specifies the statistic name.",
- "description": "See <xref linkend=\"command-statistic-get\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"statistic-get\",
- \"arguments\": {
- \"name\": \"pkt4-received\"
- }
-}",
- "cmd-comment": "The server will respond with details of the requested statistic, with a result set to 0 indicating success and the specified statistic as the value of the \"arguments\" parameter."
-}
+ "brief": [
+ "The statistic-get command retrieves a single statistic. It takes a single string parameter called name that specifies the statistic name."
+ ],
+ "cmd-comment": [
+ "The server will respond with details of the requested statistic, with a result set to 0 indicating success and the specified statistic as the value of the \"arguments\" parameter."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-get\",",
+ " \"arguments\": {",
+ " \"name\": \"pkt4-received\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-get\"/>",
+ "name": "statistic-get",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-remove-all",
- "brief": "The statistic-remove-all command attempts to delete all statistics.",
- "description": "See <xref linkend=\"command-statistic-remove-all\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"statistic-remove-all\",
- \"arguments\": { }
-}",
- "cmd-comment": "If the removal of all statistics was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
-}
+ "brief": [
+ "The statistic-remove-all command attempts to delete all statistics."
+ ],
+ "cmd-comment": [
+ "If the removal of all statistics was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-remove-all\",",
+ " \"arguments\": { }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-remove-all\"/>",
+ "name": "statistic-remove-all",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-remove",
- "brief": "The statistic-remove command attempts to delete a single statistic. It takes a single string parameter called name that specifies the statistic name.",
- "description": "See <xref linkend=\"command-statistic-remove\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"statistic-remove\",
- \"arguments\": {
- \"name\": \"pkt4-received\"
- }
-}",
- "cmd-comment": "If the specific statistic is found and its removal was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
-}
+ "brief": [
+ "The statistic-remove command attempts to delete a single statistic. It takes a single string parameter called name that specifies the statistic name."
+ ],
+ "cmd-comment": [
+ "If the specific statistic is found and its removal was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-remove\",",
+ " \"arguments\": {",
+ " \"name\": \"pkt4-received\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-remove\"/>",
+ "name": "statistic-remove",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-reset-all",
- "brief": "The statistic-reset command sets all statistics to their neutral values: 0 for integer, 0.0 for float, 0h0m0s0us for time duration and \"\" for string type.",
- "description": "See <xref linkend=\"command-statistic-reset-all\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"statistic-reset-all\",
- \"arguments\": { }
-}",
- "cmd-comment": "If the operation is successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
-}
+ "brief": [
+ "The statistic-reset command sets all statistics to their neutral values: 0 for integer, 0.0 for float, 0h0m0s0us for time duration and \"\" for string type."
+ ],
+ "cmd-comment": [
+ "If the operation is successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-reset-all\",",
+ " \"arguments\": { }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-reset-all\"/>",
+ "name": "statistic-reset-all",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-reset",
- "brief": "The statistic-reset command sets the specified statistic to its neutral value: 0 for integer, 0.0 for float, 0h0m0s0us for time duration and \"\" for string type. It takes a single string parameter called name that specifies the statistic name.",
- "description": "See <xref linkend=\"command-statistic-reset\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
- "cmd-syntax": "{
- \"command\": \"statistic-reset\",
- \"arguments\": {
- \"name\": \"pkt4-received\"
- }
-}",
- "cmd-comment": "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
-}
+ "brief": [
+ "The statistic-reset command sets the specified statistic to its neutral value: 0 for integer, 0.0 for float, 0h0m0s0us for time duration and \"\" for string type. It takes a single string parameter called name that specifies the statistic name."
+ ],
+ "cmd-comment": [
+ "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-reset\",",
+ " \"arguments\": {",
+ " \"name\": \"pkt4-received\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-reset\"/>",
+ "name": "statistic-reset",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-sample-age-set-all",
- "brief": "The statistic-sample-age-set-all command sets time based limit for all statistics. It takes a single integer parameter called duration.",
- "description": "See <xref linkend=\"command-statistic-sample-age-set-all\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.6.0",
- "cmd-syntax": "{
- \"command\": \"statistic-sample-age-set-all\",
- \"arguments\": {
- \"duration\": 1245
- }
-}",
- "cmd-comment": "The server will respond with message about successfully set limits for all statistics, with a result set to 0 indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
-}
+ "brief": [
+ "The statistic-sample-age-set-all command sets time based limit for all statistics. It takes a single integer parameter called duration."
+ ],
+ "cmd-comment": [
+ "The server will respond with message about successfully set limits for all statistics, with a result set to 0 indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-sample-age-set-all\",",
+ " \"arguments\": {",
+ " \"duration\": 1245",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-sample-age-set-all\"/>",
+ "name": "statistic-sample-age-set-all",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-sample-age-set",
- "brief": "The statistic-sample-age-set command sets time based limit for single statistic. It takes two parameters: a string called name and an integer value called duration.",
- "description": "See <xref linkend=\"command-statistic-sample-age-set\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.6.0",
- "cmd-syntax": "{
- \"command\": \"statistic-sample-age-set\",
- \"arguments\": {
- \"name\": \"pkt4-received\",
- \"duration\": 1245
- }
-}",
- "cmd-comment": "The server will respond with message about successfully set limit for the given statistic, with a result set to 0 indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
-}
+ "brief": [
+ "The statistic-sample-age-set command sets time based limit for single statistic. It takes two parameters: a string called name and an integer value called duration."
+ ],
+ "cmd-comment": [
+ "The server will respond with message about successfully set limit for the given statistic, with a result set to 0 indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-sample-age-set\",",
+ " \"arguments\": {",
+ " \"name\": \"pkt4-received\",",
+ " \"duration\": 1245",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-sample-age-set\"/>",
+ "name": "statistic-sample-age-set",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-sample-count-set-all",
- "brief": "The statistic-sample-count-set-all command sets size based limit for all statistics. It takes a single integer parameter called max-samples.",
- "description": "See <xref linkend=\"command-statistic-sample-count-set-all\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.6.0",
- "cmd-syntax": "{
- \"command\": \"statistic-sample-count-set-all\",
- \"arguments\": {
- \"max-samples\": 100
- }
-}",
- "cmd-comment": "The server will respond with message about successfully set limits for all statistics, with a result set to 0 indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
-}
+ "brief": [
+ "The statistic-sample-count-set-all command sets size based limit for all statistics. It takes a single integer parameter called max-samples."
+ ],
+ "cmd-comment": [
+ "The server will respond with message about successfully set limits for all statistics, with a result set to 0 indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-sample-count-set-all\",",
+ " \"arguments\": {",
+ " \"max-samples\": 100",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-sample-count-set-all\"/>",
+ "name": "statistic-sample-count-set-all",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "statistic-sample-count-set",
- "brief": "The statistic-sample-count-set command sets size based limit for single statistic. It takes two parameters: a string called name and an integer value called max-samples.",
- "description": "See <xref linkend=\"command-statistic-sample-count-set\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.6.0",
- "cmd-syntax": "{
- \"command\": \"statistic-sample-count-set\",
- \"arguments\": {
- \"name\": \"pkt4-received\",
- \"max-samples\": 100
- }
-}",
- "cmd-comment": "The server will respond with message about successfully set limit for the given statistic, with a result set to 0 indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
-}
+ "brief": [
+ "The statistic-sample-count-set command sets size based limit for single statistic. It takes two parameters: a string called name and an integer value called max-samples."
+ ],
+ "cmd-comment": [
+ "The server will respond with message about successfully set limit for the given statistic, with a result set to 0 indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-sample-count-set\",",
+ " \"arguments\": {",
+ " \"name\": \"pkt4-received\",",
+ " \"max-samples\": 100",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-sample-count-set\"/>",
+ "name": "statistic-sample-count-set",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "subnet4-add",
- "brief": "This command is used to create and add a new subnet to the existing server configuration.",
- "description": "See <xref linkend=\"idp69\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "This command is used to create and add a new subnet to the existing server configuration."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet4-add\",",
+ " \"arguments\": {",
+ " \"subnets\": [ {",
+ " \"id\": 123,",
+ " \"subnet\": \"10.20.30.0/24\",",
+ " ...",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp69\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet4-add\",
- \"arguments\": {
- \"subnets\": [ {
- \"id\": 123,
- \"subnet\": \"10.20.30.0/24\",
- ...
- } ]
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet added\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": 123,
- \"subnet\": \"10.20.30.0/24\"
- }
- ]
- }
-}"
-}
+ "name": "subnet4-add",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet added\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": 123,",
+ " \"subnet\": \"10.20.30.0/24\"",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "subnet4-del",
- "brief": "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of.",
- "description": "See <xref linkend=\"idp71\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet4-del\",",
+ " \"arguments\": {",
+ " \"id\": 123",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp71\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet4-del\",
- \"arguments\": {
- \"id\": 123
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet 192.0.2.0/24 (id 123) deleted\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": 123,
- \"subnet\": \"192.0.2.0/24\"
- }
- ]
- }
-}"
-}
+ "name": "subnet4-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet 192.0.2.0/24 (id 123) deleted\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": 123,",
+ " \"subnet\": \"192.0.2.0/24\"",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "subnet4-get",
- "brief": "This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet4-list, which is used to discover available subnets with their respective subnet identifiers and prefixes.",
- "description": "See <xref linkend=\"idp67\"/>",
- "support": [ "kea-dhcp4" ],
"avail": "1.3.0",
+ "brief": [
+ "This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet4-list, which is used to discover available subnets with their respective subnet identifiers and prefixes."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet4-get\",",
+ " \"arguments\": {",
+ " \"id\": 10",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp67\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet4-get\",
- \"arguments\": {
- \"id\": 10
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"Info about IPv4 subnet 10.0.0.0/8 (id 10) returned\",
- \"arguments\": {
- \"subnets\": [
- {
- \"subnet\": \"10.0.0.0/8\",
- \"id\": 1,
- \"option-data\": [
- ....
- ]
- ...
- }
- ]
- }
-}"
-}
+ "name": "subnet4-get",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Info about IPv4 subnet 10.0.0.0/8 (id 10) returned\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"subnet\": \"10.0.0.0/8\",",
+ " \"id\": 1,",
+ " \"option-data\": [",
+ " ....",
+ " ]",
+ " ...",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "subnet4-list",
- "brief": "This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet.",
- "description": "See <xref linkend=\"idp65\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.3.0",
+ "brief": [
+ "This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet4-list\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp65\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet4-list\"
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 IPv4 subnets found\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": 10,
- \"subnet\": \"10.0.0.0/8\"
- },
- {
- \"id\": 100,
- \"subnet\": \"192.0.2.0/24\"
- }
+ "name": "subnet4-list",
+ "resp-comment": [
+ "If no IPv4 subnets are found, an error code is returned along with the error description."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv4 subnets found\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": 10,",
+ " \"subnet\": \"10.0.0.0/8\"",
+ " },",
+ " {",
+ " \"id\": 100,",
+ " \"subnet\": \"192.0.2.0/24\"",
+ " }",
+ " ]",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
]
-}",
- "resp-comment": "If no IPv4 subnets are found, an error code is returned along with the error description."
}
\ No newline at end of file
{
- "name": "subnet4-update",
- "brief": "This command is used to update a subnet in the existing server configuration.",
- "description": "See <xref linkend=\"idp69\"/>",
- "support": [ "kea-dhcp4"],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to update a subnet in the existing server configuration."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet4-update\",",
+ " \"arguments\": {",
+ " \"subnets\": [ {",
+ " \"id\": 123,",
+ " \"subnet\": \"10.20.30.0/24\",",
+ " ...",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp69\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet4-update\",
- \"arguments\": {
- \"subnets\": [ {
- \"id\": 123,
- \"subnet\": \"10.20.30.0/24\",
- ...
- } ]
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv4 subnet updated\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": 123,
- \"subnet\": \"10.20.30.0/24\"
- }
- ]
- }
-}"
-}
+ "name": "subnet4-update",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv4 subnet updated\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": 123,",
+ " \"subnet\": \"10.20.30.0/24\"",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}
\ No newline at end of file
{
- "name": "subnet6-add",
- "brief": "This command is used to create and add new subnet to the existing server configuration. This operation has no impact on other subnets.",
- "description": "See <xref linkend=\"idp70\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "This command is used to create and add new subnet to the existing server configuration. This operation has no impact on other subnets."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet6-add\",",
+ " \"arguments\": {",
+ " \"subnet6\": [ {",
+ " \"id\": 234,",
+ " \"subnet\": \"2001:db8:1::/64\",",
+ " ...",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp70\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet6-add\",
- \"arguments\": {
- \"subnet6\": [ {
- \"id\": 234,
- \"subnet\": \"2001:db8:1::/64\",
- ...
- } ]
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv6 subnet added\",
- \"arguments\": {
- \"subnet6\": [
- {
- \"id\": 234,
- \"subnet\": \"2001:db8:1::/64\"
- }
- ]
- }
-}"
-}
+ "name": "subnet6-add",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 subnet added\",",
+ " \"arguments\": {",
+ " \"subnet6\": [",
+ " {",
+ " \"id\": 234,",
+ " \"subnet\": \"2001:db8:1::/64\"",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "subnet6-del",
- "brief": "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of.",
- "description": "See <xref linkend=\"idp72\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet6-del\",",
+ " \"arguments\": {",
+ " \"id\": 234",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp72\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet6-del\",
- \"arguments\": {
- \"id\": 234
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv6 subnet 2001:db8:1::/64 (id 234) deleted\",
- \"subnets\": [
- {
- \"id\": 234,
- \"subnet\": \"2001:db8:1::/64\"
- }
+ "name": "subnet6-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 subnet 2001:db8:1::/64 (id 234) deleted\",",
+ " \"subnets\": [",
+ " {",
+ " \"id\": 234,",
+ " \"subnet\": \"2001:db8:1::/64\"",
+ " }",
+ " ]",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
]
-}"
-}
+}
\ No newline at end of file
{
- "name": "subnet6-get",
- "brief": "This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet6-list, which is used to discover available subnets with their respective subnet identifiers and prefixes.",
- "description": "See <xref linkend=\"idp68\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet6-list, which is used to discover available subnets with their respective subnet identifiers and prefixes."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet6-get\",",
+ " \"arguments\": {",
+ " \"id\": 11",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp68\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet6-get\",
- \"arguments\": {
- \"id\": 11
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"Info about IPv6 subnet 2001:db8:1::/64 (id 11) returned\",
- \"arguments\": {
- \"subnets\": [
- {
- \"subnet\": \"2001:db8:1::/64\",
- \"id\": 1,
- \"option-data\": [
- ...
- ]
- ....
- }
- ]
- }
-}"
-}
+ "name": "subnet6-get",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Info about IPv6 subnet 2001:db8:1::/64 (id 11) returned\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"subnet\": \"2001:db8:1::/64\",",
+ " \"id\": 1,",
+ " \"option-data\": [",
+ " ...",
+ " ]",
+ " ....",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "subnet6-list",
- "brief": "This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet.",
- "description": "See <xref linkend=\"idp66\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.3.0",
+ "brief": [
+ "This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet6-list\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp66\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet6-list\"
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"2 IPv6 subnets found\",
- \"arguments\": {
- \"subnets\": [
- {
- \"id\": 11,
- \"subnet\": \"2001:db8:1::/64\"
- },
- {
- \"id\": 233,
- \"subnet\": \"3000::/16\"
- }
+ "name": "subnet6-list",
+ "resp-comment": [
+ "If no IPv6 subnets are found, an error code is returned along with the error description."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 IPv6 subnets found\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": 11,",
+ " \"subnet\": \"2001:db8:1::/64\"",
+ " },",
+ " {",
+ " \"id\": 233,",
+ " \"subnet\": \"3000::/16\"",
+ " }",
+ " ]",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
]
-}",
- "resp-comment": "If no IPv6 subnets are found, an error code is returned along with the error description."
}
\ No newline at end of file
{
- "name": "subnet6-update",
- "brief": "This command is used to update a subnet in the existing server configuration. This operation has no impact on other subnets.",
- "description": "See <xref linkend=\"idp70\"/>",
- "support": [ "kea-dhcp6" ],
"avail": "1.6.0",
+ "brief": [
+ "This command is used to update a subnet in the existing server configuration. This operation has no impact on other subnets."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet6-update\",",
+ " \"arguments\": {",
+ " \"subnet6\": [ {",
+ " \"id\": 234,",
+ " \"subnet\": \"2001:db8:1::/64\",",
+ " ...",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp70\"/>",
"hook": "subnet_cmds",
- "cmd-syntax": "{
- \"command\": \"subnet6-update\",
- \"arguments\": {
- \"subnet6\": [ {
- \"id\": 234,
- \"subnet\": \"2001:db8:1::/64\",
- ...
- } ]
- }
-}",
- "resp-syntax": "{
- \"result\": 0,
- \"text\": \"IPv6 subnet updated\",
- \"arguments\": {
- \"subnet6\": [
- {
- \"id\": 234,
- \"subnet\": \"2001:db8:1::/64\"
- }
- ]
- }
-}"
-}
+ "name": "subnet6-update",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 subnet updated\",",
+ " \"arguments\": {",
+ " \"subnet6\": [",
+ " {",
+ " \"id\": 234,",
+ " \"subnet\": \"2001:db8:1::/64\"",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}
\ No newline at end of file
{
- "name": "version-get",
- "brief": "The version-get command returns extended information about
- Kea version. The returned string is the same as if Kea would
- be run with -V command line option.",
- "description": "See <xref linkend=\"command-version-get\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
- "cmd-syntax": "{
- \"command\": \"version-get\"
-}"
-}
+ "brief": [
+ "The version-get command returns extended information about",
+ " Kea version. The returned string is the same as if Kea would",
+ " be run with -V command line option."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"version-get\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-version-get\"/>",
+ "name": "version-get",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}
\ No newline at end of file
:name: appendices
:maxdepth: 1
+ api
manpages
kea-messages
arm/acknowledgments
projects / thirdparty / kea.git / commitdiff
