ltm persistence source-addr
ltm persistence source-addr(1) BIG-IP TMSH Manual ltm persistence source-addr(1)
NAME
source-addr - Configures a source address affinity persistence profile.
MODULE
ltm persistence
SYNTAX
Configure the source-addr component within the ltm persistence module using the syntax in the following
sections.
MODIFY
create source-addr [name]
modify source-addr [name]
options:
all
app-service [[string] | none]
defaults-from [name]
description [string]
map-proxies [enabled | disabled]
map-proxy-address [ip address]
map-proxy-class [class name]
hash-algorithm [carp | default]
mask [ [ip address] | none]
match-across-pools [enabled | disabled]
match-across-services [enabled | disabled]
match-across-virtuals [enabled | disabled]
mirror [enabled | disabled]
override-connection-limit [enabled | disabled]
timeout [integer]
edit source-addr [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
mv source-addr [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder
DISPLAY
list source-addr
list source-addr[ [ [name] | [glob] | [regex] ] ... ]
show running-config source-addr
show running-config source-addr[ [ [name] | [glob] | [regex] ] ... ]
options:
all
all-properties
non-default-properties
one-line
partition
DELETE
delete source-addr [name]
options:
all
DESCRIPTION
You can use the source-addr component to configure a source address affinity persistence profile for the
BIG-IP(r) system. Also known as simple persistence, source address affinity persistence supports TCP and UDP
protocols, and directs session requests to the same server based solely on the source IP address of a packet.
A persistence profile is a profile that enables persistence when you assign the profile to a virtual server.
Using a persistence profile means that you do not have to write an iRule to implement a type of persistence.
You can either use the default profile, or create a custom profile based on the default.
EXAMPLES
list source-addr
Displays all source address affinity persistence profiles.
create source-addr simple_persistence defaults-from source_addr
Creates a custom source address affinity persistence profile named simple_persistence that inherits its
settings from the default source address affinity persistence profile.
mv source-addr /Common/my_source-addr_profile to-folder /Common/my_folder
Moves a custom source address persistence profile named my_source-addr_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.
defaults-from
Specifies the existing profile from which the system imports settings for the new profile. The default
value is source_addr, the system default cookie persistence profile.
description
User defined description.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
hash-algorithm
Specifies the system uses hash persistence load balancing. The default value is default (no hash
persistence).
The options are:
carp Specifies to use the Cache Array Routing Protocol (CARP) to select the pool member for LB. The input
to CARP is the hash value of source address.
default
no hash persistence.
map-proxies
Enables or disables the map proxies attribute. The default value is disabled.
This attribute controls whether a source address will first be checked against an IP data-group/class to
determine whether it is a well-known proxy address. If it matches the IP class, then the source address
will be mapped to a single IP address for the purposes of persistence. The default well known proxy class
is based on a pre-defined data-group "aol" which represents the AOL(r) company's previously-published
list of proxies. Using this feature enables you to use client/source IP address persistence with a simple
persist mask, but forces all clients matching the IP class to persist to the same server. The IP
data-group/class may also be changed using either the map-proxy-class profile attribute or globally by
changing the DB variable Persist.WellKnownProxyClass. Also, the IP address used for mapping a single
source IP address for persistence may also be specifically set using the map-proxy-address profile
attribute.
map-proxy-address
Specifies the single IP address to use when the source address matches the proxy data-group/class. The
default value is any which results in the default behavior of using one of the IP addresses from the
proxy data-group/class. Note: This mapped IP address does not have to be contained in the IP
data-group/class. It may actually be any IP address since it is only used for keying the persistence
record.
map-proxy-class
Specifies the data-group/class to use for determining whether a source address is from a proxy. The
default value is none which will result in map_proxies using the class defined by the DB variable
Persist.WellKnownProxyClass.
mask Specifies an IP mask. This is the mask used by simple persistence for connections. The default value is
::.
match-across-pools
Specifies, when enabled, that the system can use any pool that contains this persistence record. The
default value is disabled.
match-across-services
Specifies, when enabled, that all persistent connections from a client IP address, which go to the same
virtual IP address, also go to the same node. The default value is disabled.
match-across-virtuals
Specifies, when enabled, that all persistent connections from the same client IP address go to the same
node. The default value is disabled.
mirror
Specifies whether the system mirrors persistence records to the high-availability peer. The default value
is disabled.
name Specifies a unique name for the component. This option is required for the commands create, delete, and
modify.
override-connection-limit
Specifies, when enabled, that the pool member connection limits are not enforced for persisted clients.
Per-virtual connection limits remain hard limits and are not disabled. The default value is disabled.
partition
Displays the administrative partition within which the component resides.
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.
timeout
Specifies the duration of the persistence entries. The default value is 180 seconds.
to-folder
source-addr persistence profiles can be moved to any folder under /Common, but configuration dependencies
may restrict moving the profile out of /Common.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, mv, 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 2008-2013, 2016. All rights reserved.
BIG-IP 2016-03-14 ltm persistence source-addr(1)