system.sfc.redundantCheckpoint
This function is used in Python Scripting.
Description​
Synchronizes chart and step variables of the specified chart instance across a redundant cluster, allowing the chart instance to continue where it left off if a redundant failover occurs. Check out redundancy sync for more information.
Client Permission Restrictions​
Permission Type: SFC Management
Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.
Syntax​
system.sfc.redundantCheckpoint(instanceId)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | instanceId | The instance identifier of the chart. |
Returns​
Nothing
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
Code Snippet
# This example will create a redundant checkpoint in case the primary Gateway in the redundant pair fails.
instanceId = "The ID of the chart you want to synchronize across the redundant pair"
system.sfc.redundantCheckpoint(instanceId)