getserviceResult Structure Definition

The getserviceResult structure defines the return type for getservice 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.

serviceList

List of services


service Structure Definition

The service structure defines the actual return type values for getservice API.

Syntax



Members

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.

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
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
NOTE: This attribute is deprecated.
This will no longer show the correct information. Use the serviceConfType2 option instead.

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.

weight

The weight of the monitor.

state

Added this field for getting state value from table.

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.
NOTE: This attribute is deprecated.
Instead of integer now serverId will be a string and you can use -customserverid instead of -serverID.

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 configured state (enable/disable) of the monitor on this server.

monstate2

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.

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

tcpprofilename

Name of the TCP profile.

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.

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

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.

weight2

The weight for the specified monitor.

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, ADNS-TCP and ADNS-DOT services.

monconnectionclose

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

nodefaultbindings

to determine if the configuration will have default ssl CIPHER and ECC curve bindings

monuserstatusmesg

This field has been introduced to show user monitor failure reasons

builtin


_nextgenapiresource


runningmonstate


svcmonstate


boundmonstatcode


boundlastresponse


boundmonstatparam1


boundmonstatparam2


boundmonstatparam3


boundresponsetime


See Also