| addservicegroup |
Use this method to creates a service group. You can group similar services into a service group and use them as a single entity. |
Syntax |
Parameters |
servicegroupname |
Name of the service group. 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. Can be changed after the name is created. This is mandatory parameter. |
servicetype |
Protocol used to exchange data with the service. This is mandatory parameter. |
cachetype |
Cache type supported by the cache server. |
maxclient |
Maximum number of simultaneous open connections for the service group. Maximum value = NS_MAX_MAXCLIENT. |
maxreq |
Maximum number of requests that can be sent on a persistent connection to the service group.
Note: Connection requests beyond this value are rejected. Maximum value = 65535. |
cacheable |
Use the transparent cache redirection virtual server to forward the request to the cache server.
Note: Do not set this parameter if you set the Cache Type. Default value = NO. |
cip |
Insert the Client IP header in requests forwarded to the service. |
cipheader |
Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config method is used as client's IP header name. |
usip |
Use client's IP address as the source IP address when initiating connection to the server. With the NO setting, which is the default, a mapped IP (MIP) address or subnet IP (SNIP) address is used as the source IP address to initiate server side connections. |
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. |
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. |
sp |
Enable surge protection for the service group. Default value = OFF. |
rtspsessionidremap |
Enable RTSP session ID mapping for the service group. 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. |
cka |
Enable client keep-alive for the service group. |
tcpb |
Enable TCP buffering for the service group. |
cmp |
Enable compression for the specified service. |
maxbandwidth |
Maximum bandwidth, in Kbps, allocated for all the services in the service group. Maximum value = NS_MAX_BW. |
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 group. Default value = ENABLED. |
downstateflush |
Flush all active transactions associated with all the services in the service group 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 group. |
httpprofilename |
Name of the HTTP profile that contains HTTP configuration settings for the service group. |
quicprofilename |
Name of QUIC profile which will be attached to the service group. |
comment |
Any information about the service group. |
appflowlog |
Enable logging of AppFlow information for the specified service group. Default value = ENABLED. |
netprofile |
Network profile for the service group. |
autoscale |
Auto scale option for a servicegroup Default value = NSA_AS_DISABLED. |
memberport |
member port |
autodisablegraceful |
Indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service. Default value = NS_NO2. |
autodisabledelay |
The time allowed (in seconds) for a graceful shutdown. During this period, new connections or requests will continue to be sent to this service for clients who already have a persistent session on the system. Connections or requests from fresh or new clients who do not yet have a persistence sessions on the system will not be sent to the service. Instead, they will be load balanced among other available services. After the delay time expires, no new requests or connections will be sent to the service. |
autodelayedtrofs |
Indicates graceful movement of IP-Port binding/s to TROFS when IP addresses are removed from DNS response. System will wait for monitor response timeout period before moving to TROFS . Default value = NS_NO2. |
monconnectionclose |
Close monitoring connections by sending the service a connection termination message with the specified bit set. Default value = MON_CONN_NONE. |
bootstrap |
Flag to check if kafka broker servicegroup is of type bootstrap or not. Default value = NS_NO2. |
topicname |
Name of the Kafka topic. |
Return Value |
Returns simpleResult |
See Also |