Persist (object)¶
Declares a persistence method
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
class* | string | “Persist” | ||
label | string | “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” | Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML | |
matchAcrossPools | boolean | false | true, false | Specifies that the system can use any pool that contains this persistence record |
matchAcrossVirtualAddresses | boolean | false | true, false | Specifies that all persistent connections from the same client IP address go to the same node |
matchAcrossVirtualPorts | boolean | false | true, false | Specifies that all persistent connections from a client IP address that go to the same virtual IP address also go to the same node |
mirror | boolean | false | true, false | If true, try to maintain persistence even after HA failover of ADC (default false) |
overrideConnectionLimit | boolean | false | true, false | If true, do not enforce pool member connection limit for persisted connections (default false) |
persistenceMethod* | string | “cookie”, “destination-address”, “hash”, “msrdp”, “sip-info”, “source-address”, “tls-session-id”, “universal” | You may customize each basic persistence method | |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks |
Persist_Addr (object)¶
Configures an address affinity persistence profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
addressMask | string | “f5ip” formatted string | Optional mask selects portion of address used by simple persistence (if omitted the system uses all address bits) | |
duration | integer | 180 | 0 - 604800 | Lifetime of persistence record (seconds, default 180) |
hashAlgorithm | string | “default” | “carp”, “default” | Specifies the algorithm the system uses for hash persistence load balancing. The hash result is the input for the algorithm. |
Persist_Cookie (object)¶
Configures a cookie persistence profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
cookieMethod | string | “insert” | “insert”, “hash”, “passive”, “rewrite” | Selects cookie processing method (default is insert) |
cookieName | string | “” | “^[0-9A-Za-z.~#$%^&*_-]*$” | Cookie name (for method ‘insert’, default (empty-string) yields system-generated name) |
duration | integer | 0 | 0 - 604800 | Lifetime of persistence record (seconds, default 0 means indefinite) |
Persist_Hash (object)¶
Configures a hash persistence profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
bufferLimit | integer | 0 | 0 - 65535 | Number of octets to buffer while pattern-matching |
count | integer | 0 | 0 - 65535 | Number of octets in cookie value to hash; 0 (default) means all |
duration | integer | 180 | 0 - 604800 | Lifetime of persistence record (seconds, default 180) |
endPattern | string | “” | Regular expression which matches end of data to hash; default “” averts matching | |
hashAlgorithm | string | “default” | “carp”, “default” | Specifies the algorithm the system uses for hash persistence load balancing. The hash result is the input for the algorithm. |
iRule | BIG-IP AS3 pointer to iRule if any (declared separately) | |||
startAt | integer | 0 | 0 - 65535 | Index of first octet in packet to hash |
startPattern | string | “” | Regular expression which matches start of data to hash; default “” averts matching |
Persist_MSRDP (object)¶
Configures a Microsoft(r) Remote Display Protocol (MSRDP) persistence profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
duration | integer | 300 | 0 - 604800 | Lifetime of persistence record (seconds, default 300) |
sessionBroker | boolean | true | true, false | If true (default), the system will persist the client to the server chosen by session broker |
Persist_SIP (object)¶
Configures a Session Initiation Protocol (SIP) persistence profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
duration | integer | 180 | 0 - 604800 | Lifetime of persistence record (seconds, default 180) |
header* | string | Suggested values include: Call-ID, To, From, SIP-ETag, and Subject |
Persist_TLS_Session (object)¶
Configures a Secure Socket Layer (SSL) persistence profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
duration | integer | 300 | 0 - 604800 | Lifetime of persistence record (seconds, default 300) |
Persist_UIE (object)¶
Configures a universal persistence profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
duration | integer | 180 | 0 - 604800 | Lifetime of persistence record (seconds, default 180) |
iRule* | BIG-IP AS3 pointer to required iRule (declared separately) |