"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" ],
+ "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"config-test\",
{
"name": "config-write",
- "brief": "The config-write command instructs the Kea server to write its current configuration to a file on disk.",
+ "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" ],
+ "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"config-write\",
"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" , "ca" ],
+ "support": [ "kea-dhcp4", "kea-dhcp6" , "kea-ctrl-agent" ],
"avail": "1.0.0",
"cmd-syntax": "{
\"command\": \"list-commands\",
{
"name": "network4-list",
"brief": "The network4-list command is used to retrieve full list of currently configured shared networks.",
- "description": "See <xref linkend=\"idp73\"/>",
+ "description": "See <xref linkend=\"command-networkX-list\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
{
"name": "network6-del",
"brief": "The network6-del command is used to delete existing shared networks.",
- "description": "See <xref linkend=\"idp76\"/>",
+ "description": "See <xref linkend=\"command-network6-del\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
\"name\": \"floor13\"
}
}",
- "cmd-comment": "The network6-del command uses exactly the same syntax for both the command and the response.",
+ "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": "network6-list",
"brief": "The network6-list command is used to retrieve full list of currently configured shared networks.",
- "description": "See <xref linkend=\"idp73\"/>",
+ "description": "See <xref linkend=\"command-networkX-list\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"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" ],
+ "support": [ "kea-dhcp4", "kea-dhcp6", "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."
+ "cmd-comment": "The server will respond with a confirmation that the shutdown
+ procedure has been initiated."
}
{
"name": "stat-lease4-get",
- "brief": "The stat-lease4-get command fetches lease statistics for a range of known subnets.",
- "description": "See <xref linkend=\"idp81\"/>",
+ "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", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "stat_cmds",
\"text\": \"stat-lease4-get: 2 rows found\",
\"arguments\": {
\"result-set\": {
- \"columns\": [ \"subnet-id\", \"total-addresses\", \"assigned-addresses\", \"declined-addresses\" ]
+ \"columns\": [ \"subnet-id\",
+ \"total-addresses\",
+ \"assigned-addresses\",
+ \"declined-addresses\" ]
\"rows\": [
[ 10, 256, 111, 0 ],
[ 20, 4098, 2034, 4 ]
{
"name": "stat-lease6-get",
- "brief": "The stat-lease6-get command fetches lease statistics for a range of known subnets.",
- "description": "See <xref linkend=\"idp81\"/>",
+ "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-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "stat_cmds",
\"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.",
-}
\ No newline at end of file
+ "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."
+}
\"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.",
-}
\ No newline at end of file
+ "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."
+}
}
]
}
-}",
-}
\ 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.",
+ "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", "kea-dhcp6" ],
"avail": "1.3.0",
}
]
}
-}",
-}
\ No newline at end of file
+}"
+}
}
]
}
-}",
-}
\ No newline at end of file
+}"
+}
}
]
}
-}",
-}
\ 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.",
+ "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-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
\"subnet\": \"2001:db8:1::/64\"
}
]
-}",
-}
\ No newline at end of file
+}"
+}
}
]
}
-}",
-}
\ No newline at end of file
+}"
+}
{
"name": "version-get",
- "brief": "The version-get command returns on the control channel what the command line -v argument displays with in arguments the extended version, i.e., what the command line -V argument displays.",
+ "brief": "The version-get command returns on the control channel what the
+ command line -v argument displays with in arguments the extended
+ version, i.e., what the command line -V argument displays.",
"description": "See <xref linkend=\"command-version-get\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
+ "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"version-get\"
-}",
-}
\ No newline at end of file
+}"
+}
config-write
dhcp-disable
dhcp-enable
+ha-continue
ha-heartbeat
ha-scopes
ha-sync
<section xml:id="ha-server-states">
<title>Server States</title>
- <para>The DHCP server operating within an HA setup runs a state machine
+ <para id="command-ha-heartbeat">The DHCP server operating
+ within an HA setup runs a state machine
and the state of the server can be retrieved by its peers using the
<command>ha-heartbeat</command> command sent over the RESTful API. If
the partner server doesn't respond to the <command>ha-heartbeat</command>
HA hook library which are available for the administrator.
</para>
- <section xml:id="ha-sync-command">
+ <section xml:id="command-ha-sync">
<title>ha-sync command</title>
<para>The <command>ha-sync</command> is issued to instruct the
server to synchronize its local lease database with the
</para>
</section> <!-- ha-sync-command -->
- <section xml:id="ha-scopes-command">
+ <section xml:id="command-ha-scopes">
<title>ha-scopes command</title>
<para>This command allows for modifying the HA scopes that the
server is serving. Consult <xref linkend="ha-load-balancing-config"/>
<screen>
{
"command": "ha-scopes",
- "service": [ "dhcp4 "],
+ "service": [ "dhcp4" ],
"arguments": {
"scopes": [ "HA_server1", "HA_server2" ]
}
</para>
</section> <!-- ha-scopes-command -->
- <section xml:id="ha-continue-command">
+ <section xml:id="command-ha-continue">
<title>ha-continue command</title>
<para>This command is used to resume the operation of the paused HA
state machine as described in the <xref linkend="ha-pause-state-machine"/>.
</screen>
</para>
- <section>
+ <section id="command-lease4-add">
<title>lease4-add, lease6-add commands</title>
- <para>
+ <para id="command-lease6-add">
<command>lease4-add</command> and <command>lease6-add</command>
commands allow for the creation of a new lease. Typically Kea creates
a lease on its own, when it first sees a new device. However,
</para>
- <section>
+ <section id="command-lease4-get">
<title>lease4-get, lease6-get commands</title>
- <para><command>lease4-get</command> or <command>lease6-get</command>
+ <para id="command-lease6-get">
+ <command>lease4-get</command> or <command>lease6-get</command>
can be used to query the lease database and retrieve existing
leases. There are two types of parameters the
<command>lease4-get</command> supports: (address) or (subnet-id,
</section>
- <section>
+ <section id="command-lease4-get-all">
<title>lease4-get-all, lease6-get-all commands</title>
- <para><command>lease4-get-all</command> and
+ <para id="command-lease6-get-all"><command>lease4-get-all</command> and
<command>lease6-get-all</command> are used to retrieve all
IPv4 or IPv6 leases or all leases for the specified set of
subnets. All leases are returned when there are no arguments
</section>
- <section>
+ <section id="command-lease4-del">
<title>lease4-del, lease6-del commands</title>
- <para><command>leaseX-del</command> can be used to delete a lease from
+ <para id="command-lease6-del">
+ <command>leaseX-del</command> can be used to delete a lease from
the lease database. There are two types of parameters this command
supports, similar to leaseX-get commands: (address) for both v4 and
v6, (subnet-id, identifier-type, identifier) for v4 and (subnet-id,
</para>
</section>
- <section>
+ <section id="command-lease4-update">
<title>lease4-update, lease6-update commands</title>
- <para><command>lease4-update</command> and
+ <para id="command-lease6-update"><command>lease4-update</command> and
<command>lease6-update</command> commands can be used to update
existing leases. Since all lease database backends are indexed by IP
addresses, it is not possible to update an address. All other fields
</para>
</section>
- <section>
+ <section id="command-lease4-wipe">
<title>lease4-wipe, lease6-wipe commands</title>
- <para><command>lease4-wipe</command> and
+ <para id="command-lease6-wipe"><command>lease4-wipe</command> and
<command>lease6-wipe</command> are designed to remove all
leases associated with a given subnet. This administrative
task is expected to be used when existing subnet is being
will not retrieve statistics for it.
</para>
-<section>
+<section id="command-stat-lease4-get">
<title>stat-lease4-get, stat-lease6-get commands</title>
- <para>
+ <para id="command-stat-lease6-get">
The <command>stat-lease4-get</command> and <command>stat-lease6-get</command>
commands fetch lease statistics for a range of known subnets. The
range of subnets is determined through the use of optional command
</para>
</section>
- <section xml:id="cmd-reservation-add">
+ <section xml:id="command-reservation-add">
<title>reservation-add command</title>
<para>
<command>reservation-add</command> allows for the insertion of a new host. It
</itemizedlist>
</para>
- <section>
+ <section id="command-subnet4-list">
<title>subnet4-list command</title>
<para>
This command is used to list all currently configured subnets. The
</para>
</section>
- <section>
+ <section id="command-subnet6-list">
<title>subnet6-list command</title>
<para>
This command is used to list all currently configured subnets. The
</para>
</section>
- <section>
+ <section id="command-subnet4-get">
<title>subnet4-get command</title>
<para>This command is used to retrieve detailed information about the
specified subnet. This command usually follows the
</para>
</section>
- <section>
+ <section id="command-subnet6-get">
<title>subnet6-get command</title>
<para>This command is used to retrieve detailed information about the
specified subnet. This command usually follows the
</para>
</section>
- <section>
+ <section id="command-subnet4-add">
<title>subnet4-add</title>
<para>
This command is used to create and add new subnet to the existing
</para>
</section>
- <section>
+ <section id="command-subnet6-add">
<title>subnet6-add</title>
<para>
This command is used to create and add new subnet to the existing
</section>
- <section>
+ <section id="command-subnet4-del">
<title>subnet4-del command</title>
<para>
This command is used to remove a subnet from the server's configuration.
</para>
</section>
- <section>
+ <section id="command-subnet6-del">
<title>subnet6-del command</title>
<para>
This command is used to remove a subnet from the server's configuration.
</para>
</section>
- <section>
+ <section id="command-network4-list">
<title>network4-list, network6-list commands</title>
- <para>
+ <para id="command-network6-list">
These commands are used to retrieve full list of currently configured
shared networks. The list contains only very basic information about
each shared network. If more details are needed, please use
</para>
</section>
- <section>
+ <section id="command-network4-get">
<title>network4-get, network6-get commands</title>
- <para>
+ <para id="command-network6-get">
These commands are used to retrieve detailed information
about shared networks, including subnets currently
being part of a given network. Both commands take one
</para>
</section>
- <section>
+ <section id="command-network4-add">
<title>network4-add, network6-add commands</title>
- <para>
+ <para id="command-network6-add">
These commands are used to add a new shared network. New
network has to have unique name. This command requires one parameter
<command>shared-networks</command>, which is a list and
applies to subnets within the network.
</para>
</section>
- <section>
+ <section id="command-network4-del">
<title>network4-del, network6-del commands</title>
- <para>
+ <para id="command-network6-del">
These commands are used to delete existing shared
networks. Both commands take exactly one parameter 'name' that
specifies the name of the network to be removed. An example invocation
<command>subnet6-del</command> commands.</para>
</section>
- <section>
+ <section id="command-network4-subnet-add">
<title>network4-subnet-add, network6-subnet-add commands</title>
- <para>
+ <para id="command-network6-subnet-add">
These commands are used to add existing subnets to existing shared
networks. There are several ways to add new shared network. System
administrator can add the whole shared network at once, either by
filled with default values, rather than inherited from
global scope or from the shared network.</para></note>
</section>
- <section>
+ <section id="command-network4-subnet-del">
<title>network4-subnet-del, network6-subnet-del commands</title>
- <para>
+ <para id="command-network6-subnet-del">
These commands are used to remove a subnet that is part of existing shared
network and demote it to a plain, stand-alone subnet. If you want to
remove a subnet completely, use <command>subnet4-del</command> or