Introduced : BIG-IP_v9.4.0
Gets the CMP enabled states for the specified virtual servers. Enables or disables CMP. Note that this setting can influence the CMP enable mode set automatically by the system and configuration. You can not always enable CMP, but you can always disable it.


EnabledState [] get_cmp_enabled_state(
    in String [] virtual_servers


Parameter Type Description
virtual_servers String [] The virtual server definitions to get the CMP enabled states of.

Return Type

Type Description
EnabledState [] The CMP enabled states of the specified virtual servers.


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


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.