slb template persist source-ip

Configure the granularity of load balancing persistence (selection of the same server resources) for clients, based on source IP address.

source-ip Specification

Type Collection
Object Key(s) name
Collection Name source-ip-list
Collection URI /axapi/v3/slb/template/persist/source-ip/
Element Name source-ip
Element URI /axapi/v3/slb/template/persist/source-ip/{name}
Element Attributes source-ip_attributes
Schema source-ip schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/template/persist/source-ip/

source-ip Attributes

Create List

POST

/axapi/v3/slb/template/persist/source-ip/

source-ip Attributes

Get Object

GET

/axapi/v3/slb/template/persist/source-ip/{name}

source-ip Attributes

Get List

GET

/axapi/v3/slb/template/persist/source-ip/

source-ip-list

Modify Object

POST

/axapi/v3/slb/template/persist/source-ip/{name}

source-ip Attributes

Replace Object

PUT

/axapi/v3/slb/template/persist/source-ip/{name}

source-ip Attributes

Replace List

PUT

/axapi/v3/slb/template/persist/source-ip/

source-ip-list

Delete Object

DELETE

/axapi/v3/slb/template/persist/source-ip/{name}

source-ip Attributes

source-ip-list

source-ip-list is JSON List of source-ip Attributes

source-ip-list : [

source-ip Attributes

dont-honor-conn-rules

Description: Ignores connection limit settings configured on real servers and real ports. This option is useful for applications in which multiple sessions (connections) are likely to be used for the same persistent client source IP address.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enforce-higher-priority

Description: Enables Source-IP Persistence Override and Reselect. When this feature is enabled, the ACOS device continually checks for the presence of higher-priority servers, even if source-IP persistence is enabled and sessions are already established between client and server.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hash-persist

Description: Enables hash-based persistence. Hash-based persistence provides the persistence and performance benefits of hash-based load balancing, while allowing use of advanced SLB features that require stateful load balancing.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

incl-dst-ip

Description: Used to support the ALG protocol firewall load balancing feature for protocols such as FTP. This option helps ensure that special persistent session will be matched on both the source IP and destination IP addresses.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

incl-sport

Description: Includes the source port in persistent sessions.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

match-type

Description: Specifies the granularity of persistence.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description: Name of the template.

Type: string

Format: string-rlx

Required: Yes

netmask

Description: Specifies the granularity of IP address hashing for server port selection.

Type: string

Format: ipv4-netmask

Default: 255.255.255.255

netmask6

Description: Specifies the granularity of IPv6 address hashing for initial server port selection.

Type: number

Range: 1-128

Default: 128

scan-all-members

Description: Persist with SCAN of all members

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server

Description: Traffic from a given client to the same VIP is always sent to the same real server, for any service port requested by the client.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: server and service-group are mutually exclusive

service-group

Description: This option is applicable if you also plan to use URL switching or host switching. URL or host switching is used for every request to select a service group. The first time URL or host switching selects a given service group, the load-balancing method is used to select a real port within the service group. The next time URL or host switching selects the same service group, the same real port is used. Thus, service group selection is performed for every request, but once a service group is selected for a request, the request goes to the same real port that was selected the first time that service group was selected.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: service-group and server are mutually exclusive

timeout

Description: Specifies how many minutes the mapping remains persistent after the last time traffic from the client is sent to the server.

NOTE: The timeout for a source-IP persistent session will not be reset if the timeout in the source-IP persistence template is set to 1 minute. If the timeout is set to 1 minute, sessions will always age out after 1 minute, even if they are active.

Type: number

Range: 1-2000

Default: 5

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string