Gslb

Description

API


    POST /api/gslb
    PUT /api/gslb/&ltkey>
    DELETE /api/gslb/&ltkey>
    GET /api/gslb
    GET /api/gslb/&ltkey>

CLI


    configure gslb &ltkey>
    show gslb &ltkey>

Data

Gslb

uuid

Type
string
Category
required
Description
UUID of the GSLB object.

name

Type
string
Category
required
Description
Name for the GSLB object.

dns_configs

Type
DNSConfig
Category
repeated
Description
Sub domain configuration for the GSLB. GSLB service's FQDN must be a match one of these subdomains.

sites

Type
GslbSite
Category
repeated
Description
Select Avi site member belonging to this Gslb.

leader_cluster_uuid

Type
string
Category
optional
Description
Mark this Site as leader of GSLB configuration. This site is the one among the Avi sites.

send_interval

Type
uint32
Category
optional
Description
Frequency with which group members communicate.
Units
sec
Default
15

clear_on_max_retries

Type
uint32
Category
optional
Description
Max retries after which the remote site is treatedas a fresh start. In fresh start all the configsare downloaded.
Default
20

view_id

Type
uint64
Category
optional,readonly
Description
The view-id is used in maintenance mode to differentiate partitioned groups while they havethe same gslb namespace. Each partitioned groupwill be able to operate independently by using theview-id.
Default
0

third_party_sites

Type
GslbThirdPartySite
Category
repeated
Description
Third party site member belonging to this Gslb.

client_ip_addr_group

Type
GslbClientIpAddrGroup
Category
optional
Description
Group to specify if the client ip addresses are public or private.

description

Type
string
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
required
Description

DNSConfig

domain_name

Type
string
Category
optional
Description
GSLB subdomain used for GSLB service FQDN match and placement.

GslbSite

cluster_uuid

Type
string
Category
optional
Description
UUID of the 'Cluster' object of the Controller Cluster in this site.

name

Type
string
Category
optional
Description
Name for the Site Controller Cluster.

address

Type
string
Category
optional
Description
IP Address or a DNS resolvable, fully qualified domain name of the Site Controller Cluster.

ip_addresses

Type
IpAddr
Category
repeated
Description
IP Address(es) of the Site's Cluster. For a 3-node cluster, either the cluster vIP is provided, or the list of controller IPs in the cluster are provided.

port

Type
uint32
Category
optional
Description
The Site Controller Cluster's REST API port number.
Default
443

username

Type
string
Category
optional
Description
The username used when authenticating with the Site.

password

Type
string
Category
optional
Description
The password used when authenticating with the Site.

dns_vs_uuids

Type
string
Category
repeated
Description
The list of DNS-VSes on which the GSes shall be placed. The site has to be an ACTIVE member.

member_type

Type
enum
Category
optional
Description
The site's member type: A leader is set to ACTIVE while allmembers are set to passive.
Default
GSLB_PASSIVE_MEMBER
Choices
GSLB_ACTIVE_MEMBER, GSLB_PASSIVE_MEMBER

enabled

Type
bool
Category
optional
Description
Enable or disable the Site. This is useful in maintenance scenarios such as upgrade and routine maintenance. A disabled site's configuration shall be retained but it will not get any new configuration updates. It shall not participate in Health-Status monitoring. VIPs of the Virtual Services on the disabled site shall not be sent in DNS response. When a site transitions from disabled to enabled, it is treated similar to the addition of a new site.
Default
True

location

Type
GslbGeoLocation
Category
optional
Description
Geographic location of the site.

hm_proxies

Type
GslbHealthMonitorProxy
Category
repeated
Description
User can designate certain Avi sites to run health monitor probes for VIPs/VS(es) for this site. This is useful in network deployments where the VIPs/VS(es) are reachable only from certain sites. A typical scenario is a firewall between two GSLB sites. User may want to run health monitor probes from sites on either side of the firewall so that each designated site can derive a datapath view of the reachable members. If the health monitor proxies are not configured, then the default behavior is to run health monitor probes from all the active sites.

ratio

Type
uint32
Category
optional
Description
User can overide the individual GslbPoolMember ratio for all the VIPs/VS(es) of this site. If this field is not configured then the GslbPoolMember ratio gets applied.

IpAddr

addr

Type
string
Category
required
Description
IP address

type

Type
enum
Category
required
Description
Choices
V4, DNS

GslbGeoLocation

source

Type
enum
Category
optional
Description
This field describes the source of the GeoLocation.
Choices
GSLB_LOCATION_SRC_USER_CONFIGURED, GSLB_LOCATION_SRC_INHERIT_FROM_SITE, GSLB_LOCATION_SRC_FROM_GEODB

location

Type
GeoLocation
Category
optional
Description
Geographic location of the site.

GeoLocation

latitude

Type
float
Category
optional
Description
Latitude of the location.

longitude

Type
float
Category
optional
Description
Longitude of the location.

name

Type
string
Category
optional
Description
Location name in the format Country/State/City.

tag

Type
string
Category
optional
Description
Location tag string - example: USEast.

GslbHealthMonitorProxy

proxy_type

Type
enum
Category
optional
Description
This field identifies the health monitor proxy behavior. The designated site for health monitor proxy can monitor public or private or all the members of a given site.
Default
GSLB_HEALTH_MONITOR_PROXY_PRIVATE_MEMBERS
Choices
GSLB_HEALTH_MONITOR_PROXY_ALL_MEMBERS, GSLB_HEALTH_MONITOR_PROXY_PRIVATE_MEMBERS

site_uuid

Type
string
Category
optional
Description
This field identifies the site that will health monitor on behalf of the current site. i.e. it will be a health monitor proxy and monitor members of the current site.

GslbThirdPartySite

cluster_uuid

Type
string
Category
optional,readonly
Description
Third-party-site identifier generated by Avi.

name

Type
string
Category
optional
Description
Name of the third-party Site.

enabled

Type
bool
Category
optional
Description
Enable or disable the third-party Site. This is useful in maintenance scenarios such as upgrade and routine maintenance. A disabled site's configuration shall be retained but it will not get any new configuration updates. VIPs associated with the disabled site shall not be sent in DNS response.
Default
True

location

Type
GslbGeoLocation
Category
optional
Description
Geographic location of the site.

hm_proxies

Type
GslbHealthMonitorProxy
Category
repeated
Description
User can designate certain Avi sites to run health monitor probes for VIPs/VS(es) for this site. This is useful in network deployments where the VIPs/VS(es) are reachable only from certain sites. A typical scenario is a firewall between two GSLB sites. User may want to run health monitor probes from sites on either side of the firewall so that each designated site can derive a datapath view of the reachable members. If the health monitor proxies are not configured, then the default behavior is to run health monitor probes from all the active sites.

ratio

Type
uint32
Category
optional
Description
User can overide the individual GslbPoolMember ratio for all the VIPs of this site. If this field is not configured, then the GslbPoolMember ratio gets applied.

GslbClientIpAddrGroup

type

Type
enum
Category
optional
Description
Specify whether this client IP address range is public or private.
Default
GSLB_IP_PUBLIC
Choices
GSLB_IP_PUBLIC, GSLB_IP_PRIVATE

addrs

Type
IpAddr
Category
repeated
Description
Configure IP address(es)

ranges

Type
IpAddrRange
Category
repeated
Description
Configure IP address range(s)

prefixes

Type
IpAddrPrefix
Category
repeated
Description
Configure IP address prefix(es)

IpAddrRange

begin

Type
IpAddr
Category
required
Description
Starting IP address of the range

end

Type
IpAddr
Category
required
Description
Ending IP address of the range

IpAddrPrefix

ip_addr

Type
IpAddr
Category
required
Description

mask

Type
int32
Category
required
Description

References

Tenant

Sub Objects

GslbRuntimeInternal

API


    GET /api/gslb/&ltkey>/runtime/internal/&ltkey>

CLI


    show gslb &ltkey> internal

Data

GslbRuntimeInternal

info

Type
GslbRuntime
Category
optional
Description

GslbRuntime

uuid

Type
string
Category
optional
Description

name

Type
string
Category
optional
Description

ldr_state

Type
CfgState
Category
optional
Description

flr_state

Type
CfgState
Category
repeated
Description

dns_enabled

Type
bool
Category
optional
Description

site

Type
GslbSiteRuntime
Category
repeated
Description

event_cache

Type
EventCache
Category
optional
Description

third_party_sites

Type
GslbThirdPartySiteRuntime
Category
repeated
Description

CfgState

uuid

Type
string
Category
optional
Description
object-uuid that is being synced to follower.

cfg_version

Type
uint32
Category
optional
Description
cfg-version synced to follower.

cfg_version_in_flight

Type
uint32
Category
optional
Description
cfg-version in flight to follower.

status

Type
enum
Category
optional
Description
Status of the object.
Default
SYSERR_SUCCESS
Choices
SYSERR_SUCCESS, SYSERR_FAILURE, SYSERR_OUT_OF_MEMORY, SYSERR_NO_ENT, SYSERR_INVAL, SYSERR_ACCESS, SYSERR_FAULT, SYSERR_IO, SYSERR_TIMEOUT, SYSERR_NOT_SUPPORTED, SYSERR_NOT_READY, SYSERR_UPGRADE_IN_PROGRESS, SYSERR_WARM_START_IN_PROGRESS, SYSERR_TRY_AGAIN, SYSERR_BAD_REQUEST, SYSERR_TEST1, SYSERR_TEST2, SYSERR_QUEUE_TRANSPORT_FAILURE, SYSERR_QUEUE_RETRY_TASK, SYSERR_DATASTORE_TRANSPORT_FAILURE, SYSERR_DATASTORE_UNKNOWN_FAILURE, SYSERR_DATASTORE_OBJECT_DOES_NOT_EXIST, SYSERR_DATASTORE_REFERENCE_DOES_NOT_EXIST, SYSERR_DATASTORE_DB_LOCKED, SYSERR_DATASTORE_LOCK_FAILURE, SYSERR_DATASTORE_TBL_NOT_EXIST, SYSERR_SVC_COMMON_OBJECT_NOT_IN_CACHED_VIEW, SYSERR_RPC_CANCELED_BY_CLIENT, SYSERR_RPC_TIMED_OUT, SYSERR_RPC_SEND_FAILED, SYSERR_RPC_CANCELED_BY_TRANSACTION_CLEANUP, SYSERR_NO_MULTICAST_RECEIVERS, SYSERR_RPC_FAILED, SYSERR_RPC_CONNECT_FAILED, SYSERR_CONTROLLER_NOT_READY, SYSERR_VERSION_MISMATCH, SYSERR_INVALID_METHOD, SYSERR_DESERIALIZATION, SYSERR_SERIALIZATION, SYSERR_ENQUEUE, SYSERR_DEQUEUE, SYSERR_VS_INVALID_METHOD, SYSERR_VS_NOT_PRESENT, SYSERR_VS_INVALID_REQUEST, SYSERR_VS_NOT_ENOUGH_RESOURCES, SYSERR_VS_SE_NOT_AVAILABLE, SYSERR_VS_VNIC_FAILURE, SYSERR_VS_DELETE_WHILE_STILL_BEING_REFERRED, SYSERR_INVALID_HEALTH_MONITOR_TYPE, SYSERR_VS_SE_ASSIGNMENT_FAILED, SYSERR_VS_INVALID_OBJECT, SYSERR_VS_SERVICE_ENGINE_DOWN, SYSERR_VS_RPC_FAILURE, SYSERR_VS_NOT_BOUND, SYSERR_VS_DISABLED, SYSERR_VS_INTERNAL_ERROR, SYSERR_VS_SCALEOUT_ERROR, SYSERR_VS_SCALEIN_ERROR, SYSERR_VS_MIGRATE_ERROR, SYSERR_VS_MIGRATE_SCALEOUT_ERROR, SYSERR_VS_MIGRATE_SCALEIN_ERROR, SYSERR_VS_AWAIT_STATIC_SE, SYSERR_VS_MIN_SE_NOT_ASSIGNED, SYSERR_SE_MGR_VNIC_ALLOC_FAIL, SYSERR_SE_MGR_VNIC_NOT_FOUND, SYSERR_SE_MGR_UNKNOWN_SE, SYSERR_SE_MGR_UNKNOWN_STATE_TRANSITION, SYSERR_SE_MGR_SE_OFFLINE_HB_FAILURE, SYSERR_SE_UPGRADE_IN_PROGRESS, SYSERR_SE_NOT_CONNECTED, SYSERR_RM_RES_UNAVAIL, SYSERR_RM_RES_UNAVAIL_NOTIFY, SYSERR_RM_RES_NOT_INUSE, SYSERR_RM_CONSUMER_NOT_FOUND, SYSERR_RM_REACHABILITY_FAILED, SYSERR_RM_RELEASE_SE_UNAVAIL, SYSERR_RM_UNKNOWN_SE_GROUP, SYSERR_RM_NO_SE_FOUND, SYSERR_RM_PARTIAL_SE_FOUND, SYSERR_RM_AWAIT_VM_CREATE, SYSERR_RM_AWAIT_VNIC_ADD, SYSERR_RM_AWAIT_BOOTUP, SYSERR_RM_RESOURCE_NOT_FOUND, SYSERR_RM_CANNOT_SPAWN_SE, SYSERR_RM_RES_NOT_NEEDED, SYSERR_RM_RES_INFRA_DELETED, SYSERR_RM_RES_USER_DELETED, SYSERR_RM_RES_USER_REBOOTED, SYSERR_RM_RES_CRASHED, SYSERR_RM_RES_CONN_LOST, SYSERR_RM_RES_VIP_REACH_LOST, SYSERR_RM_VS_PROCESSING, SYSERR_RM_VNIC_IP_FAILURE, SYSERR_RM_STATIC_NO_POOL, SYSERR_RM_STATIC_POOL_EXHAUSTED, SYSERR_RM_VIP_MULT_NETWORKS, SYSERR_RM_SRVR_MULT_NETWORKS, SYSERR_RM_VIP_NO_NETWORK, SYSERR_RM_SRVR_NO_NETWORK, SYSERR_RM_MAX_PARALLEL_SE_CREATE, SYSERR_RM_MAX_SE_CREATE_ATTEMPTS, SYSERR_RM_MULT_SE_CRASH, SYSERR_RM_VS_SE_CREATE_IN_PROG, SYSERR_RM_VS_SE_BOOTUP_IN_PROG, SYSERR_RM_VS_SE_VNIC_ADD_IN_PROG, SYSERR_RM_VS_SE_VNIC_IP_IN_PROG, SYSERR_RM_NO_SUITABLE_HOST, SYSERR_RM_NO_SE_IN_SE_GRP, SYSERR_RM_ALL_SE_IN_SE_GRP_DOWN, SYSERR_RM_NO_SE_IN_SE_GRP_SRVR_ACC, SYSERR_RM_NO_SE_IN_SE_GRP_VIP_ACC, SYSERR_RM_ALL_SE_IN_SE_GRP_MAX_VS, SYSERR_RM_ALL_SE_IN_SE_GRP_NW_ACC_MAX_VS, SYSERR_RM_VIP_SE_NW_ACC, SYSERR_RM_VIP_SE_MAX_VS, SYSERR_RM_VIP_SE_GRP_MISMATCH, SYSERR_RM_VIP_SE_PENDING_OP, SYSERR_RM_MULT_MGMT_SUBNET, SYSERR_RM_MAX_SE_IN_GRP, SYSERR_RM_BOOTUP_FAILURE, SYSERR_RM_PENDING_VNIC_OP, SYSERR_RM_SE_MGMT_NO_STATIC_IPS_CONFIGURED, SYSERR_RM_SE_MGMT_STATIC_IPS_EXHAUSTED, SYSERR_RM_NO_MGMT_SUBNET, SYSERR_RM_MGMT_DHCP_FAILURE, SYSERR_RM_CANNOT_ADD_VNICS, SYSERR_RM_CONSUMER_RESOURCES_SATISFIED, SYSERR_RM_DATA_DHCP_FAILURE, SYSERR_RM_QUERY_HOST_IN_PROGRESS, SYSERR_RM_INSUFFICIENT_BUFFER_SE, SYSERR_RM_NO_DEFAULT_GW_SE_MGMT_NW, SYSERR_RM_PARENT_SE_NW_ACC, SYSERR_RM_PARENT_SE_MAX_VS, SYSERR_RM_PARENT_SE_GRP_MISMATCH, SYSERR_RM_DEF_GW_INCORRECT, SYSERR_RM_NETWORK_NOT_FOUND, SYSERR_RM_ALL_SE_IN_SE_GRP_USED, SYSERR_RM_SE_GRP_PENDING_OP, SYSERR_RM_ALL_SE_IN_SE_GRP_DISABLED, SYSERR_RM_VS_SE_PING_CHECK_IN_PROG, SYSERR_RM_CONSUMER_PENDING_TASK, SYSERR_RM_SE_GRP_VIP_NW_ACC, SYSERR_RM_SE_GRP_NW_ACC, SYSERR_RM_SE_GRP_MAX_VS, SYSERR_RM_ALL_SE_IN_SE_GRP_GW_DOWN, SYSERR_RM_SE_GW_DOWN, SYSERR_RM_SE_DISCONNECTED, SYSERR_VI_MGR_SEVM_VNIC_SUCCESS, SYSERR_VI_MGR_SEVM_CREATE_FAIL_NO_HW_INFO, SYSERR_VI_MGR_SEVM_CREATE_FAIL_DUPLICATE_NAME, SYSERR_VI_MGR_SEVM_CREATE_FAIL_NO_MGMT_NW, SYSERR_VI_MGR_SEVM_CREATE_FAIL_NO_CPU, SYSERR_VI_MGR_SEVM_CREATE_FAIL_NO_MEM, SYSERR_VI_MGR_SEVM_CREATE_FAIL_NO_LEASE, SYSERR_VI_MGR_SEVM_CREATE_FAIL_OVF_ERROR, SYSERR_VI_MGR_SEVM_CREATE_NO_HOST_VM_NETWORK, SYSERR_VI_MGR_SEVM_CREATE_FAIL_NO_PROGRESS, SYSERR_VI_MGR_SEVM_CREATE_FAIL_ABORTED, SYSERR_VI_MGR_SEVM_CREATE_FAILURE, SYSERR_VI_MGR_SEVM_CREATE_FAIL_POWER_ON, SYSERR_VI_MGR_SEVM_VNIC_NO_VM, SYSERR_VI_MGR_SEVM_VNIC_MAC_ADDR_ERROR, SYSERR_VI_MGR_SEVM_VNIC_FAILURE, SYSERR_VI_MGR_SEVM_VNIC_NO_PG_PORTS, SYSERR_VI_MGR_SEVM_DELETE_FAILURE, SYSERR_VI_MGR_SEVM_CREATE_LIMIT_REACHED, SYSERR_VI_MGR_SEVM_SET_MGMT_IP_FAILED, SYSERR_VI_MGR_SEVM_CREATE_ACCESS_ERROR, SYSERR_VI_MGR_SEVM_CREATE_NO_IMAGE, SYSERR_VI_MGR_SEVM_VINFRA_UNINITIALIZED, SYSERR_VI_MGR_SEVM_CREATE_NO_HOST, SYSERR_VI_MGR_SEVM_CREATE_FAIL_NO_MGMT_NW_PORTS, SYSERR_VI_MGR_SEVM_INVALID_DATA, SYSERR_VI_MGR_SEVM_CREATE_FAIL_MULTIPLE_MGMT_NW, SYSERR_VI_MGR_SEVM_VCENTER_CONN_FAIL, SYSERR_VI_MGR_SEVM_TIMED_OUT, SYSERR_VI_MGR_SEVM_NO_SOURCE_CLONE, SYSERR_VI_MGR_SEVM_NO_AVAILABILITY_ZONE, SYSERR_VI_MGR_SEVM_FLAVOR_UNAVAIL, SYSERR_VI_MGR_SEVM_DELETED, SYSERR_VI_MGR_SEVM_VINFRA_FAILURE, SYSERR_VI_MGR_SEVM_VNIC_FAILURE_QUESTION, SYSERR_VI_MGR_LOGIN_FAIL_NO_VCENTER, SYSERR_VI_MGR_LOGIN_FAIL_USER_CREDENTIALS, SYSERR_VI_MGR_VCENTER_VERSION_MISMATCH, SYSERR_DB_CACHE_TBL_NOT_FOUND, SYSERR_DB_CACHE_OBJ_NOT_FOUND, SYSERR_DB_QUERY_QUEUED, SYSERR_DB_QUERY_BATCHED, SYSERR_DB_UPDATE_FAILED, SYSERR_DB_QUERY_FAILED, SYSERR_OS_AGENT_Q_FULL, SYSERR_OS_AGENT_OPENSTACK_UNINITIALIZED, SYSERR_OS_AGENT_OPENSTACK_ACCESSERR, SYSERR_OS_AGENT_OPENSTACK_RESOURCEERR, SYSERR_OS_AGENT_TENANT_ABSENT, SYSERR_OS_AGENT_INVALID_DATA, SYSERR_CC_SVC_Q_FULL, SYSERR_CC_AGENT_UNINITIALIZED, SYSERR_CC_AGENT_ACCESSERR, SYSERR_CC_AGENT_RESOURCEERR, SYSERR_CC_AGENT_TENANT_ACCESSERR, SYSERR_CC_AGENT_TENANT_ABSENT, SYSERR_CC_SVC_INVALID_DATA, SYSERR_CC_OS_AGENT_NEUTRON_HOST_ACCESSERR, SYSERR_CC_NO_FLAVOR, SYSERR_CC_AGENT_ABSENT, SYSERR_CC_AGENT_CONFIG_FAILURE, SYSERR_CC_AGENT_DECONFIG_FAILURE, SYSERR_CC_AGENT_NON_INFRA_SEVM, SYSERR_MESOS_DISCOVERY_DEPLOYMENT_FAIL, SYSERR_MESOS_DISCOVERY_TIMEOUT, SYSERR_MARATHON_APP_TERMINATED, SYSERR_MARATHON_INACCESSIBLE, SYSERR_FLEET_API_ERROR, SYSERR_MESOS_SSH_CMD_TIMEOUT, SYSERR_MESOS_SSH_ABORTED, SYSERR_MESOS_SSH_FAILURE, SYSERR_MESOS_SSH_NOTFOUND, SYSERR_CC_AGENT_VNIC_NO_IPS_AVAILABLE, SYSERR_CC_AGENT_VNIC_NO_SUBNETWORK, SYSERR_CC_AGENT_VNIC_FAILURE, SYSERR_CC_AGENT_SCALE_IN_FAILED, SYSERR_CC_AGENT_DS_FAILED, SYSERR_CC_AGENT_NOT_IMPLEMENTED, SYSERR_CC_AGENT_METHOD_NOT_IMPLEMENTED, SYSERR_CC_AGENT_GENERIC_FAILURE, SYSERR_RUM_TOOMANYSAMPLES, SYSERR_METRICS_TOO_MANY_MSG, SYSERR_METRICS_TOO_MANY_MSG_ACROSS_ENTITIES, SYSERR_ANOMALYZER_NOT_ENOUGH_SAMPLES, SYSERR_AUTOSCALE_REASON_INTELLIGENT_AUTOSCALE, SYSERR_AUTOSCALE_REASON_CONFIG_UPDATE, SYSERR_AUTOSCALE_REASON_POOL_STATE_CHANGE, SYSERR_AUTOSCALE_REASON_ALERT, SYSERR_AUTOSCALEIN_FAILED_LIMIT_EXCEEDED, SYSERR_AUTOSCALEOUT_FAILED_LIMIT_EXCEEDED, SYSERR_AUTOSCALE_IGNORED_AS_WITHIN_COOLDOWN, SYSERR_AUTOSCALE_ORCHESTRATION_TIMEOUT, SYSERR_AUTOSCALE_REASON_NOT_ENOUGH_SERVERS, SYSERR_AUTOSCALE_REASON_TOO_MANY_SERVERS, SYSERR_AUTOSCALE_REASON_ORCHESTRATION_FAILED, SYSERR_AUTOSCALE_REASON_MANUAL, SYSERR_AUTOSCALE_POLICY_NOT_FOUND, SYSERR_SEAGENT_OBJ_INACTIVE, SYSERR_SEAGENT_OBJ_AWAITING_DP_PROGRAMMING, SYSERR_SEAGENT_OBJ_ACTIVE, SYSERR_SEAGENT_OBJ_GRAPHDB_ERROR, SYSERR_SEAGENT_OBJ_DP_ERROR, SYSERR_SEAGENT_OBJ_DISABLED_RULE_POOL, SYSERR_SEAGENT_EASTWEST_VS_SUBNET_ERROR, SYSERR_GSLB_INVALID_MTYPE, SYSERR_GSLB_INVALID_SITE_CREDENTIALS, SYSERR_GSLB_OBJECT_NOT_FOUND, SYSERR_GSLB_INVALID_OPS, SYSERR_GSLB_PARTIAL_SUCCESS, SYSERR_GSLB_FQDN_CONFLICT, SYSERR_GSLB_CLEANUP_IN_PROGRESS, SYSERR_GSLB_METHOD_NOP

reason

Type
string
Category
optional
Description

site_uuid

Type
string
Category
optional
Description
site_uuid to which the object was synced.

last_changed_time

Type
TimeStamp
Category
optional
Description

TimeStamp

secs

Type
Unknown
Category
required
Description

usecs

Type
Unknown
Category
required
Description

GslbSiteRuntime

site_info

Type
GslbSiteRuntimeInfo
Category
optional
Description

site_cfg

Type
GslbSiteRuntimeCfg
Category
optional
Description

site_stats

Type
GslbSiteRuntimeStats
Category
optional
Description

rxed_site_hs

Type
GslbSiteHealthStatus
Category
optional
Description

GslbSiteRuntimeInfo

cluster_uuid

Type
string
Category
optional
Description

name

Type
string
Category
optional
Description

role

Type
enum
Category
optional
Description
Site Role: Leader or Follower.
Default
GSLB_NOT_A_MEMBER
Choices
GSLB_LEADER, GSLB_MEMBER, GSLB_NOT_A_MEMBER

sw_version

Type
string
Category
optional
Description
Current Software version of the site
Default
Not-Initialized

oper_status

Type
OperationalStatus
Category
optional
Description

state

Type
enum
Category
optional
Description
Default
SITE_STATE_NULL
Choices
SITE_STATE_NULL, SITE_STATE_JOIN_IN_PROGRESS, SITE_STATE_LEAVE_IN_PROGRESS, SITE_STATE_INIT, SITE_STATE_UNREACHABLE, SITE_STATE_MMODE, SITE_STATE_DISABLE_IN_PROGRESS, SITE_STATE_DISABLED

state_reason

Type
string
Category
optional
Description
State - Reason

last_changed_time

Type
TimeStamp
Category
optional
Description

enabled

Type
bool
Category
optional
Description
Enable/disable state retrieved from the cfg

num_of_retries

Type
int32
Category
optional
Description
Number of retry attempts to reach the remote site
Default
0

cluster_leader

Type
string
Category
optional
Description
The Leader-IP/VIP/FQDN of the site-cluster

hs_state

Type
bool
Category
optional
Description
Health-status monitoring enable or disable

rrtoken

Type
string
Category
repeated
Description
Current outstanding request-response token of the message to this site

dns_info

Type
GslbDnsInfo
Category
optional
Description
operational dns state at the site

event_cache

Type
EventCache
Category
optional
Description
event-cache used for event throttling.

site_type

Type
enum
Category
optional
Description
Indicates if it is Avi Site or third-party.
Choices
GSLB_AVI_SITE, GSLB_THIRD_PARTY_SITE

OperationalStatus

state

Type
enum
Category
optional
Description
Choices
OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL

reason

Type
string
Category
repeated
Description

reason_code

Type
uint64
Category
optional
Description

last_changed_time

Type
TimeStamp
Category
optional
Description

reason_code_string

Type
string
Category
optional
Description

GslbDnsInfo

dns_active

Type
bool
Category
optional
Description
This field indicates that atleast one DNS is active at the site.

dns_vs_states

Type
GslbPerDnsState
Category
repeated
Description

se_table

Type
GslbDnsSeInfo
Category
repeated
Description
This tables holds all the se-related info across all DNS-VS(es).

gs_status

Type
GslbDnsGsStatus
Category
optional
Description
This field encapsulates the Gs-status edge-triggered framework.

retry_count

Type
uint32
Category
optional
Description
This field is used to track the retry attempts for SE download errors.

GslbPerDnsState

uuid

Type
string
Category
optional
Description
Configured dns-vs-uuid at the site.

name

Type
string
Category
optional
Description
Configured dns-vs-name at the site.

valid_dns_vs

Type
bool
Category
optional
Description
This field indicates that the local VS is configured to be a DNS service. The services, network profile and application profile are configured in Virtual Service for DNS operations.
Default
False

oper_status

Type
OperationalStatus
Category
optional
Description

se_list

Type
string
Category
repeated
Description
The service engines associated with the DNS-VS

gslb_download

Type
GslbDownloadStatus
Category
optional
Description
This field describes the Gslb, GslbService, GslbHealthMonitor download status to the dns-vs.

geo_download

Type
GslbDownloadStatus
Category
optional
Description
This field describes the GeoDbProfile download status to the dns-vs.

GslbDownloadStatus

state

Type
enum
Category
optional
Description
This field indicates the download state to a dns-vs(es) or a VS or a SE depending on the usage context.
Default
GSLB_DOWNLOAD_NONE
Choices
GSLB_DOWNLOAD_NONE, GSLB_DOWNLOAD_DONE, GSLB_DOWNLOAD_PENDING, GSLB_DOWNLOAD_ERROR

last_changed_time

Type
TimeStamp
Category
optional
Description

GslbDnsSeInfo

uuid

Type
string
Category
optional
Description
UUID of the service engine.

ip

Type
IpAddr
Category
optional
Description
Service engine's fabric IP used to push Geo files.

fd_download

Type
GslbDownloadStatus
Category
optional
Description
This field describes the fd download status to the SE.

fd_info

Type
ConfigInfo
Category
optional
Description
Geo files queue for sequencing files to SE.

ConfigInfo

state

Type
enum
Category
optional
Description
Choices
REPL_NONE, REPL_ENABLED, REPL_DISABLED

writer_count

Type
uint32
Category
optional
Description

reader_count

Type
uint32
Category
optional
Description

queue

Type
VersionInfo
Category
repeated
Description

VersionInfo

uuid

Type
string
Category
optional
Description

name

Type
string
Category
optional
Description

ops

Type
enum
Category
optional
Description
Choices
GSLB_NONE, GSLB_CREATE, GSLB_UPDATE, GSLB_DELETE, GSLB_PURGE, GSLB_DECL

GslbDnsGsStatus

type

Type
enum
Category
optional
Description
Describes the type (partial/full) of the last GS status sent to Dns-VS(es).
Choices
GSLB_NO_UPDATE, GSLB_FULL_UPDATE, GSLB_PARTIAL_UPDATE

last_changed_time

Type
TimeStamp
Category
optional
Description

state

Type
enum
Category
optional
Description
State variable to trigger full or partial update
Choices
GSLB_FULL_UPDATE_PENDING, GSLB_PARTIAL_UPDATE_PENDING

num_partial_updates

Type
uint32
Category
optional
Description
Counter to track the number of partial updates sent. Once it reaches the partial updates threshold, a full update is sent.

partial_update_threshold

Type
uint32
Category
optional
Description
Threshold after which a full GS Status is sent.
Default
10

EventCache

dns_state

Type
bool
Category
optional
Description

exceptions

Type
string
Category
repeated
Description
Cache the exception strings in the system

GslbSiteRuntimeCfg

glb_info

Type
ConfigInfo
Category
optional
Description
Gslb info published for a site

ghm_info

Type
ConfigInfo
Category
optional
Description
GHM info published for a site

gs_info

Type
ConfigInfo
Category
optional
Description
GS info published for a site

mm_info

Type
ConfigInfo
Category
optional
Description
Maintenance mode info published for a site

gap_info

Type
ConfigInfo
Category
optional
Description
Gslb Application Persistence info published for a site

geo_info

Type
ConfigInfo
Category
optional
Description
Gslb GeoDb info published for a site

fd_info

Type
ConfigInfo
Category
optional
Description
Gslb GeoDb files published for a site

sync_info

Type
GslbSiteCfgSyncInfo
Category
optional
Description
Configuration sync-info of the site

GslbSiteCfgSyncInfo

sync_state

Type
enum
Category
optional
Description
Configuration sync-state of the site
Choices
GSLB_SITE_CFG_IN_SYNC, GSLB_SITE_CFG_OUT_OF_SYNC, GSLB_SITE_CFG_SYNC_DISABLED, GSLB_SITE_CFG_SYNC_IN_PROGRESS, GSLB_SITE_CFG_SYNC_NOT_APPLICABLE

last_changed_time

Type
TimeStamp
Category
optional
Description

errored_objects

Type
VersionInfo
Category
repeated
Description
Objects that could NOT be synced to the site

GslbSiteRuntimeStats

num_glb_cr_txed

Type
uint32
Category
optional
Description

num_glb_cr_rxed

Type
uint32
Category
optional
Description

num_glb_del_txed

Type
uint32
Category
optional
Description

num_glb_del_rxed

Type
uint32
Category
optional
Description

num_glb_upd_txed

Type
uint32
Category
optional
Description

num_glb_upd_rxed

Type
uint32
Category
optional
Description

num_gs_cr_txed

Type
uint32
Category
optional
Description

num_gs_cr_rxed

Type
uint32
Category
optional
Description

num_gs_del_txed

Type
uint32
Category
optional
Description

num_gs_del_rxed

Type
uint32
Category
optional
Description

num_gs_upd_txed

Type
uint32
Category
optional
Description

num_gs_upd_rxed

Type
uint32
Category
optional
Description

num_ghm_cr_txed

Type
uint32
Category
optional
Description

num_ghm_cr_rxed

Type
uint32
Category
optional
Description

num_ghm_del_txed

Type
uint32
Category
optional
Description

num_ghm_del_rxed

Type
uint32
Category
optional
Description

num_ghm_upd_txed

Type
uint32
Category
optional
Description

num_ghm_upd_rxed

Type
uint32
Category
optional
Description

num_health_msgs_txed

Type
uint32
Category
optional
Description

num_health_msgs_rxed

Type
uint32
Category
optional
Description

num_of_timeouts

Type
uint32
Category
optional
Description

num_of_events_generated

Type
uint32
Category
optional
Description

num_of_bad_responses

Type
uint32
Category
optional
Description

num_of_skip_outstanding_requests

Type
uint32
Category
optional
Description

num_geo_cr_txed

Type
uint32
Category
optional
Description

num_geo_cr_rxed

Type
uint32
Category
optional
Description

num_geo_del_txed

Type
uint32
Category
optional
Description

num_geo_del_rxed

Type
uint32
Category
optional
Description

num_geo_upd_txed

Type
uint32
Category
optional
Description

num_geo_upd_rxed

Type
uint32
Category
optional
Description

num_gap_cr_txed

Type
uint32
Category
optional
Description

num_gap_cr_rxed

Type
uint32
Category
optional
Description

num_gap_del_txed

Type
uint32
Category
optional
Description

num_gap_del_rxed

Type
uint32
Category
optional
Description

num_gap_upd_txed

Type
uint32
Category
optional
Description

num_gap_upd_rxed

Type
uint32
Category
optional
Description

num_file_cr_txed

Type
uint32
Category
optional
Description

num_file_del_txed

Type
uint32
Category
optional
Description

GslbSiteHealthStatus

timestamp

Type
float
Category
optional
Description
Timestamp of Health-Status generation

sw_version

Type
string
Category
optional
Description
Current Software version of the site

dns_info

Type
GslbDnsInfo
Category
optional
Description
DNS info at the site

controller_gsinfo

Type
GslbPoolMemberRuntimeInfo
Category
repeated
Description
Controller retrieved GSLB service operational info based of virtual service state.

datapath_gsinfo

Type
GslbPoolMemberRuntimeInfo
Category
repeated
Description
Controller retrieved GSLB service operational info based of dns datapath resolution. This information is generated only on those sites that have DNS-VS participating in GSLB.

glb_table

Type
CfgState
Category
repeated
Description
GSLB state at member

ghm_table

Type
CfgState
Category
repeated
Description
GSLB health monitor state at member

gs_table

Type
CfgState
Category
repeated
Description
GSLB service state at member

geo_table

Type
CfgState
Category
repeated
Description
GSLB Geo Db profile state at member

gap_table

Type
CfgState
Category
repeated
Description
GSLB application persistence profile state at member

GslbPoolMemberRuntimeInfo

gs_uuid

Type
string
Category
optional
Description
The GSLB service to which this member belongs

gs_name

Type
string
Category
optional
Description

cluster_uuid

Type
string
Category
optional
Description
The Site Controller Cluster UUID to which this member belongs

site_name

Type
string
Category
optional
Description
The Site 's name is required for event-generation etc

vs_uuid

Type
string
Category
optional
Description
VS UUID belonging to this GSLB service

vs_name

Type
string
Category
optional
Description
VS name belonging to this GSLB service

fqdn

Type
string
Category
optional
Description
FQDN address of the member.

ip

Type
IpAddr
Category
optional
Description
GSLB pool member's configured VIP.

oper_ips

Type
IpAddr
Category
repeated
Description
Operational VIPs of the member: that can map to multiple VS IP addresses such as private, public and floating addresses.

vip_type

Type
enum
Category
optional
Description
Describes the VIP type: Avi or third-party.
Choices
NON_AVI_VIP, AVI_VIP

services

Type
Service
Category
repeated
Description
services configured on the virtual service.

ip_value_to_se

Type
uint32
Category
optional
Description
This is an internal field that conveys the IP address from the controller to service engine in binary format.

oper_status

Type
OperationalStatus
Category
optional
Description
Pool member's consolidated operational status

controller_status

Type
OperationalStatus
Category
optional
Description
Controller retrieved member status at the site

datapath_status

Type
GslbPoolMemberDatapathStatus
Category
repeated
Description
DNS computed member status from different sites

vserver_l4_metrics

Type
VserverL4MetricsObj
Category
optional
Description
Front end L4 metrics of the virtual service

vserver_l7_metrics

Type
VserverL7MetricsObj
Category
optional
Description
Front end L7 metrics of the virtual service

Service

port

Type
uint32
Category
required
Description
The Virtual Service's port number.

enable_ssl

Type
bool
Category
optional
Description
Enable SSL termination and offload for traffic from clients.
Default
False

override_network_profile_ref

Type
Reference to NetworkProfile
Category
optional
Description
Override the network profile for this specific service port.

port_range_end

Type
uint32
Category
optional
Description
The end of the Virtual Service's port number range.
Default
0

GslbPoolMemberDatapathStatus

site_uuid

Type
string
Category
optional
Description

oper_status

Type
OperationalStatus
Category
optional
Description

location

Type
GeoLocation
Category
optional
Description

VserverL4MetricsObj

node_obj_id

Type
string
Category
required
Description

sum_dup_ack_retransmits

Type
Unknown
Category
optional
Description
Total duplicate ACK retransmits across all connections

sum_sack_retransmits

Type
Unknown
Category
optional
Description
Total SACK retransmits across all connections

sum_timeout_retransmits

Type
Unknown
Category
optional
Description
Total connection timeouts in the interval

sum_out_of_orders

Type
Unknown
Category
optional
Description
Total out of order packets across all connections

avg_syns

Type
Unknown
Category
optional
Description
Total syncs sent across all connections

avg_new_established_conns

Type
Unknown
Category
optional
Description
Averaged rate of new client connections per second.

sum_finished_conns

Type
Unknown
Category
optional
Description
Total number of finished connections

max_open_conns

Type
Unknown
Category
optional
Description
Max number of open connections

sum_connections_dropped

Type
Unknown
Category
optional
Description
Total connections dropped including failed

avg_rx_pkts

Type
Unknown
Category
optional
Description
Average rate of packets received per second

avg_rx_bytes

Type
Unknown
Category
optional
Description
Average rate of bytes received per second

avg_tx_pkts

Type
Unknown
Category
optional
Description
Average rate of packets transmitted per second

avg_tx_bytes

Type
Unknown
Category
optional
Description
Average rate of bytes transmitted per second

sum_end_to_end_rtt_bucket1

Type
Unknown
Category
optional
Description
Total connections that have RTT values from 0 to RTT threshold

sum_end_to_end_rtt_bucket2

Type
Unknown
Category
optional
Description
Total connections that have RTT values RTT threshold and above

sum_conn_duration

Type
Unknown
Category
optional
Description
Total duration across all connections

sum_zero_window_size_events

Type
Unknown
Category
optional
Description
Total number of zero window size events across all connections

sum_server_flow_control

Type
Unknown
Category
optional
Description
Total number of connections with server flow control condition

sum_end_to_end_rtt

Type
Unknown
Category
optional
Description
Sum of end to end network RTT experienced by end clients. Higher value would increase response times experienced by clients.

avg_bandwidth

Type
Unknown
Category
optional
Description
Average transmit and receive network bandwidth between client and virtual service.

sum_lossy_connections

Type
Unknown
Category
optional
Description
Total connections that were lossy due to high packet retransmissions.

sum_lossy_req

Type
Unknown
Category
optional
Description
Total requests that were lossy due to high packet retransmissions.

sum_connection_errors

Type
Unknown
Category
optional
Description
Total number of client network connections that were lossy or dropped.

pct_connection_errors

Type
Unknown
Category
optional
Description
Percent of l4 connection dropped and lossy for virtual service

avg_total_rtt

Type
Unknown
Category
optional
Description
Average network round trip time between client and virtual service

sum_rtt_valid_connections

Type
Unknown
Category
optional
Description
Total number connections used for rtt

apdexc

Type
Unknown
Category
optional
Description
apdex measuring quality of network connections to servers

apdexrtt

Type
Unknown
Category
optional
Description
apdex measuring network connection quality based on RTT

avg_complete_conns

Type
Unknown
Category
optional
Description
Rate of total connections per second

avg_lossy_connections

Type
Unknown
Category
optional
Description
Rate of lossy connections per second

avg_connections_dropped

Type
Unknown
Category
optional
Description
Rate of dropped connections per second

avg_errored_connections

Type
Unknown
Category
optional
Description
Rate of total errored connections per second

avg_policy_drops

Type
Unknown
Category
optional
Description
Rate of total connections dropped due to VS policy per second. It includes drops due to rate limits, security policy drops, connection limits etc.

max_rx_pkts_absolute

Type
Unknown
Category
optional
Description
Total number of received frames

max_rx_bytes_absolute

Type
Unknown
Category
optional
Description
Total number of received bytes

max_tx_pkts_absolute

Type
Unknown
Category
optional
Description
Total number of transmitted frames

max_tx_bytes_absolute

Type
Unknown
Category
optional
Description
Total number of transmitted bytes

sum_connection_dropped_user_limit

Type
Unknown
Category
optional
Description
Total number of connection dropped due to vserver connection limit

sum_packet_dropped_user_bandwidth_limit

Type
Unknown
Category
optional
Description
Total number of packets dropped due to vserver bandwidth limit

avg_l4_client_latency

Type
Unknown
Category
optional
Description
Average L4 connection duration which does not include client RTT

avg_dos_syn_flood

Type
Unknown
Category
optional
Description
DoS attack: Rate of Syn Floods

avg_dos_bad_rst_flood

Type
Unknown
Category
optional
Description
DoS attack: Rate of Bad Rst Floods

avg_dos_malformed_flood

Type
Unknown
Category
optional
Description
DoS attack: Rate of Malformed Packet Floods

avg_dos_fake_session

Type
Unknown
Category
optional
Description
DoS attack: Rate of Fake Sessions

avg_dos_zero_window_stress

Type
Unknown
Category
optional
Description
DoS attack: Rate of Zero Window Stresses

avg_dos_small_window_stress

Type
Unknown
Category
optional
Description
DoS attack: Rate of Small Window Stresses

avg_dos_http_timeout

Type
Unknown
Category
optional
Description
DoS attack: Rate of HTTP Timeouts

avg_dos_http_error

Type
Unknown
Category
optional
Description
DoS attack: Rate of HTTP Errors

avg_dos_http_abort

Type
Unknown
Category
optional
Description
DoS attack: Rate of HTTP Aborts

avg_dos_ssl_error

Type
Unknown
Category
optional
Description
DoS attack: Rate of HTTP SSL Errors

avg_dos_app_error

Type
Unknown
Category
optional
Description
DoS attack: Rate of HTTP App Errors

avg_network_dos_attacks

Type
Unknown
Category
optional
Description
Number of Network DDOS attacks occurring

avg_application_dos_attacks

Type
Unknown
Category
optional
Description
Number of Application DDOS attacks occurring

avg_dos_rx_bytes

Type
Unknown
Category
optional
Description
Average rate of bytes received per second related to DDoS attack

avg_dos_tx_bytes

Type
Unknown
Category
optional
Description
Average rate of bytes transmitted per second related to DDoS attack

avg_dos_bandwidth

Type
Unknown
Category
optional
Description
Average transmit and receive network bandwidth between client and virtual service related to DDoS attack.

avg_dos_total_req

Type
Unknown
Category
optional
Description
Total number of request used for L7 dos requests normalization

avg_dos_req

Type
Unknown
Category
optional
Description
Number of request considered as DoS

avg_dos_conn

Type
Unknown
Category
optional
Description
Number of connections considered as DoS

pct_dos_rx_bytes

Type
Unknown
Category
optional
Description
Percentage of received bytes as part of a DoS attack.

pct_dos_bandwidth

Type
Unknown
Category
optional
Description
DoS bandwidth percentage.

pct_network_dos_attacks

Type
Unknown
Category
optional
Description
Deprecated

pct_application_dos_attacks

Type
Unknown
Category
optional
Description
Fraction of L7 requests owing to DoS.

pct_policy_drops

Type
Unknown
Category
optional
Description
Fraction of L4 requests dropped owing to policy.

pct_connections_dos_attacks

Type
Unknown
Category
optional
Description
Fraction of L4 connections owing to DoS.

pct_pkts_dos_attacks

Type
Unknown
Category
optional
Description
Fraction of packets owing to DoS.

avg_dos_non_syn_flood

Type
Unknown
Category
optional
Description
DoS attack: Non SYN packet flood

avg_dos_slow_uri

Type
Unknown
Category
optional
Description
DoS attack: Slow Uri

avg_dos_conn_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Connections dropped due to VS rate limit

avg_dos_req_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to VS rate limit

avg_dos_conn_ip_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Connections dropped due to IP rate limit

avg_dos_req_ip_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to IP rate limit

avg_dos_req_uri_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to URL rate limit

avg_dos_req_ip_uri_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to IP+URL rate limit

avg_dos_req_ip_rl_drop_bad

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to IP rate limit for bad requests

avg_dos_req_uri_rl_drop_bad

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to URL rate limit for bad requests

avg_dos_req_ip_uri_rl_drop_bad

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to IP+URL rate limit for bad requests

avg_dos_req_ip_scan_bad_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to bad IP rate limit

avg_dos_req_ip_scan_unknown_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to unknown IP rate limit

avg_dos_req_uri_scan_bad_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to bad URL rate limit

avg_dos_req_uri_scan_unknown_rl_drop

Type
Unknown
Category
optional
Description
DoS attack: Requests dropped due to unknown URL rate limit

avg_rx_pkts_dropped

Type
Unknown
Category
optional
Description
Average rate of received packets dropped per second

avg_rx_bytes_dropped

Type
Unknown
Category
optional
Description
Average rate of received bytes dropped per second

avg_lossy_req

Type
Unknown
Category
optional
Description
Averaged rate of lossy request per second.

avg_pkts_policy_drops

Type
Unknown
Category
optional
Description
Averaged rate of dropped packets per second due to policy

avg_bytes_policy_drops

Type
Unknown
Category
optional
Description
Averaged rate bytes dropped per second.

avg_total_connections

Type
Unknown
Category
optional
Description
Averaged rate bytes dropped per second.

max_num_active_se

Type
Unknown
Category
optional
Description
Max number of SEs.

avg_dos_attacks

Type
Unknown
Category
optional
Description
Number DDOS attacks occurring

VserverL7MetricsObj

node_obj_id

Type
string
Category
required
Description

sum_get_reqs

Type
Unknown
Category
optional
Description
Total number of HTTP GET requests

sum_post_reqs

Type
Unknown
Category
optional
Description
Total number of HTTP POST requests

sum_other_reqs

Type
Unknown
Category
optional
Description
Total number of HTTP requests that are not GET or POST requests

sum_finished_sessions

Type
Unknown
Category
optional
Description
Number of server sessions closed in this interval

sum_reqs_finished_sessions

Type
Unknown
Category
optional
Description
Total number of requests served across server sessions closed in the interval

max_concurrent_sessions

Type
Unknown
Category
optional
Description
Maximum number of concurrent HTTP sessions

avg_reqs_per_session

Type
Unknown
Category
optional
Description
Average requests per session measured for closed sessions

sum_resp_1xx

Type
Unknown
Category
optional
Description
Total number of HTTP 1XX responses

avg_resp_1xx

Type
Unknown
Category
optional
Description
Rate of 1xx HTTP responses sent per second

sum_resp_2xx

Type
Unknown
Category
optional
Description
Total number of HTTP 2XX responses

avg_resp_2xx

Type
Unknown
Category
optional
Description
Rate of 2xx HTTP responses sent per second

sum_resp_3xx

Type
Unknown
Category
optional
Description
Total number of HTTP 3XX responses

avg_resp_3xx

Type
Unknown
Category
optional
Description
Rate of 3xx HTTP responses sent per second

sum_resp_4xx

Type
Unknown
Category
optional
Description
Total number of HTTP 4XX error responses

avg_resp_4xx

Type
Unknown
Category
optional
Description
Rate of 4xx HTTP responses sent per second

avg_resp_4xx_avi_errors

Type
Unknown
Category
optional
Description
Rate of 4xx HTTP responses as errors sent by avi. It does not include any error codes excluded in the analytics profile and pool server errors

sum_resp_5xx

Type
Unknown
Category
optional
Description
Total number of HTTP 5XX error responses

avg_resp_5xx

Type
Unknown
Category
optional
Description
Rate of 5xx HTTP responses sent per second

avg_resp_5xx_avi_errors

Type
Unknown
Category
optional
Description
Rate of 5xx HTTP responses as errors sent by avi. It does not include any error codes excluded in the analytics profile and pool server errors

sum_errors

Type
Unknown
Category
optional
Description
Count of HTTP 400 and 500 errors for a virtual service in a time interval.

avg_error_responses

Type
Unknown
Category
optional
Description
Rate of HTTP error responses sent per second. It does not include errors excluded in analytics profile.

avg_errors_excluded

Type
Unknown
Category
optional
Description
Rate of HTTP responses excluded as errors based on analytics profile

pct_response_errors

Type
Unknown
Category
optional
Description
Percent of 4xx and 5xx responses

sum_get_client_txn_latency_bucket1

Type
Unknown
Category
optional
Description
Total number of HTTP GET requests that were responded satisfactorily within latency threshold

sum_get_client_txn_latency_bucket2

Type
Unknown
Category
optional
Description
Total number of HTTP GET requests that were responded beyond latency threshold but within tolerated limits

sum_post_client_txn_latency_bucket1

Type
Unknown
Category
optional
Description
Total number of HTTP POST requests that were responded satisfactorily within latency threshold

sum_post_client_txn_latency_bucket2

Type
Unknown
Category
optional
Description
Total number of HTTP POST requests that were responded beyond latency threshold but within tolerated limits

sum_other_client_txn_latency_bucket1

Type
Unknown
Category
optional
Description
Total number of HTTP requests other than GET or POST that were responded satisfactorily within latency threshold

sum_other_client_txn_latency_bucket2

Type
Unknown
Category
optional
Description
Total number of HTTP requests other than GET or POST that were responded beyond latency threshold but within tolerated limits

avg_total_requests

Type
Unknown
Category
optional
Description
Average rate of client HTTP requests received by the virtual service per second.

sum_total_responses

Type
Unknown
Category
optional
Description
Total number of HTTP responses sent

avg_complete_responses

Type
Unknown
Category
optional
Description
Rate of HTTP responses sent per second

avg_cache_hits

Type
Unknown
Category
optional
Description
Average cache hit of requests

avg_cache_bytes

Type
Unknown
Category
optional
Description
Average cache bytes

avg_cacheable_hits

Type
Unknown
Category
optional
Description
Average cacheable hit of requests

avg_cacheable_bytes

Type
Unknown
Category
optional
Description
Average cacheable bytes

pct_cache_hits

Type
Unknown
Category
optional
Description
Percentage cache hit of requests

pct_cacheable_hits

Type
Unknown
Category
optional
Description
Percentage cacheable hit of requests

avg_pre_compression_bytes

Type
Unknown
Category
optional
Description
Average pre compression bytes

avg_post_compression_bytes

Type
Unknown
Category
optional
Description
Average post compression bytes

apdexr

Type
Unknown
Category
optional
Description
Client Apdex measures quality of server response based on latency

sum_get_client_txn_latency

Type
Unknown
Category
optional
Description
Total latency from responses to all the GET requests

sum_post_client_txn_latency

Type
Unknown
Category
optional
Description
Total latency from responses to all the POST requests

sum_other_client_txn_latency

Type
Unknown
Category
optional
Description
Total latency from responses to all the requests other than GET or POST

avg_client_txn_latency

Type
Unknown
Category
optional
Description
Average client transaction latency computed by adding response latencies across all HTTP requests.

sum_client_data_transfer_time

Type
Unknown
Category
optional
Description
Average client data transfer time computed by adding response latencies across all HTTP requests.

avg_client_data_transfer_time

Type
Unknown
Category
optional
Description
Average client data transfer time that represents latency of sending response to the client excluding the RTT time . Higher client data transfer time signifies lower bandwidth between client and Avi Service Engine

sum_redirection_time

Type
Unknown
Category
optional
Description
Total redirect latency reported by client

sum_dns_lookup_time

Type
Unknown
Category
optional
Description
Total domain lookup latency reported by client

sum_connection_time

Type
Unknown
Category
optional
Description
Total client connection latency reported by client

sum_blocking_time

Type
Unknown
Category
optional
Description
Total time client was blocked

sum_application_response_time

Type
Unknown
Category
optional
Description
Total time taken by server to respond to requesti

sum_server_rtt

Type
Unknown
Category
optional
Description
Sum of all server Round Trip Times for all samples

sum_client_rtt

Type
Unknown
Category
optional
Description
Sum of all client Round Trip Times for all samples

sum_service_time

Type
Unknown
Category
optional
Description
Total time from receipt of request to start of response

sum_page_download_time

Type
Unknown
Category
optional
Description
Total time to transfer response to client

sum_browser_rendering_time

Type
Unknown
Category
optional
Description
Total browser rendering latency reported by client

sum_dom_content_load_time

Type
Unknown
Category
optional
Description
Total dom content latency reported by client

sum_page_load_time

Type
Unknown
Category
optional
Description
Total Page Load Time reported by client

sum_num_page_load_time_bucket1

Type
Unknown
Category
optional
Description
Total samples that had satisfactory page load time

sum_num_page_load_time_bucket2

Type
Unknown
Category
optional
Description
Total samples that had tolerated page load time

sum_waiting_time

Type
Unknown
Category
optional
Description
Total waiting reported by client

sum_num_rum_samples

Type
Unknown
Category
optional
Description
Total samples used for rum metrics

sum_rum_client_data_transfer_time

Type
Unknown
Category
optional
Description
Total client data transfer time by client

avg_redirection_time

Type
Unknown
Category
optional
Description
Average redirect latency reported by client

avg_dns_lookup_time

Type
Unknown
Category
optional
Description
Average domain lookup latency reported by client

avg_connection_time

Type
Unknown
Category
optional
Description
Average client connection latency reported by client

avg_blocking_time

Type
Unknown
Category
optional
Description
Average time client was blocked as reported by client

avg_server_rtt

Type
Unknown
Category
optional
Description
Average server Round Trip Time

avg_client_rtt

Type
Unknown
Category
optional
Description
Average client Round Trip Time

avg_application_response_time

Type
Unknown
Category
optional
Description
Average server/application response latency

avg_browser_rendering_time

Type
Unknown
Category
optional
Description
Average browser rendering latency

avg_service_time

Type
Unknown
Category
optional
Description
Average latency from receipt of request to start of response

avg_page_download_time

Type
Unknown
Category
optional
Description
Average Page Load time reported by clients

avg_dom_content_load_time

Type
Unknown
Category
optional
Description
Average Dom content Load Time reported by clients

avg_page_load_time

Type
Unknown
Category
optional
Description
Average Page Load Time reported by client

avg_waiting_time

Type
Unknown
Category
optional
Description
Average Waiting Time reported by client

avg_rum_client_data_transfer_time

Type
Unknown
Category
optional
Description
Total client data transfer time by client

rum_apdexr

Type
Unknown
Category
optional
Description
Apdex measures quality of server response based on Real User Metric

avg_ssl_handshakes_new

Type
Unknown
Category
optional
Description
Average new successful SSL sessions

avg_ssl_handshakes_reused

Type
Unknown
Category
optional
Description
Average new successful resumed SSL sessions

avg_ssl_handshake_protocol_errors

Type
Unknown
Category
optional
Description
Average SSL handshake failed due to clients or protocol errors

avg_ssl_handshake_network_errors

Type
Unknown
Category
optional
Description
Average SSL handshakes failed due to network errors

avg_ssl_handshakes_timedout

Type
Unknown
Category
optional
Description
Average SSL handshakes timed out

avg_ssl_errors

Type
Unknown
Category
optional
Description
Average SSL errors due to clients, protocol errors,network errors and handshake timeouts

max_ssl_open_sessions

Type
Unknown
Category
optional
Description
Maximum number of open SSL sessions

avg_ssl_ver_ssl30

Type
Unknown
Category
optional
Description
Average SSL Sessions with version 3.0

avg_ssl_ver_tls10

Type
Unknown
Category
optional
Description
Average SSL Sessions with TLS version 1.0

avg_ssl_ver_tls11

Type
Unknown
Category
optional
Description
Average SSL Sessions with TLS version 1.1

avg_ssl_ver_tls12

Type
Unknown
Category
optional
Description
Average SSL Sessions with TLS version 1.2

avg_ssl_auth_rsa

Type
Unknown
Category
optional
Description
Average SSL Sessions using RSA certificate

avg_ssl_auth_ecdsa

Type
Unknown
Category
optional
Description
Average SSL Sessions using Elliptic Curve DSA (ECDSA) certificates

avg_ssl_auth_dsa

Type
Unknown
Category
optional
Description
Average SSL Sessions using DSA certificate

avg_ssl_connections

Type
Unknown
Category
optional
Description
Average SSL Sessions

avg_ssl_failed_connections

Type
Unknown
Category
optional
Description
Average SSL connections failed due to protocol , network or timeout reasons

pct_ssl_failed_connections

Type
Unknown
Category
optional
Description
Percent of SSL connections failured due to protocol , network or timeout reasons

avg_satisfactory_responses

Type
Unknown
Category
optional
Description
Avg number of HTTP requests that completed within satisfactory latency

avg_tolerated_responses

Type
Unknown
Category
optional
Description
Avg number of HTTP requests that completed within tolerated latency

avg_frustrated_responses

Type
Unknown
Category
optional
Description
Avg number of HTTP requests that completed within frustrated latency

avg_ssl_kx_rsa

Type
Unknown
Category
optional
Description
Average SSL Exchanges using RSA

avg_ssl_kx_dh

Type
Unknown
Category
optional
Description
Average SSL Exchanges using Diffie-Hellman

avg_ssl_kx_ecdh

Type
Unknown
Category
optional
Description
Average SSL Exchanges using RSA

avg_ssl_rsa_pfs

Type
Unknown
Category
optional
Description
Average SSL Exchanges using RSA Cerificates and PFS

avg_ssl_handshakes_pfs

Type
Unknown
Category
optional
Description
Average SSL Exchanges using PFS

ssl_protocol_strength

Type
Unknown
Category
optional
Description
Protocol strength of SSL ciphers used.

avg_ssl_rsa_non_pfs

Type
Unknown
Category
optional
Description
Average SSL Exchanges using RSA Cerificates without PFS

avg_ssl_ecdsa_pfs

Type
Unknown
Category
optional
Description
Average SSL Exchanges using EC Cerificates and PFS

avg_ssl_ecdsa_non_pfs

Type
Unknown
Category
optional
Description
Average SSL Exchanges using EC Cerificates without PFS

avg_ssl_handshakes_non_pfs

Type
Unknown
Category
optional
Description
Average SSL Exchanges using Non-PFS

GslbThirdPartySiteRuntime

site_info

Type
GslbSiteRuntimeInfo
Category
optional
Description

GslbRuntimeDetail

API


    GET /api/gslb/&ltkey>/runtime/detail/&ltkey>
	Query Params: GlbParamsFilter

CLI


    show gslb &ltkey> detail filter [site_name]

Data

GslbRuntimeDetail

info

Type
GslbRuntime
Category
optional
Description

GslbRuntimeSummary

API


    GET /api/gslb/&ltkey>/runtime/&ltkey>

CLI


    show gslb &ltkey> summary

Data

GslbRuntimeSummary

info

Type
GslbRuntime
Category
optional
Description

Filters

GlbParamsFilter

site_name

Type
string
Category
optional
Description