2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-30 21:45:37 +00:00

Add new file

This commit is contained in:
Suzanne Goldlust
2018-10-04 13:03:47 -04:00
committed by Tomek Mrugalski
parent 2828217c12
commit beaab2727a

47
doc/api/network6-get.json Normal file
View File

@@ -0,0 +1,47 @@
{
"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-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
"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."
}