]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3002] add examples for SZTP redirect options
authorPiotrek Zadroga <piotrek@isc.org>
Fri, 15 Sep 2023 10:41:55 +0000 (12:41 +0200)
committerPiotrek Zadroga <piotrek@isc.org>
Thu, 21 Sep 2023 07:35:01 +0000 (07:35 +0000)
doc/examples/kea4/all-options.json
doc/examples/kea6/all-options.json

index 9e3e4cf81d12a865e523ebfb030a79d3ed83008d..607d1491d4c4a86b538d20901af8be892c045052 100644 (file)
         "name": "sip-ua-cs-domains"
       },
 
-      // Option codes 142-145 are not defined in Kea.
+      // Option code 142 is not defined in Kea.
+
+      /*
+       0                             1
+       0  1  2  3  4  5  6  7  8  9  0  1  2  3  4  5
+      +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
+      |   option-code (143)   |     option-length     |
+      +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
+      .                                               .
+      .    bootstrap-server-list (variable length)    .
+      .                                               .
+      +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
+
+      option-code: OPTION_V4_SZTP_REDIRECT (143)
+
+      option-length: The option length in octets.
+
+      bootstrap-server-list: A list of servers for the
+       client to attempt contacting, in order to obtain
+       further bootstrapping data. Each URI entry in the
+       bootstrap-server-list is structured as follows:
+
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-...-+-+-+-+-+-+-+
+      |       uri-length              |          URI                  |
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-...-+-+-+-+-+-+-+
+
+      uri-length: 2 octets long; specifies the length of the URI data.
+      URI: URI of the SZTP bootstrap server.
+      */
+      // Type: array of {tuple}
+      {
+        "code": 143,
+        "data": "https://sztp1.example.com:8443, https://sztp2.example.com:8444",
+        "name": "v4-sztp-redirect"
+      },
+
+      // Option codes 144-145 are not defined in Kea.
 
       // Type: uint8, IPv4 address, IPv4 address, array of {FQDN}
       {
index eee66349c3da79c0800beeb100da4813b7655e96..bd38f40d943a91b29780539c976b26914cb7eb1f 100644 (file)
       // Option code 112 is unassigned.
       // Option codes 113-134 are not defined in Kea.
 
-      // Option codes 136-142 are unassigned.
+      /*
+       0                   1                   2                   3
+       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      |       option-code (136)       |          option-length        |
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      .           bootstrap-server-list (variable length)             .
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+      option-code: OPTION_V6_SZTP_REDIRECT (136)
+
+      option-length: The option length in octets.
+
+      bootstrap-server-list: A list of servers for the
+       client to attempt contacting, in order to obtain
+       further bootstrapping data. Each URI entry in the
+       bootstrap-server-list is structured as follows:
+
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-...-+-+-+-+-+-+-+
+      |       uri-length              |          URI                  |
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-...-+-+-+-+-+-+-+
+
+      uri-length: 2 octets long; specifies the length of the URI data.
+      URI: URI of the SZTP bootstrap server.
+      */
+      // Type: array of {tuple}
+      {
+        "code": 136,
+        "data": "https://sztp1.example.com:8443, https://sztp2.example.com:8444",
+        "name": "v6-sztp-redirect"
+      },
+
+      // Option codes 137-142 are unassigned.
 
       /*
        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1