The NetScaler load balancing virtual server.
Base Class | Comtrade.Citrix.NetScaler.Appliance.Component.LoadBalancing.VirtualServer |
Abstract | False |
Hosted | True |
Singleton | False |
Extension | False |
Accessibility | Public |
ElementId | 742e5d35-f680-9c1b-77c5-f212481160c7 |
Property Name | Type | Display Name (ENU) | Description (ENU) | Key | Max Length | Min Length | Case Sensitive |
---|---|---|---|---|---|---|---|
System.Entity: | |||||||
string | Display Name | Display name of monitoring object. | false | 256 | 0 | False | |
ComTrade.Citrix.NetScaler.Appliance.Component.Base: | |||||||
string | MPNS Key | The NetScaler Management Pack key value. It is combination of host id, serial number and NetScaler IP address. | false | 256 | 0 | False | |
string | Device IP Address | The NetScaler Device IP Address. | false | 256 | 0 | False | |
string | Device Key | The key property of the device node in System Center Operations Manager. | true | 256 | 0 | False | |
ComTrade.Citrix.NetScaler.Appliance.Component.VirtualServer: | |||||||
string | Name | The name for the virtual server. | true | 256 | 0 | False | |
string | Service Name | The name of the service, if any, to which the virtual server policy is bound. | false | 256 | 0 | False | |
Comtrade.Citrix.NetScaler.Appliance.Component.LoadBalancing.VirtualServer: | |||||||
string | IP Address | The IP address of the virtual server. | false | 256 | 0 | False | |
string | Protocol | The service type. | false | 256 | 0 | False | |
string | Port | Port | false | 256 | 0 | False | |
string | Persistence | Persistence type for the virtual server.Note:The <persistenceType> parameter can take one of the following options: SOURCEIP - When configured, the system selects a physical service based on the Load Balancing method, and then directs all the subsequent requests arriving from the same IP as the first request to the same physical service. COOKIEINSERT - When configured, the system inserts an HTTP cookie into the client responses. The cookie is inserted into the "Cookie" header field of the HTTP response. The client stores the cookie (if enabled) and includes it in all the subsequent requests, which then match the cookie criteria. The cookie contains information about the service where the requests have to be sent. SSLSESSION ID - When configured, the system creates a persistence that is session based on the arriving SSL Session ID, which is part of the SSL handshake process. All requests with the same SSL session ID are directed to the initially selected physical service. CU... | false | 256 | 0 | False | |
string | Time-out (mins) | The time period for which the persistence is in effect for a specific client. The value ranges from 2 to 1440 minutes. | false | 256 | 0 | False | |
string | Backup Persistence | Use this parameter to specify a backup persistence type for the virtual server.The Backup persistence option is used when the primary configured persistence mechanism on virtual server fails.The <persistenceBacup> parameter can take one of the following options: SOURCEIP NONE | false | 256 | 0 | False | |
string | Backup Time-out | The maximum time backup persistence is in effect for a specific client. | false | 256 | 0 | False | |
string | Method | The load balancing method for the virtual server. The valid options for this parameter are:ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, URLHASH, DOMAINHASH, DESTINATIONIPHASH, SOURCEIPHASH, SRCIPDESTIPHASH,LEASTBANDWIDTH, LEASTPACKETS, TOKEN, SRCIPDESTIPHASH, CUSTOMLOAD, SRCIPSRCPORTHASH, LRTM, CALLIDHASSH. When the load balancing policy is configured as: ROUNDROBIN - When configured, the system distributes incoming requests to each server in rotation, regardless of the load. When different weights are assigned to services then weighted round robin occurs and requests go to services according to how much weighting has been set. LEASTCONNECTION (default value)- When configured, the system selects the service that has the least number of connections. For TCP, HTTP, HTTPS and SSL_TCP services the least number of connections includes: Established, active connections to a service. Connection reuse applies to HTTP and HTTPS. Hence the count includes only those connections which ... | false | 256 | 0 | False | |
string | IPv4 Netmask | Use this parameter to set the DESTINATIONIPHASH or SOURCEIPHASH policy.Enter the netmask to be used in modifying the destination or source IP address or network. | false | 256 | 0 | False | |
string | IPv6 Mask Length | The Network mask. Use this parameter if you are setting the DESTINATIONIPHASH or SOURCEIPHASH policy. Enter the netmask to be used in modifying the destination or source IP address or network. | false | 256 | 0 | False | |
string | Expression | Expression | false | 256 | 0 | False | |
string | IPv4 Netmask | Use this parameter to specify if the persistency is IP based. This parameter is Optional. | false | 256 | 0 | False | |
string | IPv6 Mask Length | The persistence mask. Use this parameter if you are using IP based persistence type on a ipv6 vserver. | false | 256 | 0 | False | |
string | Priority Queuing | Priority Queuing | false | 256 | 0 | False | |
string | Sure Connect | Sure Connect | false | 256 | 0 | False | |
string | RTSP Natting | RTSP Natting | false | 256 | 0 | False | |
string | Redirection Mode | Use this parameter to specify the LB mode. If the value is specified as IP then the traffic is sent to the physical servers by changing the destination IP address to that of the physical server. If the value is MAC then the traffic is sent to the physical servers , by changing the destination MAC address to that of one of the physical servers, the destination IP is not changed. MAC mode is used mostly in Firewall Load Balancing scenario. | false | 256 | 0 | False | |
string | Sessionless load balancing | Sessionless load balancing | false | 256 | 0 | False | |
string | Cacheable | Cacheable | false | 256 | 0 | False | |
string | Spillover Method | The spillover factor based on which the traffic will be given to the backupvserver once the main virtual server reaches the spillover threshold. | false | 256 | 0 | False | |
string | Spillover Persistence | The state of the spillover persistence. | false | 256 | 0 | False | |
string | Spillover Persistence Time-out (mins) | The spillover persistency entry timeout. | false | 256 | 0 | False | |
string | Redirect Port Rewrite | Redirect Port Rewrite | false | 256 | 0 | False | |
string | Down State Flush | Down State Flush. | false | 256 | 0 | False | |
string | Backup Virtual Server | The Backup Virtual Server. | false | 256 | 0 | False | |
string | Disable Primary When Down | When this argument is enabled, traffic will continue reaching backup vservers even after primary comes UP from DOWN state. | false | 256 | 0 | False | |
string | VServer IP Port Insertion | The virtual IP and port header insertion option for the vserver. VIPADDR - Header contains the vserver's IP address and port number without any translation. OFF - The virtual IP and port header insertion option is disabled. V6TOV4MAPPING - Header contains the mapped IPv4 address corresponding to the IPv6 address of the vserver and the port number. An IPv6 address can be mapped to a user-specified IPv4 address using the set ns ip6 command. | false | 256 | 0 | False | |
string | Authentication FQDN | FQDN of authentication vserver | false | 256 | 0 | False | |
string | Form Based Authentication | This option toggles on or off the application of authentication of incoming users to the vserver. | false | 256 | 0 | False | |
string | 401 Based Authentication | This option toggles on or off the HTTP 401 response based authentication. | false | 256 | 0 | False | |
string | Authentication vServer Name | Name of authentication vserver | false | 256 | 0 | False | |
string | Push | Process traffic on bound Push vserver. | false | 256 | 0 | False | |
string | Push VServer | The lb vserver of type PUSH/SSL_PUSH to which server pushes the updates received on the client facing non-push lb vserver. | false | 256 | 0 | False | |
string | Push Label Expression | Use this parameter to specify the expression to extract the label in response from server.The string can be either a named expression (configured using add policy expression command) or else it can be an in-line expression with a maximum of 63 characters. | false | 256 | 0 | False | |
string | Push Multiple Clients | Specify if multiple web 2.0 connections from the same client can connect to this vserver and expect updates. | false | 256 | 0 | False | |
string | TCP Profile | The name of the TCP profile. | false | 256 | 0 | False | |
string | HTTP Profile | Name of the HTTP profile. | false | 256 | 0 | False | |
string | New Service Startup Request Rate | The number of requests/sec or percentage of requests/sec a new service should receive compared to the existing services. The maximum possible value for requests/sec is 65536 and percentage of requests is 100 |
false | 256 | 0 | False | |
string | New Service Request unit | The unit for new service request value | false | 256 | 0 | False | |
string | Increment Interval | The interval in seconds after which the new services requests limit should be automatically increased. | false | 256 | 0 | False | |
string | MSSQL Server Version | Server Version | false | 256 | 0 | False | |
string | MySQL Protocol Version | The protocol version returned by the mysql vserver. | false | 256 | 0 | False | |
string | MySQL Server Version | The server version string returned by the mysql vserver. | false | 256 | 0 | False | |
string | MySQL Character Set | The character set returned by the mysql vserver. | false | 256 | 0 | False | |
string | AppFlow Logging | The AppFlow Logging flag. | false | 256 | 0 | False | |
string | Net Profile | The net profile. | false | 256 | 0 | False | |
string | Weight | The weight for the specified service. | false | 256 | 0 | False | |
string | Redirect URL | Redirect URL | false | 256 | 0 | False | |
string | Type | Type of LB vserver. | false | 256 | 0 | False | |
string | CacheType | Cache type. | false | 256 | 0 | False | |
string | Redirect | Cache redirect type. | false | 256 | 0 | False | |
string | Precedence | Precedence. | false | 256 | 0 | False | |
string | HomePage | Home page. | false | 256 | 0 | False | |
string | PolicyName | Name of the policy bound to the LB vserver. | false | 256 | 0 | False | |
string | ServiceGroupName | The service group name bound to the selected load balancing virtual server. | false | 256 | 0 | False | |
string | DynamicWeight | Dynamic weight | false | 256 | 0 | False | |
string | Cache VServer | Cache virtual server. | false | 256 | 0 | False | |
string | Priority | Priority. | false | 256 | 0 | False | |
string | Health (By Weight) | Health of vserver based on percentage of weights of active svcs/all svcs. This does not consider administratively disabled svcs | false | 256 | 0 | False | |
string | GotoPriorityExpression | Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. | false | 256 | 0 | False | |
string | RuleType | Rule type. | false | 256 | 0 | False | |
string | GroupName | LB group to which the lb vserver is to be bound. | false | 256 | 0 | False | |
string | CookieDomain | Domain name to be used in the set cookie header in case of cookie persistence. | false | 256 | 0 | False | |
string | Map | Map. | false | 256 | 0 | False | |
string | Gt2GB | Allow for greater than 2 GB transactions on this vserver. | false | 256 | 0 | False | |
string | ThresholdValue | Tells whether threshold exceeded for this service participating in CUSTOMLB | false | 256 | 0 | False | |
string | Invoke | Invoke flag. | false | 256 | 0 | False | |
string | LabelType | The invocation type. | false | 256 | 0 | False | |
string | LabelName | Name of the label invoked. | false | 256 | 0 | False | |
string | CookieIpPort | Encryped Ip address and port of the service that is inserted into the set-cookie http header | false | 256 | 0 | False | |
string | VServer Id | Vserver Id | false | 256 | 0 | False | |
string | Version | Cookie version | false | 256 | 0 | False | |
string | PolicySubType | PolicySubType | false | 256 | 0 | False | |
string | Redirect URL | Redirect URL | false | 256 | 0 | False | |
string | ICMP VServer Response | Can be active or passive | false | 256 | 0 | False | |
string | Bindpoint | The bindpoint to which the policy is bound | false | 256 | 0 | False | |
string | Persistence AVP Number | Persistence AVP Number | false | 256 | 0 | False | |
string | SSL Profile | SSL Profile | false | 256 | 0 | False |