LocalLB::ProfileDiameterEndpoint¶
Introduced : BIG-IP_v11.4.0
The ProfileDiameterEndpoint interface enables you to manipulate a
local load balancer&aposs DiameterEndpoint profile. The Diameter base
protocol is intended to provide an Authentication, Authorization and
Accounting (AAA) framework for applications such as network access or
IP mobility. Diameter is also intended to work in both local
Authentication, Authorization & Accounting and roaming situations. On
top of it, there are some different application types e.g. Gx
(communication between Policy Charging Rules Function (PCRF) and
Policy Charging Enforcement Function (PCEF)), Gy (charging) etc. The
PEM (Policy Enforcement Manager) module uses this profile.
Methods¶
| Method | Description | Introduced |
| get_all_statistics | Gets the statistics for all DiameterEndpoint 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 DiameterEndpoint profiles. | BIG-IP_v11.4.0 |
| get_destination_host | Gets the destination host for the specified profiles. | BIG-IP_v11.4.0 |
| get_destination_realm | Gets the destination realm for the specified profiles. | BIG-IP_v11.4.0 |
| get_fatal_grace_time | Gets the fatal-grace-time periods, in seconds, for the specified DiameterEndpoint profiles. | BIG-IP_v11.4.0 |
| get_fatal_grace_time_state | Gets the fatal-grace-time states for the specified DiameterEndpoint profiles. | BIG-IP_v11.4.0 |
| get_list | Gets a list of all DiameterEndpoint profiles. | BIG-IP_v11.4.0 |
| get_maximum_retransmit_attempts | Gets the maximum retransmit attempts. | BIG-IP_v11.4.0 |
| get_origin_host | Gets the origin host for the specified profiles. | BIG-IP_v11.4.0 |
| get_origin_realm | Gets the origin realm for the specified profiles. | BIG-IP_v11.4.0 |
| get_product_name | Gets the products for a set of DiameterEndpoint profiles. | BIG-IP_v11.4.0 |
| get_retransmit_delay | Gets the retransmit delay in milliseconds. | BIG-IP_v11.4.0 |
| get_statistics | Gets the statistics for the specified DiameterEndpoint profiles. | BIG-IP_v11.4.0 |
| get_statistics_by_virtual | Gets the statistics for the specified DiameterEndpoint profiles, by virtual server. | BIG-IP_v11.4.0 |
| get_supported_application_type | Gets the supported application types for the specified DiameterEndpoint profiles. The application types include Gx (communication between PCRF and PCEF), Gy (credit-control) etc. The current options are Gx only. | 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 DiameterEndpoint 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 DiameterEndpoint 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 |
| replace_supported_application_types | Replaces the lists of applications supported by the specified DiameterEndpoint profiles. The supported applications will be ordered as they are listed in the arguments. | BIG-IP_v11.4.0 |
| reset_statistics | Resets the statistics for the specified DiameterEndpoint profiles. | BIG-IP_v11.4.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified DiameterEndpoint profiles, for specified virtual servers. | 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 DiameterEndpoint profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.4.0 |
| set_destination_host | Sets the destination host for the specified profiles. This specifies the destination host for diameter messages. The Destination-Host AVP is of type DiameterIdentity. This AVP MUST be present in all unsolicited agent initiated messages, MAY be present in request messages, and MUST NOT be present in Answer messages. This should be a FQDN. See RFC 3588 section 6.5. | BIG-IP_v11.4.0 |
| set_destination_realm | Sets the destination realm for the specified profiles. This specifies the destination realm for diameter messages. The Destination-Realm AVP is of type DiameterIdentity, and contains the realm the message is to be routed to. The Destination-Realm AVP MUST NOT be present in Answer messages. Diameter Clients insert the realm portion of the User-Name AVP. Diameter servers initiating a request message use the value of the Origin-Realm AVP from a previous message received from the intended target host (unless it is known a priori). When present, the Destination-Realm AVP is used to perform message routing decisions. This should be a FQDN. See RFC 3588 section 6.6. | BIG-IP_v11.4.0 |
| set_fatal_grace_time | Sets the fatal-grace-time periods, in seconds, for the specified DiameterEndpoint profiles. This defines the period that a diameter connection can be down before all sessions associated with that diameter endpoint are terminated. If the connection is re-established before the grace time ends then the sessions will not be terminated automatically. | BIG-IP_v11.4.0 |
| set_fatal_grace_time_state | Sets the fatal-grace-time states for the specified DiameterEndpoint profiles. This specifies whether fatal-grace-time option is enabled or not. | BIG-IP_v11.4.0 |
| set_maximum_retransmit_attempts | Sets the maximum retransmit attempts. This specifies the number of times an outgoing request message will be retransmitted before being dropped. | BIG-IP_v11.4.0 |
| set_origin_host | Sets the origin host for the specified profiles. This specifies the origin host for diameter messages. The Origin-Host Attribute-Value Pairs (AVP) is of type DiameterIdentity, and MUST be present in all Diameter messages. This AVP identifies the endpoint that originated the Diameter message. Relay agents MUST NOT modify this AVP. This should be a FQDN. See RFC 3588 section 6.3. | BIG-IP_v11.4.0 |
| set_origin_realm | Sets the origin realms for the specified profiles. This specifies the origin realm for diameter messages. The Origin-Realm AVP is of type DiameterIdentity. This AVP contains the Realm of the originator of any Diameter message and MUST be present in all messages. This should be a FQDN. See RFC 3588 section 6.4. | BIG-IP_v11.4.0 |
| set_product_name | Sets the product names for the specified DiameterEndpoint profiles. This specifies the string used in the product-name AVP in the capabilities exchange messages. | BIG-IP_v11.4.0 |
| set_retransmit_delay | Sets the retransmit delay. This specifies the delay in milliseconds after which an unanswered request will be retransmitted. | BIG-IP_v11.4.0 |
Structures¶
Structure
Description
DiameterEndpointProfileStatisticEntry
A struct that describes statistics for a particular profile.
DiameterEndpointProfileStatistics
A struct that describes DiameterEndpoint profile statistics and timestamp.
ProfileDiameterApplicationTypeSequence
A structure that specifies a DiameterApplicationType enum used in profile attributes.
Enumerations¶
| Enumeration | Description |
| DiameterApplicationType | Specifies the application types of the DiameterEndpoint. Application types of diameter endpoint are possible application protocols that run over diameter base protocol as defined by RFC 3588. These applications include Gx (see below for details), etc. Right now, only Gx protocol (application) is supported. More supports will be added later. |
Aliases¶
| Alias | Type | Description |
| DiameterApplicationTypeSequence | DiameterApplicationType [] | A list of DiameterApplicationType enums. |
| DiameterEndpointProfileStatisticEntrySequence | DiameterEndpointProfileStatisticEntry [] | A sequence of DiameterEndpoint profile statistics. |
| ProfileDiameterApplicationTypeSequenceSequence | ProfileDiameterApplicationTypeSequence [] | A list of ProfileDiameterApplicationTypeSequences. |
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.