diff options
| -rw-r--r-- | src/lib/dhcpsrv/database_backends.dox | 148 |
1 files changed, 118 insertions, 30 deletions
diff --git a/src/lib/dhcpsrv/database_backends.dox b/src/lib/dhcpsrv/database_backends.dox index d5cb0deede..24f644a99b 100644 --- a/src/lib/dhcpsrv/database_backends.dox +++ b/src/lib/dhcpsrv/database_backends.dox @@ -126,18 +126,53 @@ @subsubsection lease4-csv DHCPv4 lease entry format in CSV files - - <b>address</b> - IPv4 address - - <b>hwaddr</b> - hardware address (without the hardware type) - - <b>client_id</b> - client identifier - - <b>valid_lifetime</b> - valid lifetime (uint32_t) - - <b>expire</b> - expiration date (uint64_t, cltt + valid lifetime) - - <b>subnet_id</b> - DHCPv4 subnet identifier (uint32_t) - - <b>fqdn_fwd</b> - FQDN forward DNS RR update flag (bool, 0 or 1) - - <b>fqdn_rev</b> - FQDN reverse DNS RR update flag (bool, 0 or 1) - - <b>hostname</b> - hostname (separators are escaped) - - <b>state</b> - lease state (uint32_t, 0 to 3) - - <b>user_context</b> - user context (separators are escaped) - - <b>pool_id</b> - pool identifier (uint32_t) + - <b>address</b> - IPv4 address \n + type: string \n + example: `192.0.2.1 + + - <b>hwaddr</b> - hardware address (without the hardware type) \n + type: string \n + example: '00:01:02:03:04:05` + + - <b>client_id</b> - client identifier \n + type: string \n + example: `01:02:03:03:04:aa:bb:cc` + + - <b>valid_lifetime</b> - valid lifetime \n + type: uint32_t \n + example: 200 + + - <b>expire</b> - expiration date \n + type: uint64_t (cltt + valid lifetime) \n + example: 1733517739 + + - <b>subnet_id</b> - DHCPv4 subnet identifier \n + type: int32_t (0 and max excluded) \n + example: 1 + + - <b>fqdn_fwd</b> - FQDN forward DNS RR update flag \n + type: bool (0 or 1) \n + example: 0 + + - <b>fqdn_rev</b> - FQDN reverse DNS RR update flag \n + type: bool (0 or 1) \n + example: 1 + + - <b>hostname</b> - hostname \n + type: string (separators are escaped) \n + example: foo.bar + + - <b>state</b> - lease state \n + type: int32_t (0 to 3) \n + example: 0 + + - <b>user_context</b> - user context \n + type: string (separators are escaped) \n + example: <tt>{ \"foo\": true }</tt> + + - <b>pool_id</b> - pool identifier \n + type: uint32_t \n + example: 0 for instance: \verbatim @@ -148,24 +183,77 @@ @subsection lease6-csv DHCPv6 lease entry format in CSV files - - <b>address</b> - IPv6 address - - <b>DUID</b> - client DUID - - <b>valid_lifetime</b> - valid lifetime (uint32_t) - - <b>expire</b> - expiration date (uint64_t, cltt + valid lifetime) - - <b>subnet_id</b> - DHCPv6 subnet identifier (uint32_t) - - <b>pref_lifetime</b> - preferred lifetime (uint32_t) - - <b>lease_type</b> - lease type (Lease::Type enum0 for NA, 2 for PD) - - <b>iaid</b> - IA identifier (uint32_t) - - <b>prefix_len</b> - prefix length (uint8_t, 0 to 128) - - <b>fqdn_fwd</b> - FQDN forward DNS RR update flag (bool, 0 or 1) - - <b>fqdn_rev</b> - FQDN reverse DNS RR update flag (bool, 0 or 1) - - <b>hostname</b> - hostname (separators are escaped) - - <b>hwaddr</b> - hardware address (hardware type is in hwtype column) - - <b>state</b> - lease state (uint32_t, 0 to 3) - - <b>user_context</b> - user context (separators are escaped) - - <b>hwtype</b> - hardware type (uint16_t) - - <b>hwaddr_source</b> - source of hardware address and type (uint32_t, 8 bit mask) - - <b>pool_id</b> - pool identifier (uint32_t) + - <b>address</b> - IPv6 address \n + type: string \n + example: 2001:db8:1::1 + + - <b>DUID</b> - client DUID \n + type: string \n + example: 01:02:03:04:05:aa:bb:cc + + - <b>valid_lifetime</b> - valid lifetime \n + type: uint32_t \n + example: 200 + + - <b>expire</b> - expiration date \n + type: uint64_t (cltt + valid lifetime) \n + example: 1733517739 + + - <b>subnet_id</b> - DHCPv6 subnet identifier \n + type: int32_t (0 and max excluded) \n + example: 1 + + - <b>pref_lifetime</b> - preferred lifetime \n + type: uint32_t \n + example: 100 + + - <b>lease_type</b> - lease type \n + type: Lease::Type enum (0 for NA, 2 for PD) \n + example: 0 + + - <b>iaid</b> - IA identifier \n + type: uint32_t + example: 1 + + - <b>prefix_len</b> - prefix length \n + type: uint8_t (0 to 128) + example: 64 + + - <b>fqdn_fwd</b> - FQDN forward DNS RR update flag \n + type: bool (0 or 1) \n + example: 0 + + - <b>fqdn_rev</b> - FQDN reverse DNS RR update flag \n + type: bool (0 or 1) \n + example: 1 + + - <b>hostname</b> - hostname \n + type: string (separators are escaped) \n + example: foo.bar + + - <b>hwaddr</b> - hardware address (hardware type is in hwtype column) \n + type: string \n + example: '00:01:02:03:04:05` + + - <b>state</b> - lease state \n + type: int32_t (0 to 3) \n + example: 0 + + - <b>user_context</b> - user context \n + type: string (separators are escaped) \n + example: <tt>{ \"foo\": true }</tt> + + - <b>hwtype</b> - hardware type \n + type: uint16_t (can be empty/omitted) \n + example: 1 + + - <b>hwaddr_source</b> - source of hardware address and type \n + tyoe: uint32_t (one bit from an 8 bit mask, can be empty/omitted) \n + example: 0 + + - <b>pool_id</b> - pool identifier \n + type: uint32_t \n + example: 0 For instance: \verbatim |