Differences

This shows you the differences between two versions of the page.

--- litespeed_wiki:lslb:zconf [2017/08/01 17:44]
Ron Saad [Sending ZeroConfig API Messages]
+++ litespeed_wiki:lslb:zconf [2019/07/23 14:07]
Kevin Fwu
@@ Line 14: / Line 14: @@
 curl --silent -X POST --data-binary $DATA https://<i>user:password</i>@<i>my_load_balancer.com:my_listner_port</i>/<i>API_COMMAND</i>?name=<i>my_cluster</i>
 </pre>
-<p><b>The fields <i>user</i> and <i>my_cluster</i> must NOT contain ':' (colon) characters.</html>
+<p><b>The fields <i>user</i> and <i>my_cluster</i> must NOT contain ':' (colon) characters.</b></html>
 ==== Handling ZeroConfig API Responses ====
 Messages to the ZeroConfig API receive HTTP responses, with common status codes (typically 200 for success, 400 for invalid messages / failures). Response bodies may contain data from the ZeroConfig system or error messages detailing a problem encountered while trying to process a received message.
@@ Line 35: / Line 35: @@
   float: left;
   clear: left;
-  margin-right: 5px;
+  margin-right: 10px;
   font-weight: bold;
   }
-dd { display: inline; }
+dd {
+  display: inline;
+  }
 </style>
-<dl>
+<div><dl>
 <dt>ZCUP:<dt><dd>Cluster up message</dd><br />
 <dt>ZCDOWN:<dt><dd>Cluster down message</dd><br />
-<dt>ZCSSL:<dt><dd>SSL credentials message</dd>
+<dt>ZCSSL:<dt><dd>Add SSL credentials message<br /></dd>
-</dl>
+<dt>ZCSSLRELEASE:<dt><dd>Delete SSL credentials message<br /></dd>
+<dt>ZCOWNRRELEASE:<dt><dd>Relinquish ownership of config records</dd></dl></div>
 </html>
 Configuration messages are sent to LiteSpeed Web ADC using the HTTP protocol with Basic Authentication over a secure connection. Once the ZConf Listeners are configured according to the Setup section above, they will accept and process configuration messages sent to their respective IP and port.
@@ Line 63: / Line 66: @@
   * ''ip_addr'' is a ZConf Listener IP address, ''port'' is the ZConf Listener port (optional if the standard 443, although in most configurations it is typically set to a different port, leaving 443 available for load balancer traffic).
   * ''cluster_name'' is a user assigned name for the cluster being configured.
+Tip:
+A ZeroConf VHost is **NOT** the same as an ADC VHost. VHost in the context of a ZeroConf ZCUP message is defined as the list of domains that share the conf_list and template. A single VHost configuration can include thousands of domains as long as they share the conf_list. For example, if there is a backend server with 1000 domains that are listening to port 443, they can share a vhost.
 Data:
@@ Line 71: / Line 78: @@
         [
             {
+                <u>"template" : "<i>VHost template name</i>",</u>
                 "domain_list" :
                     [ <i>list of domains (strings)</i> ],
@@ Line 125: / Line 133: @@
                 "domain_list" :
                     [ "dom4", "dom5", "dom6" ],
+                "conf_list" :
+                    [
+                        {
+                            "lb_port_list" : [ 443 ],
+                            "dport" : 443,
+                            "be_ssl" : true,
+                            "ip_list" :
+                                [
+                                    { "ip" : "192.168.1.103" },
+                                    { "ip" : "192.168.1.104" }
+                                ]
+                        }
+                    ]
+            },
+            {
+                "template" : "noCacheTemplate"
+                "domain_list" :
+                    [ "dom7", "dom8", "dom9" ],
                 "conf_list" :
                     [
@@ Line 142: / Line 168: @@
 }
  </code>
+Note:
+  * Templates introduced in ADC version 2.4 build 11.
@@ Line 186: / Line 215: @@
         [
             {
-                "domain" : "litespeedtech.com",
+                "domain_list" : [ "litespeedtech.com", "blog.litespeedtech.com" ],
                 "key" : "-----BEGIN RSA PRIVATE KEY----- ... " ,
                 "cert" : "-----BEGIN CERTIFICATE----- ... " ,
@@ Line 192: / Line 221: @@
             }
         ]
+}
+</code>
+==== ZCSSLRELEASE Message ====
+Delete SSL data (key, cert and CA bundle) for specified domains from LiteSpeed Web ADC
+URL: ''<nowiki>https://[user:password@]ip_addr[:port]/ZCSSLRELEASE?name=cluster_name</nowiki>''
+Data:
+<html><pre class="code">
+conf=
+{
+    "ssl_list" :
+        [
+            {
+                "domain_list" : [ <i>a domain name (string)</i> <u>, more quoted domain names separated by commas </u> ]            }
+            <u>, { <i>more ssl configs</i> } ... </u>
+        ]
+}
+</pre></html>
+Data example:
+<code>
+conf=
+{
+    "ssl_list" :
+        [
+            {
+                "domain_list" : [ "litespeedtech.com", "blog.litespeedtech.com" ]
+            }
+        ]
+}
+</code>
+==== ZCOWNRRELEASE Message ====
+Relinquish ownership of any configuration records for specified domains from LiteSpeed Web ADC (allows
+specified domains to be owned by a different authorized user, such as when transferring to another
+provider).
+URL: ''<nowiki>https://[user:password@]ip_addr[:port]/ZCOWNRRELEASE?name=cluster_name</nowiki>''
+Data:
+<html><pre class="code">
+conf=
+{
+    "domain_list" : [ <i>a domain name (string)</i> <u>, more quoted domain names separated by commas </u> ]
+}
+</pre></html>
+Data example:
+<code>
+conf=
+{
+     "domain_list" : [ "litespeedtech.com", "blog.litespeedtech.com" ]
 }
 </code>