getgslbvserverResult Structure Definition

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

gslbvserverList

List of gslbvservers


gslbvserver Structure Definition

The gslbvserver structure defines the actual return type values for getgslbvserver API.

Syntax



Members

name

Name of the GSLB virtual server.

servicetype

Protocol used by services bound to the virtual server.

state

State of the GSLB virtual server.

iptype

The IP type for this GSLB vserver.
NOTE: This attribute is deprecated.

dnsrecordtype

The IP type for this GSLB vserver.

persistencetype

Indicates if persistence is set on the gslb vserver

persistenceid

Persistence id of the gslb vserver

lbmethod

The load balancing method set for the virtual server

backuplbmethod

Indicates the backup method in case the primary fails

tolerance

Indicates the deviation we can tolerate when we have the LB method as RTT

timeout

Idle timeout for persistence entries.

state2

State of the gslb vserver.

netmask

The netmask used in the SOURCEIPHASH policy.

v6netmasklen

The netmask used for ipv6 traffic in the SOURCE/DEST IPHASH policy.

persistmask

The netmask used while SOURCEIP based persistency is ENABLED.

v6persistmasklen

The netmask applied for ipv6 traffic when the persistency type is SOURCEIP.

servicename

The service name.

weight

Weight for the service.

domainname

The name of the domain for which TTL and/or backupIP has changed.

ttl

TTL for the given domain.

backupip

Backup IP for the given domain.

cookiedomain

The cookie domain for the GSLB domain. This will be used when inserting the GSLB site cookie in the HTTP response. By default, cookie domain will not be inserted.

cookietimeout

Time out value of the cookie in minutes

sitedomainttl

Site domain TTL.

ipaddress

IP address.

port

Port number.

status

Current status of the gslb vserver. During the initial phase if the configured lb method is not round robin , the vserver will adopt round robin to distribute traffic for a predefined number of requests.

lbrrreason

Reason why a vserver is in RR. The following are the reasons: 1 - MEP is DOWN (GSLB) 2 - LB method has changed 3 - Bound service's state changed to UP 4 - A new service is bound 5 - Startup RR factor has changed 6 - LB feature is enabled 7 - Load monitor is not active on a service 8 - Vserver is Enabled 9 - SSL feature is Enabled 10 - All bound services have reached threshold. Using effective state to load balance (GSLB) 11 - Primary state of bound services are not UP. Using effective state to load balance (GSLB) 12 - No LB decision can be made as all bound services have either reached threshold or are not UP (GSLB) 13 - All load monitors are active

preferredlocation

The target site to be returned in the DNS response when a policy is successfully evaluated against the incoming DNS request. Target site is specified in dotted notation with up to 6 qualifiers. Wildcard `*' is accepted as a valid qualifier token.

backupvserver

Backup vserver in case the primary fails

backupsessiontimeout

A non zero value enables the feature. The minimum value is 2 minutes. To disable the feature set the value to zero. The created session is in effect for a specific client per domain.
NOTE: This attribute is deprecated.
This is a deprecated attribute.

edr

Indicates if Empty Down Response is enabled/disabled

ecs

If enabled, respond with EDNS Client Subnet (ECS) option in the response for a DNS query with ECS. The ECS address will be used for persistence and spillover persistence (if enabled) instead of the LDNS address. Persistence mask is ignored if ECS is enabled.

ecsaddrvalidation

Validate if ECS address is a private or unroutable address and in such cases, use the LDNS IP.

mir

Indicates if Multi IP Response is enabled/disabled

disableprimaryondown

Continue to direct traffic to the backup chain even after the primary GSLB virtual server returns to the UP state. Used when spillover is configured for the virtual server.

dynamicweight

Dynamic weight method. Possible values are, the svc count or the svc weights or ignore both.

iscname

is cname feature set on vserver

cumulativeweight

Cumulative weight is the weight of GSLB service considering both its configured weight and dynamic weight. It is equal to product of dynamic weight and configured weight of the gslb service

dynamicconfwt

Weight obtained by the virtue of bound service count or weight

thresholdvalue

Tells whether threshold exceeded for this service participating in CUSTOMLB

sitepersistence

Type of Site Persistence set

svreffgslbstate

Effective state of the gslb svc

gslbthreshold

Indicates if gslb svc has reached threshold

considereffectivestate

If the primary state of all bound GSLB services is DOWN, consider the effective states of all the GSLB services, obtained through the Metrics Exchange Protocol (MEP), when determining the state of the GSLB virtual server. To consider the effective state, set the parameter to STATE_ONLY. To disregard the effective state, set the parameter to NONE. The effective state of a GSLB service is the ability of the corresponding virtual server to serve traffic. The effective state of the load balancing virtual server, which is transferred to the GSLB service, is UP even if only one virtual server in the backup chain of virtual servers is in the UP state.

cnameentry

The cname of the gslb service.

totalservices

Total number of services bound to the vserver.

activeservices

Total number of active services bound to the vserver.

statechangetimesec

Time when last state change happened. Seconds part.

statechangetimemsec

Time at which last state change happened. Milliseconds part.

tickssincelaststatechange

Time in 10 millisecond ticks since the last state change.

comment

Any comments that you might want to associate with the GSLB virtual server.

sopersistencetimeout

Timeout for spillover persistence, in minutes.

somethod

Type of threshold that, when exceeded, triggers spillover. Available settings function as follows: * CONNECTION - Spillover occurs when the number of client connections exceeds the threshold. * DYNAMICCONNECTION - Spillover occurs when the number of client connections at the GSLB virtual server exceeds the sum of the maximum client (Max Clients) settings for bound GSLB services. Do not specify a spillover threshold for this setting, because the threshold is implied by the Max Clients settings of the bound GSLB services. * BANDWIDTH - Spillover occurs when the bandwidth consumed by the GSLB virtual server's incoming and outgoing traffic exceeds the threshold. * HEALTH - Spillover occurs when the percentage of weights of the GSLB services that are UP drops below the threshold. For example, if services gslbSvc1, gslbSvc2, and gslbSvc3 are bound to a virtual server, with weights 1, 2, and 3, and the spillover threshold is 50%, spillover occurs if gslbSvc1 and gslbSvc3 or gslbSvc2 and gslbSvc3 transition to DOWN. * NONE - Spillover does not occur.

sobackupaction

Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists

sopersistence

If spillover occurs, maintain source IP address based persistence for both primary and backup GSLB virtual servers.

sothreshold

Threshold at which spillover occurs. Specify an integer for the CONNECTION spillover method, a bandwidth value in kilobits per second for the BANDWIDTH method (do not enter the units), or a percentage for the HEALTH method (do not enter the percentage symbol).

health

Health of vserver based on percentage of weights of active svcs/all svcs. This does not consider administratively disabled svcs

appflowlog

Enable logging appflow flow information

policyname

Name of the policy bound to the GSLB vserver.

priority

Priority.

gotopriorityexpression

Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. o If gotoPriorityExpression is not present or if it is equal to END then the policy bank evaluation ends here o Else if the gotoPriorityExpression is equal to NEXT then the next policy in the priority order is evaluated. o Else gotoPriorityExpression is evaluated. The result of gotoPriorityExpression (which has to be a number) is processed as follows: - An UNDEF event is triggered if . gotoPriorityExpression cannot be evaluated . gotoPriorityExpression evaluates to number which is smaller than the maximum priority in the policy bank but is not same as any policy's priority . gotoPriorityExpression evaluates to a priority that is smaller than the current policy's priority - If the gotoPriorityExpression evaluates to the priority of the current policy then the next policy in the priority order is evaluated. - If the gotoPriorityExpression evaluates to the priority of a policy further ahead in the list then that policy will be evaluated next. This field is applicable only to rewrite and responder policies.

type

The bindpoint to which the policy is bound

vsvrbindsvcport

used for showing ports of bound entities

gslbboundsvctype

Protocol used by services bound to the GSLBvirtual server.

sitepersistcookie

This field is introduced for displaying the cookie in cluster setup.

svcsitepersistence

Type of Site Persistence set on the bound service

servername

This field is used to display server name in case of GSLB servicegroup binding to GSLB vserver

servicegroupname

The service group names.

nodefaultbindings

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

rule

Rule type

order

Order number to be assigned to the service when it is bound to the lb vserver.

order2

Order number in string form assigned to the service when it is bound to the lb vserver.

toggleorder

Configure this option to toggle order preference

orderthreshold

This option is used to to specify the threshold of minimum number of services to be UP in an order, for it to be considered in Lb decision.

currentactiveorder

current order that takes the traffic in case service or servicegroup is bound with order

_nextgenapiresource


gslbservicecurstate


gslbsvciscname


spilloverpolicyname

The bound spillover policy names.

spilloverpolicygotoprioexpression


spilloverpolicyflowtype


spilloverpolicypriority

The priorities of bound spillover policies.

lbpolicyname

The bound LB policy names.

lbpolicypriority

The priorities of bound LB policies.

lbpolicygotoprioexpression

The next_expr-s of bound LB policies.

lbpolicybindpoint

The bindpoint of bound LB policies.

svcgrpsvcname


svcgrpmemgrpname


svcgrpmemip


svcgrpmemport


svcgrpmemsvctype


svcgrpmemstate


svcgrpmemweight


svcgrpmemdynwtmethod


See Also