Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for lease file syntax #74

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+185 −1
Open

Documentation for lease file syntax #74

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
101a218
add hooks library installation instructions trac 5427
ytobi Apr 6, 2018
bee37db
document the fields of the lease files trac5164
ytobi Apr 10, 2018
c32d2b9
[5164] fixed typos
ytobi Apr 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
[5164] fixed typos
@ytobi
ytobi committed Apr 24, 2018
commit c32d2b9ee2ffca0b1dd8df4668916c6ff9fe1314
39 changes: 16 additions & 23 deletions doc/guide/dhcp4-srv.xml
View file
Original file line number Diff line number Diff line change
@@ -309,41 +309,41 @@ be followed by a comma and another object definition.</para>
<section>
<title>DHCPv4 lease field description</title>
<para>
Lease issued by the dhcp4 are stored in the backends with the fields as,
Leases issued by the dhcp4 server are stored in the backends with the fields as,
<screen>address,hwaddr,client_id,valid_lifetime,expire,subnet_id,fqdn_fwd,fqdn_rev,hostname,state</screen>
</para>
<para>
Lets decipher these fields
Let's decipher these fields
<itemizedlist>
<listitem>
<simpara><command>address</command>: This field is the actual IPv4 address.
offered/assinged to a host
<simpara><command>address</command>: This field is the actual IPv4 address
offered or assigned to a host.
</simpara>
</listitem>
<listitem>
<simpara><command>hwaddr</command>: The hardware address/MAC address of the host/network
<simpara><command>hwaddr</command>: The hardware address/MAC address of the host or network
interface on which the lease will be used. Usually the same as <command>clien_id</command>.
</simpara>
</listitem>
<listitem>
<simpara><command>client_id</command>: A unique identifer for the host used by the host
to arquire the lease. Clients are not required to send client identifiers, this will only
appear if the client did in fact send one. Usually thesame as <command>hwaddr</command>
<simpara><command>client_id</command>: 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 <command>hwaddr</command>.
</simpara>
</listitem>
<listitem>
<simpara><command>valid_lifetime</command>: The valide-time/life-time for the lease in seconds for which the lease
is assigned(active) to the host, this is by default <command>3600</command> seconds after which it will be avaliable(free)
<simpara><command>valid_lifetime</command>: The valid-time or lifetime for the lease in seconds for which the lease
is assigned (active) to the host, this is by default <command>3600</command> seconds after which it will be available (free)
to be assign to possibly same or new host.
</simpara>
</listitem>
<listitem>
<simpara><command>expire</command>: The lease end-time, a time in seconds since epoch for which the lease
will expire and will be avaliable(free) for re-assignment.
will expire and will be available (free) for re-assignment.
</simpara>
</listitem>
<listitem>
<simpara><command>subnet_id</command>: The identifier(unique) for the particular subnet from which the lease was assigned.
<simpara><command>subnet_id</command>: The identifier (unique) for the particular subnet from which the lease was assigned.
</simpara>
</listitem>
<listitem>
@@ -354,22 +354,15 @@ be followed by a comma and another object definition.</para>
<simpara><command>fqdn_rev</command>: A bool value, was reverse update performed? Required during lease release or expiration.
</simpara>
</listitem>
<!--
<listitem>
<simpara><command>fqdn_rev</command>: If the server successfully updats the host PTR record,
this field will will contain the name that the server used for the PTR record. The name to which
the PTR record points will be the ddns-client-fqdn.
</simpara>
</listitem> -->
<listitem>
<simpara><command>hostname</command>: A string, hosts hostname. A host may send the their
<simpara><command>hostname</command>: 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 maybe shered by possible many leases if client
request two or more addresses.
is recorded in the hostname field. A hostname may be shared by possible many leases if a client
requests two or more addresses.
</simpara>
</listitem>
<listitem>
<simpara><command>state</command>: The state of the lease active, expired, or released.
<simpara><command>state</command>: The state of the lease active, expired or released.
</simpara>
</listitem>
</itemizedlist>
39 changes: 16 additions & 23 deletions doc/guide/dhcp6-srv.xml
View file
Original file line number Diff line number Diff line change
@@ -304,19 +304,19 @@ be followed by a comma and another object definition.</para>
<section>
<title>DHCPv6 lease field description</title>
<para>
Lease issued by the dhcp6 are stored in the backends with the fields as.
Leases issued by the dhcp6 server are stored in the backends with the fields as.
<screen>address,duid,valid_lifetime,expire,subnet_id,pref_lifetime,lease_type,iaid,prefix_len,fqdn_fwd,fqdn_rev,hostname,hwaddr,state</screen>
</para>
<para>
Lets decipher these fields.
Let's decipher these fields.
<itemizedlist>
<listitem>
<simpara><command>address</command>: This field is the actual IPv6 address offered/assinged to a host.
<simpara><command>address</command>: This field is the actual IPv6 address offered/assigned to a host.
</simpara>
</listitem>
<listitem>
<simpara><command>duid</command>: 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.
followed by the variable number of octets that make up the actual identifier. The DUID types include(see RFC 3315).
<itemizedlist>
<listitem>
<simpara><command>DUID-LLT</command>: Link-layer address plus time.</simpara>
@@ -346,7 +346,7 @@ be followed by a comma and another object definition.</para>
</simpara>
</listitem>
<listitem>
<simpara><command>pre_lifetime</command>: Prefered lifetime expressed in seconds <!-- (since cltt) -->.
<simpara><command>pre_lifetime</command>: Prefered lifetime expressed in seconds.
</simpara>
</listitem>
<listitem>
@@ -368,13 +368,13 @@ be followed by a comma and another object definition.</para>
</simpara>
</listitem>
<listitem>
<simpara><command>iaid</command>: This field <command>"iaid"</command> uniquely identifies the <command>IA-identity-association</command>(a construct
through which a sever 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 assingment to an IA.
<simpara><command>iaid</command>: This field <command>"iaid"</command> uniquely identifies the <command>IA-identity-association</command>(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.
</simpara>
</listitem>
<listitem>
<simpara><command>prefix_len</command>: And interger, only for type <command>IA_PD</command>.
<simpara><command>prefix_len</command>: And integer, only for type <command>IA_PD</command>.
</simpara>
</listitem>
<listitem>
@@ -385,27 +385,20 @@ be followed by a comma and another object definition.</para>
<simpara><command>fqdn_rev</command>: A bool value, was reverse update performed? Required during lease release or expiration.
</simpara>
</listitem>
<!--
<listitem>
<simpara><command>fqdn_rev</command>: If the server successfully updats the host PTR record,
this field will will contain the name that the server used for the PTR record. The name to which
the PTR record points will be the ddns-client-fqdn.
</simpara>
</listitem> -->
<listitem>
<simpara><command>hwaddr</command>: The hardware address/MAC address of the host/network
interface on which the lease will be used. Usually the same as <command>clien_id</command>.
<simpara><command>hwaddr</command>: The hardware address/MAC address of the host/network interface on which the lease will be used.
Usually the same as <command>clien_id</command>.
</simpara>
</listitem>
<listitem>
<simpara><command>hostname</command>: A string, hosts hostname. A host may send the 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 maybe shered by possible many leases if client
request two or more addresses.
<simpara><command>hostname</command>: 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.
</simpara>
</listitem>
<listitem>
<simpara><command>state</command>: The state of the lease active, expired, or released.
<simpara><command>state</command>: The state of the lease active, expired or released.
</simpara>
</listitem>
</itemizedlist>