Home > Configuration > Basic > addservice

addservice

Use this method to creates a service on the NetScaler. If the service is domain based, before you create the service, create the server entry by using the add server method. Then, in this method, specify the Server parameter.

Syntax



Parameters

name

Name for the service. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the service has been created.
This is mandatory parameter.

ip

IP to assign to the service.

servername

Name of the server that hosts the service.

servicetype

Protocol in which data is exchanged with the service.
This is mandatory parameter.

port

Port number of the service.
This is mandatory parameter.
Range 1 - 65535.

cleartextport

Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic. Applicable to transparent SSL services.
Minimum value = 1.

cachetype

Cache type supported by the cache server.

maxclient

Maximum number of simultaneous open connections to the service.
Maximum value = NS_MAX_MAXCLIENT.

healthmonitor

Monitor the health of this service. Available settings function as follows: YES - Send probes to check the health of the service. NO - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times.
Default value = YES.

maxreq

Maximum number of requests that can be sent on a persistent connection to the service. Note: Connection requests beyond this value are rejected.
Maximum value = 65535.

cacheable

Use the transparent cache redirection virtual server to forward requests to the cache server. Note: Do not specify this parameter if you set the Cache Type parameter.
Default value = NO.

cip

Before forwarding a request to the service, insert an HTTP header with the client's IPv4 or IPv6 address as its value. Used if the server needs the client's IP address for security, accounting, or other purposes, and setting the Use Source IP parameter is not a viable option.

cipheader

Name for the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If you set the Client IP parameter, and you do not specify a name for the header, the appliance uses the header name specified for the global Client IP Header parameter (the cipHeader parameter in the set ns param CLI method or the Client IP Header parameter in the Configure HTTP Parameters dialog box at System > Settings > Change HTTP parameters). If the global Client IP Header parameter is not specified, the appliance inserts a header with the name "client-ip."

usip

Use the client's IP address as the source IP address when initiating a connection to the server. When creating a service, if you do not set this parameter, the service inherits the global Use Source IP setting (available in the enable ns mode and disable ns mode CLI methods, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service.

pathmonitor

Path monitoring for clustering

pathmonitorindv

Individual Path monitoring decisions

useproxyport

Use the proxy port as the source port when initiating connections with the server. With the NO setting, the client-side connection port is used as the source port for the server-side connection. Note: This parameter is available only when the Use Source IP (USIP) parameter is set to YES.

sp

Enable surge protection for the service.

rtspsessionidremap

Enable RTSP session ID mapping for the service.
Default value = OFF.

clttimeout

Time, in seconds, after which to terminate an idle client connection.
Maximum value = 31536000.

svrtimeout

Time, in seconds, after which to terminate an idle server connection.
Maximum value = 31536000.

customserverid

Unique identifier for the service. Used when the persistency type for the virtual server is set to Custom Server ID.
Default value = "None".

cka

Enable client keep-alive for the service.

tcpb

Enable TCP buffering for the service.

cmp

Enable compression for the service.

maxbandwidth

Maximum bandwidth, in Kbps, allocated to the service.
Maximum value = NS_MAX_BW.

accessdown

Use Layer 2 mode to bridge the packets sent to this service if it is marked as DOWN. If the service is DOWN, and this parameter is disabled, the packets are dropped.
Default value = NO.

monthreshold

Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN.
Maximum value = 65535.

state

Initial state of the service.
Default value = ENABLED.

downstateflush

Flush all active transactions associated with a service whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.
Default value = ENABLED.

tcpprofilename

Name of the TCP profile that contains TCP configuration settings for the service.

httpprofilename

Name of the HTTP profile that contains HTTP configuration settings for the service.

contentinspectionprofilename

Name of the ContentInspection profile that contains IPS/IDS communication related setting for the service

quicprofilename

Name of QUIC profile which will be attached to the service.

hashid

A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service.
Minimum value = 1.

comment

Any information about the service.

appflowlog

Enable logging of AppFlow information.
Default value = ENABLED.

netprofile

Network profile to use for the service.

processlocal

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

dnsprofilename

Name of the DNS profile to be associated with the service. DNS profile properties will applied to the transactions processed by a service. This parameter is valid only for ADNS, ADNS-TCP and ADNS-DOT services.

monconnectionclose

Close monitoring connections by sending the service a connection termination message with the specified bit set.
Default value = MON_CONN_NONE.

Return Value

Returns simpleResult

See Also