System::HAStatus::get_entry_timeout

Introduced : BIG-IP_v11.0.0
Gets the timeout for a set of table entries. The precise meaning of this value varies according to the feature, but in general, it is the elapsed time between when the feature&aposs error state is detected and when the corresponding action is taken.

Prototype

long [] [] get_entry_timeout(
    in boolean [] peers,
    in System__HAStatus__EntryID [] [] ids
);

Parameters

Parameter Type Description
peers boolean [] Query the peer (vs local) system’s HA status table?
ids EntryID [] [] Identifiers of the table entries to query for each specified high availability status table

Return Type

Type Description
long [] [] Timeout in seconds for each specified table entry

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.