ltm monitor diameter
ltm monitor diameter(1) BIG-IP TMSH Manual ltm monitor diameter(1)
NAME
diameter - Configures a monitor for Diameter protocol resources.
MODULE
ltm monitor
SYNTAX
Configure the diameter component within the ltm monitor module using
the syntax in the following sections.
CREATE/MODIFY
create diameter [name]
modify diameter [name]
options:
acct-application-id [ [integer] | none ]
app-service [[string] | none]
auth-application-id [ [integer] | none ]
defaults-from [name]
description [string]
host-ip-address [ [ip address] | none]
interval [integer]
manual-resume [enabled | disabled]
origin-host [ [ip address] | none]
origin-realm [ [hostname] | none]
product-name [name]
time-until-up [integer]
timeout [integer]
up-interval [integer]
vendor-id [integer]
vendor-specific-acct-application-id [ [integer] | none]
vendor-specific-auth-application-id [ [integer] | none]
vendor-specific-vendor-id [ [integer] | none]
edit diameter [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list diameter
list diameter [ [ [name] | [glob] | [regex] ] ... ]
show diameter [ [ [name] | [glob] | [regex] ] ... ]
show running-config diameter
show running-config diameter [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete diameter [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the diameter component to configure a custom monitor, or
you can use the default Diameter monitor that the Local Traffic Manager
provides. This type of monitor checks the health of Diameter protocol
resources.
EXAMPLES
create diameter my_diameter defaults-from diameter
Creates a monitor named my_diameter that inherits properties from the
default Diameter monitor.
list diameter
Displays the properties of all of the Diameter monitors.
OPTIONS
acct-application-id
Specifies the ID of the accounting portion of a Diameter
application. If you specify this option, you must also specify a
value for the auth-application-id option. The default value is
none.
Note that the acct-application-id and auth-application-id
attribute-value-pair (AVP), and the vendor-specific-auth-
application-id and vendor-specific-acct-application-id AVP are
mutually exclusive. You can only specify one of these AVPs.
app-service
Specifies the name of the application service to which the monitor
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 monitor. Only the application
service can modify or delete the monitor.
auth-application-id
Specifies the ID of the authentication and authorization portion
of a Diameter application. If you specify this option, you must
also specify a value for the acct-application-id option. The
default value is none.
Note that the acct-application-id and auth-application-id
attribute-value-pair (AVP), and the vendor-specific-auth-
application-id and vendor-specific-acct-application-id AVP are
mutually exclusive. You can only specify one set of these AVPs.
defaults-from
Specifies the name of the monitor from which you want your custom
monitor to inherit settings. The default value is firepass.
description
User defined description.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
host-ip-address
Specifies the IP address of the sender of the Diameter message for
the Diameter protocol peer discovery feature. The default value is
none.
interval
Specifies, in seconds, the frequency at which the system issues
the monitor check when either the resource is down or the status
of the resource is unknown. The default value is 10 seconds.
Important: F5 Networks recommends that when you configure this
option and the up-interval option, whichever value is greater be a
multiple of the lesser value to allow for an even distribution of
monitor checks among all monitors.
manual-resume
Specifies whether the system automatically changes the status of a
resource to up at the next successful monitor check. The default
value is disabled.
Note that if you set the manual-resume option to enabled, you must
manually mark the resource as up before the system can use it for
load balancing connections.
name Specifies a unique name for the component. This option is required
for the commands create, delete, and modify.
origin-host
Specifies the IP address from which the Diameter message
originates. The default value is the fully-qualified domain name
of the BIG-IP system.
origin-realm
Specifies the realm in which the host from which the Diameter
message originates resides. The default value is f5.com.
partition
Displays the administrative partition within which the component
resides.
product-name
Specifies the vendor-assigned name of the Diameter application.
The value of this option must remain constant across firmware
revisions for the same product. The default value is F5 BIGIP
Diameter Health Monitoring.
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.
time-until-up
Specifies the amount of time, in seconds, after the first
successful response before a node is marked up. A value of 0
(zero) causes a node to be marked up immediately after a valid
response is received from the node. The default value is 0 (zero).
timeout
Specifies the number of seconds the target has in which to respond
to the monitor request. The default value is 31 seconds.
If the target responds within the set time period, it is
considered up. If the target does not respond within the set time
period, it is considered down. Also, if the target responds with a
RESET packet, the system immediately flags the target as down
without waiting for the timeout interval to expire.
up-interval
Specifies, in seconds, the frequency at which the system issues
the monitor check when the resource is up. The default value is 0
(zero), which specifies that the system uses the value of the
interval option whether the resource is up or down.
Important: F5 Networks recommends that when you configure this
option and the interval option, whichever value is greater be a
multiple of the lesser value to allow for an even distribution of
monitor checks among all monitors.
vendor-id
Specifies the IANA SMI Network Management Private Enterprise Code
assigned to the vendor of the Diameter application. The default
value is 3375.
vendor-specific-acct-application-id
Specifies the ID of the vendor-specific accounting portion of a
Diameter application. If you specify this option, you must also
specify a value for the vendor-specific-auth-application-id
option. The default value is none.
Note that the acct-application-id and auth-application-id
attribute-value-pair (AVP), and the vendor-specific-auth-
application-id and vendor-specific-acct-application-id AVP are
mutually exclusive. You can only specify one of these AVPs.
vendor-specific-auth-application-id
Specifies the ID of the vendor-specific authentication and
authorization portion of a Diameter application. If you specify
this option, you must also specify a value for the vendor-
specific-acct-application-id option. The default value is none.
Note that the acct-application-id and auth-application-id
attribute-value-pair (AVP), and the vendor-specific-auth-
application-id and vendor-specific-acct-application-id AVP are
mutually exclusive. You can only specify one of these AVPs.
vendor-specific-vendor-id
Specifies the ID of a vendor-specific Diameter application. The
system uses this ID to advertise support for the application. The
default value is none.
SEE ALSO
create, delete, edit, glob, list, modify, regex, 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.
F5 Networks and BIG-IP (c) Copyright 2009-2010, 2012. All rights
reserved.
BIG-IP 2016-06-16 ltm monitor diameter(1)