service¶
The following operations can be performed on "service":
add | rm | set | unset | bind | unbind | enable | disable | show | rename | stat
add service¶
Creates a service on the NetScaler appliance. If the service is domain based, before you create the service, create the server entry by using the add server command. Then, in this command, specify the Server parameter.
Synopsys¶
add service <name>@ (<IP>@ | <serverName>@) <serviceType> <port> [-clearTextPort <port>] [-cacheType <cacheType>] [-maxClient <positive_integer>] [-healthMonitor ( YES | NO )] [-maxReq <positive_integer>] [-cacheable ( YES | NO )] [-cip ( ENABLED | DISABLED ) [<cipHeader>]] [-usip ( YES | NO )] [-pathMonitor ( YES | NO )] [-pathMonitorIndv ( YES | NO )] [-useproxyport ( YES | NO )] [-sc ( ON | OFF )] [-sp ( ON | OFF )] [-rtspSessionidRemap ( ON | OFF )] [-cltTimeout <secs>] [-svrTimeout <secs>] [-CustomServerID <string>] [-CKA ( YES | NO )] [-TCPB ( YES | NO )] [-CMP ( YES | NO )] [-maxBandwidth <positive_integer>] [-accessDown ( YES | NO )] [-monThreshold <positive_integer>] [-state ( ENABLED | DISABLED )] [-downStateFlush ( ENABLED | DISABLED )] [-tcpProfileName <string>] [-httpProfileName <string>] [-hashId <positive_integer>] [-comment <string>] [-appflowLog ( ENABLED | DISABLED )] [-netProfile <string>] [-td <positive_integer>] [-processLocal ( ENABLED | DISABLED )] [-dnsProfileName <string>]
Arguments¶
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.
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.
Possible values: HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, MYSQL, MSSQL, ORACLE, RADIUS, RADIUSListener, RDP, DIAMETER, SSL_DIAMETER, TFTP, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP
port
Port number of the service.
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.
Possible values: TRANSPARENT, REVERSE, FORWARD
maxClient
Maximum number of simultaneous open connections to the service.
Minimum value: 0
Maximum value: 4294967294
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.
Possible values: YES, NO
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.
Minimum value: 0
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.
Possible values: YES, NO
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.
Possible values: ENABLED, DISABLED
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 command 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 commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service.
Possible values: YES, NO
pathMonitor
Path monitoring for clustering
Possible values: YES, NO
pathMonitorIndv
Individual Path monitoring decisions
Possible values: YES, NO
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.
Possible values: YES, NO
sc
State of SureConnect for the service.
Possible values: ON, OFF
Default value: OFF
sp
Enable surge protection for the service.
Possible values: ON, OFF
rtspSessionidRemap
Enable RTSP session ID mapping for the service.
Possible values: ON, OFF
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.
Possible values: YES, NO
TCPB
Enable TCP buffering for the service.
Possible values: YES, NO
CMP
Enable compression for the service.
Possible values: YES, NO
maxBandwidth
Maximum bandwidth, in Kbps, allocated to the service.
Minimum value: 0
Maximum value: 4294967287
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.
Possible values: YES, NO
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.
Minimum value: 0
Maximum value: 65535
state
Initial state of the service.
Possible values: ENABLED, DISABLED
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.
Possible values: ENABLED, DISABLED
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.
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.
Possible values: ENABLED, DISABLED
Default value: ENABLED
netProfile
Network profile to use for the service.
td
Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.
Minimum value: 0
Maximum value: 4094
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.
Possible values: ENABLED, DISABLED
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 and ADNS-TCP services.
Example¶
add service http_svc 10.102.1.112 http 80 The below command adds the service web_svc1 for the server web_serv1, web_svc2 for web_serv2 and web_svc3 for web_serv3. add service web_svc[1-3] web_serv[1-3] http 80
rm service¶
Removes a service.
Synopsys¶
rm service <name>@
Arguments¶
name
Name of the service.
Example¶
rm service http_svc To remove services svc1, svc2 and svc3 in one go use the following command: rm service svc[1-3]
set service¶
Modifies the parameters of an existing service.
Synopsys¶
set service <name>@ [-IPAddress <ip_addr|ipv6_addr|*>@] [-maxClient <positive_integer>] [-maxReq <positive_integer>] [-cacheable ( YES | NO )] [-cip ( ENABLED | DISABLED ) [<cipHeader>]] [-usip ( YES | NO )] [-pathMonitor ( YES | NO )] [-pathMonitorIndv ( YES | NO )] [-useproxyport ( YES | NO )] [-sc ( ON | OFF )] [-sp ( ON | OFF )] [-rtspSessionidRemap ( ON | OFF )] [-healthMonitor ( YES | NO )] [-cltTimeout <secs>] [-svrTimeout <secs>] [-CustomServerID <string>] [-CKA ( YES | NO )] [-TCPB ( YES | NO )] [-CMP ( YES | NO )] [-maxBandwidth <positive_integer>] [-accessDown ( YES | NO )] [-monThreshold <positive_integer>] [-weight <positive_integer> <monitorName>] [-downStateFlush ( ENABLED | DISABLED )] [-tcpProfileName <string>] [-httpProfileName <string>] [-hashId <positive_integer>] [-comment <string>] [-appflowLog ( ENABLED | DISABLED )] [-netProfile <string>] [-processLocal ( ENABLED | DISABLED )] [-dnsProfileName <string>]
Arguments¶
name
Name of the service for which to modify parameters.
IPAddress
The new IP address of the service.
maxClient
Maximum number of simultaneous open connections to the service.
Minimum value: 0
Maximum value: 4294967294
maxReq
Maximum number of requests that can be sent on a persistent connection to the service.
Note: Connection requests beyond this value are rejected.
Minimum value: 0
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.
Possible values: YES, NO
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.
Possible values: ENABLED, DISABLED
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 command 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 commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service.
Possible values: YES, NO
pathMonitor
Path monitoring for clustering
Possible values: YES, NO
pathMonitorIndv
Individual Path monitoring decisions
Possible values: YES, NO
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.
Possible values: YES, NO
sc
State of SureConnect for the service.
Possible values: ON, OFF
Default value: OFF
sp
Enable surge protection for the service.
Possible values: ON, OFF
rtspSessionidRemap
Enable RTSP session ID mapping for the service.
Possible values: ON, OFF
Default value: OFF
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.
Possible values: YES, NO
Default value: YES
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.
Possible values: YES, NO
TCPB
Enable TCP buffering for the service.
Possible values: YES, NO
CMP
Enable compression for the service.
Possible values: YES, NO
maxBandwidth
Maximum bandwidth, in Kbps, allocated to the service.
Minimum value: 0
Maximum value: 4294967287
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.
Possible values: YES, NO
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.
Minimum value: 0
Maximum value: 65535
weight
Weight to assign to the monitor-service binding. When a monitor is UP, the weight assigned to its binding with the service determines how much the monitor contributes toward keeping the health of the service above the value configured for the Monitor Threshold parameter.
Minimum value: 1
Maximum value: 100
monitorName
Name of the monitor bound to the specified service.
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.
Possible values: ENABLED, DISABLED
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.
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.
Possible values: ENABLED, DISABLED
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.
Possible values: ENABLED, DISABLED
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 and ADNS-TCP services.
Example¶
set service http_svc -maxClient 100 The following command sets IP address 10.102.27.53 for service svc1, 10.102.27.54 for svc2 and 10.102.27.55 for svc3. set service svc[1-3] -IPAddress 10.102.27.[53-55]
unset service¶
Removes the parameter settings of the specified service. Attributes for which a default value is available revert to their default values..Refer to the set service command for meanings of the arguments.
Synopsys¶
unset service <name>@ [-maxClient] [-maxReq] [-cacheable] [-cip] [-usip] [-pathMonitor] [-pathMonitorIndv] [-useproxyport] [-sc] [-sp] [-rtspSessionidRemap] [-CustomServerID] [-CKA] [-TCPB] [-CMP] [-maxBandwidth] [-accessDown] [-monThreshold] [-cltTimeout] [-riseApbrStatsMsgCode] [-svrTimeout] [-tcpProfileName] [-httpProfileName] [-hashId] [-appflowLog] [-netProfile] [-processLocal] [-dnsProfileName] [-cipHeader] [-healthMonitor] [-downStateFlush] [-comment]
Example¶
unset service http_svc -maxClient To unset maxclients for services svc1, svc2 and svc3, the following command can be used: unset service svc[1-3] -maxClient
bind service¶
Binds a policy or a monitor to a service.
Synopsys¶
bind service <name>@ (-policyName <string> | (-monitorName <string>@ [-monState ( ENABLED | DISABLED )] [-weight <positive_integer>] [-passive]))
Arguments¶
name
Name of the service to which to bind a policy or monitor.
policyName
Name of the policy to bind to the service.
monitorName
Name of the monitor to bind to the service.
monState
Initial state of the service.
Possible values: ENABLED, DISABLED
Default value: ENABLED
weight
Weight to assign to the monitor-service binding. When a monitor is UP, the weight assigned to its binding with the service determines how much the monitor contributes toward keeping the health of the service above the value configured for the Monitor Threshold parameter.
Default value: 1
Minimum value: 1
Maximum value: 100
passive
Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.
Example¶
bind service svc1 -policyName pol1 To bind svc1, svc2 and svc3 to the policy pol1 you can use the following command: bind service svc[1-3] -policyName pol1
unbind service¶
Unbinds a policy or monitor from the specified service.
Synopsys¶
unbind service <name>@ (-policyName <string> | -monitorName <string>@)
Arguments¶
name
Name of the service from which to unbind a policy or monitor.
policyName
Name of the policy to unbind.
monitorName
Name of the monitor assigned to the service.
Example¶
unbind service http_svc -policyName pol1 To unbind a policy called pol1 on services svc1, svc2 and svc3, use the following command: unbind service svc[1-3] -policyName pol1
enable service¶
Enables a service.
Synopsys¶
enable service <name>@
Arguments¶
name
Name of the service.
Example¶
enable service http_svc To enable svc1, svc2 and svc3 in one go use the following command: enable service svc[1-3]
disable service¶
Disables a service.
Synopsys¶
disable service <name>@ [<delay>] [-graceFul ( YES | NO )]
Arguments¶
name
Name of the service.
delay
Time, in seconds, allocated to the NetScaler appliance for a graceful shutdown of the service. During this period, new requests are sent to the service only for clients who already have persistent sessions on the appliance. Requests from new clients are load balanced among other available services. After the delay time expires, no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE).
graceFul
Shut down gracefully, not accepting any new connections, and disabling the service when all of its connections are closed.
Possible values: YES, NO
Default value: NO
Example¶
disable service http_svc 10 To disable svc1, svc2 and svc3 in one go use the following command: disable service svc[1-3] 10
show service¶
Displays a list of all services configured on the NetScaler appliance, or the configuration details of the specified service.
Synopsys¶
show service [<name> | -all | -internal]show service bindings - alias for 'show svcbindings'
Arguments¶
name
Name of the service for which to display configuration details.
all
Display both user-configured and dynamically learned services.
internal
Display only dynamically learned services.
Outputs¶
numOfconnections
This will tell the number of client side connections are still open.
serverName
The name of the server for which a service has created.
policyName
The name of the policyname for which this service is bound
serviceType
The type of service
serviceConfTpye
The configuration type of the service
serviceConfType
The configuration type of the service
serviceConfType2
The configuration type of the service (Internal/Dynamic/Configured).
port
Port number of the service.
value
SSL status.
clearTextPort
The clear-text port number where clear-text data is sent. Used with SSL offload service
gslb
The GSLB option for the corresponding virtual server.
cacheType
Cache type supported by the cache server.
maxClient
Maximum number of simultaneous open connections to the service.
maxReq
Maximum number of requests that can be sent on a persistent connection to the service.
Note: Connection requests beyond this value are rejected.
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.
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
The client IP header.
usip
The use of client's IP Address option.
pathMonitor
Path monitoring for clustering
pathMonitorIndv
Individual Path monitoring for decisions.
useproxyport
The use of client's Port.
sc
The state of SureConnect for the service.
weight
The weight for the specified monitor.
state
Initial state of the service.
sp
Enable surge protection for the service.
rtspSessionidRemap
Enable RTSP session ID mapping for the service.
failedprobes
Number of the current failed monitoring probes.
cltTimeout
The idle time in seconds after which the client connection is terminated.
totalprobes
The total number of probs sent.
svrTimeout
The idle time in seconds after which the server connection is terminated.
totalfailedprobes
The total number of failed probs.
publicIP
public ip
publicPort
public port
CustomServerID
The identifier for the service. Used when the persistency type is set to Custom Server ID.
serverID
The identifier for the service. This is used when the persistency type is set to Custom Server ID.
CKA
Enable client keep-alive for the service.
TCPB
Enable TCP buffering 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.
CMP
Enable compression for the service.
maxBandwidth
The maximum bandwidth in kbps allowed for the service
accessDown
The option to allow access to disabled or down services. If enabled, all packets to the service are bridged; if disabled, they are dropped.
svrState
The state of the service
delay
The remaining time in seconds for the service to be disabled
IPAddress
The IP address of the server.
monitorName
The monitor Names.
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.
monState
The running state of the monitor on this service.
monStatCode
The code indicating the monitor response.
lastresponse
The string form of monstatcode.
responseTime
Response time of this monitor.
riseApbrStatsMsgCode
The code indicating the rise apbr status.
riseApbrStatsMsgCode2
The code indicating other rise stats.
monStatParam1
First parameter for use with message code.
monStatParam2
Second parameter for use with message code.
monStatParam3
Third parameter for use with message code.
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.
stateChangeTimeSec
Time when last state change happened. Seconds part.
stateChangeTimemSec
Time at which last state change happened. Milliseconds part.
timeSinceLastStateChange
Time in milliseconds since the last state change.
ticksSinceLastStateChange
Time in 10 millisecond ticks since the last state change.
StateUpdateReason
Checks state update reason on the secondary node.
ClMonOwner
Tells the mon owner of the service.
ClMonView
Tells the view id of the monitoring owner.
tcpProfileName
Name of the TCP profile.
httpProfileName
Name of the HTTP profile that contains HTTP configuration settings for the service.
hashId
A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service.
graceFul
Indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service.
comment
Comments associated with this service.
monitorTotalProbes
Total number of probes sent to monitor this service.
monitorTotalFailedProbes
Total number of failed probes
monitorCurrentFailedProbes
Total number of currently failed probes
stateflag
stateflag
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.
appflowLog
Enable logging of AppFlow information.
netProfile
Network profile to use for the service.
svccfgFlags
Contains the information about config info like internal/configured service
serviceIPstr
This field has been intorduced to show the dbs services ip
svcMonFlags
to store the flags of monitor bound to it
td
Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.
passive
Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.
oracleServerVersion
Oracle server version
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 and ADNS-TCP services.
devno
count
Example¶
The following is sample output of the show service -all command:4 configured services:1) svc1 (10.124.99.12:80) - HTTP State: UP Max Conn: 0 Max Req: 0 Use Source IP: NO Client Keepalive(CKA): NO TCP Buffering(TCPB): NO HTTP Compression(CMP): NO Idle timeout: Client: 180 sec Server: 360 sec Client IP: DISABLED2) svc_3 (10.100.100.3:53) - DNS State: UP Max Conn: 0 Max Req: 0 Use Source IP: NO Client Keepalive(CKA): NO TCP Buffering(TCPB): NO HTTP Compression(CMP): NO Idle timeout: Client: 180 sec Server: 360 sec Client IP: DISABLED3) tsvc1 (77.45.32.45:80) - HTTP State: UP Max Conn: 0 Max Req: 0 Use Source IP: NO Client Keepalive(CKA): NO TCP Buffering(TCPB): NO HTTP Compression(CMP): NO Idle timeout: Client: 180 sec Server: 360 sec Client IP: DISABLED4) foosvc (10.124.99.13:7979) - HTTP State: UP Max Conn: 0 Max Req: 0 Use Source IP: NO Client Keepalive(CKA): NO TCP Buffering(TCPB): NO HTTP Compression(CMP): NO Idle timeout: Client: 180 sec Server: 360 sec Client IP: DISABLED
rename service¶
Renames a service.
Synopsys¶
rename service <name>@ <newName>@
Arguments¶
name
Existing name of the service to be renamed.
newName
New 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.
Example¶
rename service svc1 svcnew
stat service¶
Displays statistics that have been collected for the specified service.
Synopsys¶
stat service [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]
Arguments¶
name
Name of the service.
detail
Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.
fullValues
Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated
ntimes
The number of times, in intervals of seven seconds, the statistics should be displayed.
Default value: 1
Minimum value: 0
logFile
The name of the log file to be used as input.
clearstats
Clear the statsistics / counters
Possible values: basic, full
Outputs¶
count
devno
stateflag
Outputs¶
Throughput (Mbps) (Throughput)
Number of bytes received or sent by this service (Mbps).
Average server TTFB (SvrTTFB)
Average TTFB between the NetScaler appliance and the server.TTFB is the time interval between sending the request packet to a service and receiving the first response from the service
IP address (IP)
The IP address on which the service is running.
Port (port)
The port on which the service is running.
Service type (Type)
The service type of this service.Possible values are ADNS, DNS, MYSQL, RTSP, SSL_DIAMETER, ADNS_TCP, DNS_TCP, NNTP, SIP_UDP, SSL_TCP, ANY, FTP, RADIUS, SNMP, TCP, DHCPRA, HTTP, RDP, SSL, TFTP, DIAMETER, MSSQL, RPCSVR, SSL_BRIDGE, UDP
State
Current state of the server. Possible values are UP, DOWN, UNKNOWN, OFS(Out of Service), TROFS(Transition Out of Service), TROFS_DOWN(Down When going Out of Service)
Requests (Req)
Total number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
Responses (Rsp)
Number of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
Request bytes (Reqb)
Total number of request bytes received on this service or virtual server.
Response bytes (Rspb)
Number of response bytes received by this service or virtual server.
Current client connections (ClntConn)
Number of current client connections.
Requests in surge queue (SurgeQ)
Number of requests in the surge queue.
Current server connections (SvrConn)
Number of current connections to the actual servers behind the virtual server.
Current Server Est connections (SvrEstConn)
Number of server connections in ESTABLISHED state.
Connections in reuse pool (ReuseP)
Number of requests in the idle queue/reuse pool.
Maximum server connections (MaxConn)
Maximum open connections allowed on this service.
Current load on the service (Load)
Load on the service that is calculated from the bound load based monitor.
Current flags on the service (CurtFlags)
Current flags on the service for internal use in display handlers.
Service hits (Hits)
Number of times that the service has been provided.
ActvTrans
Number of active transactions handled by this service. (Including those in the surge queue.)
Active Transaction means number of transactions currently served by the server including those waiting in the SurgeQ
Total Packets rcvd (PktRx)
Total number of packets received by this service or virtual server.
Total Packets sent (PktTx)
Total number of packets sent.