Citrix NetScaler Appliance (v10.x and later) LB Service

Comtrade.Citrix.NetScaler.Appliance.10.Component.LoadBalancing.Service (ClassType)

The NetScaler load balancing service.

Element properties:

Class Hierarchy:

Class Properties:

Property Name	Type	Display Name (ENU)	Description (ENU)	Key	Max Length	Min Length	Case Sensitive
System.Entity:
DisplayName	string	Display Name	Display name of monitoring object.	false	256	0	False
ComTrade.Citrix.NetScaler.Appliance.Component.Base:
HostID	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
IPAddress	string	Device IP Address	The NetScaler Device IP Address.	false	256	0	False
DeviceKey	string	Device Key	The key property of the device node in System Center Operations Manager.	true	256	0	False
Comtrade.Citrix.NetScaler.Appliance.Component.LoadBalancing.Service:
name	string	Service Name	The name of the service.	true	256	0	False
servicetype	string	Protocol	The type of service. The supported protocols are:HTTP - To load balance web servers and provide connection multiplexing, latency improvement, and other content and TCP protection benefits for HTTP traffic.FTP - To load balance FTP servers. In FTP mode, the system provides TCP protection benefits, protection against SYN attacks, and surge protection.TCP - To host any other TCP protocols that are not HTTP, FTP, NNTP, or SSL. In TCP mode, the system provides TCP protection benefits, protection against SYN attack, and surge protection.UDP - To load balance servers with UDP-based services (other than DNS).SSL - To provide end-to-end encryption and SSL acceleration.SSL_BRIDGE - To load balance SSL servers.SSL_TCP - To offload SSL traffic for TCP applications.NNTP - To load balance NNTP servers.DNS - To load balance DNS servers.ADNS: To create an authoritative DNS service.ANY - To load balance a service type not listed above (for example, for IP traffic when load balanci...	false	256	0	False
port	string	Port	The port number to be used for the service.	false	256	0	False
cleartextport	string	Clear Text Port	The clear text port number where clear text data is sent. Used with SSL offload service.	false	256	0	False
gslb	string	Gslb	The GSLB option for the corresponding virtual server.	false	256	0	False
cachetype	string	Cache Type	The cache type option supported by the cache server.	false	256	0	False
healthmonitor	string	Health Monitor	Health monitoring state of the service.	false	256	0	False
maxclient	string	Max Clients	The maximum number of open connections to the service.	false	256	0	False
maxreq	string	Max Requests	The maximum number of requests that can be sent on a persistent connection to the service.	false	256	0	False
cacheable	string	Cache Redirection	The virtual server (used in load balancing or content switching) routes a request to the virtual server (used in transparent cache redirection) on the same system before sending it to the configured servers. The virtual server used for transparent cache redirection determines if the request is directed to the cache servers or configured servers.Note: This argument is disabled by default. Do not specify this argument if a -cacheType cacheType is specified.	false	256	0	False
cip	string	Client IP	The Client IP header insertion option for the service.	false	256	0	False
cipheader	string	Header	The client IP header. If client IP insertion is enabled and the client IP header is not specified, then the value set by the ###set ns config### command will be used as the Client IP header.	false	256	0	False
usip	string	Use Source IP	The use of client's IP Address option to the source IP Address while connecting to this server.By default, the system uses a mapped IP address for its server connection; however, you can use this option to tell the system to use the client's IP address when it communicates with the server.	false	256	0	False
useproxyport	string	Use Proxy Port	When USIP is enabled, based on the setting of this variable proxy port or the client port will be used as the source port for the backend connection.	false	256	0	False
sp	string	Surge Protection	The state of Surge protection for the the service.	false	256	0	False
rtspsessionidremap	string	Session ID Remapping	Use this parameter to enable mapping of RTSP sessionid.	false	256	0	False
clttimeout	string	Client idle time-out	The idle time (in seconds) after which the client connection is terminated.	false	256	0	False
svrtimeout	string	Server idle time-out	The idle time (in seconds) after which the server connection is terminated.	false	256	0	False
customserverid	string	Server ID	The identifier for the service. This is used when the persistency type is set to Custom Server ID.	false	256	0	False
serverid	string	ServerID	The identifier for the service. This is used when the persistency type is set to Custom Server ID.	false	256	0	False
cka	string	Client Keep-Alive	The state of the Client Keep-Alive feature for the service.	false	256	0	False
tcpb	string	TCP Buffering	The state of the TCP Buffering feature for the service.	false	256	0	False
cmp	string	Compression	The state of the HTTP Compression feature for the service.	false	256	0	False
maxbandwidth	string	Max Bandwidth (kbits)	The maximum bandwidth in kbps allowed for the service.	false	256	0	False
accessdown	string	Access Down	The option to allow access to disabled or down services. If enabled, all packets to this service are bridged. If disabled, they are dropped.	false	256	0	False
monthreshold	string	Monitor Threshold	The monitoring threshold.	false	256	0	False
downstateflush	string	Down state flush	Perform delayed clean up of connections on this service.	false	256	0	False
ipmapping	string	IPMapping	The permanent mapping for the V6 Address	false	256	0	False
tcpprofilename	string	TCP profile	The name of the TCP profile.	false	256	0	False
httpprofilename	string	HTTP profile	Name of the HTTP profile.	false	256	0	False
hashid	string	Hash ID	The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods.	false	256	0	False
comment	string	Comments	Comments associated with this server.	false	256	0	False
appflowlog	string	AppFlow Logging	Enable logging appflow flow information	false	256	0	False
netprofile	string	Net Profile	The name of the network profile.	false	256	0	False
ipaddress	string	IP Address	The new IP address of the service.	false	256	0	False
policyname	string	Policy Name	The name of the policyname for which this service is bound	false	256	0	False
serviceconftype	string	Service Config Type	The configuration type of the service	false	256	0	False
delay	string	Wait Time (seconds)	The remaining time in seconds for the service to be disabled	false	256	0	False

Health Model: