Product Documentation

serviceGroup

Sep 12, 2016

The following operations can be performed on "serviceGroup":

add serviceGroup

Creates a service group. You can group similar services into a service group and use them as a single entity.

Synopsys

add serviceGroup <serviceGroupName>@ <serviceType> [-cacheType <cacheType>] [-td <positive_integer>] [-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 )] [-healthMonitor ( YES | NO )] [-sc ( ON | OFF )] [-sp ( ON | OFF )] [-rtspSessionidRemap ( ON | OFF )] [-cltTimeout <secs>] [-svrTimeout <secs>] [-CKA ( YES | NO )] [-TCPB ( YES | NO )] [-CMP ( YES | NO )] [-maxBandwidth <positive_integer>] [-monThreshold <positive_integer>] [-state ( ENABLED | DISABLED )] [-downStateFlush ( ENABLED | DISABLED )] [-tcpProfileName <string>] [-httpProfileName <string>] [-comment <string>] [-appflowLog ( ENABLED | DISABLED )] [-netProfile <string>] [-autoScale <autoScale> -memberPort <port>] [-monConnectionClose ( RESET | FIN )]

Arguments

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.

serviceType

Protocol used to exchange data 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, FIX, SSL_FIX

cacheType

Cache type supported by the cache server.

Possible values: TRANSPARENT, REVERSE, FORWARD

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

maxClient

Maximum number of simultaneous open connections for the service group.

Minimum value: 0

Maximum value: 4294967294

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.

Minimum value: 0

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.

Possible values: YES, NO

Default value: NO

cip

Insert the Client IP header in requests forwarded to the service.

Possible values: ENABLED, DISABLED

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 command 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.

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

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

sc

State of the SureConnect feature for the service group.

Possible values: ON, OFF

Default value: OFF

sp

Enable surge protection for the service group.

Possible values: ON, OFF

Default value: OFF

rtspSessionidRemap

Enable RTSP session ID mapping for the service group.

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

CKA

Enable client keep-alive for the service group.

Possible values: YES, NO

TCPB

Enable TCP buffering for the service group.

Possible values: YES, NO

CMP

Enable compression for the specified service.

Possible values: YES, NO

maxBandwidth

Maximum bandwidth, in Kbps, allocated for all the services in the service group.

Minimum value: 0

Maximum value: 4294967287

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 group.

Possible values: ENABLED, DISABLED

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.

Possible values: ENABLED, DISABLED

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.

comment

Any information about the service group.

appflowLog

Enable logging of AppFlow information for the specified service group.

Possible values: ENABLED, DISABLED

Default value: ENABLED

netProfile

Network profile for the service group.

autoScale

Auto scale option for a servicegroup

Possible values: DISABLED, DNS, POLICY

Default value: DISABLED

memberPort

member port

monConnectionClose

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

Possible values: RESET, FIN

Default value: NONE

Example

add servicegroup http_svc_group http  To add service groups sgrp1, sgrp2 and sgrp3 at one go use the following command:  add servicegroup sgrp[1-3] http

rm serviceGroup

Removes a service group.

Synopsys

rm serviceGroup <serviceGroupName>@

Arguments

serviceGroupName

Name of the service group.

Example

rm servicegroup http_svc_group  To remove multiple servicegroups at once, the following command can be used:  rm servicegroup http_svc_group[1-3]

set serviceGroup

Modifies the specified parameters of a service group.

Synopsys

set serviceGroup <serviceGroupName>@ [(<serverName>@ <port> [-weight <positive_integer>] [-CustomServerID <string>] [-hashId <positive_integer>]) | -maxClient <positive_integer> | -maxReq <positive_integer> | -cacheable ( YES | NO ) | -cip ( ENABLED | DISABLED ) | <cipHeader> | -usip ( YES | NO ) | -useproxyport ( YES | NO ) | -sc ( ON | OFF ) | -sp ( ON | OFF ) | -rtspSessionidRemap ( ON | OFF ) | -cltTimeout <secs> | -svrTimeout <secs> | -CKA ( YES | NO ) | -TCPB ( YES | NO ) | -CMP ( YES | NO ) | -maxBandwidth <positive_integer> | -monThreshold <positive_integer> | -downStateFlush ( ENABLED | DISABLED )] [-monitorName <string> -weight <positive_integer>] [-healthMonitor ( YES | NO )] [-pathMonitor ( YES | NO )] [-pathMonitorIndv ( YES | NO )] [-tcpProfileName <string>] [-httpProfileName <string>] [-comment <string>] [-appflowLog ( ENABLED | DISABLED )] [-netProfile <string>] [-monConnectionClose ( RESET | FIN )]

Arguments

serviceGroupName

Name of the service group.

serverName

Name of the server to which to bind the service group.

port

Server port number.

weight

weight of the monitor that is bound to servicegroup.

Minimum value: 1

CustomServerID

The identifier for this IP:Port pair. Used when the persistency type is set to Custom Server ID.

Default value: "None"

hashId

The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods.

Minimum value: 1

monitorName

Name of the monitor bound to the service group. Used to assign a weight to the monitor.

maxClient

Maximum number of simultaneous open connections for the service group.

Minimum value: 0

Maximum value: 4294967294

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.

Minimum value: 0

Maximum value: 65535

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

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.

Possible values: YES, NO

Default value: NO

cip

Insert the Client IP header in requests forwarded to the service.

Possible values: ENABLED, DISABLED

cipHeader

CIP Header.

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.

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 the SureConnect feature for the service group.

Possible values: ON, OFF

Default value: OFF

sp

Enable surge protection for the service group.

Possible values: ON, OFF

Default value: OFF

rtspSessionidRemap

Enable RTSP session ID mapping for the service group.

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

CKA

Enable client keep-alive for the service group.

Possible values: YES, NO

TCPB

Enable TCP buffering for the service group.

Possible values: YES, NO

CMP

Enable compression for the specified service.

Possible values: YES, NO

maxBandwidth

Maximum bandwidth, in Kbps, allocated for all the services in the service group.

Minimum value: 0

Maximum value: 4294967287

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

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.

Possible values: ENABLED, DISABLED

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.

comment

Any information about the service group.

appflowLog

Enable logging of AppFlow information for the specified service group.

Possible values: ENABLED, DISABLED

Default value: ENABLED

netProfile

Network profile for the service group.

monConnectionClose

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

Possible values: RESET, FIN

Default value: NONE

Example

set servicegroup http_svc_group -maxClient 100  To set the attribute maxclient for multiple servicegroups at once, use the following command:  set servicegroup http_svc_group[1-3] -maxClient 100

unset serviceGroup

Removes the attributes of the specified service group. Attributes for which a default value is available revert to their default values..Refer to the set serviceGroup command for meanings of the arguments.

Synopsys

unset serviceGroup <serviceGroupName>@ [<serverName>@ <port> [-weight] [-CustomServerID] [-hashId] [-riseApbrStatsMsgCode]] [-maxClient] [-maxReq] [-cacheable] [-cip] [-usip] [-useproxyport] [-sc] [-sp] [-rtspSessionidRemap] [-cltTimeout] [-svrTimeout] [-CKA] [-TCPB] [-CMP] [-maxBandwidth] [-monThreshold] [-tcpProfileName] [-httpProfileName] [-appflowLog] [-netProfile] [-monitorName] [-weight] [-healthMonitor] [-cipHeader] [-pathMonitor] [-pathMonitorIndv] [-downStateFlush] [-comment] [-monConnectionClose]

Example

unset servicegroup http_svc_group -maxClient

bind serviceGroup

Binds a service to a service group.

Synopsys

bind serviceGroup <serviceGroupName> ((<IP>@ <port>) | <serverName>@ | ((-monitorName <string>@ [-monState ( ENABLED | DISABLED )] [-passive]) | -CustomServerID <string> | -state ( ENABLED | DISABLED ) | -hashId <positive_integer> | |)) [-weight <positive_integer>]

Arguments

serviceGroupName

Name of the service group.

IP

IP address of the server that hosts the service. Mutually exclusive with the Server Name parameter.

serverName

Name of the server that hosts the service. Mutually exclusive with the IP address parameter.

port

Port number of the service. Each service must have a unique port number.

monitorName

The name of the service or a service group to which the monitor is to be bound.

monState

Administrative state assigned to the monitor and service group binding. If set to disabled, the service group is not monitored.

Possible values: ENABLED, DISABLED

Default value: ENABLED

passive

Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.

weight

CustomServerID

Unique service identifier. Used when the persistency type for the virtual server is set to Custom Server ID.

Default value: "None"

state

Initial state of the service after binding.

Possible values: ENABLED, DISABLED

Default value: ENABLED

hashId

Unique numerical identifier used by hash based load balancing methods to identify a service.

Minimum value: 1

Example

bind servicegroup http_svc_group 10.102.27.153 80  To bind multiple servers to a servicegroup, following command can be used:  bind servicegroup http_svc_group 10.102.27.[153-155] 80

unbind serviceGroup

Unbinds a service or a monitor from a service group.

Synopsys

unbind serviceGroup <serviceGroupName> ((<IP>@ <port>) | <serverName>@ | -monitorName <string>@)

Arguments

serviceGroupName

Name of the service group.

IP

IP address of the server that hosts the service. Mutually exclusive with the Server Name parameter.

serverName

Name of the server that hosts the service. Mutually exclusive with the IP Address parameter.

port

Port number of the service.

monitorName

Name of the monitor to bind to the service group.

Example

unbind servicegroup http_svc_group 10.102.27.153 80  To unbind multiple servers following command can be used:  unbind servicegroup http_svc_group 10.102.27.[153-155] 80

enable serviceGroup

Enables a service group or a member of the service group.

Synopsys

enable serviceGroup <serviceGroupName>@ [<serverName>@ <port>]

Arguments

serviceGroupName

Name of the service group.

serverName

Name of the server that hosts the service.

port

Port number of the service to be enabled.

Example

enable servicegroup http_svc_group  To enable multiple service groups at one go use the following command:  enable servicegroup http_svc_group[1-3]

disable serviceGroup

Disables a service group or a member of a service group. To disable a service group, provide only the service group name. To disable only a member of a service group, in addition to the service group name, provide the name of the server that hosts the service, and the port number of the service.

Synopsys

disable serviceGroup <serviceGroupName>@ [<serverName>@ <port>] [-delay <secs>] [-graceFul ( YES | NO )]

Arguments

serviceGroupName

Name of the service group.

serverName

Name of the server that hosts the service.

port

Port number of the service.

delay

Time, in seconds, allocated for a shutdown of the services in the service group. 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

Wait for all existing connections to the service to terminate before shutting down the service.

Possible values: YES, NO

Default value: NO

Example

disable servicegroup http_svc_group 10.102.27.153 80 -delay 10  To disable multiple servicegroups use the following command:  disable servicegroup http_svc_group[1-3] 10.102.27.[153-155] 80 -delay 30

show serviceGroup

Displays the specified service group's binding information.

Synopsys

show serviceGroup [<serviceGroupName> | -includeMembers]

Arguments

serviceGroupName

Name of the service group.

includeMembers

Display the members of the listed service groups in addition to their settings. Can be specified when no service group name is provided in the command. In that case, the details displayed for each service group are identical to the details displayed when a service group name is provided, except that bound monitors are not displayed.

Outputs

numOfconnections

This will tell the number of client side connections are still open.

serviceType

Protocol used to exchange data with the service.

port

The port number of the service to be enabled.

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.

serviceConfTpye

serviceConfType

The configuration type of the service group.

value

SSL Status.

cacheType

Cache type supported by the cache server.

maxClient

Maximum number of simultaneous open connections for the service group.

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.

cacheable

The state of cache on the service.

cip

Insert the Client IP header in requests forwarded to the service.

cipHeader

CIP Header.

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

The use of client's Port.

monweight

weight of the monitor that is bound to servicegroup.

sc

Whether SureConnect is enabled on this service or not.

sp

Enable surge protection for the service group.

rtspSessionidRemap

Enable RTSP session ID mapping for the service group.

cltTimeout

Time, in seconds, after which to terminate an idle client connection.

svrTimeout

Time, in seconds, after which to terminate an idle server connection.

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.

state

Monitor state.

svrState

The state of the service

delay

The remaning time in seconds for the service to be disabled

IP

IP Address.

serverName

The name of the server to be changed.

monitorName

Monitor name.

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.

weight

weight of the monitor that is bound to servicegroup.

CustomServerID

The identifier for this IP:Port pair. 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.

monStatCode

The code indicating the monitor response.

monStatParam1

First parameter for use with message code.

monStatParam2

Second parameter for use with message code.

monStatParam3

Third parameter for use with message code.

monitorTotalProbes

Total number of probes sent to monitor this service.

monitorTotalFailedProbes

Total number of failed probes

monitorCurrentFailedProbes

Total number of currently failed probes

downStateFlush

Flush all active transactions associated with all services in the service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

lastresponse

The string form of monstatcode.

stateChangeTimeSec

Time when last state change occurred. Seconds part.

stateChangeTimemSec

Time when last state change occurred. 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.

groupCount

Servicegroup Count

comment

Any information about the service group.

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.

hashId

The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods.

riseApbrStatsMsgCode

The code indicating the rise apbr status.

riseApbrStatsMsgCode2

The code indicating other rise stats.

graceFul

Indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service.

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 for the specified service group.

netProfile

Network profile for the service group.

autoScale

Auto scale option for a servicegroup

memberPort

member port

serviceIPstr

This field has been intorduced to show the dbs services ip

serviceGroupEntName2

passive

Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.

serviceGroupeffectivestate

Indicates the effective servicegroup state based on the state of the bound service items.If all services are UP the effective state is UP, if all are DOWN its DOWN,if all are OFS its OFS.If atleast one serviceis UP and rest are either DOWN or OFS, the effective state is PARTIAL-UP.If atleast one bound service is DOWN and rest are OFS the effective state is PARTIAL DOWN.

monConnectionClose

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

devno

count

stateflag

stat serviceGroup

Displays configuration statistics of the specified service group or all the service groups configured on the appliance.

Synopsys

stat serviceGroup [<serviceGroupName>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]

Arguments

serviceGroupName

Name of the service group for which to display settings.

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

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)

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

rename serviceGroup

Renames a service group.

Synopsys

rename serviceGroup <serviceGroupName>@ <newName>@

Arguments

serviceGroupName

Existing name of the service group.

newName

New name for the service group.

Example

rename service svcgrp1 svcgrp-new1