APIRef_tm_ltm_profile_diameter¶
mgmt/tm/ltm/profile/diameter
Virtual server Diameter traffic profile configuration
REST Endpoints
- Collection URI
/mgmt/tm/ltm/profile/diameter- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/profile/diameter/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | The application service to which the object belongs. | |
connectionPrime |
string | disabled | optional | read/write | When enabled, and the system receives a capabilities exchange request from the client, the system will establish connections and perform handshaking with all the servers prior to sending the capabilities exchange answer to the client. |
defaultsFrom |
string | optional | read/write | Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified. The default value is diameter. | |
description |
string | optional | read/write | User defined description. | |
destinationRealm |
string | optional | read/write | Specifies the realm to which the message will be routed. The destination-realm is used to perform message routing decisions. It can be an ASCII string such as an FQDN. See RFC 3588 section 6.6. A value of “none” indicates that destination-realm is disabled. The default value is “none”. | |
handshakeTimeout |
integer | 10 | optional | read/write | Specifies the handshake timeout in seconds. This setting specifies the maximum number of seconds that a connection can be idle after the capabilities exchange request was sent to the server. The default value is 10. The system will reset the connection after it has timed out. |
hostIpRewrite |
string | enabled | optional | read/write | When enabled and the message is a capabilities exchange request or capabilities exchange answer, rewrite the host-ip-address attribute with the system’s egress IP address. |
maxRetransmitAttempts |
integer | 1 | optional | read/write | Specifies the maximum number of retransmit attempts. This setting specifies the maximum number of attempts BIG-IP will take to retransmit the request messages if it does not receive the answer messages. If retransmit is unsuccessful, after the maximum number of attempts, BIG-IP will send error response. The default value is 1. |
maxWatchdogFailure |
integer | 10 | optional | read/write | Specifies 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. The default value is 10. |
originHostToClient |
string | optional | read/write | Specifies the origin host to client of the BIG-IP. The origin-host-to-client is used to overwrite the server’s actual origin host attribute when it responds to the client. It can be an ASCII string such as an FQDN. See RFC 3588 section 6.3. A value of “none” indicates that origin-host-to-client is disabled. The default value is “none”. | |
originHostToServer |
string | optional | read/write | Specifies the origin host to server of the BIG-IP. The origin-host-to-server is used to overwrite the client’s actual origin host attribute when it responds to the server. It can be an ASCII string such as an FQDN. See RFC 3588 section 6.3. A value of “none” indicates that origin-host-to-server is disabled. The default value is “none”. | |
originRealmToClient |
string | optional | read/write | Specifies the origin realm to client of the BIG-IP. The origin-realm-to-client is used to overwrite the server’s actual origin realm attribute when it responds to the client. It can be an ASCII string such as an FQDN. See RFC 3588 section 6.4. A value of “none” indicates that origin-realm-to-client is disabled. The default value is “none”. | |
originRealmToServer |
string | optional | read/write | Specifies the origin realm to server of the BIG-IP. The origin-realm-to-server is used to overwrite the client’s actual origin realm attribute when it responds to the server. It can be an ASCII string such as an FQDN. See RFC 3588 section 6.4. A value of “none” indicates that origin-realm-to-server is disabled. The default value is “none”. | |
parentAvp |
string | optional | read/write | Specifies the name of the Diameter attribute that is used to indicate if the persist-avp is embedded in a grouped avp. It can be an ASCII string or numeric ID in the range 1 to 4294967295. Acceptable strings are from RFC 3588 section 4.5. A value of “none” indicates that the persist-avp value is not embedded in a grouped avp. The default value is “none”. | |
tmPartition |
string | Common | optional | read/write | Displays the administrative partition within which this profile resides. |
persistAvp |
string | optional | read/write | Specifies the name of the Diameter attribute that will be used to persist on. It can be an ASCII string or numeric ID in the range 1 to 4294967295. Acceptable strings are defined in RFC 3588 section 4.5. A value of “none” indicates persistence is disabled. The default value is “session-id”. | |
resetOnTimeout |
string | enabled | optional | read/write | When it is enabled and the watchdog failures exceed the max watchdog failure, the system resets the connection. The default value is enabled. |
retransmitTimeout |
integer | 10 | optional | read/write | Specifies the retransmit timeout in seconds. This setting specifies the number of seconds the BIG-IP waits to retransmit the request messages if it does not receive the corresponding answer messages. The default value is 10 |
watchdogTimeout |
integer | 0 | optional | read/write | Specifies 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. |
Copyright (c) 2016, 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.