gtm listener
gtm listener(1) BIG-IP TMSH Manual gtm listener(1)
NAME
listener - Configures a Global Traffic Manager(tm) listener.
MODULE
gtm
SYNTAX
Configure the listener component within the gtm module using the syntax in the following sections.
CREATE/MODIFY
create listener [name]
modify listener [name]
options:
address [ip address]
advertise [yes | no]
app-service [[string] | none]
auto-lasthop [default | enabled | disabled ]
description [string]
[disabled | enabled]
fallback-persistence [none | [profile name] ]
ip-protocol [tcp | udp]
last-hop-pool [ [pool_name] | none]
mask { [ipv4] | [ipv6] }
persist [replace-all-with] {
[profile_name ... ] {
default [no | yes]
}
}
persist none
pool [ [pool_name] | none]
port [service port]
profiles [add | delete | replace-all-with] {
[profile name ...] {
context [all | clientside | serverside]
}
}
rules { [none | [rule_name ... ] }
source-address-translation {
options:
pool [ [pool_name] | none]
type [ automap | snat | none ]
}
source-port [change | preserve | preserve-strict]
translate-address [enabled | disabled]
translate-port [enabled | disabled]
vlans none
vlans
[ add | delete | replace-all-with ] {
[vlan name]...
}
vlans-disabled
vlans-enabled
edit listener [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
reset-stats listener
reset-stats listener [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list listener
list listener [name]
show running-config listener
show running-config listener [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
partition
show listener
show listener [name]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
DELETE
delete listener [name]
DESCRIPTION
You can use the listener component to create, display, modify, or delete a listener.
A listener is an object that listens for DNS queries. Listeners are defined for specific IP addresses, and are
always associated with port 53.
Important: When you create, modify, or delete a listener, the system saves the running configuration in the
stored configuration files.
EXAMPLES
create listener my_listener address 10.10.1.1 persist replace-all-with { source_addr }
Creates a listener named my_listener with an IP address of 10.10.1.1, which uses the source address
persistence method.
modify listener my_listener profiles replace-all-with { dns }
Replaces the profiles associated with the listener my_listener.
Note: To replace the profile associated with a listener, you must enclose the name of the new profile in curly
brackets.
list listener non-default-properties
Displays all non-default properties for all listeners.
delete listener my_listener
Deletes the listener named my_listener.
OPTIONS
address
Specifies the IP address on which the system listens. The system receives traffic sent to this IP address
and processes it as needed. This option is required.
advertise
Specifies whether to advertise the listener address to surrounding routers. The options are yes or no.
The default value is no.
app-service
Specifies the name of the application service to which the listener 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 listener. Only the application service can modify or delete the listener.
context
Specifies that the protocol profile is either a clientside or serverside profile. If not specified, the
default value is all for both sides.
description
User defined description.
(enabled | disabled)
Specifies the state of the listener. The default value is enabled.
Note: When you disable a listener, the listener no longer accepts new connection requests. However, it
allows current connections to finish processing before going to a down state.
fallback-persistence
Specifies a fallback persistence profile for the listener to use when the default persistence profile is
not available. The default value is none.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
ip-protocol
Specifies the protocol on which this listener receives network traffic. The options are udp or tcp. The
default value is udp.
last-hop-pool
Specifies the name of the last hop pool that you want the listener to use to direct reply traffic to the
last hop router. The default value is none.
mask Specifies the netmask for a network listener only. This setting is required for a network listener.
The netmask clarifies whether the host bit is an actual zero or a wildcard representation. The default
value is 255.255.255.255 for IPv4 or ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff for IPv6.
name Specifies a unique name for the component. This option is required for the commands create and modify.
partition
Displays the administrative partition within which the listener resides.
persist
Specifies a list of profiles separated by spaces that the listener uses to manage connection persistence.
The default value is none.
To enable persistence, typically you specify a single profile. However, you can specify multiple profiles
in conjunction with iRules(r) that define a persistence strategy based on incoming traffic. In the case
of multiple profiles, the default option specifies which profile you want the listener to use if an iRule
does not specify a persistence method. When you specify multiple profiles, the default value of the
default property is no. You can set the value of the default property to yes for only one of the
profiles.
pool Specifies a default pool to which you want the listener to automatically direct traffic. The default
value is none.
port Specifies the service port on which the listener listens for connections. When you create a listener, the
default value is 53 if no port number is specified.
profiles
Specifies the DNS, statistics and protocol profiles to use for this listener. When a listener is created,
if a DNS profile is not specified, the generic "dns" profile is added. If a protocol profile is not
specified, then the generic "tcp" profile is added for TCP and the "udp_gtm_dns" profile is added for
UDP. A listener always has DNS and protocol profiles once it is created. Only a statistics profile can be
added to or deleted from a listener.
The replace-all-with command replaces the profiles with the specified ones. The unspecified DNS and
protocol profiles are not changed. If statistics profiles are not specified, the replace-all-with command
removes the existing statistics profile from the listener. When the protocol is modified, if profiles are
not specified, a default protocol profile is used. DNS and statistics profiles will not change.
rules
Specifies a list of iRules, separated by spaces, that customize the listener to direct and manage
traffic. The default value is none.
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.
source-address-translation
Specifies the type of source address translation enabled for the listener as well as the pool that the
source address translation will use.
pool Specifies the name of a SNAT pool used by the specified listener.
type Specifies the type of source address translation associated with the specified listener.
The options are:
automap
Specifies the use of self IP addresses for listener source address translation.
none Specifies no source address translation to be used by the listener.
snat Specifies the use of a SNAT pool of translation addresses for listener source address
translation.
source-port
Specifies whether the system preserves the source port of the connection. The default value is preserve.
The options are:
change
Obfuscates internal network addresses.
preserve
Preserves the source port of the connection.
preserve-strict
Use this value only for UDP under very special circumstances, such as nPath or transparent (that is,
no translation of any other L3/L4 field), where there is a 1:1 relationship between virtual IP
addresses and node addresses, or when clustered multi-processing (CMP) is disabled.
translate-address
Enables or disables address translation for the listener. Disable address translation for a listener if
you want to use the listener to load balance connections to any address. This option is useful when the
system is load balancing devices that have the same IP address. The default value is disabled.
translate-port
Enables or disables port translation. Disable port translation for a listener, if you want to use the
listener to load balance connections to any service. The default value is disabled.
vlans
Specifies a list of VLANs on which traffic is either disabled or enabled, based on whether the vlans-
disabled or vlans-enabled option is specified.
vlans-disabled
Specifies that traffic is not accepted by this listener on the VLANs specified in the vlans option. This
option is mutually exclusive with the vlans-enabled option.
vlans-enabled
Specifies that traffic is accepted by this listener on only the VLANs specified in the vlans option. This
option is mutually exclusive with the vlans-disabled option.
SEE ALSO
create, delete, edit, glob, list, modify, net vlan, net vlan-group, 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.
F5 Networks and BIG-IP (c) Copyright 2008-2014, 2016. All rights reserved.
BIG-IP 2016-03-14 gtm listener(1)