Commands Supported by Both the DHCPv4 and DHCPv6 Servers
========================================================
+.. isccmd:: build-report
.. _command-build-report:
The ``build-report`` Command
"command": "build-report"
}
+.. isccmd:: config-get
.. _command-config-get:
The ``config-get`` Command
"command": "config-get"
}
+.. isccmd:: config-reload
.. _command-config-reload:
The ``config-reload`` Command
which leaves the server in an unusable state. See :ref:`command-config-set`
to learn how to recover from a non-working server.
+.. isccmd:: config-test
.. _command-config-test:
The ``config-test`` Command
{"result": 1, "text": "unsupported parameter: BOGUS (<string>:16:26)" }
+.. isccmd:: config-write
.. _command-config-write:
The ``config-write`` Command
}
}
+.. isccmd:: leases-reclaim
.. _command-leases-reclaim:
The ``leases-reclaim`` Command
for details. Also, see :ref:`lease-reclamation` for general
information about the processing of expired leases (lease reclamation).
+.. isccmd:: libreload
.. _command-libreload:
The ``libreload`` Command
The server responds with a result of either 0, indicating success,
or 1, indicating failure.
+.. isccmd:: list-commands
.. _command-list-commands:
The ``list-commands`` Command
element is a list of strings, each of which conveys one supported
command.
+.. isccmd:: config-set
.. _command-config-set:
The ``config-set`` Command
{"result": 1, "text": "unsupported parameter: BOGUS (<string>:16:26)" }
+.. isccmd:: shutdown
.. _command-shutdown:
The ``shutdown`` Command
}
}
+.. isccmd:: dhcp-disable
.. _command-dhcp-disable:
The ``dhcp-disable`` Command
}
}
+.. isccmd:: dhcp-enable
.. _command-dhcp-enable:
The ``dhcp-enable`` Command
}
}
+.. isccmd:: status-get
.. _command-status-get:
The ``status-get`` Command
section.
+.. isccmd:: server-tag-get
.. _command-server-tag-get:
The ``server-tag-get`` Command:
The ``server-tag-get`` command returns the configured server tag of
the DHCPv4 or DHCPv6 server (:ref:`cb-sharing` explains the server tag concept).
+.. isccmd:: config-backend-pull
.. _command-config-backend-pull:
The ``config-backend-pull`` Command:
(which must be configured for this command to have an effect),
explained in :ref:`dhcp4-cb-json`.
+.. isccmd:: version-get
.. _command-version-get:
The ``version-get`` Command
The GSS-TSIG hook library supports some commands, which are described below.
+.. isccmd:: gss-tsig-get-all
.. _command-gss-tsig-get-all:
The ``gss-tsig-get-all`` Command
}
}
+.. isccmd:: gss-tsig-get
.. _command-gss-tsig-get:
The ``gss-tsig-get`` Command
}
}
+.. isccmd:: gss-tsig-list
.. _command-gss-tsig-list:
The ``gss-tsig-list`` Command
}
}
+.. isccmd:: gss-tsig-key-get
.. _command-gss-tsig-key-get:
The ``gss-tsig-key-get`` Command
}
}
+.. isccmd:: gss-tsig-key-expire
.. _command-gss-tsig-key-expire:
The ``gss-tsig-key-expire`` Command
"text": "GSS-TSIG key '1234.sig-foo.com.' expired"
}
+.. isccmd:: gss-tsig-key-del
.. _command-gss-tsig-key-del:
The ``gss-tsig-key-del`` Command
"text": "GSS-TSIG key '1234.sig-foo.com.' deleted"
}
+.. isccmd:: gss-tsig-purge-all
.. _command-gss-tsig-purge-all:
The ``gss-tsig-purge-all`` Command
"text": "2 purged GSS-TSIG keys"
}
+.. isccmd:: gss-tsig-purge
.. _command-gss-tsig-purge:
The ``gss-tsig-purge`` Command
"text": "2 purged keys for GSS-TSIG server[foo]"
}
+.. isccmd:: gss-tsig-rekey-all
.. _command-gss-tsig-rekey-all:
The ``gss-tsig-rekey-all`` Command
This command is useful when, for instance, the DHCP-DDNS server is
reconnected to the network.
+.. isccmd:: gss-tsig-rekey
.. _command-gss-tsig-rekey:
The ``gss-tsig-rekey`` Command
map will be extended with additional information, e.g. object modification
time, log message created during the last modification, etc.
+.. isccmd:: remote-server4-del
.. _command-remote-server4-del:
+.. isccmd:: remote-server6-del
.. _command-remote-server6-del:
The ``remote-server4-del``, ``remote-server6-del`` Commands
does not revert the lost configuration for that server and such configuration
must be re-created manually by the user.
+.. isccmd:: remote-server4-get
.. _command-remote-server4-get:
+.. isccmd:: remote-server6-get
.. _command-remote-server6-get:
The ``remote-server4-get``, ``remote-server6-get`` Commands
}
}
+.. isccmd:: remote-server4-get-all
.. _command-remote-server4-get-all:
+.. isccmd:: remote-server6-get-all
.. _command-remote-server6-get-all:
The ``remote-server4-get-all``, ``remote-server6-get-all`` Commands
}
}
+.. isccmd:: remote-server4-set
.. _command-remote-server4-set:
+.. isccmd:: remote-server6-set
.. _command-remote-server6-set:
The ``remote-server4-set``, ``remote-server6-set`` Commands
}
+.. isccmd:: remote-global-parameter4-del
.. _command-remote-global-parameter4-del:
+.. isccmd:: remote-global-parameter6-del
.. _command-remote-global-parameter6-del:
The ``remote-global-parameter4-del``, ``remote-global-parameter6-del`` Commands
``server-tags`` list must contain the tag of the appropriate
server. There must be exactly one server tag specified in this list.
+.. isccmd:: remote-global-parameter4-get
.. _command-remote-global-parameter4-get:
+.. isccmd:: remote-global-parameter6-get
.. _command-remote-global-parameter6-get:
The ``remote-global-parameter4-get``, ``remote-global-parameter6-get`` Commands
}
+.. isccmd:: remote-global-parameter4-get-all
.. _command-remote-global-parameter4-get-all:
+.. isccmd:: remote-global-parameter6-get-all
.. _command-remote-global-parameter6-get-all:
The ``remote-global-parameter4-get-all``, ``remote-global-parameter6-get-all`` Commands
example above), the returned list combines parameters associated with
this server and all servers, but the former take precedence.
+.. isccmd:: remote-global-parameter4-set
.. _command-remote-global-parameter4-set:
+.. isccmd:: remote-global-parameter6-set
.. _command-remote-global-parameter6-set:
The ``remote-global-parameter4-set``, ``remote-global-parameter6-set`` Commands
the keyword "all". In the example above, all specified parameters are associated
with the "server1" server.
+.. isccmd:: remote-network4-del
.. _command-remote-network4-del:
+.. isccmd:: remote-network6-del
.. _command-remote-network6-del:
The ``remote-network4-del``, ``remote-network6-del`` Commands
Note that the ``server-tags`` parameter cannot be used for this command.
+.. isccmd:: remote-network4-get
.. _command-remote-network4-get:
+.. isccmd:: remote-network6-get
.. _command-remote-network6-get:
The ``remote-network4-get``, ``remote-network6-get`` Commands
Note that the ``server-tags`` parameter cannot be used for this command.
+.. isccmd:: remote-network4-list
.. _command-remote-network4-list:
+.. isccmd:: remote-network6-list
.. _command-remote-network6-list:
The ``remote-network4-list``, ``remote-network6-list`` Commands
The ``null`` value in the metadata indicates that the
returned shared network is unassigned.
+.. isccmd:: remote-network4-set
.. _command-remote-network4-set:
+.. isccmd:: remote-network6-set
.. _command-remote-network6-set:
The ``remote-network4-set``, ``remote-network6-set`` Commands
be marked unspecified in the database, even if its value was present
prior to sending the command.
+.. isccmd:: remote-option-def4-del
.. _command-remote-option-def4-del:
+.. isccmd:: remote-option-def6-del
.. _command-remote-option-def6-del:
The ``remote-option-def4-del``, ``remote-option-def6-del`` Commands
"all" must be used as the server tag. The ``server-tags`` list must contain exactly
one tag and cannot include the ``null`` value.
+.. isccmd:: remote-option-def4-get
.. _command-remote-option-def4-get:
+.. isccmd:: remote-option-def6-get
.. _command-remote-option-def6-get:
The ``remote-option-def4-get``, ``remote-option-def6-get`` Commands
The ``server-tags`` list must include exactly one server tag or the keyword
"all", and cannot contain the `null` value.
+.. isccmd:: remote-option-def4-get-all
.. _command-remote-option-def4-get-all:
+.. isccmd:: remote-option-def6-get-all
.. _command-remote-option-def6-get-all:
The ``remote-option-def4-get-all``, ``remote-option-def6-get-all`` Commands
The response contains an option definition associated with all servers, as
indicated by the metadata.
+.. isccmd:: remote-option-def4-set
.. _command-remote-option-def4-set:
+.. isccmd:: remote-option-def6-set
.. _command-remote-option-def6-set:
The ``remote-option-def4-set``, ``remote-option-def6-set`` Commands
server tag or the keyword "all", and cannot contain the
``null`` value.
+.. isccmd:: remote-option4-global-del
.. _command-remote-option4-global-del:
+.. isccmd:: remote-option6-global-del
.. _command-remote-option6-global-del:
The ``remote-option4-global-del``, ``remote-option6-global-del`` Commands
is deleted. To delete an option associated with all servers, the
keyword "all" must be specified.
+.. isccmd:: remote-option4-global-get
.. _command-remote-option4-global-get:
+.. isccmd:: remote-option6-global-get
.. _command-remote-option6-global-get:
The ``remote-option4-global-get``, ``remote-option6-global-get`` Commands
server tag or the keyword "all". It cannot contain the ``null``
value.
+.. isccmd:: remote-option4-global-get-all
.. _command-remote-option4-global-get-all:
+.. isccmd:: remote-option6-global-get-all
.. _command-remote-option6-global-get-all:
The ``remote-option4-global-get-all``, ``remote-option6-global-get-all`` Commands
}
}
+.. isccmd:: remote-option4-global-set
.. _command-remote-option4-global-set:
+.. isccmd:: remote-option6-global-set
.. _command-remote-option6-global-set:
The ``remote-option4-global-set``, ``remote-option6-global-set`` Commands
}
}
+.. isccmd:: remote-option4-network-del
.. _command-remote-option4-network-del:
+.. isccmd:: remote-option6-network-del
.. _command-remote-option6-network-del:
The ``remote-option4-network-del``, ``remote-option6-network-del`` Commands
The "dhcp4" value represents the top-level option space where the standard DHCPv4
options belong. The ``server-tags`` parameter cannot be specified for this command.
+.. isccmd:: remote-option4-network-set
.. _command-remote-option4-network-set:
+.. isccmd:: remote-option6-network-set
.. _command-remote-option6-network-set:
The ``remote-option4-network-set``, ``remote-option6-network-set`` Commands
for standard DHCP options. When specifying a value for a user-defined
DHCP option, the option code should be indicated instead of the name.
+.. isccmd:: remote-option6-pd-pool-del
.. _command-remote-option6-pd-pool-del:
The ``remote-option6-pd-pool-del`` Command
The "dhcp6" value represents the top-level option space where the standard DHCPv6
options belong. The ``server-tags`` parameter cannot be specified for this command.
+.. isccmd:: remote-option6-pd-pool-set
.. _command-remote-option6-pd-pool-set:
The ``remote-option6-pd-pool-set`` Command
for standard DHCP options. When specifying a value for a user-defined
DHCP option, the option code should be indicated instead of the name.
+.. isccmd:: remote-option4-pool-del
.. _command-remote-option4-pool-del:
+.. isccmd:: remote-option6-pool-del
.. _command-remote-option6-pool-del:
The ``remote-option4-pool-del``, ``remote-option6-pool-del`` Commands
The "dhcp4" value represents the top-level option space where the standard DHCPv4
options belong. The ``server-tags`` parameter cannot be specified for this command.
+.. isccmd:: remote-option4-pool-set
.. _command-remote-option4-pool-set:
+.. isccmd:: remote-option6-pool-set
.. _command-remote-option6-pool-set:
The ``remote-option4-pool-set``, ``remote-option6-pool-set`` Commands
for standard DHCP options. When specifying a value for a user-defined
DHCP option, the option code should be indicated instead of the name.
+.. isccmd:: remote-option4-subnet-del
.. _command-remote-option4-subnet-del:
+.. isccmd:: remote-option6-subnet-del
.. _command-remote-option6-subnet-del:
The ``remote-option4-subnet-del``, ``remote-option6-subnet-del`` Commands
The "dhcp4" value represents the top-level option space where the standard DHCPv4
options belong. The ``server-tags`` parameter cannot be specified for this command.
+.. isccmd:: remote-option4-subnet-set
.. _command-remote-option4-subnet-set:
+.. isccmd:: remote-option6-subnet-set
.. _command-remote-option6-subnet-set:
The ``remote-option4-subnet-set``, ``remote-option6-subnet-set`` Commands
for the standard DHCP options. When specifying a value for the user-defined
DHCP option, the option code should be indicated instead of the name.
+.. isccmd:: remote-subnet4-del-by-id
.. _command-remote-subnet4-del-by-id:
+.. isccmd:: remote-subnet6-del-by-id
.. _command-remote-subnet6-del-by-id:
The ``remote-subnet4-del-by-id``, ``remote-subnet6-del-by-id`` Commands
The ``server-tags`` parameter cannot be used with this command.
+.. isccmd:: remote-subnet4-del-by-prefix
.. _command-remote-subnet4-del-by-prefix:
+.. isccmd:: remote-subnet6-del-by-prefix
.. _command-remote-subnet6-del-by-prefix:
The ``remote-subnet4-del-by-prefix``, ``remote-subnet6-del-by-prefix`` Commands
The ``server-tags`` parameter cannot be used with this command.
+.. isccmd:: remote-subnet4-get-by-id
.. _command-remote-subnet4-get-by-id:
+.. isccmd:: remote-subnet6-get-by-id
.. _command-remote-subnet6-get-by-id:
The ``remote-subnet4-get-by-id``, ``remote-subnet6-get-by-id`` Commands
The ``server-tags`` parameter cannot be used with this command.
+.. isccmd:: remote-subnet4-get-by-prefix
.. _command-remote-subnet4-get-by-prefix:
+.. isccmd:: remote-subnet6-get-by-prefix
.. _command-remote-subnet6-get-by-prefix:
The ``remote-subnet4-get-by-prefix``, ``remote-subnet6-get-by-prefix`` Commands
The ``server-tags`` parameter cannot be used with this command.
+.. isccmd:: remote-subnet4-list
.. _command-remote-subnet4-list:
+.. isccmd:: remote-subnet6-list
.. _command-remote-subnet6-list:
The ``remote-subnet4-list``, ``remote-subnet6-list`` Commands
The ``null`` value in the metadata indicates that the
returned subnet is unassigned.
+.. isccmd:: remote-subnet4-set
.. _command-remote-subnet4-set:
+.. isccmd:: remote-subnet6-set
.. _command-remote-subnet6-set:
The ``remote-subnet4-set``, ``remote-subnet6-set`` Commands
will be marked as unspecified in the database, even if its value was
present prior to sending the command.
+.. isccmd:: remote-class4-del
.. _command-remote-class4-del:
+.. isccmd:: remote-class6-del
.. _command-remote-class6-del:
The ``remote-class4-del``, ``remote-class6-del`` Commands
The ``server-tags`` parameter cannot be used for this command because client
classes are uniquely identified by name.
+.. isccmd:: remote-class4-get
.. _command-remote-class4-get:
+.. isccmd:: remote-class6-get
.. _command-remote-class6-get:
The ``remote-class4-get``, ``remote-class6-get`` Commands
}
}
+.. isccmd:: remote-class4-get-all
.. _command-remote-class4-get-all:
+.. isccmd:: remote-class6-get-all
.. _command-remote-class6-get-all:
The ``remote-class4-get-all``, ``remote-class6-get-all`` Commands
}
}
+.. isccmd:: remote-class4-set
.. _command-remote-class4-set:
+.. isccmd:: remote-class6-set
.. _command-remote-class6-set:
The ``remote-class4-set``, ``remote-class6-set`` Commands
The Class Commands hook library is currently available only to ISC
customers with a paid support contract.
+.. isccmd:: class-add
.. _command-class-add:
The ``class-add`` Command
"text": "Class 'ipxe_efi_x64' added."
}
+.. isccmd:: class-update
.. _command-class-update:
The ``class-update`` Command
to the required outcome, and then issuing the ``client-update`` command with the
resulting client class attached.
+.. isccmd:: class-del
.. _command-class-del:
The ``class-del`` Command
If the class does not exist, the result of 3 is returned.
+.. isccmd:: class-list
.. _command-class-list:
The ``class-list`` Command
merely class names. To retrieve full class information, the
``class-get`` command should be used.
+.. isccmd:: class-get
.. _command-class-get:
The ``class-get`` Command
The following sections describe commands supported by the HA hook library which
are available for the administrator.
+.. isccmd:: ha-sync
.. _command-ha-sync:
The ``ha-sync`` Command
synchronization, those new (or updated) leases will not be fetched by the
synchronizing server, leading to database inconsistencies.
+.. isccmd:: ha-scopes
.. _command-ha-scopes:
The ``ha-scopes`` Command
}
}
+.. isccmd:: ha-continue
.. _command-ha-continue:
The ``ha-continue`` Command
"service": [ "dhcp4" ]
}
+.. isccmd:: ha-heartbeat
.. _command-ha-heartbeat:
The ``ha-heartbeat`` Command
the state of the entire HA setup. Sending it to only one of the servers may
not reflect issues that just began with one of the servers.
+.. isccmd:: ha-status-get
.. _command-ha-status-get:
The ``status-get`` Command
only one active server (local). The response includes no information about the
status of the backup servers.
+.. isccmd:: ha-maintenance-start
.. _command-ha-maintenance-start:
The ``ha-maintenance-start`` Command
"service": [ "dhcp4" ]
}
+.. isccmd:: ha-maintenance-cancel
.. _command-ha-maintenance-cancel:
The ``ha-maintenance-cancel`` Command
"service": [ "dhcp4" ]
}
+.. isccmd:: ha-maintenance-notify
.. _command-ha-maintenance-notify:
The ``ha-maintenance-notify`` Command
HA-enabled DHCP servers. Direct use of this command is not supported and may
produce unintended consequences.
+.. isccmd:: ha-reset
.. _command-ha-reset:
The ``ha-reset`` Command
If the server receiving this command is already in the ``waiting`` state, the
command has no effect.
+.. isccmd:: ha-sync-complete-notify
.. _command-ha-sync-complete-notify:
The ``ha-sync-complete-notify`` Command
:ref:`shell-overview`. The following sections describe the commands
available.
+.. isccmd:: cache-flush
.. _command-cache-flush:
The ``cache-flush`` Command
hosts, use ``cache-clear`` instead. The hosts are stored in FIFO
(first-in, first-out) order, so the oldest entries are always removed.
+.. isccmd:: cache-clear
.. _command-cache-clear:
The ``cache-clear`` Command
This command removes all hosts. To delete only a certain
number of cached hosts, please use ``cache-flush`` instead.
+.. isccmd:: cache-size
.. _command-cache-size:
The ``cache-size`` Command
"command": "cache-size"
}
+.. isccmd:: cache-write
.. _command-cache-write:
The ``cache-write`` Command
file. That file can then be loaded with the ``cache-load`` command or
processed by any other tool that is able to understand JSON format.
+.. isccmd:: cache-load
.. _command-cache-load:
The ``cache-load`` Command
file. That file can then be loaded with the ``cache-load`` command or
processed by any other tool that is able to understand JSON format.
+.. isccmd:: cache-get
.. _command-cache-get:
The ``cache-get`` Command
This command returns all the cached hosts; the response
may be large.
+.. isccmd:: cache-get-by-id
.. _command-cache-get-by-id:
The ``cache-get-by-id`` Command
This command returns all the cached hosts with the given hardware
address.
+.. isccmd:: cache-insert
.. _command-cache-insert:
The ``cache-insert`` Command
}
}
+.. isccmd:: cache-remove
.. _command-cache-remove:
The ``cache-remove`` Command
- ``all`` - query both sources - JSON configuration and host database(s).
- ``default`` - query the default source - it's command specific.
+.. isccmd:: reservation-add
.. _command-reservation-add:
The ``reservation-add`` Command
parameter must be specified in the configuration, and databases must not
run in read-only mode.
+.. isccmd:: reservation-get
.. _command-reservation-get:
The ``reservation-get`` Command
{ "result": 1, "text": "No 'ip-address' provided and 'identifier-type' is either missing or not a string." }
+.. isccmd:: reservation-get-all
.. _command-reservation-get-all:
The ``reservation-get-all`` Command
For more information, see :ref:`command-reservation-get-all`.
+.. isccmd:: reservation-get-page
.. _command-reservation-get-page:
The ``reservation-get-page`` command
small deployments with few reservations, it is easier to use
``reservation-get-all`` (see :ref:`command-reservation-get-all`).
+.. isccmd:: reservation-get-by-hostname
.. _command-reservation-get-by-hostname:
The ``reservation-get-by-hostname`` Command
collation, as explained in the :ref:`mysql-database` section of
:ref:`admin`.
+.. isccmd:: reservation-get-by-id
.. _command-reservation-get-by-id:
The ``reservation-get-by-id`` Command
For more information, see :ref:`command-reservation-get-by-id`.
+.. isccmd:: reservation-del
.. _command-reservation-del:
The ``reservation-del`` Command
}
}
+.. isccmd:: reservation-update
.. _command-reservation-update:
The ``reservation-update`` Command
]
}
+.. isccmd:: lease4-add
.. _command-lease4-add:
+.. isccmd:: lease6-add
.. _command-lease6-add:
The ``lease4-add``, ``lease6-add`` Commands
{ "result": 1, "text": "missing parameter 'ip-address' (<string>:3:19)" }
+.. isccmd:: lease6-bulk-apply
.. _command-lease6-bulk-apply:
The ``lease6-bulk-apply`` Command
indicates that an attempt to delete the lease was unsuccessful because
such a lease doesn't exist (an empty result).
+.. isccmd:: lease4-get
.. _command-lease4-get:
+.. isccmd:: lease6-get
.. _command-lease6-get:
The ``lease4-get``, ``lease6-get`` Commands
:math:`cltt = expire` when :math:`valid\_lft = 4294967295` and the
lease backend is MySQL or PostgreSQL.
+.. isccmd:: lease4-get-all
.. _command-lease4-get-all:
+.. isccmd:: lease6-get-all
.. _command-lease6-get-all:
The ``lease4-get-all``, ``lease6-get-all`` Commands
restriction on the number of leases returned as a result of this
command.
+.. isccmd:: lease4-get-page
.. _command-lease4-get-page:
+.. isccmd:: lease6-get-page
.. _command-lease6-get-page:
The ``lease4-get-page``, ``lease6-get-page`` Commands
includes the case when the ``count`` is equal to 0, meaning that no
leases were found.
+.. isccmd:: lease4-get-by-hw-address
.. _command-lease4-get-by-hw-address:
+.. isccmd:: lease4-get-by-client-id
.. _command-lease4-get-by-client-id:
+.. isccmd:: lease6-get-by-duid
.. _command-lease6-get-by-duid:
+.. isccmd:: lease4-get-by-hostname
.. _command-lease4-get-by-hostname:
+.. isccmd:: lease6-get-by-hostname
.. _command-lease6-get-by-hostname:
The ``lease4-get-by-*``, ``lease6-get-by-*`` Commands
list of leases in the same format as ``lease4-get-all`` or ``lease6-get-all``. This list can be
empty and is usually not large.
+.. isccmd:: lease4-del
.. _command-lease4-del:
+.. isccmd:: lease6-del
.. _command-lease6-del:
The ``lease4-del``, ``lease6-del`` Commands
or 3 (empty). The empty result means that a query has been completed properly,
but the object (a lease, in this case) has not been found.
+.. isccmd:: lease4-update
.. _command-lease4-update:
+.. isccmd:: lease6-update
.. _command-lease6-update:
The ``lease4-update``, ``lease6-update`` Commands
response, modifying it to the required outcome, and then issuing the
``lease4-update``/``lease6-update`` command with the resulting lease attached.
+.. isccmd:: lease4-wipe
.. _command-lease4-wipe:
+.. isccmd:: lease6-wipe
.. _command-lease6-wipe:
The ``lease4-wipe``, ``lease6-wipe`` Commands
Note: currently only memfile lease storage supports this command.
+.. isccmd:: lease4-resend-ddns
.. _command-lease4-resend-ddns:
+.. isccmd:: lease6-resend-ddns
.. _command-lease6-resend-ddns:
The ``lease4-resend-ddns``, ``lease6-resend-ddns`` Commands
"text": "NCR generated for: 2001:db8:1::1, hostname: example.com."
}
+.. isccmd:: lease4-write
.. _command-lease4-write:
+.. isccmd:: lease6-write
.. _command-lease6-write:
The ``lease4-write``, ``lease6-write`` Commands
Query will not contain the new data required. In order to populate this data
it is necessary to run API commands:
+.. isccmd:: extended-info4-upgrade
.. _command-extended-info4-upgrade:
For DHCPv4 lease data, the command is:
"command": "extended-info4-upgrade"
}
+.. isccmd:: binary-address6-upgrade
.. _command-binary-address6-upgrade:
For DHCPv6 lease data, there are two commands, for upgrading the binary
"command": "binary-address6-upgrade"
}
+.. isccmd:: extended-info6-upgrade
.. _command-extended-info6-upgrade:
for extended info used for by relay id and by remote id the command is
that server. In other words, if a subnet does not appear in a server's
configuration, Kea will not retrieve statistics for it.
+.. isccmd:: stat-lease4-get
.. _command-stat-lease4-get:
+.. isccmd:: stat-lease6-get
.. _command-stat-lease6-get:
The ``stat-lease4-get``, ``stat-lease6-get`` Commands
- ``network4-subnet-del``/``network6-subnet-del`` - removes a subnet from
an existing shared network and demotes it to a plain subnet.
+.. isccmd:: subnet4-list
.. _command-subnet4-list:
The ``subnet4-list`` Command
If no IPv4 subnets are found, an error code is returned along with the
error description.
+.. isccmd:: subnet6-list
.. _command-subnet6-list:
The ``subnet6-list`` Command
If no IPv6 subnets are found, an error code is returned along with the
error description.
+.. isccmd:: subnet4-get
.. _command-subnet4-get:
The ``subnet4-get`` Command
}
}
+.. isccmd:: subnet6-get
.. _command-subnet6-get:
The ``subnet6-get`` Command
}
}
+.. isccmd:: subnet4-add
.. _command-subnet4-add:
The ``subnet4-add`` Command
}
}
+.. isccmd:: subnet6-add
.. _command-subnet6-add:
The ``subnet6-add`` Command
Subnet IDs must be greater than zero and less than 4294967295.
+.. isccmd:: subnet4-update
.. _command-subnet4-update:
The ``subnet4-update`` Command
server configuration. If an incremental update of the subnet is desired, then
this can be achieved with `subnet4-delta-add <command-subnet4-delta-add_>`_.
+.. isccmd:: subnet6-update
.. _command-subnet6-update:
The ``subnet6-update`` Command
server configuration. If an incremental update of the subnet is desired, then
this can be achieved with `subnet6-delta-add <command-subnet6-delta-add_>`_.
+.. isccmd:: subnet4-del
.. _command-subnet4-del:
The ``subnet4-del`` Command
}
}
+.. isccmd:: subnet6-del
.. _command-subnet6-del:
The ``subnet6-del`` Command
]
}
+.. isccmd:: subnet4-delta-add
.. _command-subnet4-delta-add:
The ``subnet4-delta-add`` Command
or changing the pool "10.20.30.1-10.20.30.10" and by adding or changing the pool
level option 4 ("time-servers").
+.. isccmd:: subnet6-delta-add
.. _command-subnet6-delta-add:
The ``subnet6-delta-add`` Command
pd-pool "2001:db8:2::" with prefix-len 48 and by adding or changing the pd-pool
level option 22 ("sip-server-addr").
+.. isccmd:: subnet4-delta-del
.. _command-subnet4-delta-del:
The ``subnet4-delta-del`` Command
present to maintain a valid json structure and to be a valid value to be able to
be parsed.
+.. isccmd:: subnet6-delta-del
.. _command-subnet6-delta-del:
The ``subnet6-delta-del`` Command
present to maintain a valid json structure and to be a valid value to be able to
be parsed.
+.. isccmd:: network4-list
.. _command-network4-list:
+.. isccmd:: network6-list
.. _command-network6-list:
The ``network4-list``, ``network6-list`` Commands
The ``network6-list`` command uses exactly the same syntax for both the
command and the response.
+.. isccmd:: network4-get
.. _command-network4-get:
+.. isccmd:: network6-get
.. _command-network6-get:
The ``network4-get``, ``network6-get`` Commands
used in ``config-get``, just limited to returning the shared network's
information.
+.. isccmd:: network4-add
.. _command-network4-add:
+.. isccmd:: network6-add
.. _command-network6-add:
The ``network4-add``, ``network6-add`` Commands
``match-client-id``) and some that are IPv6-only (e.g. ``interface-id``). The same
applies to subnets within the network.
+.. isccmd:: network4-del
.. _command-network4-del:
+.. isccmd:: network6-del
.. _command-network6-del:
The ``network4-del``, ``network6-del`` Commands
Alternatively, to completely remove the subnets, it is possible to use the
``subnet4-del`` or ``subnet6-del`` commands.
+.. isccmd:: network4-subnet-add
.. _command-network4-subnet-add:
+.. isccmd:: network6-subnet-add
.. _command-network6-subnet-add:
The ``network4-subnet-add``, ``network6-subnet-add`` Commands
Any missing parameters will be filled with default values, rather
than inherited from the global scope or from the shared network.
+.. isccmd:: network4-subnet-del
.. _command-network4-subnet-del:
+.. isccmd:: network6-subnet-del
.. _command-network6-subnet-del:
The ``network4-subnet-del``, ``network6-subnet-del`` Commands
the ``pkt4-decline-received`` statistic so that it is no longer reported, until
and unless a duplicate address is again detected.
+.. isccmd:: stats
.. _command-stats:
Commands for Manipulating Statistics
more information on sending commands to Kea, see
:ref:`ctrl-channel`.
+.. isccmd:: statistic-get
.. _command-statistic-get:
The ``statistic-get`` Command
"result": 0
}
+.. isccmd:: statistic-reset
.. _command-statistic-reset:
The ``statistic-reset`` Command
statistic was not found), the server returns a status code of 1 (error)
and the text field contains the error description.
+.. isccmd:: statistic-remove
.. _command-statistic-remove:
The ``statistic-remove`` Command
statistic was not found), the server returns a status code of 1 (error)
and the text field contains the error description.
+.. isccmd:: statistic-get-all
.. _command-statistic-get-all:
The ``statistic-get-all`` Command
"result": 0
}
+.. isccmd:: statistic-reset-all
.. _command-statistic-reset-all:
The ``statistic-reset-all`` Command
encountered, the server returns a status code of 1 (error) and the text
field contains the error description.
+.. isccmd:: statistic-remove-all
.. _command-statistic-remove-all:
The ``statistic-remove-all`` Command
error is encountered, the server returns a status code of 1 (error) and
the text field contains the error description.
+.. isccmd:: statistic-sample-age-set
.. _command-statistic-sample-age-set:
The ``statistic-sample-age-set`` Command
requested statistic was not found), the server returns a status code
of 1 (error) and the text field contains the error description.
+.. isccmd:: statistic-sample-age-set-all
.. _command-statistic-sample-age-set-all:
The ``statistic-sample-age-set-all`` Command
and an empty parameters field. If an error is encountered, the server returns
a status code of 1 (error) and the text field contains the error description.
+.. isccmd:: statistic-sample-count-set
.. _command-statistic-sample-count-set:
The ``statistic-sample-count-set`` Command
requested statistic was not found), the server returns a status code
of 1 (error) and the text field contains the error description.
+.. isccmd:: statistic-sample-count-set-all
.. _command-statistic-sample-count-set-all:
The ``statistic-sample-count-set-all`` Command