LocalLB::ProfileAuth¶
Introduced : BIG-IP_v9.0
The ProfileAuth interface enables you to manipulate a local load
balancer&aposs authentication profile.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified auth profiles. | BIG-IP_v9.0 |
| delete_all_profiles | Deletes all auth profiles. | BIG-IP_v9.0 |
| delete_profile | Deletes the specified auth profiles. | BIG-IP_v9.0 |
| get_all_statistics | Gets the statistics for all the Auth profiles. | BIG-IP_v9.0 |
| get_authentication_method | Gets the authentication methods that the specified profiles will be using. | BIG-IP_v9.0 |
| get_configuration_name | Gets the names of the authentication configurations that the specified profiles will be using. | BIG-IP_v9.0 |
| get_credential_source | Gets the sources of the credentials that the specified profiles will be using. | BIG-IP_v9.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.0 |
| get_description | Gets the descriptions for a set of authentication profiles. | BIG-IP_v11.0.0 |
| get_idle_timeout | Gets the idle timeout for the specified auth profiles. | BIG-IP_v9.0 |
| get_list | Gets a list of all auth profiles. | BIG-IP_v9.0 |
| get_profile_mode | Gets the modes for the specified auth profiles. | BIG-IP_v9.0 |
| get_rule_name | Gets the names of rules that the specified profiles will be using. | BIG-IP_v9.0 |
| get_statistics | Gets the statistics for the specified Auth profiles. | BIG-IP_v9.0 |
| get_statistics_by_virtual | Gets the statistics for the specified profiles, by virtual server. | BIG-IP_v11.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| is_base_profile | Determines whether the specified authentication 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.0 |
| is_system_profile | Determines whether the specified authentication 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 Auth profiles. | BIG-IP_v9.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v11.0.0 |
| set_authentication_method | Sets the authentication methods that the specified profiles will be using. | BIG-IP_v9.0 |
| set_configuration_name | Sets the names of the authentication configurations that the specified profiles will be using. | BIG-IP_v9.0 |
| set_credential_source | Sets the sources of the credentials that the specified profiles will be using. | BIG-IP_v9.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.0 |
| set_description | Sets the description for a set of authentication profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_idle_timeout | Sets the idle timeout for the specified auth profiles. | BIG-IP_v9.0 |
| set_profile_mode | Sets the modes for the specified auth profiles. | BIG-IP_v9.0 |
| set_rule_name | Sets the names of rules that the specified profiles will be using. | BIG-IP_v9.0 |
Structures¶
Structure
Description
A struct that describes statistics for a particular Auth profile.
A struct that describes profile statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| ProfileAuthStatisticEntrySequence | ProfileAuthStatisticEntry [] | A sequence of ProfileAuth statistics. |
See Also¶
iControl ::
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.