ltm profile diameter¶

ltm profile diameter(1) BIG-IP TMSH Manual ltm profile diameter(1)

NAME
diameter - Configures a profile to manage Diameter network traffic.

MODULE
ltm profile

SYNTAX
Configure the diameter component within the ltm profile module using the syntax in the following sections.

CREATE/MODIFY
create diameter [name]
modify diameter [name]
options:
app-service [[string] | none]
connection-prime [disabled | enabled]
defaults-from [name]
description [string]
destination-realm [string]
handshake-timeout [number]
host-ip-rewrite [disabled | enabled]
max-retransmit-attempts [number]
max-watchdog-failure [number]
origin-host-to-client [string]
origin-host-to-server [string]
origin-realm-to-client [string]
origin-realm-to-server [string]
overwrite-destination-host [disabled | enabled]
parent-avp [ [number] | [string] ]
persist-avp [ [number] | [string] ]
reset-on-timeout [disabled | enabled]
retransmit-timeout [number]
watchdog-timeout [number]

mv diameter [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder

edit diameter [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties

reset-stats diameter
reset-stats diameter [ [ [name] | [glob] | [regex] ] ... ]

DISPLAY
list diameter
list diameter [ [ [name] | [glob] | [regex] ] ... ]
show running-config diameter
show running-config diameter [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition

show diameter
show diameter [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
global

DELETE
delete diameter [name]

DESCRIPTION
You can use the diameter component to configure a profile to manage Diameter network traffic.

EXAMPLES
create diameter my_diameter_profile defaults-from diameter

Creates a Diameter profile named my_diameter_profile that inherits its settings from the system default Diameter profile.

list diameter

Displays the properties of all Diameter profiles.

mv diameter /Common/my_diameter_profile to-folder /Common/my_folder

Moves a custom diameter profile named my_diameter_profile to a folder named my_folder, where my_folder has already been
created and exists within /Common.

OPTIONS
app-service
Specifies the name of the application service to which the profile belongs. The default value is none. Note: If the
strict-updates option is enabled on the application service that owns the object, you cannot modify or delete the
profile. Only the application service can modify or delete the profile.

connection-prime
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. The default value is disabled.

defaults-from
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
User defined description.

destination-realm
This attribute has been deprecated as of BIG-IP v11.3.0. Specifies the realm to which messages are routed. A value of
none indicates that the destination-realm option is disabled. The default value is none.

You can specify a fully qualified domain name as an ASCII string. For more information about this option, see RFC 3588
section 6.6.

glob Displays the items that match the glob expression. See help glob for a description of glob expression syntax.

handshake-timeout
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.

You can specify a numeric value in the range 0 to 4294967295. The recommended value is in the range of 5 to 30

host-ip-rewrite
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. The default value is enabled.

max-retransmit-attempts
Specifies the maximum number of retransmit attempts. This setting specifies the maximum number of attempts that BIG-IP
will take to retransmit the request messages if it does not receive the corresponding answer messages. If retransmit
is unsuccessful, after maximum attempts, BIG_IP will send an error response. The default value is 1.

You can specify a numeric value in the range 0 to 4294967295. The recommended value is in the range of 1 to 10

max-watchdog-failure
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.

You can specify a numeric value in the range 0 to 4294967295.

name Specifies a unique name for the component. This option is required for the commands create, delete, and modify.

origin-host
This attribute has been deprecated as of BIG-IP v11.3.0. Please use, origin-host-to-client or origin-host-to-server.
Specifies the origin host of BIG-IP. The origin-host is used to overwrite the server's actual origin host attribute
when it responds to the client. A value of none indicates that origin-host is disabled. The default value is none.

You can specify an ASCII string as a FQDN. See RFC 3588 section 6.3.

origin-host-to-client
Specifies the origin host to client of BIG-IP. The origin-host-to-client is used to overwrite the server's actual
origin host attribute when it responds to the client. A value of none indicates that origin-host-to-client is
disabled. The default value is none.

You can specify an ASCII string as a FQDN. See RFC 3588 section 6.3.

origin-host-to-server
Specifies the origin host to server of BIG-IP. The origin-host-to-server is used to overwrite the client's actual
origin host attribute when it responds to the server. A value of none indicates that origin-host-to-server is
disabled. The default value is none.

You can specify an ASCII string as a FQDN. See RFC 3588 section 6.3.

origin-realm
This attribute has been deprecated as of BIG-IP v11.3.0. Please use, origin-realm-to-client or origin-realm-to-server.
Specifies the origin realm of BIG-IP. The origin-realm is used to overwrite the server's actual origin realm attribute
when it responds to the client. A value of none indicates that origin-realm is disabled. The default value is none.

You can specify an ASCII string as a FQDN. See RFC 3588 section 6.4.

origin-realm-to-client
Specifies the origin realm of BIG-IP. The origin-realm-to-client is used to overwrite the server's actual origin realm
attribute when it responds to the client. A value of none indicates that origin-realm-to-client is disabled. The
default value is none.

You can specify an ASCII string as a FQDN. See RFC 3588 section 6.4.

origin-realm-to-server
Specifies the origin realm to server of BIG-IP. The origin-realm-to-server is used to overwrite the client's actual
origin realm attribute when it responds to the server. A value of none indicates that origin-realm-to-server is
disabled. The default value is none.

You can specify an ASCII string as a FQDN. See RFC 3588 section 6.4.

overwrite-destination-host
This attribute has been deprecated as of BIG-IP v11.3.0. When you enable this option, the system replaces the value of
the destination host field in the Diameter header with the BIG-IP(r) pool member address. When you disable this
option, the system does not modify the destination host field. The default value is enabled.

parent-avp
Specifies the name of the Diameter attribute that the system uses to indicate if the persist-avp option is embedded in
a grouped avp. A value of none indicates that the value of the persist-avp option is not embedded in a grouped avp.
The default value is none.

You can specify an ASCII string or a numeric ID in the range 1 to 4294967295. Acceptable strings can be found in RFC
3588 section 4.5.

partition
Displays the administrative partition within which the profile resides.

persist-avp
Specifies the name of the Diameter attribute that the system persists on. A value of none indicates that persistence
is disabled. The default value is session-id.

You can specify an ASCII string or a numeric ID in the range 1 to 4294967295. Acceptable strings can be found in RFC
3588 section 4.5.

regex
Displays the items that match the regular expression. The regular expression must be preceded by an at sign (@[regular
expression]) to indicate that the identifier is a regular expression. See help regex for a description of regular
expression syntax.

reset-on-timeout
When it is enabled and the watchdog failures exceed the max watchdog failure, the system resets the connection. The
default value is enabled.

retransmit-timeout
Specifies the retransmit timeout in seconds. This setting specifies the number of seconds to retransmit the request
messages if BIG-IP does not receive the corresponding answer messages . The default value is 10.

You can specify a numeric value in the range 0 to 4294967295. The recommended value is in the range of 5 to 30

to-folder
diameter profiles can be moved to any folder under /Common, but configuration dependencies may restrict moving the
profile out of /Common.

watchdog-timeout
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.

You can specify a numeric value in the range 0 to 4294967295. The recommended value is in the range of 6 to 30

SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, mv, regex, reset-stats, show, tmsh

COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
use, without the express written permission of F5 Networks, Inc.

BIG-IP 2015-07-22 ltm profile diameter(1)