ltm persistence hash
ltm persistence hash(1) BIG-IP TMSH Manual ltm persistence hash(1)
NAME
hash - Configures a hash persistence profile.
MODULE
ltm persistence
SYNTAX
Configure the hash component within the ltm persistence module using the syntax in the following sections.
MODIFY
create hash [name]
modify hash [name]
options:
all
app-service [[string] | none]
defaults-from [name]
description [string]
hash-algorithm [carp | default]
hash-buffer-limit [integer]
hash-end-pattern [none | [string] ]
hash-length [integer]
hash-offset [integer]
hash-start-pattern [none | [string] ]
match-across-pools [enabled | disabled]
match-across-services [enabled | disabled]
match-across-virtuals [enabled | disabled]
mirror [enabled | disabled]
override-connection-limit [enabled | disabled]
rule [iRule name]
timeout [integer]
edit hash [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
mv hash [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder
DISPLAY
list hash
list hash [ [ [name] | [glob] | [regex] ] ... ]
show running-config hash
show running-config hash [ [ [name] | [glob] | [regex] ] ... ]
options:
all
all-properties
non-default-properties
one-line
partition
DELETE
delete hash [name]
options:
all
DESCRIPTION
You can use the hash component to configure a hash persistence profile for the BIG-IP(r) system. Hash
persistence can also be activated from an existing iRule.
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 hash
Displays all hash persistence profiles.
create hash hash_persistence defaults-from hash
Creates a custom hash persistence profile named hash_persistence that inherits its settings from the default
hash persistence profile.
mv hash /Common/my_hash_profile to-folder /Common/my_folder
Moves a custom hash persistence profile named my_hash_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 hash, 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 algorithm the system uses for hash persistence load balancing. The default value is
default.
The options are:
carp Specifies to use the Cache Array Routing Protocol (CARP) to select the pool member for LB.
default
Specifies to use indexing of pool members to select the pool member for LB.
hash-buffer-limit
Specifies the maximum buffer length the system collects to locate the hashing pattern for hash
persistence load balancing. The default value is 0 (zero).
hash-end-pattern
Specifies the string that describes the ending location of the hash pattern that the system uses to
perform hash persistence load balancing. The default value is none.
hash-length
Specifies the length of data within the packet in bytes that the system uses to calculate the hash value
when performing hash persistence load balancing. The default value is 0 (zero) bytes.
hash-offset
Specifies the start offset within the packet from which the system begins the hash when performing hash
persistence load balancing. The default value is 0 (zero).
hash-start-pattern
Specifies the string that describes the start location of the hash pattern that the system uses to
perform hash persistence load balancing. The default value is none.
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.
rule Specifies a rule name, if you are using a rule for universal persistence.
timeout
Specifies the duration of the persistence entries. The default value is 180 seconds.
to-folder
hash 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-2010, 2012. All rights reserved.
BIG-IP 2014-01-14 ltm persistence hash(1)