Introduced : BIG-IP_v11.4.0
Gets the sync status of the system. This gets the status of the current device&aposs presence in all device groups in which it is a member. If there is a communication problem with any device group, then this method will note it. Use the get_sync_status method in this interface to get information about connectivity and sync status for a particular device group.


SyncStatus get_sync_status_overview(



Parameter Type Description

Return Type

Type Description
SyncStatus The sync status.


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

See Also


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.