Zero Touch Deployment - Revision history

Hans.zeiner: /* Firewall Rules */

2024-11-07T16:02:04Z

‎Firewall Rules

Hans.zeiner: /* Provisioning details */

2024-11-07T16:01:31Z

‎Provisioning details

Hans.zeiner: /* Provisioning details */

2024-11-04T08:21:16Z

‎Provisioning details

Sven: /* Items */

2024-06-07T08:55:18Z

‎Items

Sven: /* POST */

2020-05-25T12:06:05Z

‎POST

Sven: /* DELETE */

2020-05-25T09:42:35Z

‎DELETE

Sven: /* PUT */

2020-05-25T09:40:10Z

‎PUT

Sven: /* PUT */

2020-05-25T09:37:38Z

‎PUT

Sven: /* PUT */

2020-05-19T05:24:37Z

‎PUT

Sven: /* HTTP responses */

2020-04-28T18:56:24Z

‎HTTP responses

@@ Line 17: / Line 17: @@
 | align=center style="background-color:#0066a1;border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" |<div style="color:white"> '''Trusted Host'''</div>
 | align=center style="background-color:#0066a1;border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" |<div style="color:white"> '''Protocol'''</div>
-| align=center style="background-color:#0066a1;border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" |<div style="color:white"> '''More Port'''</div>
+| align=center style="background-color:#0066a1;border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" |<div style="color:white"> '''Port'''</div>
 |-
 | align=left style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" | '''cloud-setup.com'''

@@ Line 9: / Line 9: @@
 In the process of connecting to cloud-setup.com, the phone will validate the connection to the server via a hard coded root certificate that comes with every phone software version.
-==== Firewall Rules ====
+==== '''Firewall Rules''' ====
 Host address and port numbers for ZTP

← Older revision		Revision as of 08:21, 4 November 2024
Line 8:		Line 8:

	In the process of connecting to cloud-setup.com, the phone will validate the connection to the server via a hard coded root certificate that comes with every phone software version.		In the process of connecting to cloud-setup.com, the phone will validate the connection to the server via a hard coded root certificate that comes with every phone software version.
		+
		+	==== Firewall Rules ====
		+
		+	Host address and port numbers for ZTP
		+
		+	{\|
		+	\|-
		+	\| align=center style="background-color:#0066a1;border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" \|<div style="color:white"> '''Trusted Host'''</div>
		+	\| align=center style="background-color:#0066a1;border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" \|<div style="color:white"> '''Protocol'''</div>
		+	\| align=center style="background-color:#0066a1;border-top:0.05pt solid #000000;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" \|<div style="color:white"> '''More Port'''</div>
		+	\|-
		+	\| align=left style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" \| '''cloud-setup.com'''
		+	\| align=left style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" \| TLS
		+
		+	\| align=center style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;" \| 18443
		+	\|}

	== API ==		== API ==

@@ Line 209: / Line 209: @@
 | false
 | The port of a DLS server
 |-
 | bw-dms-addr

@@ Line 35: / Line 35: @@
 |}
-The data received on a successful request.
+The data received on a successful request with HTTP response code 200
-   {"mac":"01:23:45:67:89:ab","result":"OK","data":"'<Item name="bw-dms-addr">https://192.168.0.100/home</Item>\r\n<Item name="language-iso">de</Item>'"}
+   {"mac":"01:23:45:67:89:ab","data":"'<Item name="bw-dms-addr">https://192.168.0.100/home</Item>\r\n<Item name="language-iso">de</Item>'"}
 {| {{DefaultTable}}
@@ Line 45: / Line 45: @@
 |-
 | mac
-| The MAC address sent in the request or ERROR if no MAC given
+| The MAC address sent in the request or ERROR if no MAC given.
 |-
-| result
+| certificate<br>''optional''
-| The result of the request. Can be OK or ERROR
+| If a certificate is prepared for the provided MAC address, will contain the lifetime.
 |-
 | data<br>''optional''
-| If the result is OK, value will contain the data prepared for the given MAC address
+| If the response code is 200, value will contain the data prepared for the given MAC address.
 |-
 | reason<br>''optional''
-| If the result is ERROR, will contain the reason for the ERROR response
+| If the response code is not 200, will contain the reason for the response.
 |}

@@ Line 114: / Line 114: @@
 |-
 | data<br>''optional''
-| If the result is OK, value will contain the data prepared for the given MAC address.
+| Will contain the result of the data prepared for the given MAC address.
 |-
 | reason<br>''optional''

@@ Line 58: / Line 58: @@
 ==== PUT ====
-The PUT method is used to prepare information about devices for zero touch deployment. The data sent in the PUT request must contain the mac address and deployment data of the device.
+The PUT method is used to prepare information about devices for zero touch deployment. The data sent in the PUT request must contain the mac address and either the deployment data of the device or the certificate request.
    {"mac":"01:23:45:67:89:ab","certificate":"true","data":[Data-Object]}
@@ Line 75: / Line 75: @@
 | "true" or "false"
 |-
-| data<br>'''required'''
+| data<br>'''optional'''
 | The data provided as another Array of supported item objects
 |}
@@ Line 98: / Line 98: @@
 |}
-The data received on a successful request.
+The data received on a successful request with HTTP response code 200
-   {"mac":"01:23:45:67:89:ab","result":"OK","certificate":"{Certificate-Object}","data":"[Data-Object]"}
+   {"mac":"01:23:45:67:89:ab","certificate":"{Certificate-Object}","data":"[Data-Object]"}
 {| {{DefaultTable}}
@@ Line 108: / Line 108: @@
 |-
 | mac
-| The MAC address sent in the request or ERROR if no MAC given
+| The MAC address sent in the request or ERROR if no MAC given.
 |-
-| result
+| certificate<br>''optional''
-| The result of the request. Can be OK or ERROR
+| If a device certificate certificate was requested, will contain the result of the request.
 |-
 | data<br>''optional''
-| If the result is OK, value will contain the data prepared for the given MAC address
+| If the result is OK, value will contain the data prepared for the given MAC address.
 |-
 | reason<br>''optional''
-| If the result is ERROR, will contain the reason for the ERROR response
+| If the HTTP response code is not 200, will contain the reason for the response.
 |}
 Result for Certificate-Object
-   {"result":"OK","serial":"..."}
+   {"code":201,"serial":"..."}
 {| {{DefaultTable}}
@@ Line 132: / Line 129: @@
 ! width="500" | Value
 |-
-| result
+| code
-| The result of the request. Can be OK or ERROR
+| The response code of the request. 201 on successful creation.
 |-
 | serial<br>''optional''
-| If the result is OK, will contain the serial number of the certificate
+| If the response code is 201, will contain the serial number of the certificate created.
 |-
 | lifetime<br>''optional''
-| If the result is ERROR because a certificate exists, will contain the lifetime of the current certificate
+| If the response code is 200 because a certificate already exists, will contain the lifetime of the current certificate.
 |-
 | reason<br>''optional''
-| If the result is ERROR, will contain the reason for the ERROR response
+| If the response code is not 201, will contain the reason for the response
 |}
 Result for Data-Oject
-   [{"name":"acs-server-address","result":"OK"},...]
+   [{"name":"acs-server-address","code":200},...]
 {| {{DefaultTable}}
@@ Line 155: / Line 152: @@
 |-
 | name
-| The name of the item
+| The name of the item.
 |-
-| result
+| code
-| The result of the request. Can be OK or ERROR
+| The response code of the request. 200 on success.
 |-
 | reason<br>''optional''
-| If the result is ERROR, will contain the reason for the ERROR response
+| If the response code is not 200, will contain the reason for the response
 |}

@@ Line 247: / Line 247: @@
 {| {{DefaultTable}}
 |-
-! width="100" | HTTP error code
+! width="100" | HTTP code
 ! width="500" | Description
 |-