Set Synchronization Configuration

Sets configuration for proxy settings synchronization.

URL

HTTP Method

POST Parameters

Parameter	Required	Type	Description	Acceptable Values
mode	false	string	Specifies the synchronization mode. Defaults to "learn"	"teach" "learn"
password	true	string	Specifies whether to enable health checking.	alphanumeric, space, dash, slash, underscore, period and parentheses. 8-32 characters
peer	false	string containing IP address, or array of strings containing IP addresses	Specifies the IP address(es) of the peer(s) to sync with. Required when protocol is set to "unicast". Parameter is ignored for "multicast".	"<ip address>" ["<ip address>", "<ip address>", ...]
protocol	true	string	Specifies the transmission protocol. Only "unicast" is supported in AWS or Azure.	"unicast" "multicast"
status	false	string containing integer	Specifies whether proxy settings synchronization is enabled. Defaults to "0".	"0" → Disabled "1" → Enabled
sync_style	true	string	Specifies the what to sync among the cluster. If set to "full" and appliance is configured for multiple SSL proxies, the Listen IP of each proxy must be set to "*" (All Inbound).	"full" "template"
interface	false	array of strings containing integers	Enables synchronization on the specified interface if provided. Parameter not usable if a different interface is already configured for synchronization.	Name of interface (list of interfaces can be obtained with Get Interfaces)

Response Parameters

Returns a string indicating success/error.

Example: Configure appliance sync config as a unicast learner with a single peer

Request

POST Parameters

{
"mode": "learn",
"password": "ninja_password",
"peer": "1.2.3.4",
"protocol": "unicast",
"status": "1",
"sync_style": "full"
}

Response

{"result":"success"}

Example: Configure appliance sync settings as a multicast teacher

Request

POST Parameters

{
"mode": "teach",
"password": "ninja_password",
"protocol": "multicast",
"status": "1",
"sync_style": "full"
}

Response

{"result":"success"}

Example: Configure appliance sync settings as a unicast teacher with multiple peers, and also enable synchronization on eth1

Request

POST Parameters

{
"mode": "teach",
"password": "ninja_password",
"peer": [
"4.3.2.1",
"5.4.3.2"
],
"protocol": "unicast",
"status": "1",
"sync_style": "template",
"interface": "eth1"
}

Response

{"result":"success"}