APIRef_tm_gtm_listener¶

mgmt/tm/gtm/listener

Listeners accept DNS queries sent to a particular address.

REST Endpoints

Collection URI: /mgmt/tm/gtm/listener
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/gtm/listener/~resource id
Resource Methods: OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key: name, partition, subPath

Properties

Name	Type	Default Value	Required	Access	Description
`address`	string		required	read/write	Specifies the IP address on which the system listens. The system receives traffic sent to this IP address and processes it as needed.
`advertise`	string		optional	read/write	Specifies whether this listener’s address is advertised to surrounding routers.
`appService`	string		optional	read/write	The application service that the object belongs to.
`autoLasthop`	string	default	optional	read/write	Specifies whether to automatically map last hop for pools or not. The default is to use next level’s default.
`description`	string		optional	read/write	User defined description.
`disabled`	boolean	true	optional	read/write	Note that 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.
`enabled`	boolean	true	optional	read/write	Specifies the state of the listener. The default value is enabled. This brings the listener to a state where it will accept new connections.
`fallbackPersistence`	string		optional	read/write	Specifies a fallback persistence profile for the listener to use when the default persistence profile is not available.
`ipProtocol`	string		optional	read/write	Specifies the protocol on which this listener receives network traffic. The options are udp or tcp.
`lastHopPool`	string		optional	read/write	Specifies the name of the last hop pool that you want the listener to use to direct reply traffic to the last hop router.
`mask`	string	ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff	optional	read/write	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.
`tmPartition`	string	Common	optional	read/write	Specifies the partition within which this object resides. F5 Networks recommends that you create listeners in partition Common.
`pool`	string		optional	read/write	Specifies a default pool to which you want the listener to automatically direct traffic.
`port`	integer		optional	read/write	Specifies the port on which the listener listens for connections.
`sourcePort`	string	preserve	optional	read/write	Specifies whether the system preserves the source port of the connection. The default is preserve. Use of the preserve-strict setting should be restricted to UDP only 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. The change setting is useful for obfuscating internal network addresses.
`translateAddress`	string	enabled	optional	read/write	Enables or disables address translation for the listener. Turn address translation off 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.
`translatePort`	string	enabled	optional	read/write	Enables or disables port translation. Turn port translation off for a listener if you want to use the listener to load balance connections to any service.
`vlansDisabled`	boolean		optional	read/write	Specifies that traffic will not be accepted by this listener on the VLANS specified in the vlans option.
`vlansEnabled`	boolean		optional	read/write	Specifies that traffic will be accepted by this listener only on the VLANS specified in the vlans option.

Subcollections

Name	Type	Default Value	Required	Access	Description
`profiles`	array_structure		optional	read/write

Lists

Name	Type	Default Value	Required	Access	Description
`rules (ltm/rule)`	array_structure		optional	read/write	The iRules you want run on this listener. iRules help automate the intercepting, processing, and routing of application traffic.
`vlans (net/tunnels/tunnel)`	array_structure		optional	read/write	Specifies a list of VLANs on which traffic is either disabled or enabled, based on the vlans-disabled and vlans-enabled settings.

Structures

Name	Type	Default Value	Required	Access	Description
`/source-address-translation`	array_structure		optional	read/write
`/source-address-translation/pool`	string		optional	read/write	Specifies the name of a SNAT pool used by the specified listener.
`/source-address-translation/type`	string	none	optional	read/write	Specifies the type of source address translation associated with the specified listener.
`/source-address-translation/pool`	string		optional	read/write	Specifies the name of a SNAT pool used by the specified listener.
`/source-address-translation/type`	string	none	optional	read/write	Specifies the type of source address translation associated with the specified listener.

Array Structures

Name	Type	Default Value	Required	Access	Description
`/persist`	array_structure		optional	read/write
`/persist/default`	string	no	optional	read/write

iControl Reference Index

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.