-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
lbparameter
-
-
-
-
-
-
-
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
lbparameter
Configuration for LB parameter resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
httponlycookieflag |
|
Read-write | 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.
Default value: ENABLED Possible values = ENABLED, DISABLED |
usesecuredpersistencecookie |
|
Read-write | Encode persistence cookie values using SHA2 hash.
Default value: DISABLED Possible values = ENABLED, DISABLED |
useencryptedpersistencecookie |
|
Read-write | Encode persistence cookie values using SHA2 hash.
Default value: DISABLED Possible values = ENABLED, DISABLED |
cookiepassphrase |
|
Read-write | Use this parameter to specify the passphrase used to generate secured persistence cookie value. It specifies the passphrase with a maximum of 31 characters. |
consolidatedlconn |
|
Read-write | To find the service with the fewest connections, the virtual server uses the consolidated connection statistics from all the packet engines. The NO setting allows consideration of only the number of connections on the packet engine that received the new connection.
Default value: YES Possible values = YES, NO |
useportforhashlb |
|
Read-write | Include the port number of the service when creating a hash for hash based load balancing methods. With the NO setting, only the IP address of the service is considered when creating a hash.
Default value: YES Possible values = YES, NO |
preferdirectroute |
|
Read-write | Perform route lookup for traffic received by the Citrix ADC, and forward the traffic according to configured routes. Do not set this parameter if you want a wildcard virtual server to direct packets received by the appliance to an intermediary device, such as a firewall, even if their destination is directly connected to the appliance. Route lookup is performed after the packets have been processed and returned by the intermediary device.
Default value: YES Possible values = YES, NO |
startuprrfactor |
|
Read-write | Number of requests, per service, for which to apply the round robin load balancing method before switching to the configured load balancing method, thus allowing services to ramp up gradually to full load. Until the specified number of requests is distributed, the Citrix ADC is said to be implementing the slow start mode (or startup round robin). Implemented for a virtual server when one of the following is true
|
monitorskipmaxclient |
|
Read-write | When a monitor initiates a connection to a service, do not check to determine whether the number of connections to the service has reached the limit specified by the service’s Max Clients setting. Enables monitoring to continue even if the service has reached its connection limit.
Default value: DISABLED Possible values = ENABLED, DISABLED |
monitorconnectionclose |
|
Read-write | Close monitoring connections by sending the service a connection termination message with the specified bit set.
Default value: FIN Possible values = RESET, FIN |
vserverspecificmac |
|
Read-write | Allow a MAC-mode virtual server to accept traffic returned by an intermediary device, such as a firewall, to which the traffic was previously forwarded by another MAC-mode virtual server. The second virtual server can then distribute that traffic across the destination server farm. Also useful when load balancing Branch Repeater appliances.
Note: The second virtual server can also send the traffic to another set of intermediary devices, such as another set of firewalls. If necessary, you can configure multiple MAC-mode virtual servers to pass traffic successively through multiple sets of intermediary devices. Default value: DISABLED Possible values = ENABLED, DISABLED |
allowboundsvcremoval |
|
Read-write | This is used, to enable/disable the option of svc/svcgroup removal, if it is bound to one or more vserver. If it is enabled, the svc/svcgroup can be removed, even if it bound to vservers. If disabled, an error will be thrown, when the user tries to remove a svc/svcgroup without unbinding from its vservers.
Default value: ENABLED Possible values = ENABLED, DISABLED |
retainservicestate |
|
Read-write | This option is used to retain the original state of service or servicegroup member when an enable server command is issued.
Default value: OFF Possible values = ON, OFF |
dbsttl |
|
Read-write | Specify the TTL for DNS record for domain based service. The default value of ttl is 0 which indicates to use the TTL received in DNS response for monitors.
Default value: 0 |
maxpipelinenat |
|
Read-write | Maximum number of concurrent requests to allow on a single client connection, which is identified by the |
literaladccookieattribute |
|
Read-write | 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 - set lb parameter -LiteralADCCookieAttribute “;SameSite=None”. |
computedadccookieattribute |
|
Read-write | 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 bind rewrite global lbpol 100 next -type RES_OVERRIDE set lb param -ComputedADCCookieAttribute "$lbvar" For incoming client request, if above policy evaluates TRUE, then SameSite=Strict will be appended to ADC generated cookie. |
storemqttclientidandusername |
|
Read-write | This option allows to store the MQTT clientid and username in transactional logs.
Default value: NO Possible values = YES, NO |
dropmqttjumbomessage |
|
Read-write | When this option is enabled, MQTT messages of length greater than 64k will be dropped and the client/server connections will be reset.
Default value: YES Possible values = YES, NO |
lbhashalgorithm |
|
Read-write | This option dictates the hashing algorithm used for hash based LB methods (URLHASH, DOMAINHASH, SOURCEIPHASH, DESTINATIONIPHASH, SRCIPDESTIPHASH, SRCIPSRCPORTHASH, TOKEN, USER_TOKEN, CALLIDHASH).
Default value: DEFAULT Possible values = DEFAULT, PRAC, JARH |
lbhashfingers |
|
Read-write | 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.
Default value: 256 Minimum value = 1 Maximum value = 1024 |
undefaction |
|
Read-write | Action to perform when policy evaluation creates an UNDEF condition. Available settings function as follows
|
proximityfromself |
|
Read-write | Use the ADC location instead of client IP for static proximity LB or GSLB decision.
Default value: NO Possible values = YES, NO |
sessionsthreshold |
|
Read-only | This option is used to get the upper-limit on the number of persistent sessions set by the administrator for this system.
Minimum value = 1 |
builtin | <String[]> | Read-only | .
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL |
feature |
|
Read-only | The feature to be checked while applying this config. |
adccookieattributewarningmsg |
|
Read-only | Used to describe any configuration issue with respect to ns variable configured as part of set lb parameter. |
lbhashalgowinsize |
|
Read-only | This options allows to increase window size used in LB hashing algorithm(DEFAULT).
Default value: 16 |
overridepersistencyfororder |
|
Read-only | This option is used to override persistency when order is configured for services or servicegroups.
Default value: NO Possible values = YES, NO |
Operations
(click to see Properties )
- UPDATE
- UNSET
- GET (ALL)
Some options that you can use for each operations:
-
Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
-
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER: <username>
X-NITRO-PASS: <password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note:
*
Mandatory parameters are marked in
red
and placeholder content is marked in
green
update
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbparameter HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"lbparameter":{
"httponlycookieflag":<String_value>,
"usesecuredpersistencecookie":<String_value>,
"useencryptedpersistencecookie":<String_value>,
"cookiepassphrase":<String_value>,
"consolidatedlconn":<String_value>,
"useportforhashlb":<String_value>,
"preferdirectroute":<String_value>,
"startuprrfactor":<Double_value>,
"monitorskipmaxclient":<String_value>,
"monitorconnectionclose":<String_value>,
"vserverspecificmac":<String_value>,
"allowboundsvcremoval":<String_value>,
"retainservicestate":<String_value>,
"dbsttl":<Double_value>,
"maxpipelinenat":<Double_value>,
"literaladccookieattribute":<String_value>,
"computedadccookieattribute":<String_value>,
"storemqttclientidandusername":<String_value>,
"dropmqttjumbomessage":<String_value>,
"lbhashalgorithm":<String_value>,
"lbhashfingers":<Double_value>,
"undefaction":<String_value>,
"proximityfromself":<String_value>
}}
<!--NeedCopy-->
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
unset
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbparameter? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"lbparameter":{
"httponlycookieflag":true,
"usesecuredpersistencecookie":true,
"useencryptedpersistencecookie":true,
"cookiepassphrase":true,
"consolidatedlconn":true,
"useportforhashlb":true,
"preferdirectroute":true,
"startuprrfactor":true,
"monitorskipmaxclient":true,
"monitorconnectionclose":true,
"vserverspecificmac":true,
"allowboundsvcremoval":true,
"retainservicestate":true,
"dbsttl":true,
"maxpipelinenat":true,
"literaladccookieattribute":true,
"computedadccookieattribute":true,
"storemqttclientidandusername":true,
"dropmqttjumbomessage":true,
"lbhashalgorithm":true,
"lbhashfingers":true,
"undefaction":true,
"proximityfromself":true
}}
<!--NeedCopy-->
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbparameter HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "lbparameter": [ {
"httponlycookieflag":<String_value>,
"usesecuredpersistencecookie":<String_value>,
"useencryptedpersistencecookie":<String_value>,
"cookiepassphrase":<String_value>,
"consolidatedlconn":<String_value>,
"useportforhashlb":<String_value>,
"preferdirectroute":<String_value>,
"startuprrfactor":<Double_value>,
"monitorskipmaxclient":<String_value>,
"monitorconnectionclose":<String_value>,
"vserverspecificmac":<String_value>,
"sessionsthreshold":<Double_value>,
"builtin":<String[]_value>,
"feature":<String_value>,
"allowboundsvcremoval":<String_value>,
"retainservicestate":<String_value>,
"dbsttl":<Double_value>,
"maxpipelinenat":<Double_value>,
"literaladccookieattribute":<String_value>,
"computedadccookieattribute":<String_value>,
"adccookieattributewarningmsg":<String_value>,
"storemqttclientidandusername":<String_value>,
"dropmqttjumbomessage":<String_value>,
"lbhashalgowinsize":<Double_value>,
"lbhashalgorithm":<String_value>,
"lbhashfingers":<Double_value>,
"undefaction":<String_value>,
"overridepersistencyfororder":<String_value>,
"proximityfromself":<String_value>
}]}
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.