| getserverResult Structure Definition |
The getserverResult structure defines the return type for getserver 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. |
serverList |
List of servers |
| server Structure Definition |
The server structure defines the actual return type values for getserver API. |
Syntax |
Members |
name |
Name of the server for which to display parameters. |
internal |
Display names of the servers that have been created for internal use. |
ipaddress |
Server IP address. |
domain |
Server domain name. |
ipaddress2 |
The IP Address of server. |
state |
The State of the server. |
domain2 |
The domain name of the server. |
domainresolveretry |
Time, in seconds, for which the NetScaler must wait, after DNS resolution fails, before sending the next DNS query to resolve the domain name. |
servicename |
The services attatched to the server. |
servicegroupname |
servicegroups bind to this server |
translationip |
IP address used to transform the server's DNS-resolved IP address. |
translationmask |
The netmask of the translation ip |
comment |
Any information about the server. |
servicetype |
The type of bound service |
serviceipaddress |
The IP address of the bound service |
serviceipstr |
This field has been intorduced to show the dbs services ip |
port |
The port number to be used for the bound service. |
svrstate |
The state of the bound service |
statechangetimesec |
Time when last state change happened. Seconds part. |
tickssincelaststatechange |
Time in 10 millisecond ticks since the last state change. |
ipv6address |
Support IPv6 addressing mode. If you configure a server with the IPv6 addressing mode, you cannot use the server in the IPv4 addressing mode. |
port2 |
port of the service. |
servicetype2 |
service type of the service. |
svrcfgflags |
service flags to denote its a db enabled. |
autoscale |
Auto scale option for a servicegroup |
customserverid |
A positive integer to identify the service. Used when the persistency type is set to Custom Server ID. |
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. |
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. |
maxbandwidth |
Maximum bandwidth, in Kbps, allocated for all the services in the service group. |
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 methods, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service. |
cka |
Enable client keep-alive for the service group. |
tcpb |
Enable TCP buffering for the service group. |
cmp |
Enable compression for the specified service. |
clttimeout |
Time, in seconds, after which to terminate an idle client connection. |
svrtimeout |
Time, in seconds, after which to terminate an idle server connection. |
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. |
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. |
cacheable |
Use the transparent cache redirection virtual server to forward the request to the cache server. |
sp |
Enable surge protection for the service group. |
downstateflush |
Perform delayed clean-up of connections to all services in the service group. |
appflowlog |
Enable logging of AppFlow information for the specified service group. |
boundtd |
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. |
querytype |
Specify the type of DNS resolution to be done on the configured domain to get the backend services. Valid query types are A, AAAA and SRV with A being the default querytype. The type of DNS resolution done on the domains in SRV records is inherited from ipv6 argument. |
servicegroupentname2 |
Used for show server of SRV type to indicate target FQDNs |
svcitmpriority |
Indicates the Priority of the SRV target FQDN |
svcitmactsvcs |
Indicates the total number of active IPs for SRV target FQDN |
svcitmboundsvcs |
Indicates the total number of bound IPs for the SRV target FQDN |
weight |
Indicates the weight of bound IPs |
_nextgenapiresource |
boundservicegroupsvctype |
boundservicegroupsvcip |
boundservicegroupport |
boundservicegroupsvccustomsvrid |
boundservicegroupsvrstate |
boundservicegroupsvcmonitorthreshold |
boundservicegroupsvcmaxclient |
boundservicegroupsvcmaxreq |
boundservicegroupsvcmaxbandwidth |
boundservicegroupsvcusip |
boundservicegroupsvccka |
boundservicegroupsvctcpb |
boundservicegroupsvccmp |
boundservicegroupsvcclttimeout |
boundservicegroupsvcsvrtimeout |
boundservicegroupsvcciphdr |
boundservicegroupsvccip |
boundservicegroupsvccachbl |
boundservicegroupsvcsp |
boundservicegroupsvcdownstateflush |
boundservicegroupsvcappflowlog |
boundservicegrouptd |
See Also |