LocalLB::ProfileXML¶
Introduced : BIG-IP_v9.0.3
The ProfileXML interface enables you to manipulate a local load
balancer&aposs XML profile.
Methods¶
| Method | Description | Introduced |
| add_namespace_mappings | Adds sets of namespace mappings to a set of XML profiles. Specifies a list of mappings between namespaces and prefixes to be used in the profile context. For example, to define a namespace mapping of XML schema namespace one would add the namespace mapping of the prefix “xsd” to the namespace “http://www.w3.org/2001/XMLSchema”. | BIG-IP_v10.2.0 |
| add_xpath_queries | Adds sets of XPath query strings to a set of XML profiles. A match of any of the queries will trigger an iRule event. For example, to trigger an iRule event on document having title of the first book node under the bookstore element it&aposs needed to add the “/bookstore/book[1]/title” XPath query to a xml profile. | BIG-IP_v10.2.0 |
| create | Creates the specified XML profiles. | BIG-IP_v9.0.3 |
| delete_all_profiles | Deletes all XML profiles. | BIG-IP_v9.0.3 |
| delete_profile | Deletes the specified XML profiles. | BIG-IP_v9.0.3 |
| get_abort_on_error_state | Gets the state that if true, abort the connection on errors. This method is deprecated (and is a no-op), as the feature was never implemented. | BIG-IP_v9.0.3 |
| get_all_statistics | Gets the statistics for all the XML profiles. | BIG-IP_v9.0.3 |
| 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.3 |
| get_description | Gets the descriptions for a set of XML profiles. | BIG-IP_v11.0.0 |
| get_list | Gets a list of all XML profiles. | BIG-IP_v9.0.3 |
| get_maximum_buffer_size | Gets the values that specify the maximum buffer size for the specified profiles. This method is deprecated (and is a no-op), as the feature was never implemented. | BIG-IP_v9.0.3 |
| get_multiple_query_matches_state | Gets the states that specify whether multiple matches for a single XPath query are given. | BIG-IP_v11.0.0 |
| get_namespace_mappings | Gets sets of namespace mappings of a set of XML profiles. | BIG-IP_v10.2.0 |
| get_statistics | Gets the statistics for the specified XML profiles. | BIG-IP_v9.0.3 |
| 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.3 |
| get_xpath_queries | Gets sets of XPath query strings of a set of XML profiles. | BIG-IP_v10.2.0 |
| is_base_profile | Determines whether the specified XML 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.3 |
| is_system_profile | Determines whether the specified XML 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 |
| remove_all_namespace_mappings | Removes all the namespace mappings from a set of XML profiles. | BIG-IP_v10.2.0 |
| remove_all_xpath_queries | Removes all the XPath queries from a set of XML profiles. | BIG-IP_v10.2.0 |
| remove_namespace_mappings | Removes sets of namespace mappings from a set of XML profiles. | BIG-IP_v10.2.0 |
| remove_xpath_queries | Removes sets of XPath query strings from a set of XML profiles. | BIG-IP_v10.2.0 |
| reset_statistics | Resets the statistics for the specified XML profiles. | BIG-IP_v9.0.3 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v11.0.0 |
| set_abort_on_error_state | Sets the state that if true, abort the connection on errors. This method is deprecated (and is a no-op), as the feature was never implemented. | BIG-IP_v9.0.3 |
| 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.3 |
| set_description | Sets the description for a set of XML profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_maximum_buffer_size | Sets the values that specify the maximum buffer size for the specified profiles. This method is deprecated (and is a no-op), as the feature was never implemented. | BIG-IP_v9.0.3 |
| set_multiple_query_matches_state | Sets the states that specify whether multiple matches for a single XPath query are given. If the state is enabled, each match will trigger an iRule event. | BIG-IP_v11.0.0 |
Structures¶
Structure
Description
A struct that contains definition for the namespace mapping.
ProfileNamespaceMappingSequence
A structure that specifies a sequence of namespace mappings strings used in profile attributes.
A struct that describes statistics for a particular XML profile.
A struct that describes profile statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| NamespaceMappingSequence | NamespaceMapping [] | A sequence of NamespaceMapping&aposs. |
| NamespaceMappingSequenceSequence | NamespaceMapping [] [] | An alias for a sequence of NamespaceMapping&aposs for a particular XML profile. |
| ProfileNamespaceMappingSequenceSequence | ProfileNamespaceMappingSequence [] | A sequence of sequence of profile namespace mappings strings. |
| ProfileXMLStatisticEntrySequence | ProfileXMLStatisticEntry [] | A sequence of ProfileXML 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.