Commit 0e70fff3 authored by Marcin Siodelski's avatar Marcin Siodelski
Browse files

[#643,!421] Updated API docs for global parameters setting.

parent 2810c44a
......@@ -7,13 +7,14 @@
"cmd-syntax": "{
\"command\": \"remote-global-parameter4-del\",
\"arguments\": {
\"parameters\": [ <parameter name> ],
\"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.",
"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.\",
......
......@@ -9,10 +9,11 @@
\"arguments\": {
\"remote\": {
<specification of the database to connect to>
}
},
\"server-tags\": [ <single server tag as string> ]
}
}",
"cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
"cmd-comment": "The <command>server-tags</command> list is mandatory and it muct 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.\",
......@@ -21,18 +22,18 @@
{
<first parameter name>: <first parameter value>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
},
{
<second parameter name>: <second parameter value>,
\"metadata\": {
\"server-tag\": <server tag>
\"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."
"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."
}
......@@ -7,13 +7,14 @@
"cmd-syntax": "{
\"command\": \"remote-global-parameter4-get\",
\"arguments\": {
\"parameters\": [ <parameter name> ],
\"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.",
"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.\",
......@@ -21,11 +22,11 @@
\"parameters\": {
<parameter name>: <parameter value>,
\"metadata\": {
\"server-tag\": <server tag>
\"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."
"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."
}
......@@ -13,10 +13,11 @@
},
\"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.",
"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.\",
......
......@@ -7,17 +7,19 @@
"cmd-syntax": "{
\"command\": \"remote-global-parameter6-del\",
\"arguments\": {
\"parameters\": [ <parameter name> ],
\"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.",
"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
}"
}
}"
}
......@@ -5,14 +5,15 @@
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-global-parameter6-get-all\"
\"command\": \"remote-global-parameter6-get-all\",
\"arguments\": {
\"remote\": {
<specification of the database to connect to>
}
},
\"server-tags\": [ <single server tag as string> ]
}
}",
"cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
"cmd-comment": "The <command>server-tags</command> list is mandatory and it muct 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.\",
......@@ -21,18 +22,18 @@
{
<first parameter name>: <first parameter value>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
},
{
<second parameter name>: <second parameter value>,
\"metadata\": {
\"server-tag\": <server tag>
\"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."
"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."
}
......@@ -5,15 +5,16 @@
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-global-parameter6-get\"
\"command\": \"remote-global-parameter6-get\",
\"arguments\": {
\"parameters\": [ <parameter name> ],
\"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.",
"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.\",
......@@ -21,11 +22,11 @@
\"parameters\": {
<parameter name>: <parameter value>,
\"metadata\": {
\"server-tag\": <server tag>
\"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."
"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-set",
"brief": "This command is used to create or update one more global DHCP parameters in the configuration database.",
"brief": "This command is used to create or update one more global parameters in the configuration database.",
"support": [ "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "cb_cmds",
......@@ -13,10 +13,11 @@
},
\"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.",
"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.\",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment