LocalLB::ProfileUserStatistic

Introduced : BIG-IP_v9.2.0
The ProfileUserStatistic interface enables you to manage user-defined statistics in a profile. The user can define up to 32 user-defined statistics in each profile.

Methods

Method Description Introduced
create Creates the specified user-defined statistic profiles. BIG-IP_v9.2.0
delete_all_profiles Deletes all user-defined statistic profiles. BIG-IP_v9.2.0
delete_profile Deletes the specified user-defined statistic profiles. BIG-IP_v9.2.0
get_all_statistics Gets the statistics for all the user-defined statistic profiles. Only the statistic values of the user-defined statistics will be returned, i.e. even though there are up to 32 custom statistics in any given profile, but if only 3 of those custom statistics have been defined by the user, then only the values of those 3 statistics will be returned. BIG-IP_v9.2.0
get_default_profile Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. BIG-IP_v9.2.0
get_description Gets the descriptions for a set of statistics profiles. BIG-IP_v11.0.0
get_list Gets a list of all user-defined statistic profiles. BIG-IP_v9.2.0
get_statistic_name Gets the user-defined statistic names in the specified profiles. BIG-IP_v9.2.0
get_statistics Gets the statistics for the specified user-defined statistic profiles. Only the statistic values of the user-defined statistics will be returned, i.e. even though there are up to 32 custom statistics in any given profile, but if only 3 of those custom statistics have been defined by the user, then only the values of those 3 statistics will be returned. BIG-IP_v9.2.0
get_version Gets the version information for this interface. BIG-IP_v9.2.0
is_base_profile Determines whether the specified statistics profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). BIG-IP_v9.2.0
is_system_profile Determines whether the specified statistics profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). BIG-IP_v11.0.0
reset_statistics Resets the statistics for the specified user-defined statistic profiles. BIG-IP_v9.2.0
set_default_profile Sets the names of the default profiles from which the specified profiles will derive default values for its attributes. BIG-IP_v9.2.0
set_description Sets the description for a set of statistics profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_statistic_name Sets the user-defined statistic names in the specified profiles. BIG-IP_v9.2.0

Structures

Structure

Description

ProfileUserStatisticStatisticEntry

A struct that describes statistics for a particular user-defined statistic profile.

ProfileUserStatisticStatistics

A struct that describes profile statistics and timestamp.

UserStatistic

A user-defined statistic entry with type and value.

UserStatisticName

A struct that describes a user-defined statistic name.


Enumerations

Enumeration Description
UserStatisticKey A list of user statistic fields in the profile.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ProfileUserStatisticStatisticEntrySequence ProfileUserStatisticStatisticEntry [] A sequence of ProfileUserStatistic statistics.
UserStatisticKeySequence UserStatisticKey [] A sequence of user-defined statistic keys.
UserStatisticKeySequenceSequence UserStatisticKey [] [] A sequence of sequence of user-defined statistic keys.
UserStatisticNameSequence UserStatisticName [] A sequence of UserStatisticName&aposs.
UserStatisticNameSequenceSequence UserStatisticName [] [] A sequence of sequence of UserStatisticName&aposs.
UserStatisticSequence UserStatistic [] A sequence of different statistics.

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.