LocalLB::ProfileSPM

Introduced : BIG-IP_v11.4.0
The ProfileSPM interface enables you to manipulate a local load balancer&aposs Subscriber Policy Manager (SPM) profile. If a subscriber does not have policies assigned to it either dynamically or statically, it is an unknown subscriber. Otherwise, the subscriber has its own policies. On top of that, there are global policies that can be applied to all subscribers (subscribers with their own polices or unknown subscribers).

Methods

Method Description Introduced
add_high_precedence_global_policy Adds a set of global policies with high precedence for the specified profiles. BIG-IP_v11.4.0
add_low_precedence_global_policy Adds a set of global policies with low precedence for the specified profiles. BIG-IP_v11.4.0
add_unknown_subscriber_policy Adds a set of policies for unknown subscribers for the specified profiles. BIG-IP_v11.4.0
create Creates the specified SPM profiles. BIG-IP_v11.4.0
delete_all_profiles Deletes all SPM profiles. BIG-IP_v11.4.0
delete_profile Deletes the specified SPM profiles. BIG-IP_v11.4.0
get_default_profile Gets the names of the default profiles from which the specified profiles will derive default values for attributes. BIG-IP_v11.4.0
get_description Gets the description for a set of SPM profiles. BIG-IP_v11.4.0
get_high_precedence_global_policy Gets a set of global policies with high precedence for the specified profiles. This specifies global enforcement policies to apply to all subscribers in parallel with the subscriber policies. The global policy can be of high or low precedence. If rules of this type in the global and subscriber policies conflict, the high precedence global policy overrides the subscriber policy. BIG-IP_v11.4.0
get_list Gets a list of all SPM profiles. BIG-IP_v11.4.0
get_low_precedence_global_policy Gets a set of global policies with low precedence for the specified profiles. This specifies global enforcement policies to apply to all subscribers in parallel with the subscriber policies. The global policy can be of high or low precedence. If rules of this type in the global and subscriber policies conflict, the subscriber policy overrides the low precedence global policy. BIG-IP_v11.4.0
get_unknown_subscriber_policy Gets a set of policies for unknown subscribers for the specified profiles. This specifies enforcement policies to apply to subscribers that do not currently have policies assigned to them either dynamically or statically. In more detail, the unknown subscribers are defined as those that are in the non-provisioned state for any reason. This might include new subscribers waiting for the provisioning response from Policy Charging Rules Function (PCRF), or established subscribers that are neither found in PCRF nor in local subscriber registry. The unknown subscriber policy operates on the subscriber session concurrently with any global policy configured in the system. BIG-IP_v11.4.0
get_version Gets the version information for this interface. BIG-IP_v11.4.0
is_base_profile Determines whether the specified SPM 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_v11.4.0
is_system_profile Determines whether the specified SPM 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.4.0
remove_all_high_precedence_global_policies Removes all global policies with high precedence for the specified profiles. BIG-IP_v11.4.0
remove_all_low_precedence_global_policies Removes all global policies with low precedence for the specified profiles. BIG-IP_v11.4.0
remove_all_unknown_subscriber_policies Removes all policies for unknown subscribers for the specified profiles. BIG-IP_v11.4.0
remove_high_precedence_global_policy Removes a set of global policies with high precedence for the specified profiles. BIG-IP_v11.4.0
remove_low_precedence_global_policy Removes a set of global policies with low precedence for the specified profiles. BIG-IP_v11.4.0
remove_unknown_subscriber_policy Removes a set of policies for unknown subscribers for the specified profiles. BIG-IP_v11.4.0
set_default_profile Sets the names of the default profiles from which the specified profiles will derive default values for attributes. BIG-IP_v11.4.0
set_description Sets the description for a set of SPM profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.4.0

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description

See Also

iControl ::
iControl :: LocalLB :: ProfileSPM

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


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

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.