wiki:Commands

Version 1 (modified by tomek, 4 years ago) (diff)

--

Control API Requirements

Kea provides a control channel that allows external entity send administrative commands to the server. This document explains rationale that led to certain decisions and enumerates desired capabilities.

Administrative actions

  1. Kea MUST support shutdown command.
  2. Control channel MUST support accepting commands and sending responses bigger than 1500 bytes. This is required for a number of scenarios: getting all leases from a subnet, getting statistics for multiple subnets when # of subnets is large etc.

Run-time operations

  1. Kea MUST support (list all statistics related commands here).

Configuration management

Leases management

  1. Kea MUST support add-lease4 command.
  2. Kea MUST support add-lease6 command.
  3. Kea MUST support get-lease4 command. Available parameters:
    • (v4 address), (hwaddr, subnet-id), (client-id, subnet-id)
  4. Kea MUST support get-lease6 command. Available parameters:
    • (v6 address), (duid, subnet-id)
  5. Kea MUST support update-lease4 command.
  6. Kea MUST support update-lease6 command.
  7. Kea MUST support delete-lease4 command.
  8. Kea MUST support delete-lease6 command.

Reservations management

  1. Kea MUST support add-reservation command that includes IPv4 reservation.
  2. Kea MUST support add-reservation command that includes IPv6 reservation.
  3. Kea MUST support add-reservation command that makes reservation for a hostname.
  4. Kea MUST support add-reservation command that makes reservation based on hardware address.
  5. Kea MUST support add-reservation command that makes reservation based on DUID.
  6. Kea SHOULD support add-reservation command that makes reservation based on remote-id.
  7. Kea SHOULD support add-reservation command that makes reservation based on subscriber-id.
  8. Kea MAY support add-reservation command that makes reservation based on client-id.
  9. Kea SHOULD support add-reservation command that reserves certain v4 options for a client.
  10. Kea SHOULD support add-reservation command that reserves certain v6 options for a client.