| getservicegroupResult Structure Definition |
The getservicegroupResult structure defines the return type for getservicegroup API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
servicegroupList |
List of servicegroups |
| servicegroup Structure Definition |
The servicegroup structure defines the actual return type values for getservicegroup API. |
Syntax |
Members |
servicegroupname |
Name of the service group. |
includemembers |
Display the members of the listed service groups in addition to their settings. |
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. |
serviceconftpye |
NOTE: This attribute is deprecated. This will no longer show the correct information. Use the serviceConfType option instead. |
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. |
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 |
The state of the service group |
svrstate |
The state of the service |
delay |
The remaining 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 |
Monitor state. |
weight |
Weight to assign to the servers in the service group. |
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. NOTE: This attribute is deprecated. Instead of integer now serverId will be a string and you can use -customserverid instead of -serverID. |
monstate2 |
The running state of the monitor on this service. |
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. NOTE: This attribute is deprecated. This will no longer show the correct information. Use the ticksSinceLastStateChange option instead. |
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. |
quicprofilename |
Name of QUIC profile which will be attached to 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. |
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 |
autodisablegraceful |
Indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service. |
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 . |
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. |
nodefaultbindings |
to determine if the configuration is from stylebooks |
nameserver |
Specify the nameserver to which the query for bound domain needs to be sent. If not specified, use the global nameserver |
dbsttl |
Specify the TTL for DNS record for domain based service.The default value of ttl is 0 which indicates to use the TTL received in DNS response for monitors |
svcitmactsvcs |
This gives the total active service items for an FQDN for SRV type server binding |
svcitmpriority |
This gives the priority of the FQDN service items for SRV server binding |
svcitmboundsvcs |
This gives the total bound items for an FQDN for SRV type server binding |
responsetime |
Response time of this monitor in milli sec. |
bootstrap |
Flag to check if kafka broker servicegroup is of type bootstrap or not. |
topicname |
Name of the Kafka topic. |
members |
Desired servicegroupmember binding set. Any existing servicegroupmember which is not part of the input will be deleted or disabled based on graceful setting on servicegroup. |
failedmembers |
List of servicegroupmembers which couldn't be bound. |
trofsreason |
Specify reason if service group member in TROFS |
monuserstatusmesg |
This field has been introduced to show user monitor failure reasons |
order |
Order number to be assigned to the servicegroup member |
order2 |
Order number in string form to be assigned to the servicegroup member |
trofsdelay |
Delay before moving to TROFS |
_nextgenapiresource |
svcgrpmonbindweight |
ipaddress |
svcstate |
svcgrpentsvrid |
svcgrpentstate |
svchashid |
svcgrpentgraceful |
svcgrpentdelay |
See Also |