diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index 395b74b5be..d03e5eb0e2 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -306,6 +306,68 @@ be followed by a comma and another object definition. All leases issued by the server are stored in the lease database. Currently there are four database backends available: memfile (which is the default backend), MySQL, PostgreSQL and Cassandra. +
+ DHCPv4 lease field description + + Leases issued by the dhcp4 server are stored in the backends with the fields as, + address,hwaddr,client_id,valid_lifetime,expire,subnet_id,fqdn_fwd,fqdn_rev,hostname,state + + + Let's decipher these fields + + + address: This field is the actual IPv4 address + offered or assigned to a host. + + + + hwaddr: The hardware address/MAC address of the host or network + interface on which the lease will be used. Usually the same as clien_id. + + + + client_id: A unique identifier for the host used by the host + to acquire the lease. Clients are not required to send client identifiers, this will only + appear if a client, in fact, did send one. Usually the same as hwaddr. + + + + valid_lifetime: The valid-time or lifetime for the lease in seconds for which the lease + is assigned (active) to the host, this is by default 3600 seconds after which it will be available (free) + to be assign to possibly same or new host. + + + + expire: The lease end-time, a time in seconds since epoch for which the lease + will expire and will be available (free) for re-assignment. + + + + subnet_id: The identifier (unique) for the particular subnet from which the lease was assigned. + + + + fqdn_fwd: A bool value, was forward update performed? Required during lease release or expiration. + + + + fqdn_rev: A bool value, was reverse update performed? Required during lease release or expiration. + + + + hostname: A string, hosts hostname. A host may send their + hostname in the host-name option. If the client sends its hostname in this way, the hostname + is recorded in the hostname field. A hostname may be shared by possible many leases if a client + requests two or more addresses. + + + + state: The state of the lease active, expired or released. + + + + +
Memfile - Basic Storage for Leases diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index 9ca2dd62dc..c38b8c6606 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -301,6 +301,109 @@ be followed by a comma and another object definition. All leases issued by the server are stored in the lease database. Currently there are four database backends available: memfile (which is the default backend), MySQL, PostgreSQL and Cassandra. +
+ DHCPv6 lease field description + + Leases issued by the dhcp6 server are stored in the backends with the fields as. + address,duid,valid_lifetime,expire,subnet_id,pref_lifetime,lease_type,iaid,prefix_len,fqdn_fwd,fqdn_rev,hostname,hwaddr,state + + + Let's decipher these fields. + + + address: This field is the actual IPv6 address offered/assigned to a host. + + + + duid: A string, DHCP Unique Identifier, consists of a two-octet type code represented in network byte order, + followed by the variable number of octets that make up the actual identifier. The DUID types include(see RFC 3315). + + + DUID-LLT: Link-layer address plus time. + + + DUID-EN: Vendor-assigned Unique ID based on Enterprise Number. + + + DUID-LL: Link-layer address. + + + + + + valid_lifetime: The valide-time/life-time for the lease in seconds for which the lease + is assigned(active) to the host, this is by default 3600 seconds after which it will be avaliable(free) + to be assign to possibly same or new host. + + + + expire: The lease end-time, a time in seconds since epoch for which the lease + will expire and will be avaliable(free) for re-assignment. + + + + subnet_id: The identifier(unique) for the particular subnet from which the lease was assigned. + + + + pre_lifetime: Prefered lifetime expressed in seconds. + + + + lease_type: Lease type, one of the following, + + + IA_NA: Non-temporary v6 addresses. + + + + IA_TA: Temporary v6 addresses. + + + + IA_PD: Prefix delegations. + + + + + + + iaid: This field "iaid" uniquely identifies the IA-identity-association(a construct through + which a server and a client can identify, group, and manage a set of related IPv6 addresses). In DHCPv6 a lease is identified by client's DUID+ia-id. + see Section 10 of RFC 3315, see section 11 of RFC 3315 for selecting addresses for assignment to an IA. + + + + prefix_len: And integer, only for type IA_PD. + + + + fqdn_fwd: A bool value, was forward update performed? Required during lease release or expiration. + + + + fqdn_rev: A bool value, was reverse update performed? Required during lease release or expiration. + + + + hwaddr: The hardware address/MAC address of the host/network interface on which the lease will be used. + Usually the same as clien_id. + + + + hostname: A string, hosts hostname. A host may send their hostname + in the host-name option. If the client sends its hostname in this way, the hostname is recorded + in the hostname field. A hostname may be shared by possible many leases if a client requests two + or more addresses. + + + + state: The state of the lease active, expired or released. + + + + +
Memfile - Basic Storage for Leases diff --git a/doc/guide/hooks.xml b/doc/guide/hooks.xml index c2db963278..24be83b8c7 100644 --- a/doc/guide/hooks.xml +++ b/doc/guide/hooks.xml @@ -36,12 +36,31 @@ documentation of the libraries to see if this is the case. + The next section describes how to build and install hooks libraries. + +
+ +
+ How to build and install + + Headers and sources for hooks libraries are in src/hooks form parent kea directory, + to build hooks libraries form this directory run + $ make + + + And then install hooks libraries by running + # make install + + The libraries are writen to [Kea installation directory]/local/lib/ and headers to + [Kea installation directory] /local/include/kea/hooks/ + + The next section describes how to configure hooks libraries. If you are interested in writing your own hooks library, information can be found in the Kea Developer's Guide. -
+
Configuring Hooks Libraries