summaryrefslogtreecommitdiffstats
path: root/doc/examples
diff options
context:
space:
mode:
authorPiotrek Zadroga <piotrek@isc.org>2023-09-15 12:41:55 +0200
committerPiotrek Zadroga <piotrek@isc.org>2023-09-21 09:35:01 +0200
commitac65b67c353d73d0203c6d69a6070cefc516d93c (patch)
tree5056db933d02561f6bb4c6d11e49051ea3d289ec /doc/examples
parent[#3067] addressed review comments (diff)
downloadkea-ac65b67c353d73d0203c6d69a6070cefc516d93c.tar.xz
kea-ac65b67c353d73d0203c6d69a6070cefc516d93c.zip
[#3002] add examples for SZTP redirect options
Diffstat (limited to 'doc/examples')
-rw-r--r--doc/examples/kea4/all-options.json38
-rw-r--r--doc/examples/kea6/all-options.json34
2 files changed, 70 insertions, 2 deletions
diff --git a/doc/examples/kea4/all-options.json b/doc/examples/kea4/all-options.json
index 9e3e4cf81d..607d1491d4 100644
--- a/doc/examples/kea4/all-options.json
+++ b/doc/examples/kea4/all-options.json
@@ -1475,7 +1475,43 @@
"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}
{
diff --git a/doc/examples/kea6/all-options.json b/doc/examples/kea6/all-options.json
index eee66349c3..bd38f40d94 100644
--- a/doc/examples/kea6/all-options.json
+++ b/doc/examples/kea6/all-options.json
@@ -1707,7 +1707,39 @@
// 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