diff options
Diffstat (limited to 'src/share/api/lease4-add.json')
| -rw-r--r-- | src/share/api/lease4-add.json | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/src/share/api/lease4-add.json b/src/share/api/lease4-add.json new file mode 100644 index 0000000..3e6e834 --- /dev/null +++ b/src/share/api/lease4-add.json @@ -0,0 +1,28 @@ +{ + "access": "write", + "avail": "1.3.0", + "brief": [ + "This command administratively adds a new IPv4 lease." + ], + "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", + "name": "lease4-add", + "resp-comment": [ + "If the returned result is equal to 4, it indicates that the lease could not be created because it was in conflict with the server's state or its notion of the configuration. The High Availability hook library can handle such a result differently than a general error. A general error of 1 can indicate issues with processing the command, database availability etc." + ], + "support": [ + "kea-dhcp4" + ] +} |