LocalLB::ProfileDiameterSession¶
Introduced : BIG-IP_v13.0.0
The ProfileDiameterSession interface enables you to manipulate a local
load balancer&aposs Diameter Session profile.
Methods¶
| Method | Description | Introduced |
| add_array_acct_application_id | Adds to the list of accounting application identifiers. | BIG-IP_v13.0.0 |
| add_array_auth_application_id | Adds to the list of authentication and authorization application identifiers. | BIG-IP_v13.0.0 |
| create | Creates the specified Diameter Session profiles. | BIG-IP_v13.0.0 |
| delete_all_profiles | Deletes all Diameter Session profiles. | BIG-IP_v13.0.0 |
| delete_profile | Deletes the specified Diameter Session profiles. | BIG-IP_v13.0.0 |
| get_acct_application_id | Gets the singular accounting application identifier for a specific application, as specified in RFC 6733. The Acct-Application-Id AVP (AVP Code 258), of which there can be several in a diameter message, is of type Unsigned32 and is used in order to advertise support of the accounting portion of an application. If present in a message other than CER and CEA, the value of the Acct-Application-Id AVP MUST match the Application Id present in the Diameter message header. Compare to get_array_acct_application_id, which returns a list of the same values. | BIG-IP_v13.0.0 |
| get_all_statistics | Gets the statistics for all the Diameter Session profiles. | BIG-IP_v13.0.0 |
| get_array_acct_application_id | Gets the accounting application identifiers for a specific application, as specified in RFC 6733. The Acct-Application-Id AVP (AVP Code 258), of which there can be several in a diameter message, is of type Unsigned32 and is used in order to advertise support of the accounting portion of an application. If present in a message other than CER and CEA, the value of the Acct-Application-Id AVP MUST match the Application Id present in the Diameter message header. | BIG-IP_v13.0.0 |
| get_array_auth_application_id | Gets the Authentication and Authorization identifiers for a specific application, as specified in RFC 6733. The Auth-Application-Id AVP (AVP Code 258), of which there can be several in a diameter message, is an array of type Unsigned32 and is used in order to advertise support of the Authentication and Authorization portion of an application. If present in a message other than CER and CEA, the value of the Auth-Application-Id AVP MUST match the Application Id present in the Diameter message header. | BIG-IP_v13.0.0 |
| get_auth_application_id | Gets the singular Authentication and Authorization identifier for a specific application, as specified in RFC 6733. The Auth-Application-Id AVP (AVP Code 258), of which there can be several in a diameter message, is an array of type Unsigned32 and is used in order to advertise support of the Authentication and Authorization portion of an application. If present in a message other than CER and CEA, the value of the Auth-Application-Id AVP MUST match the Application Id present in the Diameter message header. Compare to get_array_auth_application_id, which returns a list of the same values. | BIG-IP_v13.0.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_v13.0.0 |
| get_description | Gets the descriptions for a set of Diameter Session profiles. | BIG-IP_v13.0.0 |
| get_destination_host_rewrite | Gets the value to rewrite the Destination-Host Attribute-Value Pair (AVP) to on egress. | BIG-IP_v13.0.0 |
| get_destination_realm_rewrite | Gets the value to rewrite the Destination-Realm AVP Attribute-Value Pair (AVP) to on egress. | BIG-IP_v13.0.0 |
| get_discard_unroutable_state | Gets value when enabled, messages which have failed routing are discarded. | BIG-IP_v13.0.0 |
| get_handshake_timeout | Get the number of seconds before the handshake times out to a peer. | BIG-IP_v13.0.0 |
| get_host_ip_address | Gets the IP address of the diameter server. | BIG-IP_v13.0.0 |
| get_list | Gets a list of all Diameter Session profiles. | BIG-IP_v13.0.0 |
| get_maximum_message_size | Gets maximum message size (in bytes). | BIG-IP_v13.0.0 |
| get_maximum_watchdog_failures | Gets the maximum number of device watchdog failures that the traffic management system can take before it tears down the connection. After the system receives this number of device watchdog failures, it closes the connection if the reset-on-timeout is enabled. However, if the reset-on-timeout is not enabled, but the watchdog timeout count is 3 times max-watchdog-failures, then the connection is closed. | BIG-IP_v13.0.0 |
| get_origin_host | Gets the Origin-Host. | BIG-IP_v13.0.0 |
| get_origin_host_rewrite | Gets the value to rewrite the Origin-Host Attribute-Value Pair (AVP). | BIG-IP_v13.0.0 |
| get_origin_realm | Get the Origin-Realm. | BIG-IP_v13.0.0 |
| get_origin_realm_rewrite | Gets the value to rewrite the Origin-Realm Attribute-Value Pair (AVP) to on egress. | BIG-IP_v13.0.0 |
| get_persist_avp | Gets the Diameter Attribute-Value Pair used for persistence. | BIG-IP_v13.0.0 |
| get_persist_timeout | Gets the timeout value for persistence entries (in seconds). | BIG-IP_v13.0.0 |
| get_persist_type | Gets the type of the persistence. | BIG-IP_v13.0.0 |
| get_product_name | Gets the vendor-assigned name for the product. | BIG-IP_v13.0.0 |
| get_reset_on_timeout_state | Gets the value that, when enabled, if the watchdog failures exceed the max watchdog failure, the system resets the connection. | BIG-IP_v13.0.0 |
| get_route_unconfigured_peers_state | Gets value when enabled, unconfigured peers are added to the route table. | BIG-IP_v13.0.0 |
| get_statistics | Gets the statistics for the specified Diameter Session profiles. | BIG-IP_v13.0.0 |
| get_statistics_by_virtual | Gets the statistics for the specified profiles, by virtual server. | BIG-IP_v13.0.0 |
| get_vendor_id | Gets the vendor identification number. | BIG-IP_v13.0.0 |
| get_vendor_specific_acct_application_id | Gets the vendor-specific accounting application id. | BIG-IP_v13.0.0 |
| get_vendor_specific_auth_application_id | Gets the authentication identification number for the vendor-specific application. | BIG-IP_v13.0.0 |
| get_vendor_specific_vendor_id | Gets the vendor identification number for the vendor-specific application. | BIG-IP_v13.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v13.0.0 |
| get_watchdog_timeout | Gets the watchdog timeout (in seconds). | BIG-IP_v13.0.0 |
| is_base_profile | Determines whether the specified Diameter Session 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_v13.0.0 |
| is_system_profile | Determines whether the specified Diameter Session 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_v13.0.0 |
| remove_all_array_acct_application_ids | Removes all accounting application identifiers from the list. | BIG-IP_v13.0.0 |
| remove_all_array_auth_application_ids | Removes all authorization application identifiers from the list. | BIG-IP_v13.0.0 |
| remove_array_acct_application_id | Removes from the list of accounting application identifiers. | BIG-IP_v13.0.0 |
| remove_array_auth_application_id | Removes from the list of authorization application identifiers. | BIG-IP_v13.0.0 |
| reset_statistics | Resets the statistics for the specified Diameter Session profiles. | BIG-IP_v13.0.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v13.0.0 |
| set_acct_application_id | Sets the singular accounting application identifier for a specific application, as specified in RFC 6733. The Acct-Application-Id AVP (AVP Code 258), of which there can be several in a diameter message, is of type Unsigned32 and is used in order to advertise support of the accounting portion of an application. If present in a message other than CER and CEA, the value of the Acct-Application-Id AVP MUST match the Application Id present in the Diameter message header. Compare to add_array_acct_application_id, remove_array_acct_application_id, and remove_all_array_acct_application_id which alter the list version of the same values. | BIG-IP_v13.0.0 |
| set_auth_application_id | Sets the singular Authentication and Authorization identifier for a specific application, as specified in RFC 6733. The Auth-Application-Id AVP (AVP Code 258), of which there can be several in a diameter message, is an array of type Unsigned32 and is used in order to advertise support of the Authentication and Authorization portion of an application. If present in a message other than CER and CEA, the value of the Auth-Application-Id AVP MUST match the Application Id present in the Diameter message header. Compare to add_array_auth_application_id, remove_array_auth_application_id and remove_all_array_auth_application_id, which deal with lists of the same values. | BIG-IP_v13.0.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_v13.0.0 |
| set_description | Sets the description for a set of Diameter Session profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v13.0.0 |
| set_destination_host_rewrite | Sets the value to rewrite the Destination-Host Attribute-Value Pair (AVP) to on egress. Do not rewrite if value is none. Default value is none. The Destination-Host AVP (AVP Code 293) 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. The absence of the Destination-Host AVP will cause a message to be sent to any Diameter server supporting the application within the realm specified in Destination-Realm AVP. | BIG-IP_v13.0.0 |
| set_destination_realm_rewrite | Sets the value to rewrite the Destination-Realm Attribute-Value Pair (AVP) to on egress. Do not rewrite if value is none. Default value is none. The Destination-Realm AVP (AVP Code 283) is of type DiameterIdentity and contains the realm to which the message is to be routed. 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. The CCF for a request message that includes the Destination-Realm AVP SHOULD list the Destination-Realm AVP as a required AVP (an AVP indicated as {AVP}); otherwise, the message is inherently a nonroutable message. | BIG-IP_v13.0.0 |
| set_discard_unroutable_state | Sets value when enabled, messages which have failed routing are discarded. | BIG-IP_v13.0.0 |
| set_handshake_timeout | Set the number of seconds before the handshake times out to a peer. | BIG-IP_v13.0.0 |
| set_host_ip_address | Sets the IP address of the diameter server. If no value is specified, the system uses the BIG-IP system&aposs IP address on the VLAN that the system uses to generate traffic to the server. | BIG-IP_v13.0.0 |
| set_maximum_message_size | Sets maximum message size (in bytes). If a message exceeds this limit, the entire message is dropped. The default value is 0, which means no such restriction is enforced in BIG-IP. | BIG-IP_v13.0.0 |
| set_maximum_watchdog_failures | Sets the maximum number of device watchdog failures that the traffic management system can take before it tears down the connection. After the system receives this number of device watchdog failures, it closes the connection if the reset-on-timeout is enabled. However, if the reset-on-timeout is not enabled, but the watchdog timeout count is 3 times max-watchdog-failures, then the connection is closed. | BIG-IP_v13.0.0 |
| set_origin_host | Sets the hostname to be used as the Origin-Host Attribute-Value Pair (AVP). This identifier of the originating server in the form siteserver.f5.com. You must specify the Origin-Host. The Origin-Host AVP (AVP Code 264) is of type DiameterIdentity, and it MUST be present in all Diameter messages. This AVP identifies the endpoint that originated the Diameter message. Relay agents MUST NOT modify this AVP. The value of the Origin-Host AVP is guaranteed to be unique within a single host. Note that the Origin-Host AVP may resolve to more than one address as the Diameter peer may support more than one address. | BIG-IP_v13.0.0 |
| set_origin_host_rewrite | Sets the value to rewrite the Origin-Host Attribute-Value Pair (AVP) to on egress. Do not rewrite if value is empty string. Default value is empty string. The Origin-Host AVP (AVP Code 264) is of type DiameterIdentity, and it MUST be present in all Diameter messages. This AVP identifies the endpoint that originated the Diameter message. Relay agents MUST NOT modify this AVP. The value of the Origin-Host AVP is guaranteed to be unique within a single host. Note that the Origin-Host AVP may resolve to more than one address as the Diameter peer may support more than one address. | BIG-IP_v13.0.0 |
| set_origin_realm | Set the Origin-Realm Attribute-Value Pair (AVP). You must specify the Origin-Realm. The Origin-Realm AVP (AVP Code 296) is of type DiameterIdentity. This AVP contains the Realm of the originator of any Diameter message and MUST be present in all messages. | BIG-IP_v13.0.0 |
| set_origin_realm_rewrite | Sets the value to rewrite the Origin-Realm Attribute-Value Pair (AVP) to on egress. Do not rewrite if value is none. Default value is none. The Origin-Realm AVP (AVP Code 296) is of type DiameterIdentity. This AVP contains the Realm of the originator of any Diameter message and MUST be present in all messages. | BIG-IP_v13.0.0 |
| set_persist_avp | Sets the Diameter Attribute-Value Pair (AVP) that is used for persistence. The format is AVP[index] for a single AVP or a[x]:b[y]:c[z]:d[w] for a grouped AVP. There may be at most 4 AVPs in a group. The AVP name is used as the session-key; it may be an ASCII string or numeric ID in the range 1 to 4294967295 (AVP code can be specified instead of AVP name). The default value is “SESSION-ID[0]”. A grouped-AVP can be specified with the following syntax: grouped-AVP-name[index]:nested-AVP1[index1]:nested-AVP2[index2], where “nested-AVP1” and “nested-AVP2” are the AVPs in the grouped AVP. | BIG-IP_v13.0.0 |
| set_persist_timeout | Sets the timeout value for persistence entries (in seconds). Its recommended to have the persist timeout to be greater than transaction timeout, specified in the Diameter router configuration, as the lesser of the two is used when creating the persist record on receiving of the first Diameter request message. Upon receiving of the response for the first Diameter request message the persistence record is updated with the persist timeout value. (For any subsequent responses received the persist timeout is updated for the persist record.) | BIG-IP_v13.0.0 |
| set_persist_type | Sets the type of the persistence. None - Persistence is disabled AVP - To persist based on AVP in the message. Custom - To persist based on the custom key specified using iRule. | BIG-IP_v13.0.0 |
| set_product_name | Sets the vendor-assigned name for the product. The Product-Name AVP (AVP Code 269) is of type UTF8String and contains the vendor-assigned name for the product. The Product-Name AVP SHOULD remain constant across firmware revisions for the same product. | BIG-IP_v13.0.0 |
| set_reset_on_timeout_state | Sets the value that, when enabled, if the watchdog failures exceed the max watchdog failure, the system resets the connection. The default value is enabled. | BIG-IP_v13.0.0 |
| set_route_unconfigured_peers_state | Sets value when enabled, unconfigured peers are added to the route table. | BIG-IP_v13.0.0 |
| set_vendor_id | Sets the vendor identification number assigned to your diameter server by the Internet Assigned Numbers Authority (IANA). The default is 3375. The Vendor-Id AVP (AVP Code 266) is of type Unsigned32 and contains the IANA “SMI Network Management Private Enterprise Codes” [ENTERPRISE] value assigned to the Diameter Software vendor. It is envisioned that the combination of the Vendor-Id, Product-Name (Section 5.3.7), and Firmware-Revision (Section 5.3.4) AVPs may provide useful debugging information. A Vendor-Id value of zero in the CER or CEA message is reserved and indicates that this field is ignored. | BIG-IP_v13.0.0 |
| set_vendor_specific_acct_application_id | Sets the vendor-specific accounting application id, as specified in RFC 6733. The Acct-Application-Id AVP (AVP Code 259) is of type Unsigned32 and is used in order to advertise support of the accounting portion of an application. If present in a message other than CER and CEA, the value of the Acct-Application-Id AVP MUST match the Application Id present in the Diameter message header. | BIG-IP_v13.0.0 |
| set_vendor_specific_auth_application_id | Sets the authentication identification number for the vendor-specific application, as specified in RFC 6733. The Auth-Application-Id AVP (AVP Code 258) is of type Unsigned32 and is used in order to advertise support of the Authentication and Authorization portion of an application. If present in a message other than CER and CEA, the value of the Auth-Application-Id AVP MUST match the Application Id present in the Diameter message header. | BIG-IP_v13.0.0 |
| set_vendor_specific_vendor_id | Sets the vendor identification number for the vendor-specific application. This number is assigned to your diameter server by the Internet Assigned Numbers Authority (IANA). The default is 3375. The Vendor-Id AVP (AVP Code 266) is of type Unsigned32 and contains the IANA “SMI Network Management Private Enterprise Codes” [ENTERPRISE] value assigned to the Diameter Software vendor. It is envisioned that the combination of the Vendor-Id, Product-Name (Section 5.3.7), and Firmware-Revision (Section 5.3.4) AVPs may provide useful debugging information. A Vendor-Id value of zero in the CER or CEA message is reserved and indicates that this field is ignored. | BIG-IP_v13.0.0 |
| set_watchdog_timeout | Sets the watchdog timeout (in seconds). This setting specifies the number of seconds that a connection is idle before the device watchdog request is sent. The default value is 0, which means BIG-IP will not send a device watchdog request to either client or server side. | BIG-IP_v13.0.0 |
Structures¶
Structure
Description
DiameterSessionProfileStatisticEntry
A struct that describes statistics for a particular Diameter profile.
DiameterSessionProfileStatistics
A struct that describes profile statistics and timestamp.
A structure that specifies Diameter session profile persist types used in profile attributes.
Enumerations¶
| Enumeration | Description |
| PersistKey | A list of Diameter session profile persist keys. The key specifies the method of extraction of persistence key to be used to persist on. |
| PersistType | A list of diameter session profile persist types. The type specifies the method of persistence to employ for eliminating the necessity for a route lookup load balancing decision for each message. |
Aliases¶
| Alias | Type | Description |
| DiameterSessionProfileStatisticEntrySequence | DiameterSessionProfileStatisticEntry [] | A sequence of ProfileDiameterSession statistics. |
| ProfilePersistTypeSequence | ProfilePersistType [] | A sequence of profile persist types. |
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.