Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
litespeed_wiki:lslb:zconf [2018/04/19 13:38] Ron Saad [API Configuration Messages] |
litespeed_wiki:lslb:zconf [2019/07/23 13:13] Kevin Fwu [ZCUP Message] |
||
---|---|---|---|
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> | 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> | </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 ==== | ==== 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. | 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 47: | Line 47: | ||
<dt>ZCDOWN:<dt><dd>Cluster down message</dd><br /> | <dt>ZCDOWN:<dt><dd>Cluster down message</dd><br /> | ||
<dt>ZCSSL:<dt><dd>Add SSL credentials message<br /></dd> | <dt>ZCSSL:<dt><dd>Add SSL credentials message<br /></dd> | ||
- | <dt>ZCSSLRELEASE:<dt><dd>Delete SSL credentials message</dd> | + | <dt>ZCSSLRELEASE:<dt><dd>Delete SSL credentials message<br /></dd> |
- | </dl></div> | + | <dt>ZCOWNRRELEASE:<dt><dd>Relinquish ownership of config records</dd></dl></div> |
</html> | </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. | 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 74: | Line 74: | ||
[ | [ | ||
{ | { | ||
+ | <u>"template" : "<i>VHost template name</i>",</u> | ||
"domain_list" : | "domain_list" : | ||
[ <i>list of domains (strings)</i> ], | [ <i>list of domains (strings)</i> ], | ||
Line 128: | Line 129: | ||
"domain_list" : | "domain_list" : | ||
[ "dom4", "dom5", "dom6" ], | [ "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" : | "conf_list" : | ||
[ | [ | ||
Line 145: | Line 164: | ||
} | } | ||
</code> | </code> | ||
+ | |||
+ | Note: | ||
+ | * Templates introduced in ADC version 2.4 build 11. | ||
Line 198: | Line 220: | ||
</code> | </code> | ||
==== ZCSSLRELEASE Message ==== | ==== ZCSSLRELEASE Message ==== | ||
- | Provide SSL data (key, cert and CA bundle) to LiteSpeed Web ADC | + | 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>'' | URL: ''<nowiki>https://[user:password@]ip_addr[:port]/ZCSSLRELEASE?name=cluster_name</nowiki>'' | ||
Line 228: | Line 250: | ||
} | } | ||
] | ] | ||
+ | } | ||
+ | </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> | </code> |