[826-documentation-of-cb_cmds-embedded-commands] Added API files

diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am
index e41ed809446e5408959a8850f53228de5ab3e830..83b2487efb95769ae9194e93453fa123664213e6 100644 (file)
--- a/doc/sphinx/Makefile.am
+++ b/doc/sphinx/Makefile.am
@@ -80,6 +80,20 @@ mes_files=$(foreach mf,$(mes_files1), $(top_srcdir)/$(mf))
 # list of api files that are used to generate api.rst
 api_files1=$(shell cat api-files.txt)
 api_files=$(foreach af,$(api_files1), $(srcdir)/$(af))
+api_files+=$(srcdir)/api/remote-option4-network-del.json
+api_files+=$(srcdir)/api/remote-option4-network-set.json
+api_files+=$(srcdir)/api/remote-option4-pool-del.json
+api_files+=$(srcdir)/api/remote-option4-pool-set.json
+api_files+=$(srcdir)/api/remote-option4-subnet-del.json
+api_files+=$(srcdir)/api/remote-option4-subnet-set.json
+api_files+=$(srcdir)/api/remote-option6-network-del.json
+api_files+=$(srcdir)/api/remote-option6-network-set.json
+api_files+=$(srcdir)/api/remote-option6-pd-pool-del.json
+api_files+=$(srcdir)/api/remote-option6-pd-pool-set.json
+api_files+=$(srcdir)/api/remote-option6-pool-del.json
+api_files+=$(srcdir)/api/remote-option6-pool-set.json
+api_files+=$(srcdir)/api/remote-option6-subnet-del.json
+api_files+=$(srcdir)/api/remote-option6-subnet-set.json
 
 EXTRA_DIST += mes-files.txt
 EXTRA_DIST += api-files.txt

diff --git a/doc/sphinx/api/cmds-list b/doc/sphinx/api/cmds-list
index bcfaf87c3779a66f484e69c5e094b5cba0fad29f..35f448ca4bcf27d17da136f70588f54ad05079b1 100644 (file)
--- a/doc/sphinx/api/cmds-list
+++ b/doc/sphinx/api/cmds-list
@@ -83,6 +83,20 @@ remote-option6-global-del
 remote-option6-global-get
 remote-option6-global-get-all
 remote-option6-global-set
+remote-option4-network-del
+remote-option4-network-set
+remote-option4-pool-del
+remote-option4-pool-set
+remote-option4-subnet-del
+remote-option4-subnet-set
+remote-option6-network-del
+remote-option6-network-set
+remote-option6-pd-pool-del
+remote-option6-pd-pool-set
+remote-option6-pool-del
+remote-option6-pool-set
+remote-option6-subnet-del
+remote-option6-subnet-set
 remote-server4-del
 remote-server4-get
 remote-server4-get-all

diff --git a/doc/sphinx/api/remote-option4-network-del.json b/doc/sphinx/api/remote-option4-network-del.json
new file mode 100644 (file)
index 0000000..0304e26
--- /dev/null
+++ b/doc/sphinx/api/remote-option4-network-del.json
@@ -0,0 +1,44 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command deletes a DHCPv4 shared network option from the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly one name of the shared network and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option4-network-del\",",
+        "    \"arguments\": {",
+        "        \"shared-networks\": [",
+        "            {",
+        "                \"name\": <shared network name>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option4-network-del",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"1 DHCPv4 option(s) deleted.\",",
+        "    \"arguments\": {",
+        "        \"count\": 1",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option4-network-set.json b/doc/sphinx/api/remote-option4-network-set.json
new file mode 100644 (file)
index 0000000..ea1177b
--- /dev/null
+++ b/doc/sphinx/api/remote-option4-network-set.json
@@ -0,0 +1,49 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command creates or replaces a DHCPv4 shared network option in the configuration database."
+    ],
+    "cmd-comment": [
+        "The provided lists must contain exactly one name of the shared network and one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option4-network-set\",",
+        "    \"arguments\": {",
+        "    \"arguments\": {",
+        "        \"shared-networks\": [",
+        "            {",
+        "                \"name\": <shared network name>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                <shared network option specification>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option4-network-set",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"DHCPv4 option successfully set.\",",
+        "    \"arguments\": {",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ]",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option4-pool-del.json b/doc/sphinx/api/remote-option4-pool-del.json
new file mode 100644 (file)
index 0000000..a1a58ac
--- /dev/null
+++ b/doc/sphinx/api/remote-option4-pool-del.json
@@ -0,0 +1,44 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command deletes a DHCPv4 address pool option from the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly address pool specification and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option4-pool-del\",",
+        "    \"arguments\": {",
+        "        \"pools\": [",
+        "            {",
+        "                \"pool\": <pool range or prefix>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option4-pool-del",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"1 DHCPv4 option(s) deleted.\",",
+        "    \"arguments\": {",
+        "        \"count\": 1",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option4-pool-set.json b/doc/sphinx/api/remote-option4-pool-set.json
new file mode 100644 (file)
index 0000000..0167c9d
--- /dev/null
+++ b/doc/sphinx/api/remote-option4-pool-set.json
@@ -0,0 +1,48 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command creates or replaces a DHCPv4 address pool option in the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly address pool specification and exactly one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option4-pool-set\",",
+        "    \"arguments\": {",
+        "        \"pools\": [",
+        "            {",
+        "                \"pool\": <pool range or prefix>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                <address pool option specification>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option4-pool-set",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"DHCPv4 option successfully set.\",",
+        "    \"arguments\": {",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ]",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option4-subnet-del.json b/doc/sphinx/api/remote-option4-subnet-del.json
new file mode 100644 (file)
index 0000000..15991a5
--- /dev/null
+++ b/doc/sphinx/api/remote-option4-subnet-del.json
@@ -0,0 +1,44 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command deletes a DHCPv4 subnet option from the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly one ID of the subnet and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option4-subnet-del\",",
+        "    \"arguments\": {",
+        "        \"subnets\": [",
+        "            {",
+        "                \"id\": <subnet identifier>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option4-subnet-del",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"1 DHCPv4 option(s) deleted.\",",
+        "    \"arguments\": {",
+        "        \"count\": 1",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option4-subnet-set.json b/doc/sphinx/api/remote-option4-subnet-set.json
new file mode 100644 (file)
index 0000000..7eebe93
--- /dev/null
+++ b/doc/sphinx/api/remote-option4-subnet-set.json
@@ -0,0 +1,48 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command creates or replaces a DHCPv4 subnet option in the configuration database."
+    ],
+    "cmd-comment": [
+        "The provided lists must contain exactly one ID of the subnet and one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option4-subnet-set\",",
+        "    \"arguments\": {",
+        "        \"subnets\": [",
+        "            {",
+        "                \"id\": <subnet identifier>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                <subnet option specification>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option4-subnet-set",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"DHCPv4 option successfully set.\",",
+        "    \"arguments\": {",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ]",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option6-network-del.json b/doc/sphinx/api/remote-option6-network-del.json
new file mode 100644 (file)
index 0000000..c0b6a19
--- /dev/null
+++ b/doc/sphinx/api/remote-option6-network-del.json
@@ -0,0 +1,44 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command deletes a DHCPv6 shared network option from the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly one name of the shared network and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option6-network-del\",",
+        "    \"arguments\": {",
+        "        \"shared-networks\": [",
+        "            {",
+        "                \"name\": <shared network name>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option6-network-del",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"1 DHCPv6 option(s) deleted.\",",
+        "    \"arguments\": {",
+        "        \"count\": 1",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option6-network-set.json b/doc/sphinx/api/remote-option6-network-set.json
new file mode 100644 (file)
index 0000000..e7f8ad1
--- /dev/null
+++ b/doc/sphinx/api/remote-option6-network-set.json
@@ -0,0 +1,49 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command creates or replaces a DHCPv6 shared network option in the configuration database."
+    ],
+    "cmd-comment": [
+        "The provided lists must contain exactly one name of the shared network and one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option6-network-set\",",
+        "    \"arguments\": {",
+        "    \"arguments\": {",
+        "        \"shared-networks\": [",
+        "            {",
+        "                \"name\": <shared network name>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                <shared network option specification>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option6-network-set",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"DHCPv6 option successfully set.\",",
+        "    \"arguments\": {",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ]",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option6-pd-pool-del.json b/doc/sphinx/api/remote-option6-pd-pool-del.json
new file mode 100644 (file)
index 0000000..295787e
--- /dev/null
+++ b/doc/sphinx/api/remote-option6-pd-pool-del.json
@@ -0,0 +1,45 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command deletes a DHCPv6 prefix delegation pool option from the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly prefix delegation pool specification and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option6-pd-pool-del\",",
+        "    \"arguments\": {",
+        "        \"pd-pools\": [",
+        "            {",
+        "                \"prefix\": <pool prefix (address part)>",
+        "                \"prefix-len\": <pool prefix (length part)>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option6-pd-pool-del",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"1 DHCPv6 option(s) deleted.\",",
+        "    \"arguments\": {",
+        "        \"count\": 1",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option6-pd-pool-set.json b/doc/sphinx/api/remote-option6-pd-pool-set.json
new file mode 100644 (file)
index 0000000..d3db399
--- /dev/null
+++ b/doc/sphinx/api/remote-option6-pd-pool-set.json
@@ -0,0 +1,49 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command creates or replaces a DHCPv6 prefix delegation pool option in the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly prefix delegation pool specification and exactly one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option6-pd-pool-set\",",
+        "    \"arguments\": {",
+        "        \"pd-pools\": [",
+        "            {",
+        "                \"prefix\": <pool prefix (address part)>",
+        "                \"prefix-len\": <pool prefix (length part)>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                <prefix delegation pool option specification>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option6-pd-pool-set",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"DHCPv6 option successfully set.\",",
+        "    \"arguments\": {",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ]",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option6-pool-del.json b/doc/sphinx/api/remote-option6-pool-del.json
new file mode 100644 (file)
index 0000000..42d70c5
--- /dev/null
+++ b/doc/sphinx/api/remote-option6-pool-del.json
@@ -0,0 +1,44 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command deletes a DHCPv6 address pool option from the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly address pool specification and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option6-pool-del\",",
+        "    \"arguments\": {",
+        "        \"pools\": [",
+        "            {",
+        "                \"pool\": <pool range or prefix>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option6-pool-del",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"1 DHCPv6 option(s) deleted.\",",
+        "    \"arguments\": {",
+        "        \"count\": 1",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option6-pool-set.json b/doc/sphinx/api/remote-option6-pool-set.json
new file mode 100644 (file)
index 0000000..09cb0c3
--- /dev/null
+++ b/doc/sphinx/api/remote-option6-pool-set.json
@@ -0,0 +1,48 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command creates or replaces a DHCPv6 address pool option in the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly address pool specification and exactly one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option6-pool-set\",",
+        "    \"arguments\": {",
+        "        \"pools\": [",
+        "            {",
+        "                \"pool\": <pool range or prefix>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                <address pool option specification>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option6-pool-set",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"DHCPv6 option successfully set.\",",
+        "    \"arguments\": {",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ]",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option6-subnet-del.json b/doc/sphinx/api/remote-option6-subnet-del.json
new file mode 100644 (file)
index 0000000..9ae2cdb
--- /dev/null
+++ b/doc/sphinx/api/remote-option6-subnet-del.json
@@ -0,0 +1,44 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command deletes a DHCPv6 subnet option from the configuration database."
+    ],
+    "cmd-comment": [
+        "This command includes two lists with exactly one ID of the subnet and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option6-subnet-del\",",
+        "    \"arguments\": {",
+        "        \"subnets\": [",
+        "            {",
+        "                \"id\": <subnet identifier>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option6-subnet-del",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"1 DHCPv6 option(s) deleted.\",",
+        "    \"arguments\": {",
+        "        \"count\": 1",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/api/remote-option6-subnet-set.json b/doc/sphinx/api/remote-option6-subnet-set.json
new file mode 100644 (file)
index 0000000..146d66d
--- /dev/null
+++ b/doc/sphinx/api/remote-option6-subnet-set.json
@@ -0,0 +1,48 @@
+{
+    "avail": "1.6.0",
+    "brief": [
+        "This command creates or replaces a DHCPv6 subnet option in the configuration database."
+    ],
+    "cmd-comment": [
+        "The provided lists must contain exactly one ID of the subnet and one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option6-subnet-set\",",
+        "    \"arguments\": {",
+        "        \"subnets\": [",
+        "            {",
+        "                \"id\": <subnet identifier>",
+        "            }",
+        "        ],",
+        "        \"options\": [",
+        "            {",
+        "                <subnet option specification>",
+        "            }",
+        "        ],",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        }",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option6-subnet-set",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"DHCPv6 option successfully set.\",",
+        "    \"arguments\": {",
+        "        \"options\": [",
+        "            {",
+        "                \"code\": <option code>,",
+        "                \"space\": <option space>",
+        "            }",
+        "        ]",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/arm/hooks-cb-cmds.rst b/doc/sphinx/arm/hooks-cb-cmds.rst
index e1566f00a7c985302bc58311b1ca034b2c2409df..f713406dcd21eb12735ba2fe94ebc7f733641c57 100644 (file)
--- a/doc/sphinx/arm/hooks-cb-cmds.rst
+++ b/doc/sphinx/arm/hooks-cb-cmds.rst
@@ -1544,3 +1544,26 @@ to the database when the keyword "all" is used as the server tag.</para>
    specified for the updated subnet instance. Any unspecified parameter
    will be marked as unspecified in the database, even if its value was
    present prior to sending the command.
+
+The Embedded Option Commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These commands are used to create, replace or delete an option embedded
+in an IPv4 or IPv6 shared network, subnet, address pool, or IPv6 prefix
+delegation pool.
+
+.. _command-remote-option4-network-del:
+.. _command-remote-option4-network-set:
+.. _command-remote-option4-pool-del:
+.. _command-remote-option4-pool-set:
+.. _command-remote-option4-subnet-del:
+.. _command-remote-option4-subnet-set:
+.. _command-remote-option6-network-del:
+.. _command-remote-option6-network-set:
+.. _command-remote-option6-pd-pool-del:
+.. _command-remote-option6-pd-pool-set:
+.. _command-remote-option6-pool-del:
+.. _command-remote-option6-pool-set:
+.. _command-remote-option6-subnet-del:
+.. _command-remote-option6-subnet-set:
+