getlbprofileResult Structure Definition

The getlbprofileResult structure defines the return type for getlbprofile API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

lbprofileList

List of lbprofiles


lbprofile Structure Definition

The lbprofile structure defines the actual return type values for getlbprofile API.

Syntax



Members

lbprofilename

Name of the LB profile.

dbslb

Enable database specific load balancing for MySQL and MSSQL service types.

processlocal

By turning on this option packets destined to a vserver in a cluster will not under go any steering. Turn this option for single pa cket request response mode or when the upstream device is performing a proper RSS for connection based distribution.

httponlycookieflag

Include the HttpOnly attribute in persistence cookies. The HttpOnly attribute limits the scope of a cookie to HTTP requests and helps mitigate the risk of cross-site scripting attacks.

cookiepassphrase

Use this parameter to specify the passphrase used to generate secured persistence cookie value. It specifies the passphrase with a maximum of 31 characters.

usesecuredpersistencecookie

Encode persistence cookie values using SHA2 hash.
NOTE: This attribute is deprecated.
This method is decrepricated in 12.0, instead use UseEncryptedPersistenceCookie

useencryptedpersistencecookie

Encode persistence cookie values using SHA2 hash.

vsvrcount

Total number of vservers , the profile is bound to

literaladccookieattribute

String configured as LiteralADCCookieAttribute will be appended as attribute for Citrix ADC cookie (for example: LB cookie persistence , GSLB site persistence, CS cookie persistence, LB group cookie persistence). Sample usage - add lb profile lbprof -LiteralADCCookieAttribute ";SameSite=None"

computedadccookieattribute

ComputedADCCookieAttribute accepts ns variable as input in form of string starting with $ (to understand how to configure ns variable, please check man add ns variable). policies can be configured to modify this variable for every transaction and the final value of the variable after policy evaluation will be appended as attribute to Citrix ADC cookie (for example: LB cookie persistence , GSLB sitepersistence, CS cookie persistence, LB group cookie persistence). Only one of ComputedADCCookieAttribute, LiteralADCCookieAttribute can be set. Sample usage - add ns variable lbvar -type TEXT(100) -scope Transaction add ns assignment lbassign -variable $lbvar -set "\\";SameSite=Strict\\"" add rewrite policy lbpol lbassign bind rewrite global lbpol 100 next -type RES_OVERRIDE add lb profile lbprof -ComputedADCCookieAttribute "$lbvar" For incoming client request, if above policy evaluates TRUE, then SameSite=Strict will be appended to ADC generated cookie

adccookieattributewarningmsg

Used to describe any configuration issue with respect to ns variable configured as part of add/set lb profile

storemqttclientidandusername

This option allows to store the MQTT clientid and username in transactional logs

lbhashalgowinsize

This options allows to increase window size used in LB hashing algorithm(DEFAULT).

lbhashalgorithm

This option dictates the hashing algorithm used for hash based LB methods (URLHASH, DOMAINHASH, SOURCEIPHASH, DESTINATIONIPHASH, SRCIPDESTIPHASH, SRCIPSRCPORTHASH, TOKEN, USER_TOKEN, CALLIDHASH).

lbhashfingers

This option is used to specify the number of fingers to be used in PRAC and JARH algorithms for hash based LB methods. Increasing the number of fingers might give better distribution of traffic at the expense of additional memory.

proximityfromself

Use the ADC location instead of client IP for static proximity LB or GSLB decision.

_nextgenapiresource


See Also