System::ConfigSync::synchronize_to_group_v2

Introduced : BIG-IP_v11.2.0
Synchronize the configuration from the specified device to the given group. This method causes the configuration for the specified device to be pushed to all members of the given device group. If force is true, then the configuration will be pushed unconditionally. If force is false, then update all devices in the device group that have configuration older than the specified device.

Prototype

 synchronize_to_group_v2(
    in String group,
    in String device,
    in boolean force
);

Parameters

Parameter Type Description
group String The group to synchronize to.
device String The device to synchronize to the group. As of version 11.2.0 this parameter is ignored and the name of the local device is used instead. As of 11.5.1 it is considered again and must include the partition name if force=’false’ i.e. /Common/mydevice.example.com
force boolean If true, then synchronize unconditionally. If false, then update all devices in the device group that have configuration older than the specified device.

Return Type

Type Description
void  

Exceptions

Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.