VirtualService
Description
API
POST /api/virtualservice
PUT /api/virtualservice/<key>
DELETE /api/virtualservice/<key>
GET /api/virtualservice
GET /api/virtualservice/<key>
CLI
configure virtualservice <key>
show virtualservice <key>
Examples
To create a basic virtualservice object that has both http and https enabled
POST /api/virtualservice
{
"services": [
{
"port": 80
},
{
"enable_ssl": true,
"port": 443
}
],
"vip": [
{
"ip_address": {
"type": "V4",
"addr": "10.10.2.28"
}
}
],
"name": "production_vs"
}
Create a basic virtualservice object that requires IP to be auto-allocated and DNS record to be registered. @Assumptions: - This example assumes the virtualservice being created is part of a Cloud with Infoblox as IPAM & DNS provider - On Infoblox server - "10.10.10.0/24" is configured for VIPs - "prod.corp" is configured as zone
POST /api/virtualservice
{
"vip": [
{
"auto_allocate_ip": true,
"ipam_network_subnet": {
"subnet": {
"mask": 24,
"ip_addr": {
"type": "V4",
"addr": "10.10.10.0"
}
}
}
}
],
"name": "production_vs",
"fqdn": "production_vs.prod.corp"
}
Create a basic virtualservice object that requires IP to be auto-allocated and DNS record to be registered. @Assumptions: - This example assumes the virtualservice being created is part of a Cloud with Internal IPAM & DNS provider - On Avi - Network object containing free IPs from "10.10.10.0/24" is already created - "prod.corp" is configured as a domain name in DNS provider config in Avi
POST /api/virtualservice
{
"vip": [
{
"auto_allocate_ip": true,
"ipam_network_subnet": {
"subnet": {
"mask": 24,
"ip_addr": {
"type": "V4",
"addr": "10.10.10.0"
}
},
"network_ref": "/api/network/network-042975ea-376d-4e59-b8da-1b299be51eb1"
}
}
],
"name": "production_vs",
"fqdn": "production_vs.prod.corp"
}
Data
VirtualService
uuid
- Type
- string
- Category
- required
- Description
- UUID of the VirtualService.
name
- Type
- string
- Category
- required
- Description
- Name for the Virtual Service.
fqdn
- Type
- string
- Category
- optional
- Description
- DNS resolvable, fully qualified domain name of the virtualservice. Only one of 'fqdn' and 'dns_info' configuration is allowed.
ip_address
- Type
- IpAddr
- Category
- optional
- Description
- IP Address of the Virtual Service.
enabled
- Type
- bool
- Category
- optional
- Description
- Enable or disable the Virtual Service.
- Default
- True
services
- Type
- Service
- Category
- repeated
- Description
- List of Services defined for this Virtual Service.
application_profile_ref
- Type
- Reference to ApplicationProfile
- Category
- optional
- Description
- Enable application layer specific features for the Virtual Service.
- Default
- /api/applicationprofile?name=System-HTTP
network_profile_ref
- Type
- Reference to NetworkProfile
- Category
- optional
- Description
- Determines network settings such as protocol, TCP or UDP, and related options for the protocol.
- Default
- /api/networkprofile?name=System-TCP-Proxy
server_network_profile_ref
- Type
- Reference to NetworkProfile
- Category
- optional
- Description
- Determines the network settings profile for the server side of TCP proxied connections. Leave blank to use the same settings as the client to VS side of the connection.
pool_ref
- Type
- Reference to Pool
- Category
- optional
- Description
- The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.
se_group_ref
- Type
- Reference to ServiceEngineGroup
- Category
- optional
- Description
- The Service Engine Group to use for this Virtual Service. Moving to a new SE Group is disruptive to existing connections for this VS.
network_security_policy_ref
- Type
- Reference to NetworkSecurityPolicy
- Category
- optional
- Description
- Network security policies for the Virtual Service.
http_policies
- Type
- HTTPPolicies
- Category
- repeated
- Description
- HTTP Policies applied on the data traffic of the Virtual Service
dns_policies
- Type
- DnsPolicies
- Category
- repeated
- Description
- DNS Policies applied on the dns traffic of the Virtual Service
ssl_key_and_certificate_refs
- Type
- Reference to SSLKeyAndCertificate
- Category
- repeated
- Description
- Select or create one or two certificates, EC and/or RSA, that will be presented to SSL/TLS terminated connections.
ssl_profile_ref
- Type
- Reference to SSLProfile
- Category
- optional
- Description
- Determines the set of SSL versions and ciphers to accept for SSL/TLS terminated connections.
performance_limits
- Type
- PerformanceLimits
- Category
- optional
- Description
- Optional settings that determine performance limits like max connections or bandwdith etc.
analytics_policy
- Type
- AnalyticsPolicy
- Category
- optional
- Description
- Determines analytics settings for the application.
network_ref
- Type
- Reference to Network
- Category
- optional
- Description
- Manually override the network on which the Virtual Service is placed.
vrf_context_ref
- Type
- Reference to VrfContext
- Category
- optional
- Description
- Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to.
enable_autogw
- Type
- bool
- Category
- optional
- Description
- Response traffic to clients will be sent back to the source MAC address of the connection, rather than statically sent to a default gateway.
- Default
- True
port_uuid
- Type
- string
- Category
- optional
- Description
- (internal-use) Network port assigned to the Virtual Service IP address.
subnet_uuid
- Type
- string
- Category
- optional
- Description
- It represents subnet for the Virtual Service IP address allocation when auto_allocate_ip is True.It is only applicable in OpenStack or AWS cloud. This field is required if auto_allocate_ip is True.
analytics_profile_ref
- Type
- Reference to AnalyticsProfile
- Category
- optional
- Description
- Specifies settings related to analytics.
- Default
- /api/analyticsprofile?name=System-Analytics-Profile
discovered_network_ref
- Type
- Reference to Network
- Category
- repeated
- Description
- (internal-use) Discovered networks providing reachability for client facing Virtual Service IP. This field is deprecated.
discovered_subnet
- Type
- IpAddrPrefix
- Category
- repeated
- Description
- (internal-use) Discovered subnets providing reachability for client facing Virtual Service IP. This field is deprecated.
host_name_xlate
- Type
- string
- Category
- optional
- Description
- Translate the host name sent to the servers to this value. Translate the host name sent from servers back to the value used by the client.
subnet
- Type
- IpAddrPrefix
- Category
- optional
- Description
- Subnet providing reachability for client facing Virtual Service IP.
discovered_networks
- Type
- DiscoveredNetwork
- Category
- repeated
- Description
- (internal-use) Discovered networks providing reachability for client facing Virtual Service IP. This field is used internally by Avi, not editable by the user.
vs_datascripts
- Type
- VSDataScripts
- Category
- repeated
- Description
- Datascripts applied on the data traffic of the Virtual Service
client_auth
- Type
- HTTPClientAuthenticationParams
- Category
- optional
- Description
- HTTP authentication configuration for protected resources.
weight
- Type
- uint32
- Category
- optional
- Description
- The Quality of Service weight to assign to traffic transmitted from this Virtual Service. A higher weight will prioritize traffic versus other Virtual Services sharing the same Service Engines.
- Default
- 1
delay_fairness
- Type
- bool
- Category
- optional
- Description
- Select the algorithm for QoS fairness. This determines how multiple Virtual Services sharing the same Service Engines will prioritize traffic over a congested network.
- Default
- False
max_cps_per_client
- Type
- uint32
- Category
- optional
- Description
- Maximum connections per second per client IP.
- Default
- 0
limit_doser
- Type
- bool
- Category
- optional
- Description
- Limit potential DoS attackers who exceed max_cps_per_client significantly to a fraction of max_cps_per_client for a while.
- Default
- False
type
- Type
- enum
- Category
- optional
- Description
- Specify if this is a normal Virtual Service, or if it is the parent or child of an SNI-enabled virtual hosted Virtual Service.
- Default
- VS_TYPE_NORMAL
- Choices
- VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD
vh_parent_vs_ref
- Type
- Reference to VirtualService
- Category
- optional
- Description
- Specifies the Virtual Service acting as Virtual Hosting (SNI) parent.
vh_domain_name
- Type
- string
- Category
- repeated
- Description
- The exact name requested from the client's SNI-enabled TLS hello domain name field. If this is a match, the parent VS will forward the connection to this child VS.
availability_zone
- Type
- string
- Category
- optional
- Description
- Availability-zone to place the Virtual Service.
auto_allocate_ip
- Type
- bool
- Category
- optional
- Description
- Auto-allocate VIP from the provided subnet.
- Default
- False
floating_ip
- Type
- IpAddr
- Category
- optional
- Description
- Floating IP to associate with this Virtual Service.
auto_allocate_floating_ip
- Type
- bool
- Category
- optional
- Description
- Auto-allocate floating/elastic IP from the Cloud infrastructure.
- Default
- False
floating_subnet_uuid
- Type
- string
- Category
- optional
- Description
- If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. This field is applicable only if the VirtualService belongs to an OpenStack or AWS cloud. In OpenStack or AWS cloud it is required when auto_allocate_floating_ip is selected.
cloud_type
- Type
- enum
- Category
- optional
- Description
- Default
- CLOUD_NONE
- Choices
- CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S
avi_allocated_vip
- Type
- bool
- Category
- optional
- Description
- (internal-use) VIP allocated by Avi in the Cloud infrastructure.
- Default
- False
avi_allocated_fip
- Type
- bool
- Category
- optional
- Description
- (internal-use) FIP allocated by Avi in the Cloud infrastructure.
- Default
- False
connections_rate_limit
- Type
- RateProfile
- Category
- optional
- Description
- Rate limit the incoming connections to this virtual service
requests_rate_limit
- Type
- RateProfile
- Category
- optional
- Description
- Rate limit the incoming requests to this virtual service
use_bridge_ip_as_vip
- Type
- bool
- Category
- optional
- Description
- Use Bridge IP as VIP on each Host in Mesos deployments
- Default
- False
flow_dist
- Type
- enum
- Category
- optional
- Description
- Criteria for flow distribution among SEs.
- Default
- LOAD_AWARE
- Choices
- LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT
ign_pool_net_reach
- Type
- bool
- Category
- optional
- Description
- Ignore Pool servers network reachability constraints for Virtual Service placement.
- Default
- False
ssl_sess_cache_avg_size
- Type
- uint32
- Category
- optional
- Description
- Expected number of SSL session cache entries (may be exceeded).
- Default
- 1024
pool_group_ref
- Type
- Reference to PoolGroup
- Category
- optional
- Description
- The pool group is an object that contains pools.
remove_listening_port_on_vs_down
- Type
- bool
- Category
- optional
- Description
- Remove listening port if VirtualService is down
- Default
- False
description
- Type
- string
- Category
- optional
- Description
tenant_ref
- Type
- Reference to Tenant
- Category
- required
- Description
cloud_ref
- Type
- Reference to Cloud
- Category
- optional,readonly
- Description
- Default
- /api/cloud?name=Default-Cloud
east_west_placement
- Type
- bool
- Category
- optional
- Description
- Force placement on all SE's in service group (Mesos mode only)
- Default
- False
scaleout_ecmp
- Type
- bool
- Category
- optional
- Description
- Disable re-distribution of flows across service engines for a virtual service. Enable if the network itself performs flow hashing with ECMP in environments such as GCP
- Default
- False
microservice_ref
- Type
- Reference to MicroService
- Category
- optional
- Description
- Microservice representing the virtual service
service_pool_select
- Type
- ServicePoolSelector
- Category
- repeated
- Description
- Select pool based on destination port
created_by
- Type
- string
- Category
- optional
- Description
- Creator name
cloud_config_cksum
- Type
- string
- Category
- optional
- Description
- Checksum of cloud configuration for VS. Internally set by cloud connector
enable_rhi
- Type
- bool
- Category
- optional
- Description
- Enable Route Health Injection using the BGP Config in the vrf context
snat_ip
- Type
- IpAddr
- Category
- repeated
- Description
- NAT'ted floating source IP Address(es) for upstream connection to servers
active_standby_se_tag
- Type
- enum
- Category
- optional
- Description
- This configuration only applies if the VirtualService is in Legacy Active Standby HA mode and Load Distribution among Active Standby is enabled. This field is used to tag the VirtualService so that VirtualServices with the same tag will share the same Active ServiceEngine. VirtualServices with different tags will have different Active ServiceEngines. If one of the ServiceEngine's in the ServiceEngineGroup fails, all VirtualServices will end up using the same Active ServiceEngine. Redistribution of the VirtualServices can be either manual or automated when the failed ServiceEngine recovers. Redistribution is based on the auto redistribute property of the ServiceEngineGroup.
- Default
- ACTIVE_STANDBY_SE_1
- Choices
- ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2
flow_label_type
- Type
- enum
- Category
- optional
- Description
- Criteria for flow labelling.
- Default
- NO_LABEL
- Choices
- NO_LABEL, SERVICE_LABEL
enable_rhi_snat
- Type
- bool
- Category
- optional
- Description
- Enable Route Health Injection for Source NAT'ted floating IP Address using the BGP Config in the vrf context
static_dns_records
- Type
- DnsRecord
- Category
- repeated
- Description
- List of static DNS records applied to this Virtual Service. These are static entries and no health monitoring is performed against the IP addresses.
ipam_network_subnet
- Type
- IPNetworkSubnet
- Category
- optional
- Description
- Subnet and/or Network for allocating VirtualService IP by IPAM Provider module.
dns_info
- Type
- DnsInfo
- Category
- repeated
- Description
- Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Note that only one of fqdn and dns_info setting is allowed.
service_metadata
- Type
- string
- Category
- optional
- Description
- Metadata pertaining to the Service provided by this virtual service. In Openshift/Kubernetes environments, egress pod info is stored. Any user input to this field will be overwritten by Avi Vantage.
traffic_clone_profile_ref
- Type
- Reference to TrafficCloneProfile
- Category
- optional
- Description
- Server network or list of servers for cloning traffic.
content_rewrite
- Type
- ContentRewriteProfile
- Category
- optional
- Description
- Profile used to match and rewrite strings in request and/or response body.
sideband_profile
- Type
- SidebandProfile
- Category
- optional
- Description
- Sideband configuration to be used for this virtualservice.It can be used for sending traffic to sideband VIPs for external inspection etc.
vip
- Type
- Vip
- Category
- repeated
- Description
- List of Virtual Service IPs. While creating a 'Shared VS',please use vsvip_ref to point to the shared entities.
nsx_securitygroup
- Type
- string
- Category
- repeated
- Description
- A list of NSX Service Groups representing the Clients which can access the Virtual IP of the Virtual Service
vsvip_ref
- Type
- Reference to VsVip
- Category
- optional
- Description
- Mostly used during the creation of Shared VS, this fieldrefers to entities that can be shared across Virtual Services.
IpAddr
addr
- Type
- string
- Category
- required
- Description
- IP address
type
- Type
- enum
- Category
- required
- Description
- Choices
- V4, DNS
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
HTTPPolicies
index
- Type
- int32
- Category
- required
- Description
- Index of the virtual service HTTP policy collection
http_policy_set_ref
- Type
- Reference to HTTPPolicySet
- Category
- required
- Description
- UUID of the virtual service HTTP policy collection
DnsPolicies
index
- Type
- uint32
- Category
- optional
- Description
- Index of the dns policy
dns_policy_ref
- Type
- Reference to DnsPolicy
- Category
- optional
- Description
- UUID of the dns policy
AnalyticsPolicy
full_client_logs
- Type
- FullClientLogs
- Category
- optional
- Description
client_log_filters
- Type
- ClientLogFilter
- Category
- repeated
- Description
client_insights
- Type
- enum
- Category
- optional
- Description
- Gain insights from sampled client to server HTTP requests and responses.
- Default
- ACTIVE
- Choices
- NO_INSIGHTS, PASSIVE, ACTIVE
metrics_realtime_update
- Type
- MetricsRealTimeUpdate
- Category
- optional
- Description
- Settings to turn on realtime metrics and set duration for realtime updates
client_insights_sampling
- Type
- ClientInsightsSampling
- Category
- optional
- Description
FullClientLogs
enabled
- Type
- bool
- Category
- required
- Description
- Capture all client logs including connections and requests. When disabled, only errors will be logged.
- Default
- False
duration
- Type
- uint32
- Category
- optional
- Description
- How long should the system capture all logs, measured in minutes. Set to 0 for infinite.
- Units
- min
- Default
- 30
all_headers
- Type
- bool
- Category
- optional
- Description
- Log all headers.
- Default
- False
ClientLogFilter
index
- Type
- uint32
- Category
- required
- Description
name
- Type
- string
- Category
- required
- Description
client_ip
- Type
- IpAddrMatch
- Category
- optional
- Description
all_headers
- Type
- bool
- Category
- optional
- Description
- Default
- False
uri
- Type
- StringMatch
- Category
- optional
- Description
enabled
- Type
- bool
- Category
- required
- Description
- Default
- False
duration
- Type
- uint32
- Category
- optional
- Description
- Units
- min
- Default
- 30
IpAddrMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for IP address matching the HTTP request
- Choices
- IS_IN, IS_NOT_IN
addrs
- Type
- IpAddr
- Category
- repeated
- Description
- IP address(es)
ranges
- Type
- IpAddrRange
- Category
- repeated
- Description
- IP address range(s)
prefixes
- Type
- IpAddrPrefix
- Category
- repeated
- Description
- IP address prefix(es)
group_refs
- Type
- Reference to IpAddrGroup
- Category
- repeated
- Description
- UUID of IP address group(s)
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
StringMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for string matching the HTTP request
- Choices
- BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH
match_str
- Type
- string
- Category
- repeated
- Description
- String value(s)
string_group_refs
- Type
- Reference to StringGroup
- Category
- repeated
- Description
- UUID of the string group(s)
MetricsRealTimeUpdate
enabled
- Type
- bool
- Category
- required
- Description
- Enables real time metrics collection. When disabled, 6 hour view is the most granular the system will track.
- Default
- False
duration
- Type
- uint32
- Category
- optional
- Description
- Real time metrics collection duration in minutes. 0 for infinite.
- Units
- min
- Default
- 30
ClientInsightsSampling
skip_uris
- Type
- StringMatch
- Category
- optional
- Description
- URL patterns to avoid when inserting RUM script.
sample_uris
- Type
- StringMatch
- Category
- optional
- Description
- URL patterns to check when inserting RUM script.
client_ip
- Type
- IpAddrMatch
- Category
- optional
- Description
- Client IP addresses to check when inserting RUM script.
DiscoveredNetwork
network_ref
- Type
- Reference to Network
- Category
- required
- Description
- Discovered network for this IP.
subnet
- Type
- IpAddrPrefix
- Category
- repeated
- Description
- Discovered subnet for this IP.
VSDataScripts
index
- Type
- int32
- Category
- required
- Description
- Index of the virtual service datascript collection
vs_datascript_set_ref
- Type
- Reference to VSDataScriptSet
- Category
- required
- Description
- UUID of the virtual service datascript collection
HTTPClientAuthenticationParams
type
- Type
- enum
- Category
- optional
- Description
- type of client authentication
- Choices
- HTTP_BASIC_AUTH
request_uri_path
- Type
- StringMatch
- Category
- optional
- Description
- Rrequest URI path when the authentication applies
auth_profile_ref
- Type
- Reference to AuthProfile
- Category
- optional
- Description
- Auth Profile to use for validating users
realm
- Type
- string
- Category
- optional
- Description
- Basic authentication realm to present to a user along with the prompt for credentials.
RateProfile
count
- Type
- int32
- Category
- optional
- Description
- Maximum number of connections or requests or packets
- Default
- 0
burst_sz
- Type
- int32
- Category
- optional
- Description
- Maximum number of connections or requests or packets to be let through instantaneously
- Default
- 0
period
- Type
- int32
- Category
- optional
- Description
- Time value in seconds to enforce rate count
- Units
- sec
- Default
- 1
explicit_tracking
- Type
- bool
- Category
- optional
- Description
- Explicitly tracks an attacker across rate periods
- Default
- False
fine_grain
- Type
- bool
- Category
- optional
- Description
- Enable fine granularity
- Default
- False
action
- Type
- RateLimiterAction
- Category
- optional
- Description
- Action to perform upon rate limiting
http_header
- Type
- string
- Category
- optional
- Description
- HTTP header name.
http_cookie
- Type
- string
- Category
- optional
- Description
- HTTP cookie name.
RateLimiterAction
type
- Type
- enum
- Category
- optional
- Description
- Type of action to be enforced upon hitting the rate limit.
- Default
- RL_ACTION_NONE
- Choices
- RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT
redirect
- Type
- HTTPRedirectAction
- Category
- optional
- Description
- Parameters for HTTP Redirect rate limit action.
status_code
- Type
- enum
- Category
- optional
- Description
- HTTP status code for Local Response rate limit action.
- Default
- HTTP_LOCAL_RESPONSE_STATUS_CODE_429
- Choices
- HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429
file
- Type
- HTTPLocalFile
- Category
- optional
- Description
- File to be used for HTTP Local response rate limit action.
HTTPRedirectAction
protocol
- Type
- enum
- Category
- required
- Description
- Protocol type
- Choices
- HTTP, HTTPS
host
- Type
- URIParam
- Category
- optional
- Description
- Host config
port
- Type
- uint32
- Category
- optional
- Description
- Port to which redirect the request
path
- Type
- URIParam
- Category
- optional
- Description
- Path config
keep_query
- Type
- bool
- Category
- optional
- Description
- Keep or drop the query of the incoming request URI in the redirected URI
- Default
- True
status_code
- Type
- enum
- Category
- optional
- Description
- HTTP redirect status code
- Default
- HTTP_REDIRECT_STATUS_CODE_302
- Choices
- HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307
URIParam
type
- Type
- enum
- Category
- required
- Description
- URI param type
- Choices
- URI_PARAM_TYPE_TOKENIZED
tokens
- Type
- URIParamToken
- Category
- repeated
- Description
- Token config either for the URI components or a constant string
URIParamToken
type
- Type
- enum
- Category
- required
- Description
- Token type for constructing the URI
- Choices
- URI_TOKEN_TYPE_HOST, URI_TOKEN_TYPE_PATH, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_REGEX
start_index
- Type
- uint32
- Category
- optional
- Description
- Index of the starting token in the incoming URI
end_index
- Type
- uint32
- Category
- optional
- Description
- Index of the ending token in the incoming URI
str_value
- Type
- string
- Category
- optional
- Description
- Constant string to use as a token
HTTPLocalFile
content_type
- Type
- string
- Category
- required
- Description
- Mime-type of the content in the file.
file_content
- Type
- string
- Category
- required
- Description
- File content to used in the local HTTP response body.
ServicePoolSelector
service_port
- Type
- uint32
- Category
- required
- Description
- Pool based destination port
service_pool_ref
- Type
- Reference to Pool
- Category
- optional
- Description
service_protocol
- Type
- enum
- Category
- optional
- Description
- Destination protocol to match for the pool selection. If not specified, it will match any protocol.
- Choices
- PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH
service_pool_group_ref
- Type
- Reference to PoolGroup
- Category
- optional
- Description
DnsRecord
fqdn
- Type
- string
- Category
- repeated
- Description
- Fully Qualified Domain Name
type
- Type
- enum
- Category
- required
- Description
- DNS record type
- Choices
- DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY
ttl
- Type
- uint32
- Category
- optional
- Description
- Time To Live for this DNS record
ip_address
- Type
- DnsARdata
- Category
- repeated
- Description
- IP address in A record
service_locator
- Type
- DnsSrvRdata
- Category
- repeated
- Description
- Service locator info in SRV record
cname
- Type
- DnsCnameRdata
- Category
- optional
- Description
- Canonical name in CNAME record
ns
- Type
- DnsNsRdata
- Category
- repeated
- Description
- Name Server information in NS record
num_records_in_response
- Type
- uint32
- Category
- optional
- Description
- Specifies the number of records returned by the DNS service. Enter 0 to return all records. Default is 0
- Default
- 0
algorithm
- Type
- enum
- Category
- optional
- Description
- Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is round-robin.
- Default
- DNS_RECORD_RESPONSE_ROUND_ROBIN
- Choices
- DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH
wildcard_match
- Type
- bool
- Category
- optional
- Description
- Enable wild-card match of fqdn: if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false.
- Default
- False
delegated
- Type
- bool
- Category
- optional
- Description
- Configured FQDNs are delegated domains (i.e. they represent a zone cut).
- Default
- False
description
- Type
- string
- Category
- optional
- Description
- Details of DNS record
DnsARdata
ip_address
- Type
- IpAddr
- Category
- required
- Description
- IP address for fqdn
DnsSrvRdata
priority
- Type
- uint32
- Category
- optional
- Description
- Priority of the target hosting the service, low value implies higher priority for this service record
- Default
- 0
weight
- Type
- uint32
- Category
- optional
- Description
- Relative weight for service records with same priority, high value implies higher preference for this service record
- Default
- 0
target
- Type
- string
- Category
- optional
- Description
- Canonical hostname, of the machine hosting the service, with no trailing period. 'default.host' is valid but not 'default.host.'
- Default
- default.host
port
- Type
- uint32
- Category
- required
- Description
- Service port
DnsCnameRdata
cname
- Type
- string
- Category
- required
- Description
- Canonical name
DnsNsRdata
nsname
- Type
- string
- Category
- required
- Description
- Name Server name
ip_address
- Type
- IpAddr
- Category
- optional
- Description
- IP address for Name Server
IPNetworkSubnet
network_ref
- Type
- Reference to Network
- Category
- optional
- Description
- Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured.
subnet
- Type
- IpAddrPrefix
- Category
- optional
- Description
- Subnet for VirtualService IP allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed.
subnet_uuid
- Type
- string
- Category
- optional
- Description
- Subnet UUID or Name or Prefix for VirtualService IP allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed.
DnsInfo
fqdn
- Type
- string
- Category
- optional
- Description
- Fully qualified domain name.
ttl
- Type
- uint32
- Category
- optional
- Description
- Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided.
type
- Type
- enum
- Category
- optional
- Description
- DNS record type
- Default
- DNS_RECORD_A
- Choices
- DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY
num_records_in_response
- Type
- uint32
- Category
- optional
- Description
- Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0
- Default
- 1
algorithm
- Type
- enum
- Category
- optional
- Description
- Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is consistent hash.
- Default
- DNS_RECORD_RESPONSE_CONSISTENT_HASH
- Choices
- DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH
ContentRewriteProfile
rewritable_content_ref
- Type
- Reference to StringGroup
- Category
- optional
- Description
- Rewrite only content types listed in this string group. Content types not present in this list are not rewritten.
- Default
- /api/stringgroup?name=System-Rewritable-Content-Types
request_rewrite_enabled
- Type
- bool
- Category
- optional
- Description
- Enable rewrite on request body.
- Default
- False
response_rewrite_enabled
- Type
- bool
- Category
- optional
- Description
- Enable rewrite on response body.
- Default
- False
req_match_replace_pair
- Type
- MatchReplacePair
- Category
- repeated
- Description
- Strings to be matched and replaced with on the request body.
rsp_match_replace_pair
- Type
- MatchReplacePair
- Category
- repeated
- Description
- Strings to be matched and replaced with on the response body.
MatchReplacePair
match_string
- Type
- string
- Category
- optional
- Description
- String to be matched.
replacement_string
- Type
- ReplaceStringVar
- Category
- optional
- Description
- Replacement string.
ReplaceStringVar
type
- Type
- enum
- Category
- optional
- Description
- Type of replacement string - can be a variable exposed from datascript, value of an HTTP header or a custom user-input literal string.
- Choices
- DATASCRIPT_VAR, HTTP_HEADER_VAR, LITERAL_STRING
val
- Type
- string
- Category
- optional
- Description
- Value of the replacement string - name of variable exposed from datascript, name of the HTTP header or a custom user-input literal string.
SidebandProfile
ip
- Type
- IpAddr
- Category
- repeated
- Description
- IP Address of the sideband server.
sideband_max_request_body_size
- Type
- int32
- Category
- optional
- Description
- Maximum size of the request body that will be sent on the sideband.
- Default
- 1024
Vip
vip_id
- Type
- string
- Category
- optional
- Description
- Unique ID associated with the vip.
ip_address
- Type
- IpAddr
- Category
- optional
- Description
- IP Address of the Vip.
enabled
- Type
- bool
- Category
- optional
- Description
- Enable or disable the Vip.
- Default
- True
network_ref
- Type
- Reference to Network
- Category
- optional
- Description
- Manually override the network on which the Vip is placed.
port_uuid
- Type
- string
- Category
- optional
- Description
- (internal-use) Network port assigned to the Vip IP address.
subnet_uuid
- Type
- string
- Category
- optional
- Description
- If auto_allocate_ip is True, then the subnet for the Vip IP address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected.
subnet
- Type
- IpAddrPrefix
- Category
- optional
- Description
- Subnet providing reachability for client facing Vip IP.
discovered_networks
- Type
- DiscoveredNetwork
- Category
- repeated
- Description
- Discovered networks providing reachability for client facing Vip IP.
availability_zone
- Type
- string
- Category
- optional
- Description
- Availability-zone to place the Virtual Service.
auto_allocate_ip
- Type
- bool
- Category
- optional
- Description
- Auto-allocate VIP from the provided subnet.
- Default
- False
floating_ip
- Type
- IpAddr
- Category
- optional
- Description
- Floating IP to associate with this Vip.
auto_allocate_floating_ip
- Type
- bool
- Category
- optional
- Description
- Auto-allocate floating/elastic IP from the Cloud infrastructure.
- Default
- False
floating_subnet_uuid
- Type
- string
- Category
- optional
- Description
- If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation.
avi_allocated_vip
- Type
- bool
- Category
- optional
- Description
- (internal-use) VIP allocated by Avi in the Cloud infrastructure.
- Default
- False
avi_allocated_fip
- Type
- bool
- Category
- optional
- Description
- (internal-use) FIP allocated by Avi in the Cloud infrastructure.
- Default
- False
ipam_network_subnet
- Type
- IPNetworkSubnet
- Category
- optional
- Description
- Subnet and/or Network for allocating VirtualService IP by IPAM Provider module.
Actions
API
POST /api/virtualservice/<key>/switchover
CLI
switchover virtualservice <key>
Data
VsSwitchoverParams
se_uuid
- Type
- string
- Category
- optional
- Description
vip_id
- Type
- string
- Category
- optional
- Description
- Default
API
POST /api/virtualservice/<key>/migrate
CLI
migrate virtualservice <key>
Data
API
POST /api/virtualservice/<key>/retryplacement
CLI
retryplacement virtualservice <key>
Data
RetryPlacementParams
vip_id
- Type
- string
- Category
- optional
- Description
- Indicates the vip_id that needs placement retrial
API
POST /api/virtualservice/<key>/scalein
CLI
scalein virtualservice <key>
Data
VsScaleinParams
from_se_ref
- Type
- Reference to ServiceEngine
- Category
- optional
- Description
scalein_primary
- Type
- bool
- Category
- optional
- Description
admin_down
- Type
- bool
- Category
- optional
- Description
- Default
- False
vip_id
- Type
- string
- Category
- optional
- Description
- Default
API
POST /api/virtualservice/<key>/resync
CLI
resync virtualservice <key>
Data
API
POST /api/virtualservice/<key>/rotatekeys
CLI
rotatekeys virtualservice <key>
API
POST /api/virtualservice/<key>/apicplacement
CLI
apicplacement virtualservice <key>
Data
ApicVSPlacementReq
vdev
- Type
- string
- Category
- optional
- Description
graph
- Type
- string
- Category
- optional
- Description
tenant_name
- Type
- string
- Category
- optional
- Description
lifs
- Type
- Lif
- Category
- repeated
- Description
vgrp
- Type
- string
- Category
- optional
- Description
network_rel
- Type
- APICNetworkRel
- Category
- repeated
- Description
Lif
lif
- Type
- string
- Category
- optional
- Description
lif_label
- Type
- string
- Category
- optional
- Description
subnet
- Type
- string
- Category
- optional
- Description
cifs
- Type
- Cif
- Category
- repeated
- Description
Cif
cif
- Type
- string
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
mac_address
- Type
- string
- Category
- optional
- Description
adapter
- Type
- string
- Category
- optional
- Description
resources
- Type
- string
- Category
- repeated
- Description
APICNetworkRel
rel_key
- Type
- string
- Category
- optional
- Description
connector
- Type
- string
- Category
- optional
- Description
target_network
- Type
- string
- Category
- optional
- Description
API
POST /api/virtualservice/<key>/scaleout
CLI
scaleout virtualservice <key>
Data
VsScaleoutParams
to_se_ref
- Type
- Reference to ServiceEngine
- Category
- optional
- Description
to_new_se
- Type
- bool
- Category
- optional
- Description
- Default
- False
to_host_ref
- Type
- Reference to VIMgrHostRuntime
- Category
- optional
- Description
admin_up
- Type
- bool
- Category
- optional
- Description
- Default
- False
new_vcpus
- Type
- uint32
- Category
- optional
- Description
vip_id
- Type
- string
- Category
- optional
- Description
- Default
References
PoolGroup
Network
SSLProfile
TrafficCloneProfile
VSDataScriptSet
MicroService
AuthProfile
VrfContext
DnsPolicy
VsVip
AnalyticsProfile
ApplicationProfile
Tenant
HTTPPolicySet
VirtualService
SSLKeyAndCertificate
StringGroup
NetworkProfile
ServiceEngineGroup
IpAddrGroup
NetworkSecurityPolicy
Pool
Cloud
Sub Objects
VsDosStatRuntime
API
CLI
show virtualservice <key> dosstat filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [cps_doser_ip] [cps_doser_mask] [cps_doser_end_ip]
Data
VsDosStatRuntime
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
syn_flood
- Type
- uint32
- Category
- required
- Description
bad_rst_flood
- Type
- uint32
- Category
- required
- Description
malformed_flood
- Type
- uint32
- Category
- required
- Description
fake_session
- Type
- uint32
- Category
- required
- Description
zero_window_stress
- Type
- uint32
- Category
- required
- Description
small_window_stress
- Type
- uint32
- Category
- required
- Description
dos_http_timeout
- Type
- uint32
- Category
- required
- Description
dos_http_error
- Type
- uint32
- Category
- required
- Description
dos_http_abort
- Type
- uint32
- Category
- required
- Description
dos_ssl_error
- Type
- uint32
- Category
- required
- Description
dos_app_error
- Type
- uint32
- Category
- required
- Description
non_syn_flood
- Type
- uint32
- Category
- optional
- Description
slow_uri
- Type
- uint32
- Category
- optional
- Description
dos_conn_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_req_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_conn_ip_rl_drop
- Type
- uint32
- Category
- optional
- Description
cps_likely_doser_stats
- Type
- CpsDoserStats
- Category
- optional
- Description
cps_vlikely_doser_stats
- Type
- CpsDoserStats
- Category
- optional
- Description
num_untracked_cps_dosers
- Type
- uint64
- Category
- optional
- Description
dos_req_ip_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_req_uri_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_req_ip_uri_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_req_ip_rl_drop_bad
- Type
- uint32
- Category
- optional
- Description
dos_req_uri_rl_drop_bad
- Type
- uint32
- Category
- optional
- Description
dos_req_ip_uri_rl_drop_bad
- Type
- uint32
- Category
- optional
- Description
dos_req_ip_scan_bad_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_req_ip_scan_unknown_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_req_uri_scan_bad_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_req_uri_scan_unknown_rl_drop
- Type
- uint32
- Category
- optional
- Description
dos_rx_bytes
- Type
- uint64
- Category
- optional
- Description
dos_req
- Type
- uint64
- Category
- optional
- Description
dos_conn
- Type
- uint64
- Category
- optional
- Description
policy_drops
- Type
- uint64
- Category
- optional
- Description
policy_drop_pkts
- Type
- uint64
- Category
- optional
- Description
policy_drop_bytes
- Type
- uint64
- Category
- optional
- Description
conn_rl_action_drops
- Type
- uint64
- Category
- optional
- Description
conn_rl_action_resets
- Type
- uint64
- Category
- optional
- Description
conn_ip_rl_action_drops
- Type
- uint64
- Category
- optional
- Description
conn_ip_rl_action_resets
- Type
- uint64
- Category
- optional
- Description
dos_req_hdr_rl_drop
- Type
- uint32
- Category
- optional
- Description
CpsDoserStats
num_cps_dosers
- Type
- uint32
- Category
- optional
- Description
cps_doser_entry
- Type
- CpsDoserEntry
- Category
- repeated
- Description
CpsDoserEntry
ip
- Type
- IpAddr
- Category
- optional
- Description
hits
- Type
- uint32
- Category
- optional
- Description
ClientSummaryInternal
API
GET /api/virtualservice/<key>/clientsummary/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> clientsummary filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
ClientSummaryInternal
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
num_client_objs
- Type
- Unknown
- Category
- optional
- Description
VirtualServiceInternal
API
GET /api/virtualservice/<key>/runtime/internal/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> internal filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
VirtualServiceInternal
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
virtualservice_config
- Type
- VirtualService
- Category
- optional
- Description
virtualservice_runtime
- Type
- VirtualServiceRuntime
- Category
- optional
- Description
vserver_rtm_flags_l4
- Type
- int32
- Category
- optional
- Description
vs_stat_index_l4
- Type
- int32
- Category
- optional
- Description
vs_master_stat_index_l4
- Type
- int32
- Category
- optional
- Description
vs_max_outstanding_conns_l4
- Type
- int32
- Category
- optional
- Description
vs_curr_outstanding_conns_l4
- Type
- int32
- Category
- optional
- Description
vs_conn_limit_drop_l4
- Type
- int32
- Category
- optional
- Description
vs_max_bps_l4
- Type
- Unknown
- Category
- optional
- Description
vs_curr_bps_l4
- Type
- Unknown
- Category
- optional
- Description
vs_bps_limit_drop_l4
- Type
- Unknown
- Category
- optional
- Description
vs_all_se_bps_l4
- Type
- Unknown
- Category
- optional
- Description
sestatuslist
- Type
- SestatusInternal
- Category
- repeated
- Description
refcnts
- Type
- VirtualServiceRefCnt
- Category
- optional
- Description
listening_sockets
- Type
- ListeningSocket
- Category
- repeated
- Description
vs_master_autogw
- Type
- int32
- Category
- optional
- Description
vs_table_entry_type
- Type
- string
- Category
- optional
- Description
vs_conn_pool_type
- Type
- string
- Category
- optional
- Description
vs_is_standby
- Type
- int32
- Category
- optional
- Description
ssl
- Type
- SSLStatsInternal
- Category
- optional
- Description
vip_masklen
- Type
- int32
- Category
- optional
- Description
l7_has_redirect
- Type
- bool
- Category
- optional
- Description
vcpus
- Type
- uint32
- Category
- optional
- Description
num_pools
- Type
- uint32
- Category
- optional
- Description
num_pools_up
- Type
- int32
- Category
- optional
- Description
fq_weight
- Type
- uint32
- Category
- optional
- Description
fq_stored
- Type
- uint32
- Category
- optional
- Description
fq_overflows
- Type
- uint64
- Category
- optional
- Description
fq_recovered
- Type
- uint64
- Category
- optional
- Description
fq_credit
- Type
- uint32
- Category
- optional
- Description
fq_delay_fairness
- Type
- bool
- Category
- optional
- Description
fq_deadline
- Type
- uint32
- Category
- optional
- Description
fq_weight_change_drops
- Type
- uint64
- Category
- optional
- Description
num_active_ses
- Type
- uint32
- Category
- optional
- Description
child_vs
- Type
- string
- Category
- repeated
- Description
selbentry_ro
- Type
- SeLbEntry
- Category
- repeated
- Description
selbentry
- Type
- SeLbEntry
- Category
- repeated
- Description
corelbentry_ro
- Type
- CoreLbEntry
- Category
- repeated
- Description
corelbentry
- Type
- CoreLbEntry
- Category
- repeated
- Description
max_rps_unknown_cip
- Type
- uint32
- Category
- optional
- Description
max_bad_rps_cip
- Type
- uint32
- Category
- optional
- Description
max_bad_rps_uri
- Type
- uint32
- Category
- optional
- Description
max_bad_rps_cip_uri
- Type
- uint32
- Category
- optional
- Description
vrf_id
- Type
- uint32
- Category
- optional
- Description
selbchentry
- Type
- SeLbChEntry
- Category
- repeated
- Description
max_num_pools_up_se_uuid
- Type
- string
- Category
- optional
- Description
max_state_se_uuid
- Type
- string
- Category
- optional
- Description
num_flow_cores_sum
- Type
- uint32
- Category
- optional
- Description
num_flow_cores_sum_changes_accepted
- Type
- uint32
- Category
- optional
- Description
num_flow_cores_sum_changes_all
- Type
- uint32
- Category
- optional
- Description
invalid_hb_replies
- Type
- uint32
- Category
- optional
- Description
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
TimeStamp
secs
- Type
- Unknown
- Category
- required
- Description
usecs
- Type
- Unknown
- Category
- required
- Description
VirtualServiceRuntime
uuid
- Type
- string
- Category
- required
- Description
datapath_debug
- Type
- DebugVirtualService
- Category
- optional
- Description
servers_configured
- Type
- bool
- Category
- optional
- Description
- Default
- True
rules_configured
- Type
- bool
- Category
- optional
- Description
- Default
- True
one_plus_one_ha
- Type
- bool
- Category
- optional
- Description
- Default
- False
apic_extension
- Type
- VsApicExtension
- Category
- optional
- Description
last_changed_time
- Type
- TimeStamp
- Category
- optional
- Description
controller_ip
- Type
- string
- Category
- optional
- Description
prev_controller_ip
- Type
- string
- Category
- optional
- Description
marked_for_delete
- Type
- bool
- Category
- optional
- Description
- Default
- False
metrics_mgr_port
- Type
- enum
- Category
- optional
- Description
- Choices
- METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3
prev_metrics_mgr_port
- Type
- enum
- Category
- optional
- Description
- Choices
- METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3
manual_placement
- Type
- bool
- Category
- optional
- Description
- Default
- False
vh_child_vs_ref
- Type
- Reference to VirtualService
- Category
- repeated
- Description
redis_ip
- Type
- string
- Category
- optional
- Description
redis_port
- Type
- int32
- Category
- optional
- Description
redis_db
- Type
- int32
- Category
- optional
- Description
tls_ticket_key
- Type
- TLSTicket
- Category
- repeated
- Description
lif
- Type
- string
- Category
- repeated
- Description
type
- Type
- enum
- Category
- optional
- Description
- Default
- VS_TYPE_NORMAL
- Choices
- VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD
east_west
- Type
- bool
- Category
- optional
- Description
- Default
- False
num_additional_se
- Type
- int32
- Category
- optional
- Description
- Default
- 0
gslb_dns_update
- Type
- GslbDnsUpdate
- Category
- optional
- Description
is_dns_vs
- Type
- bool
- Category
- optional
- Description
- Default
- False
ipam_dns_records
- Type
- DnsRecord
- Category
- repeated
- Description
version
- Type
- uint64
- Category
- optional
- Description
- Version number of the SE List update
- Default
- 0
vip_runtime
- Type
- VipRuntime
- Category
- repeated
- Description
gslb_dns_geo_update
- Type
- GslbDnsGeoUpdate
- Category
- optional
- Description
DebugVirtualService
uuid
- Type
- string
- Category
- required
- Description
name
- Type
- string
- Category
- required
- Description
flags
- Type
- DebugVsDataplane
- Category
- repeated
- Description
debug_ip
- Type
- DebugIpAddr
- Category
- optional
- Description
capture
- Type
- bool
- Category
- optional
- Description
capture_params
- Type
- DebugVirtualServiceCapture
- Category
- optional
- Description
se_params
- Type
- DebugVirtualServiceSeParams
- Category
- optional
- Description
debug_hm
- Type
- enum
- Category
- optional
- Description
- This option controls the capture of Health Monitor flows.
- Default
- DEBUG_VS_HM_NONE
- Choices
- DEBUG_VS_HM_NONE, DEBUG_VS_HM_ONLY, DEBUG_VS_HM_INCLUDE
tenant_ref
- Type
- Reference to Tenant
- Category
- optional
- Description
cloud_ref
- Type
- Reference to Cloud
- Category
- optional,readonly
- Description
- Default
- /api/cloud?name=Default-Cloud
DebugVsDataplane
flag
- Type
- enum
- Category
- required
- Description
- Choices
- DEBUG_VS_TCP_CONNECTION, DEBUG_VS_TCP_PKT, DEBUG_VS_TCP_APP, DEBUG_VS_TCP_APP_PKT, DEBUG_VS_TCP_RETRANSMIT, DEBUG_VS_TCP_TIMER, DEBUG_VS_TCP_CONN_ERROR, DEBUG_VS_TCP_PKT_ERROR, DEBUG_VS_TCP_REXMT, DEBUG_VS_TCP_ALL, DEBUG_VS_CREDIT, DEBUG_VS_PROXY_CONNECTION, DEBUG_VS_PROXY_PKT, DEBUG_VS_PROXY_ERR, DEBUG_VS_UDP, DEBUG_VS_UDP_PKT, DEBUG_VS_HM, DEBUG_VS_HM_ERR, DEBUG_VS_HM_PKT, DEBUG_VS_HTTP_CORE, DEBUG_VS_HTTP_ALL, DEBUG_VS_CONFIG, DEBUG_VS_EVENTS, DEBUG_VS_HTTP_RULES, DEBUG_VS_HM_EXT, DEBUG_VS_SSL, DEBUG_VS_ALL, DEBUG_VS_ERROR, DEBUG_VS_NONE
DebugIpAddr
addrs
- Type
- IpAddr
- Category
- repeated
- Description
ranges
- Type
- IpAddrRange
- Category
- repeated
- Description
prefixes
- Type
- IpAddrPrefix
- Category
- repeated
- Description
DebugVirtualServiceCapture
pkt_size
- Type
- uint32
- Category
- optional
- Description
- Number of bytes of each packet to capture. Use 0 to capture the entire packet.
- Default
- 128
duration
- Type
- uint32
- Category
- optional
- Description
- Number of minutes to capture packets. Use 0 to capture until manually stopped.
- Units
- min
- Default
- 0
num_pkts
- Type
- uint32
- Category
- optional
- Description
- Total number of packets to capture.
DebugVirtualServiceSeParams
se_uuids
- Type
- string
- Category
- repeated
- Description
VsApicExtension
txn_uuid
- Type
- string
- Category
- required
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
vnic
- Type
- VsSeVnic
- Category
- repeated
- Description
VsSeVnic
mac
- Type
- string
- Category
- required
- Description
type
- Type
- enum
- Category
- required
- Description
- Choices
- VNIC_TYPE_FE, VNIC_TYPE_BE, VNIC_TYPE_INT_PRIMARY, VNIC_TYPE_INT_SECONDARY, VNIC_TYPE_INT
lif
- Type
- string
- Category
- optional
- Description
TLSTicket
name
- Type
- string
- Category
- required
- Description
aes_key
- Type
- Unknown
- Category
- required
- Description
hmac_key
- Type
- Unknown
- Category
- required
- Description
GslbDnsUpdate
send_interval
- Type
- uint32
- Category
- optional
- Description
clear_on_max_retries
- Type
- uint32
- Category
- optional
- Description
obj_info
- Type
- GslbObjectInfo
- Category
- repeated
- Description
- Gslb, GslbService objects that is pushed on a per Dns basis.
GslbObjectInfo
state
- Type
- enum
- Category
- optional
- Description
- Indicates the state of the object:unchanged or changed. This is used in vs-mgr to push just the uuid or uuid + protobuf to the SE-Agent.
- Choices
- GSLB_OBJECT_CHANGED, GSLB_OBJECT_UNCHANGED
pb_name
- Type
- string
- Category
- optional
- Description
- Indicates the object type Gslb, GslbService or GslbGeoDbProfile.
object_uuid
- Type
- string
- Category
- optional
- Description
- Indicates the object uuid.
VipRuntime
vip_id
- Type
- string
- Category
- optional
- Description
fsm_state_name
- Type
- string
- Category
- optional
- Description
- Default
- VipFsmMap::Inactive
fsm_state_id
- Type
- string
- Category
- optional
- Description
- Default
- 0
servers_configured
- Type
- bool
- Category
- optional
- Description
- Default
- True
last_changed_time
- Type
- TimeStamp
- Category
- optional
- Description
marked_for_delete
- Type
- bool
- Category
- optional
- Description
- Default
- False
progress_percent
- Type
- int32
- Category
- optional
- Description
- Default
- 0
scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
metrics_mgr_port
- Type
- enum
- Category
- optional
- Description
- Choices
- METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3
prev_metrics_mgr_port
- Type
- enum
- Category
- optional
- Description
- Choices
- METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3
scaleout_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
user_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
scalein_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
scalein_request
- Type
- VsScaleinParams
- Category
- optional
- Description
migrate_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
migrate_request
- Type
- VsMigrateParams
- Category
- optional
- Description
migrate_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
migrate_scalein_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
first_time_placement
- Type
- bool
- Category
- optional
- Description
- Default
- False
se_list
- Type
- SeList
- Category
- repeated
- Description
requested_resource
- Type
- VirtualServiceResource
- Category
- optional
- Description
supp_runtime_status
- Type
- OperationalStatus
- Category
- optional
- Description
first_se_assigned_time
- Type
- TimeStamp
- Category
- optional
- Description
num_additional_se
- Type
- int32
- Category
- optional
- Description
- Default
- 0
ev_status
- Type
- VsEvStatus
- Category
- optional
- Description
ev
- Type
- string
- Category
- repeated
- Description
last_scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
ScaleStatus
state
- Type
- enum
- Category
- optional
- Description
- Choices
- SCALEOUT_PROCESSING, SCALEOUT_AWAITING_SE_ASSIGNMENT, SCALEOUT_CREATING_SE, SCALEOUT_RESOURCES, SCALEOUT_AWAITING_SE_PROGRAMMING, SCALEOUT_WAIT_FOR_SE_READY, SCALEOUT_SUCCESS, SCALEOUT_ERROR, SCALEOUT_ROLLBACK, SCALEOUT_ERROR_DISABLED, SCALEIN_AWAITING_SE_PRE_RELEASE, SCALEIN_AWAITING_SE_PROGRAMMING, SCALEIN_WAIT_FOR_SE_READY, SCALEIN_AWAITING_SE_RELEASE, SCALEIN_SUCCESS, SCALEIN_ERROR, MIGRATE_SCALEOUT_AWAITING_SE_ASSIGNMENT, MIGRATE_SCALEOUT_CREATING_SE, MIGRATE_SCALEOUT_RESOURCES, MIGRATE_SCALEOUT_AWAITING_SE_PROGRAMMING, MIGRATE_SCALEOUT_WAIT_FOR_SE_READY, MIGRATE_SCALEOUT_SUCCESS, MIGRATE_SCALEOUT_ROLLBACK, MIGRATE_SCALEOUT_ERROR, MIGRATE_SCALEIN_AWAITING_SE_PRE_RELEASE, MIGRATE_SCALEIN_AWAITING_SE_PROGRAMMING, MIGRATE_SCALEIN_WAIT_FOR_SE_READY, MIGRATE_SCALEIN_AWAITING_SE_RELEASE, MIGRATE_SCALEIN_SUCCESS, MIGRATE_SCALEIN_ERROR, MIGRATE_SUCCESS, MIGRATE_ERROR
reason
- Type
- string
- Category
- repeated
- Description
reason_code
- Type
- uint64
- Category
- optional
- Description
scale_se
- Type
- string
- Category
- optional
- Description
num_se_requested
- Type
- uint32
- Category
- optional
- Description
num_se_assigned
- Type
- uint32
- Category
- optional
- Description
reason_code_string
- Type
- string
- Category
- optional
- Description
vip_placement_resolution_info
- Type
- VipPlacementResolutionInfo
- Category
- optional
- Description
start_time_str
- Type
- string
- Category
- optional
- Description
end_time_str
- Type
- string
- Category
- optional
- Description
action
- Type
- enum
- Category
- optional
- Description
- Choices
- OTHER, CREATE, READ, UPDATE, DELETE, SCALE_OUT, SCALE_IN, SE_REMOVED, SE_DISCONNECT, SE_RECONNECT, WARM_RESTART, COLD_RESTART, UPDATE_LOGMGR_MAP, MIGRATE_SCALEOUT, MIGRATE_SCALEIN, INITIAL_PLACEMENT, ROTATE_KEYS, GLB_MGR_UPDATE, UPDATE_DNS_RECORDS, SCALEOUT_ADMINUP, SCALEIN_ADMINDOWN, SCALEOUT_READY, SCALEIN_READY, SE_PRERELEASED, SE_ADDED, SE_PRERELEASE, SE_SCALING_IN, SE_DELETING, SE_PRERELEASE_FAILED, SE_SCALEOUT_FAILED, SCALEOUT_ROLLEDBACK, RSRC_UPDATE, SE_UPDATED, GLB_MGR_UPDATE_GS_STATUS, NEW_PRIMARY, SE_FORCE_RELEASE, SWITCHOVER, SE_ASSIGN_NO_CHANGE, GLB_MGR_DNS_GEO_UPDATE, GLB_MGR_DNS_CLEANUP
VipPlacementResolutionInfo
ip
- Type
- IpAddr
- Category
- optional
- Description
pool_uuid
- Type
- string
- Category
- optional
- Description
networks
- Type
- DiscoveredNetwork
- Category
- repeated
- Description
SeList
se_ref
- Type
- Reference to ServiceEngine
- Category
- required
- Description
is_primary
- Type
- bool
- Category
- optional
- Description
- Default
- True
is_standby
- Type
- bool
- Category
- optional
- Description
- Default
- False
is_connected
- Type
- bool
- Category
- optional
- Description
- Default
- True
delete_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
vcpus
- Type
- int32
- Category
- optional
- Description
- Default
- 2
memory
- Type
- int32
- Category
- optional
- Description
- Default
- 2001
vip_intf_mac
- Type
- string
- Category
- optional
- Description
- Default
vip_subnet_mask
- Type
- int32
- Category
- optional
- Description
- Default
- 32
vnic
- Type
- VsSeVnic
- Category
- repeated
- Description
pending_download
- Type
- bool
- Category
- optional
- Description
- Default
- False
sec_idx
- Type
- int32
- Category
- optional
- Description
- Default
- 1
download_selist_only
- Type
- bool
- Category
- optional
- Description
- Default
- False
vlan_id
- Type
- int32
- Category
- optional
- Description
- Default
- 0
snat_ip
- Type
- IpAddr
- Category
- optional
- Description
vip_intf_ip
- Type
- IpAddr
- Category
- optional
- Description
vip_intf_list
- Type
- SeVipInterfaceList
- Category
- repeated
- Description
floating_intf_ip
- Type
- IpAddr
- Category
- repeated
- Description
is_portchannel
- Type
- bool
- Category
- optional
- Description
- Default
- False
scalein_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
admin_down_requested
- Type
- bool
- Category
- optional
- Description
- Default
- False
at_curr_ver
- Type
- bool
- Category
- optional
- Description
- Default
- True
version
- Type
- string
- Category
- optional
- Description
- Default
- 0.0.0
gslb_download
- Type
- bool
- Category
- optional
- Description
- This flag indicates whether the gslb, ghm, gs objects have been pushed to the DNS-VS's SE.
- Default
- False
geo_download
- Type
- bool
- Category
- optional
- Description
- This flag indicates whether the geo-files have been pushed to the DNS-VS's SE.
- Default
- False
geodb_download
- Type
- bool
- Category
- optional
- Description
- This flag indicates whether the geodb object has been pushed to the DNS-VS's SE.
- Default
- False
SeVipInterfaceList
vip_intf_mac
- Type
- string
- Category
- required
- Description
vlan_id
- Type
- int32
- Category
- optional
- Description
- Default
- 0
vip_intf_ip
- Type
- IpAddr
- Category
- optional
- Description
is_portchannel
- Type
- bool
- Category
- optional
- Description
- Default
- False
VirtualServiceResource
num_vcpus
- Type
- uint32
- Category
- optional
- Description
memory
- Type
- uint32
- Category
- optional
- Description
is_exclusive
- Type
- bool
- Category
- optional
- Description
scalein_primary
- Type
- bool
- Category
- optional
- Description
num_se
- Type
- int32
- Category
- optional
- Description
scalein_se_uuid
- Type
- string
- Category
- optional
- Description
num_standby_se
- Type
- int32
- Category
- optional
- Description
VsEvStatus
request
- Type
- string
- Category
- optional
- Description
result
- Type
- string
- Category
- optional
- Description
notes
- Type
- string
- Category
- repeated
- Description
GslbDnsGeoUpdate
ops
- Type
- enum
- Category
- optional
- Description
- Choices
- GSLB_NONE, GSLB_CREATE, GSLB_UPDATE, GSLB_DELETE, GSLB_PURGE, GSLB_DECL
se_list
- Type
- string
- Category
- repeated
- Description
obj_info
- Type
- GslbObjectInfo
- Category
- repeated
- Description
- GslbGeoDbProfile object that is pushed on on a per Dns basis.
SestatusInternal
outside_mac
- Type
- string
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
is_primary
- Type
- int32
- Category
- optional
- Description
admin_down
- Type
- int32
- Category
- optional
- Description
is_local
- Type
- int32
- Category
- optional
- Description
is_up
- Type
- int32
- Category
- optional
- Description
is_flow_dispatchable
- Type
- int32
- Category
- optional
- Description
se_hm_rsp_loss
- Type
- int32
- Category
- optional
- Description
se_hm_rqs_loss
- Type
- int32
- Category
- optional
- Description
se_hm_rsps_sent
- Type
- int32
- Category
- optional
- Description
se_hm_rqs_sent
- Type
- int32
- Category
- optional
- Description
se_hm_rsps_rcvd
- Type
- int32
- Category
- optional
- Description
se_hm_rqs_rcvd
- Type
- int32
- Category
- optional
- Description
se_hm_err_rsps
- Type
- int32
- Category
- optional
- Description
vs_bps
- Type
- Unknown
- Category
- optional
- Description
se_load
- Type
- Unknown
- Category
- optional
- Description
vs_stat_index
- Type
- int32
- Category
- optional
- Description
internal_mac
- Type
- string
- Category
- optional
- Description
deprecated1
- Type
- string
- Category
- optional
- Description
outside_vnic
- Type
- int32
- Category
- optional
- Description
internal_vnic
- Type
- int32
- Category
- optional
- Description
deprecated2
- Type
- int32
- Category
- optional
- Description
notified_controller
- Type
- int32
- Category
- optional
- Description
num_pools_up
- Type
- int32
- Category
- optional
- Description
pool_obj_count
- Type
- int32
- Category
- optional
- Description
state
- Type
- bool
- Category
- optional
- Description
sent_scaleout_ready
- Type
- int32
- Category
- optional
- Description
se_hm_fe_apic_delay
- Type
- int32
- Category
- optional
- Description
num_hb_recvd
- Type
- uint32
- Category
- optional
- Description
is_in_vsc
- Type
- uint32
- Category
- optional
- Description
num_flow_cores
- Type
- uint32
- Category
- optional
- Description
num_hb_v1_rqs_sent
- Type
- uint32
- Category
- optional
- Description
num_hb_v1_rqs_rcvd
- Type
- uint32
- Category
- optional
- Description
num_hb_v1_rsps_sent
- Type
- uint32
- Category
- optional
- Description
num_hb_v1_rsps_rcvd
- Type
- uint32
- Category
- optional
- Description
VirtualServiceRefCnt
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
refcnt
- Type
- int32
- Category
- optional
- Description
default_pool_refcount
- Type
- int32
- Category
- optional
- Description
service_refcnt
- Type
- ServiceRefCnt
- Category
- repeated
- Description
fe_np_refcnt
- Type
- NetworkProfileRefCnt
- Category
- optional
- Description
be_np_refcnt
- Type
- NetworkProfileRefCnt
- Category
- optional
- Description
app_profile_refcnt
- Type
- ApplicationProfileRefCnt
- Category
- optional
- Description
http_policy_set_refcnt
- Type
- HTTPPolicySetRefCnt
- Category
- repeated
- Description
dns_policy_refcnt
- Type
- DnsPolicyRefCnt
- Category
- repeated
- Description
comp_profile_refcnt
- Type
- int32
- Category
- optional
- Description
ServiceRefCnt
port
- Type
- int32
- Category
- optional
- Description
enable_ssl
- Type
- int32
- Category
- optional
- Description
rtm_refcnt
- Type
- int32
- Category
- optional
- Description
protocol_type
- Type
- string
- Category
- optional
- Description
NetworkProfileRefCnt
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
refcnt
- Type
- int32
- Category
- optional
- Description
ApplicationProfileRefCnt
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
cfg_refcnt
- Type
- int32
- Category
- optional
- Description
rtm_refcnt
- Type
- int32
- Category
- optional
- Description
HTTPPolicySetRefCnt
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
pool_refcnt
- Type
- HTTPRequestPolicyPoolRefCnt
- Category
- repeated
- Description
policy_refcnt
- Type
- int32
- Category
- required
- Description
HTTPRequestPolicyPoolRefCnt
pool_name
- Type
- string
- Category
- optional
- Description
pool_uuid
- Type
- string
- Category
- optional
- Description
refcnt
- Type
- int32
- Category
- optional
- Description
DnsPolicyRefCnt
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
policy_refcnt
- Type
- int32
- Category
- required
- Description
ListeningSocket
port
- Type
- uint32
- Category
- optional
- Description
refcount
- Type
- uint32
- Category
- optional
- Description
SSLStatsInternal
ssl_sessions_created
- Type
- uint64
- Category
- required
- Description
ssl_sessions_deleted
- Type
- uint64
- Category
- required
- Description
ssl_sessions_hits
- Type
- uint64
- Category
- required
- Description
ssl_sessions_misses
- Type
- uint64
- Category
- required
- Description
ssl_sessions_corrupt
- Type
- uint64
- Category
- optional
- Description
tls_tickets_issued
- Type
- uint64
- Category
- required
- Description
tls_tickets_received
- Type
- uint64
- Category
- required
- Description
tls_tickets_missing
- Type
- uint64
- Category
- optional
- Description
tls_tickets_renewed
- Type
- uint64
- Category
- optional
- Description
SeLbEntry
se_tokens
- Type
- uint32
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
CoreLbEntry
core_tokens
- Type
- uint32
- Category
- optional
- Description
core
- Type
- uint32
- Category
- optional
- Description
SeLbChEntry
key
- Type
- int32
- Category
- optional
- Description
hits
- Type
- uint32
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
GeoDbInternal
API
GET /api/virtualservice/<key>/geodbinternal/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> geodbinternal filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
GeoDbInternal
se_uuid
- Type
- string
- Category
- optional
- Description
uuid
- Type
- string
- Category
- optional
- Description
- Geo Db Profile UUID.
name
- Type
- string
- Category
- optional
- Description
- Geo Db Profile Name.
db_entries
- Type
- GeoDbEntry
- Category
- repeated
- Description
- Geo Db entries.
db_update_in_progress
- Type
- bool
- Category
- optional
- Description
- Flag to indicate if Db update is in progress.
error_file
- Type
- string
- Category
- optional
- Description
- File having an error.
error
- Type
- enum
- Category
- optional
- Description
- File error type.
- Choices
- NO_ERROR, FILE_ERROR, FILE_FORMAT_ERROR, FILE_NO_RESOURCES
GeoDbEntry
filename
- Type
- string
- Category
- optional
- Description
- Geodb Filename in the Avi supported formats.
num_entries
- Type
- uint32
- Category
- optional
- Description
- Number of entries read from this Geo db file.
num_prefixes
- Type
- uint32
- Category
- optional
- Description
- Number of prefixes read from this Geo db file.
num_errors
- Type
- uint32
- Category
- optional
- Description
- Number of parse errors for this Geo db file.
priority
- Type
- uint32
- Category
- optional
- Description
- Priority of this Geo db file.
KeyvalInternal
API
GET /api/virtualservice/<key>/keyval/<key>
CLI
show virtualservice <key> keyval
Data
KeyvalInternal
uuid
- Type
- string
- Category
- optional
- Description
keyval_entry
- Type
- KeyvalInternalEntry
- Category
- repeated
- Description
KeyvalInternalEntry
key
- Type
- string
- Category
- optional
- Description
val
- Type
- string
- Category
- optional
- Description
local_eol
- Type
- uint32
- Category
- optional
- Description
global_eol
- Type
- uint32
- Category
- optional
- Description
Actions
API
POST /api/virtualservice/<key>/keyval/clear
CLI
clear virtualservice <key> keyval
HTTPPolicySetInternal
API
GET /api/virtualservice/<key>/httppolicyset/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> httppolicyset filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
HTTPPolicySetInternal
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
uuid
- Type
- string
- Category
- required
- Description
name
- Type
- string
- Category
- required
- Description
http_policy_set
- Type
- HTTPPolicySet
- Category
- repeated
- Description
HTTPPolicySet
uuid
- Type
- string
- Category
- required
- Description
- UUID of the HTTP Policy Set
name
- Type
- string
- Category
- required
- Description
- Name of the HTTP Policy Set
http_security_policy
- Type
- HTTPSecurityPolicy
- Category
- optional
- Description
- HTTP security policy for the virtual service.
http_request_policy
- Type
- HTTPRequestPolicy
- Category
- optional
- Description
- HTTP request policy for the virtual service.
http_response_policy
- Type
- HTTPResponsePolicy
- Category
- optional
- Description
- HTTP response policy for the virtual service.
created_by
- Type
- string
- Category
- optional
- Description
- Creator name
cloud_config_cksum
- Type
- string
- Category
- optional
- Description
- Checksum of cloud configuration for Pool. Internally set by cloud connector
is_internal_policy
- Type
- bool
- Category
- optional
- Description
- Default
- False
description
- Type
- string
- Category
- optional
- Description
tenant_ref
- Type
- Reference to Tenant
- Category
- required
- Description
HTTPSecurityPolicy
rules
- Type
- HTTPSecurityRule
- Category
- repeated
- Description
- Add rules to the HTTP security policy
HTTPSecurityRule
name
- Type
- string
- Category
- required
- Description
- Name of the rule
index
- Type
- int32
- Category
- required
- Description
- Index of the rule
enable
- Type
- bool
- Category
- required
- Description
- Enable or disable the rule
- Default
- True
match
- Type
- MatchTarget
- Category
- optional
- Description
- Add match criteria to the rule
action
- Type
- HTTPSecurityAction
- Category
- optional
- Description
- Action to be performed upon successful matching
log
- Type
- bool
- Category
- optional
- Description
- Log HTTP request upon rule match
MatchTarget
client_ip
- Type
- IpAddrMatch
- Category
- optional
- Description
- Configure client ip addresses
vs_port
- Type
- PortMatch
- Category
- optional
- Description
- Configure virtual service ports
protocol
- Type
- ProtocolMatch
- Category
- optional
- Description
- Configure the type of HTTP protocol
method
- Type
- MethodMatch
- Category
- optional
- Description
- Configure HTTP methods
version
- Type
- HTTPVersionMatch
- Category
- optional
- Description
- Configure versions of the HTTP protocol
path
- Type
- PathMatch
- Category
- optional
- Description
- Configure request paths
query
- Type
- QueryMatch
- Category
- optional
- Description
- Configure request query
hdrs
- Type
- HdrMatch
- Category
- repeated
- Description
- Configure HTTP header(s)
cookie
- Type
- CookieMatch
- Category
- optional
- Description
- Configure HTTP cookie(s)
host_hdr
- Type
- HostHdrMatch
- Category
- optional
- Description
- Configure the host header
PortMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for port matching the HTTP request
- Choices
- IS_IN, IS_NOT_IN
ports
- Type
- uint32
- Category
- repeated
- Description
- Listening TCP port(s)
ProtocolMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for protocol matching the HTTP request
- Choices
- IS_IN, IS_NOT_IN
protocols
- Type
- enum
- Category
- required
- Description
- HTTP or HTTPS protocol
- Choices
- HTTP, HTTPS
MethodMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for HTTP method matching the method in the HTTP request
- Choices
- IS_IN, IS_NOT_IN
methods
- Type
- enum
- Category
- repeated
- Description
- Configure HTTP method(s)
- Choices
- HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE
HTTPVersionMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for HTTP version matching the version used in the HTTP request
- Choices
- IS_IN, IS_NOT_IN
versions
- Type
- enum
- Category
- repeated
- Description
- HTTP protocol version
- Choices
- ZERO_NINE, ONE_ZERO, ONE_ONE
PathMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for matching the path in the HTTP request URI
- Choices
- BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH
match_case
- Type
- enum
- Category
- optional
- Description
- Case sensitivity to use for the matching
- Default
- INSENSITIVE
- Choices
- SENSITIVE, INSENSITIVE
match_str
- Type
- string
- Category
- repeated
- Description
- String values
string_group_refs
- Type
- Reference to StringGroup
- Category
- repeated
- Description
- UUID of the string group(s)
QueryMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for matching the query in HTTP request URI
- Choices
- QUERY_MATCH_CONTAINS
match_case
- Type
- enum
- Category
- optional
- Description
- Case sensitivity to use for the match
- Default
- INSENSITIVE
- Choices
- SENSITIVE, INSENSITIVE
match_str
- Type
- string
- Category
- repeated
- Description
- String value(s)
string_group_refs
- Type
- Reference to StringGroup
- Category
- repeated
- Description
- UUID of the string group(s)
HdrMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for matching headers in the HTTP request
- Choices
- HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL
hdr
- Type
- string
- Category
- required
- Description
- Name of the HTTP header whose value is to be matched
match_case
- Type
- enum
- Category
- optional
- Description
- Case sensitivity to use for the match
- Default
- INSENSITIVE
- Choices
- SENSITIVE, INSENSITIVE
value
- Type
- string
- Category
- repeated
- Description
- String values to match in the HTTP header
CookieMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for matching the cookie in the HTTP request
- Choices
- HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL
name
- Type
- string
- Category
- required
- Description
- Name of the cookie
match_case
- Type
- enum
- Category
- optional
- Description
- Case sensitivity to use for the match
- Default
- INSENSITIVE
- Choices
- SENSITIVE, INSENSITIVE
value
- Type
- string
- Category
- optional
- Description
- String value in the cookie
HostHdrMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for the host header value match
- Choices
- HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL
match_case
- Type
- enum
- Category
- optional
- Description
- Case sensitivity to use for the match
- Default
- INSENSITIVE
- Choices
- SENSITIVE, INSENSITIVE
value
- Type
- string
- Category
- repeated
- Description
- String value(s) in the host header
HTTPSecurityAction
action
- Type
- enum
- Category
- required
- Description
- Type of the security action to perform
- Choices
- HTTP_SECURITY_ACTION_CLOSE_CONN, HTTP_SECURITY_ACTION_SEND_RESPONSE, HTTP_SECURITY_ACTION_ALLOW, HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS, HTTP_SECURITY_ACTION_RATE_LIMIT
status_code
- Type
- enum
- Category
- optional
- Description
- HTTP status code to use for local response
- Choices
- HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429
https_port
- Type
- uint32
- Category
- optional
- Description
- Secure SSL/TLS port to redirect the HTTP request to
file
- Type
- HTTPLocalFile
- Category
- optional
- Description
- File to be used for generating HTTP local response
rate_limit
- Type
- RateProfile
- Category
- optional
- Description
- Rate Limit profile to be used to rate-limit the flow
HTTPRequestPolicy
rules
- Type
- HTTPRequestRule
- Category
- repeated
- Description
- Add rules to the HTTP request policy
HTTPRequestRule
name
- Type
- string
- Category
- required
- Description
- Name of the rule
index
- Type
- int32
- Category
- required
- Description
- Index of the rule
enable
- Type
- bool
- Category
- required
- Description
- Enable or disable the rule
- Default
- True
match
- Type
- MatchTarget
- Category
- optional
- Description
- Add match criteria to the rule
redirect_action
- Type
- HTTPRedirectAction
- Category
- optional
- Description
- HTTP redirect action
hdr_action
- Type
- HTTPHdrAction
- Category
- repeated
- Description
- HTTP header rewrite action
rewrite_url_action
- Type
- HTTPRewriteURLAction
- Category
- optional
- Description
- HTTP request URL rewrite action
switching_action
- Type
- HTTPSwitchingAction
- Category
- optional
- Description
- Content switching action
log
- Type
- bool
- Category
- optional
- Description
- Log HTTP request upon rule match
all_headers
- Type
- bool
- Category
- optional
- Description
- Log all HTTP headers upon rule match
HTTPHdrAction
action
- Type
- enum
- Category
- required
- Description
- ADD: A new header with the new value is added irrespective of the existence of an HTTP header of the given name. REPLACE: A new header with the new value is added if no header of the given name exists, else existing headers with the given name are removed and a new header with the new value is added. REMOVE: All the headers of the given name are removed.
- Choices
- HTTP_ADD_HDR, HTTP_REMOVE_HDR, HTTP_REPLACE_HDR
hdr
- Type
- HTTPHdrData
- Category
- optional
- Description
- HTTP header information
cookie
- Type
- HTTPCookieData
- Category
- optional
- Description
- Cookie information
HTTPHdrData
name
- Type
- string
- Category
- optional
- Description
- HTTP header name
value
- Type
- HTTPHdrValue
- Category
- optional
- Description
- HTTP header value
HTTPHdrValue
var
- Type
- enum
- Category
- optional
- Description
- Variable
- Choices
- HTTP_POLICY_VAR_CLIENT_IP, HTTP_POLICY_VAR_VS_PORT, HTTP_POLICY_VAR_VS_IP, HTTP_POLICY_VAR_HTTP_HDR, HTTP_POLICY_VAR_SSL_CLIENT_FINGERPRINT, HTTP_POLICY_VAR_SSL_CLIENT_SERIAL, HTTP_POLICY_VAR_SSL_CLIENT_ISSUER, HTTP_POLICY_VAR_SSL_CLIENT_SUBJECT, HTTP_POLICY_VAR_SSL_CLIENT_RAW, HTTP_POLICY_VAR_SSL_PROTOCOL, HTTP_POLICY_VAR_SSL_SERVER_NAME, HTTP_POLICY_VAR_USER_NAME, HTTP_POLICY_VAR_SSL_CIPHER
val
- Type
- string
- Category
- optional
- Description
- HTTP header value or variable representing an HTTP header
HTTPCookieData
name
- Type
- string
- Category
- optional
- Description
- Cookie name
value
- Type
- string
- Category
- optional
- Description
- Cookie value
HTTPRewriteURLAction
host_hdr
- Type
- URIParam
- Category
- optional
- Description
- Host config
path
- Type
- URIParam
- Category
- optional
- Description
- Path config
query
- Type
- URIParamQuery
- Category
- optional
- Description
- Query config
URIParamQuery
keep_query
- Type
- bool
- Category
- optional
- Description
- Use or drop the query of the incoming request URI in the request URI to the backend server
- Default
- True
add_string
- Type
- string
- Category
- optional
- Description
- Concatenate a string to the query of the incoming request URI and then use it in the request URI going to the backend server
HTTPSwitchingAction
action
- Type
- enum
- Category
- required
- Description
- Content switching action type
- Choices
- HTTP_SWITCHING_SELECT_POOL, HTTP_SWITCHING_SELECT_LOCAL, HTTP_SWITCHING_SELECT_POOLGROUP
pool_ref
- Type
- Reference to Pool
- Category
- optional
- Description
- UUID of the pool of servers to serve the request
status_code
- Type
- enum
- Category
- optional
- Description
- HTTP status code to use when serving local response
- Choices
- HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429
file
- Type
- HTTPLocalFile
- Category
- optional
- Description
- File from which to serve local response to the request
server
- Type
- PoolServer
- Category
- optional
- Description
- Specific pool server to select
pool_group_ref
- Type
- Reference to PoolGroup
- Category
- optional
- Description
- UUID of the pool group to serve the request
PoolServer
ip
- Type
- IpAddr
- Category
- required
- Description
- IP address of the server in the poool
hostname
- Type
- string
- Category
- optional
- Description
- DNS resolvable name of the server. May be used in place of the IP address.
port
- Type
- uint32
- Category
- optional
- Description
- Port of the pool server listening for HTTP/HTTPS. Default value is the default port in the pool.
HTTPResponsePolicy
rules
- Type
- HTTPResponseRule
- Category
- repeated
- Description
- Add rules to the HTTP response policy
HTTPResponseRule
name
- Type
- string
- Category
- required
- Description
- Name of the rule
index
- Type
- int32
- Category
- required
- Description
- Index of the rule
enable
- Type
- bool
- Category
- required
- Description
- Enable or disable the rule
- Default
- True
match
- Type
- ResponseMatchTarget
- Category
- optional
- Description
- Add match criteria to the rule
hdr_action
- Type
- HTTPHdrAction
- Category
- repeated
- Description
- HTTP header rewrite action
loc_hdr_action
- Type
- HTTPRewriteLocHdrAction
- Category
- optional
- Description
- Location header rewrite action
log
- Type
- bool
- Category
- optional
- Description
- Log HTTP request upon rule match
all_headers
- Type
- bool
- Category
- optional
- Description
- Log all HTTP headers upon rule match
ResponseMatchTarget
client_ip
- Type
- IpAddrMatch
- Category
- optional
- Description
- Configure client ip addresses
vs_port
- Type
- PortMatch
- Category
- optional
- Description
- Configure virtual service ports
protocol
- Type
- ProtocolMatch
- Category
- optional
- Description
- Configure the type of HTTP protocol
method
- Type
- MethodMatch
- Category
- optional
- Description
- Configure HTTP methods
version
- Type
- HTTPVersionMatch
- Category
- optional
- Description
- Configure versions of the HTTP protocol
path
- Type
- PathMatch
- Category
- optional
- Description
- Configure request paths
query
- Type
- QueryMatch
- Category
- optional
- Description
- Configure request query
hdrs
- Type
- HdrMatch
- Category
- repeated
- Description
- Configure HTTP headers
cookie
- Type
- CookieMatch
- Category
- optional
- Description
- Configure HTTP cookie(s)
host_hdr
- Type
- HostHdrMatch
- Category
- optional
- Description
- Configure the host header
loc_hdr
- Type
- LocationHdrMatch
- Category
- optional
- Description
- Configure the location header
status
- Type
- HTTPStatusMatch
- Category
- optional
- Description
- Configure the HTTP status code(s)
rsp_hdrs
- Type
- HdrMatch
- Category
- repeated
- Description
- Configure the HTTP headers in response
LocationHdrMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for matching location header value in the HTTP response
- Choices
- HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL
match_case
- Type
- enum
- Category
- optional
- Description
- Case sensitivity to use for the match
- Default
- INSENSITIVE
- Choices
- SENSITIVE, INSENSITIVE
value
- Type
- string
- Category
- repeated
- Description
- String value(s) in the location header
HTTPStatusMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for matching the HTTP response status code(s)
- Choices
- IS_IN, IS_NOT_IN
status_codes
- Type
- int32
- Category
- repeated
- Description
- HTTP response status code(s)
ranges
- Type
- HTTPStatusRange
- Category
- repeated
- Description
- HTTP response status code range(s)
HTTPStatusRange
begin
- Type
- int32
- Category
- required
- Description
- Starting HTTP response status code
end
- Type
- int32
- Category
- required
- Description
- Ending HTTP response status code
HTTPRewriteLocHdrAction
protocol
- Type
- enum
- Category
- required
- Description
- HTTP protocol type
- Choices
- HTTP, HTTPS
port
- Type
- uint32
- Category
- optional
- Description
- Port to use in the redirected URI
host
- Type
- URIParam
- Category
- optional
- Description
- Host config
path
- Type
- URIParam
- Category
- optional
- Description
- Path config
keep_query
- Type
- bool
- Category
- optional
- Description
- Keep or drop the query from the server side redirect URI
- Default
- True
CltrackSummaryInternal
API
GET /api/virtualservice/<key>/cltracksummary/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> cltracksummary filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
CltrackSummaryInternal
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
num_cltrack_objs
- Type
- Unknown
- Category
- optional
- Description
cltrack_handle_internal
- Type
- CltrackHandleInternal
- Category
- optional
- Description
CltrackHandleInternal
num_local_create_races
- Type
- uint32
- Category
- optional
- Description
num_redis_create_races
- Type
- uint32
- Category
- optional
- Description
num_malloc_failures
- Type
- uint32
- Category
- optional
- Description
num_start_ageing_val_null
- Type
- uint32
- Category
- optional
- Description
num_start_ageing_ignored
- Type
- uint32
- Category
- optional
- Description
KeyvalSummaryInternal
API
GET /api/virtualservice/<key>/keyvalsummary/<key>
CLI
show virtualservice <key> keyvalsummary
Data
KeyvalSummaryInternal
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
num_keyval_objs
- Type
- Unknown
- Category
- optional
- Description
keyval_handle_internal
- Type
- KeyvalHandleInternal
- Category
- optional
- Description
KeyvalHandleInternal
redis_sync
- Type
- int32
- Category
- required
- Description
num_local_create_races
- Type
- uint32
- Category
- optional
- Description
num_redis_create_races
- Type
- uint32
- Category
- optional
- Description
num_unknown_srv_from_redis
- Type
- uint32
- Category
- optional
- Description
num_malloc_failures
- Type
- uint32
- Category
- optional
- Description
num_start_ageing_val_null
- Type
- uint32
- Category
- optional
- Description
num_too_early_delete
- Type
- uint32
- Category
- optional
- Description
num_redis_eol_truncate_events
- Type
- uint32
- Category
- optional
- Description
num_delete_nonexistent
- Type
- uint32
- Category
- optional
- Description
num_redis_recvd
- Type
- uint32
- Category
- optional
- Description
num_redis_sent_dp
- Type
- uint32
- Category
- optional
- Description
num_redis_sent_ag
- Type
- uint32
- Category
- optional
- Description
keyval_cache_internal
- Type
- KeyvalCacheInternal
- Category
- repeated
- Description
num_redis_bad_key
- Type
- uint32
- Category
- optional
- Description
num_redis_bad_val
- Type
- uint32
- Category
- optional
- Description
num_create_srv_null
- Type
- uint32
- Category
- optional
- Description
num_start_ageing_srv_null
- Type
- uint32
- Category
- optional
- Description
num_malloc_failures_dp
- Type
- uint32
- Category
- optional
- Description
KeyvalCacheInternal
core_num
- Type
- uint32
- Category
- optional
- Description
num_hits_creates
- Type
- uint32
- Category
- optional
- Description
num_creates_skipped
- Type
- uint32
- Category
- optional
- Description
SeConsumerProto
API
GET /api/virtualservice/<key>/placement/<key>
CLI
show virtualservice <key> placement
Data
SeConsumerProto
ref
- Type
- Reference to VirtualService
- Category
- required
- Description
svc_q_name
- Type
- string
- Category
- optional
- Description
svc_obj_uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
notify_on_avail
- Type
- bool
- Category
- required
- Description
notify_q_name
- Type
- string
- Category
- required
- Description
static_se_uuid
- Type
- string
- Category
- optional
- Description
resources_consumed
- Type
- SeResourceConsumedProto
- Category
- repeated
- Description
se_group_uuid
- Type
- string
- Category
- optional
- Description
apic_mode
- Type
- bool
- Category
- optional
- Description
- Default
- False
num_vnics
- Type
- int32
- Category
- optional
- Description
- Default
- 0
services
- Type
- VsProtocol
- Category
- repeated
- Description
tenant_uuid
- Type
- string
- Category
- optional
- Description
lifs
- Type
- string
- Category
- repeated
- Description
vip
- Type
- ConVip
- Category
- optional
- Description
servers
- Type
- ConServer
- Category
- repeated
- Description
vrf_context_uuid
- Type
- string
- Category
- optional
- Description
res_total
- Type
- VsResProfile
- Category
- required
- Description
res_pending
- Type
- VsResProfile
- Category
- required
- Description
use_res_profile
- Type
- bool
- Category
- required
- Description
num_se
- Type
- int32
- Category
- required
- Description
num_se_pending
- Type
- int32
- Category
- required
- Description
num_stby_se
- Type
- int32
- Category
- required
- Description
num_stby_se_pending
- Type
- int32
- Category
- required
- Description
disabled
- Type
- bool
- Category
- optional
- Description
- Default
- False
state
- Type
- enum
- Category
- optional
- Description
- Default
- IDLE
- Choices
- IDLE, AWAITING_SE_CREATE, AWAITING_VNIC_ADD, AWAITING_SE_BOOTUP, AWAITING_VNIC_IP, AWAITING_QUERY_HOST, AWAITING_PING_RSP, AWAITING_CHECK_SE, AWAITING_CHECK_CREATE_SE
create_se_cookie
- Type
- string
- Category
- optional
- Description
add_vnic_se_uuid
- Type
- string
- Category
- optional
- Description
bootup_se_uuid
- Type
- string
- Category
- optional
- Description
next_spawn_ticks
- Type
- uint64
- Category
- optional
- Description
num_seq_spawn_fail
- Type
- int32
- Category
- optional
- Description
- Default
- 0
spawn_fail_reason
- Type
- string
- Category
- optional
- Description
exclude_vnic_op
- Type
- bool
- Category
- optional
- Description
- Default
- False
exclude_create_op
- Type
- bool
- Category
- optional
- Description
- Default
- False
vnic_ip_se_uuid
- Type
- string
- Category
- optional
- Description
op_start_ticks
- Type
- Unknown
- Category
- optional
- Description
at_spawn_limit
- Type
- bool
- Category
- optional
- Description
- Default
- False
placement_disabled
- Type
- bool
- Category
- optional
- Description
- Default
- False
placement_disabled_reason
- Type
- string
- Category
- optional
- Description
spawn_fail_reason_code
- Type
- enum
- Category
- optional
- Description
- Default
- SYSERR_FAILURE
- 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
num_spawn_attempts
- Type
- int32
- Category
- optional
- Description
- Default
- 0
placement_history
- Type
- PlacementHistory
- Category
- repeated
- Description
placement_disabled_reason_code
- Type
- enum
- Category
- optional
- Description
- Default
- SYSERR_FAILURE
- 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
create_disabled
- Type
- bool
- Category
- optional
- Description
- Default
- False
vnic_op_disabled
- Type
- bool
- Category
- optional
- Description
- Default
- False
write_ops_disabled_reason
- Type
- string
- Category
- optional
- Description
write_ops_disabled_reason_code
- Type
- enum
- Category
- optional
- Description
- Default
- SYSERR_FAILURE
- 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
pending_vnic_op
- Type
- bool
- Category
- optional
- Description
- Default
- False
pending_vnic_op_reason
- Type
- string
- Category
- optional
- Description
vnic_ip_disabled
- Type
- bool
- Category
- optional
- Description
- Default
- False
write_ops_disabled_info
- Type
- VipPlacementResolutionInfo
- Category
- optional
- Description
static_se_uuids
- Type
- string
- Category
- repeated
- Description
query_host_cookie
- Type
- string
- Category
- optional
- Description
query_host_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
insufficient_buffer_se
- Type
- bool
- Category
- optional
- Description
- Default
- False
parent_uuid
- Type
- string
- Category
- optional
- Description
availability_zone
- Type
- string
- Category
- optional
- Description
cloud_ready
- Type
- bool
- Category
- optional
- Description
- Default
- True
cloud_unready_reason
- Type
- string
- Category
- optional
- Description
cloud_unready_reason_code
- Type
- enum
- Category
- optional
- Description
- Default
- SYSERR_FAILURE
- 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
east_west_placement
- Type
- bool
- Category
- optional
- Description
- Force placement on all SE's in service group (Mesos mode only)
- Default
- False
subnet
- Type
- IpAddrPrefix
- Category
- optional
- Description
- Subnet for choosing vnic that vip is placed on
ign_pool_net_reach
- Type
- bool
- Category
- optional
- Description
- Default
- False
num_seq_vnic_fail
- Type
- int32
- Category
- optional
- Description
- Default
- 0
enable_rhi
- Type
- bool
- Category
- optional
- Description
- Default
- False
active_standby_se_tag
- Type
- enum
- Category
- optional
- Description
- Default
- ACTIVE_STANDBY_SE_1
- Choices
- ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2
enable_rhi_snat
- Type
- bool
- Category
- optional
- Description
- Default
- False
snat_ip
- Type
- IpAddr
- Category
- repeated
- Description
ping_rsp_se_uuid
- Type
- string
- Category
- optional
- Description
ping_rsp_cookie
- Type
- string
- Category
- optional
- Description
scaleout_ecmp
- Type
- bool
- Category
- optional
- Description
- Default
- False
service_subnet
- Type
- IpAddrPrefix
- Category
- optional
- Description
- Subnet for choosing vnic that vip is placed on
dns_info
- Type
- DnsInfo
- Category
- repeated
- Description
- DNS resolvable, fully qualified domain name of the virtualservice.
fip
- Type
- IpAddr
- Category
- optional
- Description
- Floating ip associated with the virtualservice.
SeResourceConsumedProto
res_ref
- Type
- Reference to ServiceEngine
- Category
- required
- Description
consumer_ref
- Type
- Reference to VirtualService
- Category
- required
- Description
res_name
- Type
- string
- Category
- optional
- Description
consumer_name
- Type
- string
- Category
- optional
- Description
vcpus
- Type
- int32
- Category
- optional
- Description
memory
- Type
- int32
- Category
- optional
- Description
static_se_binding
- Type
- bool
- Category
- required
- Description
- Default
- False
vip
- Type
- IpAddr
- Category
- optional
- Description
is_primary
- Type
- bool
- Category
- required
- Description
is_stby
- Type
- bool
- Category
- required
- Description
vnics
- Type
- SeResourceVnic
- Category
- repeated
- Description
marked_for_scalein
- Type
- bool
- Category
- optional
- Description
- Default
- False
sec_idx
- Type
- int32
- Category
- optional
- Description
- Default
- 1
vip_intf_list
- Type
- SeVipInterfaceList
- Category
- repeated
- Description
attach_ip_cookie
- Type
- string
- Category
- optional
- Description
attach_ip_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
last_attach_ip_start_ticks
- Type
- uint32
- Category
- optional
- Description
attach_ip_success
- Type
- bool
- Category
- optional
- Description
- Default
- True
attach_ip_fail_cnt
- Type
- int32
- Category
- optional
- Description
- Default
- 0
attach_ip_fail_str
- Type
- string
- Category
- optional
- Description
attach_ip_fail_syserr
- Type
- enum
- Category
- optional
- Description
- 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
last_attach_ip_fail_ticks
- Type
- uint32
- Category
- optional
- Description
floating_intf_ip
- Type
- IpAddr
- Category
- repeated
- Description
marked_for_delete
- Type
- bool
- Category
- optional
- Description
- Default
- False
failover_attempts
- Type
- uint64
- Category
- optional
- Description
- Default
- 0
last_failover_attempt_ticks
- Type
- uint64
- Category
- optional
- Description
- Default
- 0
admin_down
- Type
- bool
- Category
- optional
- Description
- This flag is set when scalein is called with admin_down. This flag gets reset when scaleout is called with admin_up.This SE will be temporarily not receiving traffic during the admin_down but the VS will not be removed from the SE
- Default
- False
SeResourceVnic
mac_addr
- Type
- string
- Category
- required
- Description
virtual_network_id
- Type
- string
- Category
- optional
- Description
- Default
is_avi_internal_network
- Type
- bool
- Category
- required
- Description
last_vnic_op_ticks
- Type
- Unknown
- Category
- optional
- Description
- Default
- 0
marked_for_del
- Type
- bool
- Category
- optional
- Description
- Default
- False
port_uuid
- Type
- string
- Category
- optional
- Description
del_retries
- Type
- int32
- Category
- optional
- Description
- Default
- 0
connected
- Type
- bool
- Category
- optional
- Description
- Default
- True
enabled
- Type
- bool
- Category
- optional
- Description
- Default
- True
vnic_type
- Type
- enum
- Category
- optional
- Description
- Default
- RM_VNIC_FRONTEND
- Choices
- RM_VNIC_FRONTEND, RM_VNIC_BACKEND
subnet
- Type
- IpAddrPrefix
- Category
- optional
- Description
in_use
- Type
- bool
- Category
- optional
- Description
lif
- Type
- string
- Category
- optional
- Description
vrf_uuid
- Type
- string
- Category
- optional
- Description
- Default
vips
- Type
- string
- Category
- repeated
- Description
linux_name
- Type
- string
- Category
- optional
- Description
- Default
VsProtocol
service_port
- Type
- int32
- Category
- required
- Description
type
- Type
- enum
- Category
- required
- Description
- Choices
- PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH
vip
- Type
- IpAddrPrefix
- Category
- optional
- Description
service_port_end
- Type
- int32
- Category
- optional
- Description
mac_addr
- Type
- string
- Category
- optional
- Description
ConVip
vip
- Type
- IpAddr
- Category
- optional
- Description
virtual_network_id
- Type
- string
- Category
- repeated
- Description
subnet
- Type
- IpAddrPrefix
- Category
- repeated
- Description
ConServer
server_ip
- Type
- IpAddr
- Category
- required
- Description
virtual_network_id
- Type
- string
- Category
- repeated
- Description
subnet
- Type
- IpAddrPrefix
- Category
- repeated
- Description
pool_uuid
- Type
- string
- Category
- optional
- Description
VsResProfile
res
- Type
- VirtualServiceResource
- Category
- required
- Description
max_cpu_per_se
- Type
- uint32
- Category
- optional
- Description
min_cpu_per_se
- Type
- uint32
- Category
- optional
- Description
max_mem_per_se
- Type
- uint32
- Category
- optional
- Description
min_mem_per_se
- Type
- uint32
- Category
- optional
- Description
PlacementHistory
ref
- Type
- Reference to ServiceEngine
- Category
- optional
- Description
op
- Type
- enum
- Category
- optional
- Description
- Choices
- PLACEMENT_OP_BIND_SE, PLACEMENT_OP_UNBIND_SE, PLACEMENT_OP_CREATE_SE, PLACEMENT_OP_CREATE_SE_SUCCESS, PLACEMENT_OP_CREATE_SE_FAIL, PLACEMENT_OP_MOD_VNIC, PLACEMENT_OP_MOD_VNIC_SUCCESS, PLACEMENT_OP_MOD_VNIC_FAIL, PLACEMENT_OP_BOOTUP_SUCCESS, PLACEMENT_OP_BOOTUP_FAIL, PLACEMENT_OP_VNIC_IP_FAIL, PLACEMENT_OP_SWITCHOVER_PRIMARY, PLACEMENT_OP_ADD_VIP_VNIC, PLACEMENT_OP_DEL_VIP_VNIC
reason
- Type
- enum
- Category
- optional
- Description
- 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
ticks
- Type
- uint64
- Category
- optional
- Description
timestamp
- Type
- string
- Category
- optional
- Description
reason_str
- Type
- string
- Category
- optional
- Description
info
- Type
- PlacementOpInfo
- Category
- optional
- Description
user_acked
- Type
- bool
- Category
- optional
- Description
- Default
- False
name
- Type
- string
- Category
- optional
- Description
type
- Type
- string
- Category
- optional
- Description
PlacementOpInfo
create_info
- Type
- CreateInfo
- Category
- optional
- Description
mod_vnic_info
- Type
- ModVnicInfo
- Category
- optional
- Description
vnic_ip_info
- Type
- VnicIpInfo
- Category
- optional
- Description
switchover_info
- Type
- SwitchoverInfo
- Category
- optional
- Description
vip_vnic_info
- Type
- UpdVipVnicInfo
- Category
- optional
- Description
CreateInfo
name
- Type
- string
- Category
- optional
- Description
host_ref
- Type
- Reference to VIMgrHostRuntime
- Category
- optional
- Description
status
- Type
- enum
- Category
- optional
- Description
- Choices
- SEVM_SUCCESS, SEVM_CREATE_FAIL_NO_HW_INFO, SEVM_CREATE_FAIL_DUPLICATE_NAME, SEVM_CREATE_FAIL_NO_MGMT_NW, SEVM_CREATE_FAIL_NO_CPU, SEVM_CREATE_FAIL_NO_MEM, SEVM_CREATE_FAIL_NO_LEASE, SEVM_CREATE_FAIL_OVF_ERROR, SEVM_CREATE_NO_HOST_VM_NETWORK, SEVM_CREATE_FAIL_NO_PROGRESS, SEVM_CREATE_FAIL_ABORTED, SEVM_CREATE_FAILURE, SEVM_CREATE_FAIL_POWER_ON, SEVM_VNIC_NO_VM, SEVM_VNIC_MAC_ADDR_ERROR, SEVM_VNIC_FAILURE, SEVM_VNIC_NO_PG_PORTS, SEVM_DELETE_FAILURE, SEVM_CREATE_LIMIT_REACHED, SEVM_SET_MGMT_IP_FAILED, SEVM_CREATE_ACCESS_ERROR, SEVM_CREATE_NO_IMAGE, SEVM_VINFRA_UNINITIALIZED, SEVM_CREATE_NO_HOST, SEVM_CREATE_FAIL_NO_MGMT_NW_PORTS, SEVM_INVALID_DATA, SEVM_VCENTER_CONN_FAIL, SEVM_TIMED_OUT, SEVM_NO_SOURCE_CLONE, SEVM_NO_AVAILABILITY_ZONE, SEVM_FLAVOR_UNAVAIL, SEVM_DELETED, SEVM_VINFRA_FAILURE, SEVM_VNIC_FAILURE_QUESTION, SEVM_VNIC_NO_IPS_AVAILABLE, SEVM_NO_MGMT_IP_AVAILABLE
timed_out
- Type
- bool
- Category
- optional
- Description
recoverable
- Type
- bool
- Category
- optional
- Description
mgmt_network
- Type
- string
- Category
- optional
- Description
reason_code
- Type
- enum
- Category
- optional
- Description
- 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
mgmt_subnet
- Type
- IpAddrPrefix
- Category
- optional
- Description
ModVnicInfo
mac_addr
- Type
- string
- Category
- repeated
- Description
network_ref
- Type
- Reference to Network
- Category
- repeated
- Description
status
- Type
- enum
- Category
- optional
- Description
- Choices
- SEVM_SUCCESS, SEVM_CREATE_FAIL_NO_HW_INFO, SEVM_CREATE_FAIL_DUPLICATE_NAME, SEVM_CREATE_FAIL_NO_MGMT_NW, SEVM_CREATE_FAIL_NO_CPU, SEVM_CREATE_FAIL_NO_MEM, SEVM_CREATE_FAIL_NO_LEASE, SEVM_CREATE_FAIL_OVF_ERROR, SEVM_CREATE_NO_HOST_VM_NETWORK, SEVM_CREATE_FAIL_NO_PROGRESS, SEVM_CREATE_FAIL_ABORTED, SEVM_CREATE_FAILURE, SEVM_CREATE_FAIL_POWER_ON, SEVM_VNIC_NO_VM, SEVM_VNIC_MAC_ADDR_ERROR, SEVM_VNIC_FAILURE, SEVM_VNIC_NO_PG_PORTS, SEVM_DELETE_FAILURE, SEVM_CREATE_LIMIT_REACHED, SEVM_SET_MGMT_IP_FAILED, SEVM_CREATE_ACCESS_ERROR, SEVM_CREATE_NO_IMAGE, SEVM_VINFRA_UNINITIALIZED, SEVM_CREATE_NO_HOST, SEVM_CREATE_FAIL_NO_MGMT_NW_PORTS, SEVM_INVALID_DATA, SEVM_VCENTER_CONN_FAIL, SEVM_TIMED_OUT, SEVM_NO_SOURCE_CLONE, SEVM_NO_AVAILABILITY_ZONE, SEVM_FLAVOR_UNAVAIL, SEVM_DELETED, SEVM_VINFRA_FAILURE, SEVM_VNIC_FAILURE_QUESTION, SEVM_VNIC_NO_IPS_AVAILABLE, SEVM_NO_MGMT_IP_AVAILABLE
timed_out
- Type
- bool
- Category
- optional
- Description
recoverable
- Type
- bool
- Category
- optional
- Description
VnicIpInfo
network_ref
- Type
- Reference to Network
- Category
- repeated
- Description
subnet
- Type
- IpAddrPrefix
- Category
- repeated
- Description
timed_out
- Type
- bool
- Category
- optional
- Description
- Default
- True
SwitchoverInfo
old_primary_name
- Type
- string
- Category
- optional
- Description
old_primary_uuid
- Type
- string
- Category
- optional
- Description
new_primary_name
- Type
- string
- Category
- optional
- Description
new_primary_uuid
- Type
- string
- Category
- optional
- Description
UpdVipVnicInfo
se_uuid
- Type
- string
- Category
- optional
- Description
se_name
- Type
- string
- Category
- optional
- Description
primary
- Type
- bool
- Category
- optional
- Description
standby
- Type
- bool
- Category
- optional
- Description
mac_addr
- Type
- string
- Category
- repeated
- Description
GslbServiceDetail
API
CLI
show virtualservice <key> gslbservicedetail filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [gs_uuid]
Data
GslbServiceDetail
proc_id
- Type
- string
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
- Name for the GSLB service.
domain_names
- Type
- string
- Category
- repeated
- Description
- Fully qualified domain name of the GSLB service.
num_dns_ip
- Type
- uint32
- Category
- optional
- Description
- Number of IP addresses of this GSLB service to be returned by the DNS Service
ttl
- Type
- uint32
- Category
- optional
- Description
- TTL value for A records for this GSLB service served by the DNS Service
last_dp_oper_state
- Type
- OperationalStatus
- Category
- optional
- Description
groups_detail
- Type
- GslbPoolDetail
- Category
- repeated
- Description
- Select list of pools belonging to this GSLB service
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
vrf_id
- Type
- uint32
- Category
- optional
- Description
- VRF Id
GslbPoolDetail
name
- Type
- string
- Category
- optional
- Description
- Name of the GSLB pool.
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
priority
- Type
- uint32
- Category
- optional
- Description
- Priority of this pool of members. If the priority of this is the highest in the group, DNS service picks up only this member for DNS responses.
algorithm
- Type
- enum
- Category
- optional
- Description
- The load balancing algorithm will pick a local member within the GSLB service list of available Members.
- Default
- GSLB_ALGORITHM_ROUND_ROBIN
- Choices
- GSLB_ALGORITHM_ROUND_ROBIN, GSLB_ALGORITHM_CONSISTENT_HASH, GSLB_ALGORITHM_GEO
members
- Type
- GslbPoolMemberDetail
- Category
- repeated
- Description
- Select list of Virtual Services belonging to this GSLB
stats
- Type
- GslbServiceGroupStats
- Category
- optional
- Description
num_servers
- Type
- uint32
- Category
- optional
- Description
num_servers_enabled
- Type
- uint32
- Category
- optional
- Description
num_servers_up
- Type
- uint32
- Category
- optional
- Description
hmon
- Type
- HealthMonitorStatRuntime
- Category
- optional
- Description
GslbPoolMemberDetail
ip
- Type
- IpAddr
- Category
- optional
- Description
- IP Address of the GSLB pool member.
ratio
- Type
- uint32
- Category
- optional
- Description
- Overrides the default ratio of 1. Reduces the percentage the LB algorithm would pick the server in relation to its peers.
- Default
- 1
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
conn_duration
- Type
- uint64
- Category
- optional
- Description
new_established_conns
- Type
- uint64
- Category
- optional
- Description
finished_conns
- Type
- uint64
- Category
- optional
- Description
open_conns
- Type
- uint64
- Category
- optional
- Description
errored_connections
- Type
- uint64
- Category
- optional
- Description
rx_pkts
- Type
- uint64
- Category
- optional
- Description
rx_bytes
- Type
- uint64
- Category
- optional
- Description
tx_pkts
- Type
- uint64
- Category
- optional
- Description
tx_bytes
- Type
- uint64
- Category
- optional
- Description
server_uptime
- Type
- uint64
- Category
- optional
- Description
num_state_changes
- Type
- uint64
- Category
- optional
- Description
health_check_failures
- Type
- uint64
- Category
- optional
- Description
- Default
- 0
health_status
- Type
- uint64
- Category
- optional
- Description
- Default
- 0
lb_fail_count
- Type
- uint64
- Category
- optional
- Description
- Number of times load balancing failed
GslbServiceGroupStats
total_connections
- Type
- uint64
- Category
- optional
- Description
current_connections
- Type
- uint64
- Category
- optional
- Description
bad_connections
- Type
- uint64
- Category
- optional
- Description
pool_load
- Type
- int32
- Category
- optional
- Description
lb_fail_persistent_server_invalid
- Type
- uint32
- Category
- optional
- Description
lb_fail_persistent_server_down
- Type
- uint32
- Category
- optional
- Description
lb_fail_server_down
- Type
- uint32
- Category
- optional
- Description
lb_fail_add_pending
- Type
- uint32
- Category
- optional
- Description
HealthMonitorStatRuntime
last_transition_timestamp_3
- Type
- TimeStamp
- Category
- optional
- Description
last_transition_timestamp_2
- Type
- TimeStamp
- Category
- optional
- Description
last_transition_timestamp_1
- Type
- TimeStamp
- Category
- optional
- Description
server_hm_stat
- Type
- ServerHMStatRuntime
- Category
- repeated
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
ServerHMStatRuntime
server_name
- Type
- string
- Category
- optional
- Description
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
last_transition_timestamp_3
- Type
- TimeStamp
- Category
- optional
- Description
last_transition_timestamp_2
- Type
- TimeStamp
- Category
- optional
- Description
last_transition_timestamp_1
- Type
- TimeStamp
- Category
- optional
- Description
shm_runtime
- Type
- ServerHealthMonitorRuntime
- Category
- repeated
- Description
ip_addr
- Type
- IpAddr
- Category
- optional
- Description
port
- Type
- int32
- Category
- optional
- Description
ServerHealthMonitorRuntime
health_monitor_name
- Type
- string
- Category
- optional
- Description
uuid
- Type
- string
- Category
- optional
- Description
health_monitor_type
- Type
- enum
- Category
- required
- Description
- Choices
- HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB
last_transition_timestamp_3
- Type
- TimeStamp
- Category
- optional
- Description
last_transition_timestamp_2
- Type
- TimeStamp
- Category
- optional
- Description
last_transition_timestamp_1
- Type
- TimeStamp
- Category
- optional
- Description
state
- Type
- int32
- Category
- required
- Description
rise_count
- Type
- uint32
- Category
- required
- Description
fall_count
- Type
- uint32
- Category
- required
- Description
total_checks
- Type
- uint32
- Category
- optional
- Description
total_failed_checks
- Type
- uint32
- Category
- optional
- Description
total_count
- Type
- ServerHealthMonitorCounter
- Category
- repeated
- Description
curr_count
- Type
- ServerHealthMonitorCounter
- Category
- repeated
- Description
hm_initial
- Type
- uint32
- Category
- optional
- Description
hm_icmp_id
- Type
- uint32
- Category
- optional
- Description
hm_icmp_seq
- Type
- uint32
- Category
- optional
- Description
hm_icmp_accept_rsp
- Type
- uint32
- Category
- optional
- Description
avg_response_time
- Type
- uint64
- Category
- optional
- Description
recent_response_time
- Type
- uint64
- Category
- optional
- Description
min_response_time
- Type
- uint64
- Category
- optional
- Description
max_response_time
- Type
- uint64
- Category
- optional
- Description
port
- Type
- uint32
- Category
- optional
- Description
protocol
- Type
- uint32
- Category
- optional
- Description
request_string
- Type
- string
- Category
- optional
- Description
response_string
- Type
- string
- Category
- optional
- Description
bad_response_string
- Type
- string
- Category
- optional
- Description
bad_response_timestamp
- Type
- TimeStamp
- Category
- optional
- Description
response_code
- Type
- uint32
- Category
- optional
- Description
ssl_error_code
- Type
- enum
- Category
- optional
- Description
- Choices
- ADF_CLIENT_CONN_SETUP_REFUSED, ADF_SERVER_CONN_SETUP_REFUSED, ADF_CLIENT_CONN_SETUP_TIMEDOUT, ADF_SERVER_CONN_SETUP_TIMEDOUT, ADF_CLIENT_CONN_SETUP_FAILED_INTERNAL, ADF_SERVER_CONN_SETUP_FAILED_INTERNAL, ADF_CLIENT_CONN_SETUP_FAILED_BAD_PACKET, ADF_UDP_CONN_SETUP_FAILED_INTERNAL, ADF_UDP_SERVER_CONN_SETUP_FAILED_INTERNAL, ADF_CLIENT_SENT_RESET, ADF_SERVER_SENT_RESET, ADF_CLIENT_CONN_TIMEDOUT, ADF_SERVER_CONN_TIMEDOUT, ADF_USER_DELETE_OPERATION, ADF_CLIENT_REQUEST_TIMEOUT, ADF_CLIENT_CONN_ABORTED, ADF_CLIENT_SSL_HANDSHAKE_FAILURE, ADF_CLIENT_CONN_FAILED, ADF_SERVER_CERTIFICATE_VERIFICATION_FAILED, ADF_SERVER_SIDE_SSL_HANDSHAKE_FAILED, ADF_IDLE_TIMEDOUT, ADF_CLIENT_HIGH_TIMEOUT_RETRANSMITS, ADF_SERVER_HIGH_TIMEOUT_RETRANSMITS, ADF_CLIENT_HIGH_RX_ZERO_WINDOW_SIZE_EVENTS, ADF_SERVER_HIGH_RX_ZERO_WINDOW_SIZE_EVENTS, ADF_CLIENT_RTT_ABOVE_SEC, ADF_SERVER_RTT_ABOVE_500MS, ADF_CLIENT_HIGH_TOTAL_RETRANSMITS, ADF_SERVER_HIGH_TOTAL_RETRANSMITS, ADF_CLIENT_HIGH_OUT_OF_ORDERS, ADF_SERVER_HIGH_OUT_OF_ORDERS, ADF_CLIENT_HIGH_TX_ZERO_WINDOW_SIZE_EVENTS, ADF_SERVER_HIGH_TX_ZERO_WINDOW_SIZE_EVENTS, ADF_CLIENT_POSSIBLE_WINDOW_STUCK, ADF_SERVER_POSSIBLE_WINDOW_STUCK, ADF_SERVER_UNANSWERED_SYNS, ADF_RESPONSE_CODE_4XX, ADF_RESPONSE_CODE_5XX, ADF_LOAD_BALANCING_FAILED, ADF_DATASCRIPT_EXECUTION_FAILED, ADF_REQUEST_NO_POOL, ADF_RATE_LIMIT_DROP_CLIENT_IP, ADF_RATE_LIMIT_DROP_URI, ADF_RATE_LIMIT_DROP_CLIENT_IP_URI, ADF_RATE_LIMIT_DROP_UNKNOWN_URI, ADF_RATE_LIMIT_DROP_BAD_URI, ADF_REQUEST_VIRTUAL_HOSTING_APP_SELECT_FAILED, ADF_RATE_LIMIT_DROP_UNKNOWN_CIP, ADF_RATE_LIMIT_DROP_BAD_CIP, ADF_RATE_LIMIT_DROP_CLIENT_IP_BAD, ADF_RATE_LIMIT_DROP_URI_BAD, ADF_RATE_LIMIT_DROP_CLIENT_IP_URI_BAD, ADF_RATE_LIMIT_DROP_REQ, ADF_RATE_LIMIT_DROP_CLIENT_IP_CONN, ADF_RATE_LIMIT_DROP_CONN, ADF_RATE_LIMIT_DROP_HEADER, ADF_HTTP_VERSION_LT_1_0, ADF_CLIENT_HIGH_RESPONSE_TIME, ADF_SERVER_HIGH_RESPONSE_TIME, ADF_PERSISTENT_SERVER_CHANGE, ADF_DOS_SERVER_BAD_GATEWAY, ADF_DOS_SERVER_GATEWAY_TIMEOUT, ADF_DOS_CLIENT_SENT_RESET, ADF_DOS_CLIENT_CONN_TIMEOUT, ADF_DOS_CLIENT_REQUEST_TIMEOUT, ADF_DOS_CLIENT_CONN_ABORTED, ADF_DOS_CLIENT_BAD_REQUEST, ADF_DOS_CLIENT_REQUEST_ENTITY_TOO_LARGE, ADF_DOS_CLIENT_REQUEST_URI_TOO_LARGE, ADF_DOS_CLIENT_REQUEST_HEADER_TOO_LARGE, ADF_DOS_CLIENT_CLOSED_REQUEST, ADF_DOS_SSL_ERROR, ADF_X509_CLIENT_CERTIFICATE_VERIFICATION_FAILED, ADF_X509_CLIENT_CERTIFICATE_NOT_YET_VALID, ADF_X509_CLIENT_CERTIFICATE_EXPIRED, ADF_X509_CLIENT_CERTIFICATE_REVOKED, ADF_X509_CLIENT_CERTIFICATE_INVALID_CA, ADF_X509_CLIENT_CERTIFICATE_CRL_NOT_PRESENT, ADF_X509_CLIENT_CERTIFICATE_CRL_NOT_YET_VALID, ADF_X509_CLIENT_CERTIFICATE_CRL_EXPIRED, ADF_X509_CLIENT_CERTIFICATE_CRL_ERROR, ADF_X509_CLIENT_CERTIFICATE_CHAINING_ERROR, ADF_X509_CLIENT_CERTIFICATE_INTERNAL_ERROR, ADF_X509_CLIENT_CERTIFICATE_FORMAT_ERROR, ADF_UDP_PORT_NOT_REACHABLE, ADF_UDP_CONN_TIMEOUT, ADF_X509_SERVER_CERTIFICATE_VERIFICATION_FAILED, ADF_X509_SERVER_CERTIFICATE_NOT_YET_VALID, ADF_X509_SERVER_CERTIFICATE_EXPIRED, ADF_X509_SERVER_CERTIFICATE_REVOKED, ADF_X509_SERVER_CERTIFICATE_INVALID_CA, ADF_X509_SERVER_CERTIFICATE_CRL_NOT_PRESENT, ADF_X509_SERVER_CERTIFICATE_CRL_NOT_YET_VALID, ADF_X509_SERVER_CERTIFICATE_CRL_EXPIRED, ADF_X509_SERVER_CERTIFICATE_CRL_ERROR, ADF_X509_SERVER_CERTIFICATE_CHAINING_ERROR, ADF_X509_SERVER_CERTIFICATE_INTERNAL_ERROR, ADF_X509_SERVER_CERTIFICATE_FORMAT_ERROR, ADF_X509_SERVER_CERTIFICATE_HOSTNAME_ERROR, ADF_SSL_R_BAD_CHANGE_CIPHER_SPEC, ADF_SSL_R_BLOCK_CIPHER_PAD_IS_WRONG, ADF_SSL_R_DIGEST_CHECK_FAILED, ADF_SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST, ADF_SSL_R_EXCESSIVE_MESSAGE_SIZE, ADF_SSL_R_LENGTH_MISMATCH, ADF_SSL_R_NO_CIPHERS_PASSED, ADF_SSL_R_NO_CIPHERS_SPECIFIED, ADF_SSL_R_NO_COMPRESSION_SPECIFIED, ADF_SSL_R_NO_SHARED_CIPHER, ADF_SSL_R_RECORD_LENGTH_MISMATCH, ADF_SSL_R_PARSE_TLSEXT, ADF_SSL_R_UNEXPECTED_MESSAGE, ADF_SSL_R_UNEXPECTED_RECORD, ADF_SSL_R_UNKNOWN_ALERT_TYPE, ADF_SSL_R_UNKNOWN_PROTOCOL, ADF_SSL_R_WRONG_VERSION_NUMBER, ADF_SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC, ADF_SSL_R_RENEGOTIATE_EXT_TOO_LONG, ADF_SSL_R_RENEGOTIATION_ENCODING_ERR, ADF_SSL_R_RENEGOTIATION_MISMATCH, ADF_SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED, ADF_SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING, ADF_SSL_R_INAPPROPRIATE_FALLBACK, ADF_SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE, ADF_SSL_R_SSLV3_ALERT_BAD_RECORD_MAC, ADF_SSL_R_TLSV1_ALERT_DECRYPTION_FAILED, ADF_SSL_R_TLSV1_ALERT_RECORD_OVERFLOW, ADF_SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE, ADF_SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE, ADF_SSL_R_SSLV3_ALERT_NO_CERTIFICATE, ADF_SSL_R_SSLV3_ALERT_BAD_CERTIFICATE, ADF_SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE, ADF_SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED, ADF_SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED, ADF_SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN, ADF_SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER, ADF_SSL_R_TLSV1_ALERT_UNKNOWN_CA, ADF_SSL_R_TLSV1_ALERT_ACCESS_DENIED, ADF_SSL_R_TLSV1_ALERT_DECODE_ERROR, ADF_SSL_R_TLSV1_ALERT_DECRYPT_ERROR, ADF_SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION, ADF_SSL_R_TLSV1_ALERT_PROTOCOL_VERSION, ADF_SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY, ADF_SSL_R_TLSV1_ALERT_INTERNAL_ERROR, ADF_SSL_R_TLSV1_ALERT_USER_CANCELLED, ADF_SSL_R_TLSV1_ALERT_NO_RENEGOTIATION, ADF_CLIENT_AUTH_UNKNOWN_USER, ADF_CLIENT_AUTH_LOGIN_FAILED, ADF_CLIENT_AUTH_MISSING_CREDENTIALS, ADF_CLIENT_AUTH_SERVER_CONN_ERROR, ADF_CLIENT_AUTH_USER_NOT_AUTHORIZED, ADF_CLIENT_AUTH_TIMED_OUT, ADF_CLIENT_AUTH_UNKNOWN_ERROR, ADF_CLIENT_DNS_FAILED_INVALID_QUERY, ADF_CLIENT_DNS_FAILED_INVALID_DOMAIN, ADF_CLIENT_DNS_FAILED_NO_SERVICE, ADF_CLIENT_DNS_FAILED_GS_DOWN, ADF_CLIENT_DNS_FAILED_NO_VALID_GS_MEMBER, ADF_SERVER_DNS_ERROR_RESPONSE, ADF_CLIENT_DNS_FAILED_UNSUPPORTED_QUERY, ADF_MEMORY_EXHAUSTED
curr_failed_checks
- Type
- uint32
- Category
- optional
- Description
snat_ip
- Type
- IpAddr
- Category
- optional
- Description
- SNAT IP
ServerHealthMonitorCounter
type
- Type
- enum
- Category
- required
- Description
- Choices
- ARP_UNRESOLVED, CONNECTION_REFUSED, CONNECTION_TIMEOUT, RESPONSE_CODE_MISMATCH, PAYLOAD_CONTENT_MISMATCH, SERVER_UNREACHABLE, CONNECTION_RESET, CONNECTION_ERROR, HOST_ERROR, ADDRESS_ERROR, NO_PORT, PAYLOAD_TIMEOUT, NO_RESPONSE, NO_RESOURCES, SSL_ERROR, SSL_CERT_ERROR, PORT_UNREACHABLE, SCRIPT_ERROR, OTHER_ERROR, SERVER_DISABLED, REMOTE_STATE, MAINTENANCE_RESPONSE_CODE_MATCH, MAINTENANCE_PAYLOAD_CONTENT_MATCH, CHUNKED_RESPONSE_PAYLOAD_NOT_FOUND, GSLB_POOL_MEMBER_DOWN, GSLB_POOL_MEMBER_DISABLED, GSLB_POOL_MEMBER_STATE_UNKNOWN
count
- Type
- uint32
- Category
- required
- Description
VirtualServiceRuntimeDetail
API
CLI
show virtualservice <key> detail filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [type] [service_port] [vservertype]
Data
VirtualServiceRuntimeDetail
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
one_plus_one_ha
- Type
- bool
- Category
- optional
- Description
- Default
- False
service_engine
- Type
- VipSeAssigned
- Category
- repeated
- Description
config_status
- Type
- ConfigurationStatus
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
l7_virtual_service_stats_runtime
- Type
- L7VirtualServiceStatsRuntime
- Category
- repeated
- Description
fel4stats
- Type
- VserverL4Stats
- Category
- repeated
- Description
fel7stats
- Type
- VserverL7Stats
- Category
- repeated
- Description
vs_type
- Type
- string
- Category
- optional
- Description
migrate_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
scalein_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
scaleout_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
user_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
progress_percent
- Type
- int32
- Category
- optional
- Description
- Default
- 0
last_scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
vs_placement_resolution_info
- Type
- VsPlacementResolutionInfo
- Category
- optional
- Description
num_se_requested
- Type
- uint32
- Category
- optional
- Description
num_se_assigned
- Type
- uint32
- Category
- optional
- Description
se_create_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
upgrade_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
migrate_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
migrate_scalein_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
vh_child_vs_ref
- Type
- Reference to VirtualService
- Category
- repeated
- Description
type
- Type
- enum
- Category
- optional
- Description
- Default
- VS_TYPE_NORMAL
- Choices
- VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD
virtual_service_auth_stats
- Type
- VirtualServiceAuthStats
- Category
- repeated
- Description
first_se_assigned_time
- Type
- TimeStamp
- Category
- optional
- Description
east_west
- Type
- bool
- Category
- optional
- Description
- Default
- False
microservice_uuid
- Type
- string
- Category
- optional
- Description
- Microservice representing the virtual service
vip_detail
- Type
- VipRuntimeDetail
- Category
- repeated
- Description
dns_stats
- Type
- VserverDNSStats
- Category
- repeated
- Description
uuid
- Type
- string
- Category
- optional
- Description
VipSeAssigned
ref
- Type
- Reference to ServiceEngine
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
primary
- Type
- bool
- Category
- optional
- Description
standby
- Type
- bool
- Category
- optional
- Description
connected
- Type
- bool
- Category
- required
- Description
scalein_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
snat_ip
- Type
- IpAddr
- Category
- optional
- Description
admin_down_requested
- Type
- bool
- Category
- optional
- Description
- Default
- False
ConfigurationStatus
state
- Type
- enum
- Category
- required
- Description
- Default
- CONFIG_UP
- Choices
- CONFIG_UP, CONFIG_DOWN, CONFIG_CREATING, CONFIG_RESOURCES, CONFIG_INACTIVE, CONFIG_DISABLED, CONFIG_UNUSED, CONFIG_UNKNOWN, CONFIG_PROCESSING, CONFIG_INITIALIZING, CONFIG_ERROR_DISABLED, CONFIG_AWAIT_MANUAL_PLACEMENT, CONFIG_UPGRADING, CONFIG_SE_PROCESSING, CONFIG_PARTITIONED
reason
- Type
- string
- Category
- repeated
- Description
reason_code
- Type
- uint64
- Category
- optional
- Description
last_changed_time
- Type
- TimeStamp
- Category
- optional
- Description
pvt_data
- Type
- Unknown
- Category
- optional
- Description
pvt_data_2
- Type
- Unknown
- Category
- optional
- Description
reason_code_string
- Type
- string
- Category
- optional
- Description
L7VirtualServiceStatsRuntime
connections_handled
- Type
- uint64
- Category
- required
- Description
requests_handled
- Type
- uint64
- Category
- required
- Description
response_2xx
- Type
- uint64
- Category
- required
- Description
response_3xx
- Type
- uint64
- Category
- required
- Description
response_4xx
- Type
- uint64
- Category
- required
- Description
response_5xx
- Type
- uint64
- Category
- required
- Description
cache_hits
- Type
- uint64
- Category
- required
- Description
cache_bytes
- Type
- uint64
- Category
- required
- Description
rl_unknown_uri_drop
- Type
- uint64
- Category
- optional
- Description
rl_bad_uri_drop
- Type
- uint64
- Category
- optional
- Description
rl_cip_drop
- Type
- uint64
- Category
- optional
- Description
rl_uri_drop
- Type
- uint64
- Category
- optional
- Description
rl_cip_uri_drop
- Type
- uint64
- Category
- optional
- Description
rl_unknown_cip_drop
- Type
- uint64
- Category
- optional
- Description
rl_bad_cip_drop
- Type
- uint64
- Category
- optional
- Description
rl_cip_drop_bad
- Type
- uint64
- Category
- optional
- Description
rl_uri_drop_bad
- Type
- uint64
- Category
- optional
- Description
rl_cip_uri_drop_bad
- Type
- uint64
- Category
- optional
- Description
fe_bytes_sent
- Type
- uint64
- Category
- optional
- Description
fe_bytes_rxd
- Type
- uint64
- Category
- optional
- Description
be_bytes_sent
- Type
- uint64
- Category
- optional
- Description
be_bytes_rxd
- Type
- uint64
- Category
- optional
- Description
session_init_alloc_errors
- Type
- uint64
- Category
- optional
- Description
session_init_conf_errors
- Type
- uint64
- Category
- optional
- Description
session_pre_connect_alloc_errors
- Type
- uint64
- Category
- optional
- Description
session_pre_connect_socket_errors
- Type
- uint64
- Category
- optional
- Description
session_connect_errors
- Type
- uint64
- Category
- optional
- Description
session_post_connect_alloc_errors
- Type
- uint64
- Category
- optional
- Description
session_post_connect_socket_errors
- Type
- uint64
- Category
- optional
- Description
session_post_connect_client_errors
- Type
- uint64
- Category
- optional
- Description
session_post_connect_server_errors
- Type
- uint64
- Category
- optional
- Description
VserverL4Stats
node_obj_id
- Type
- string
- Category
- required
- Description
dup_ack_retransmits
- Type
- uint64
- Category
- required
- Description
sack_retransmits
- Type
- uint64
- Category
- required
- Description
timeout_retransmits
- Type
- uint64
- Category
- required
- Description
out_of_orders
- Type
- uint64
- Category
- required
- Description
syns
- Type
- uint64
- Category
- required
- Description
new_established_conns
- Type
- uint64
- Category
- required
- Description
complete_conns
- Type
- uint64
- Category
- required
- Description
finished_conns
- Type
- uint64
- Category
- required
- Description
open_conns
- Type
- uint64
- Category
- required
- Description
connections_dropped
- Type
- uint64
- Category
- required
- Description
lossy_connections
- Type
- uint64
- Category
- required
- Description
errored_connections
- Type
- uint64
- Category
- required
- Description
policy_drops
- Type
- uint64
- 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.
rx_pkts
- Type
- uint64
- Category
- required
- Description
rx_bytes
- Type
- uint64
- Category
- required
- Description
tx_pkts
- Type
- uint64
- Category
- required
- Description
tx_bytes
- Type
- uint64
- Category
- required
- Description
rx_pkts_absolute
- Type
- uint64
- Category
- required
- Description
rx_bytes_absolute
- Type
- uint64
- Category
- required
- Description
tx_pkts_absolute
- Type
- uint64
- Category
- required
- Description
tx_bytes_absolute
- Type
- uint64
- Category
- required
- Description
end_to_end_rtt
- Type
- uint64
- Category
- required
- Description
end_to_end_rtt_bucket1
- Type
- uint64
- Category
- required
- Description
end_to_end_rtt_bucket2
- Type
- uint64
- Category
- required
- Description
conn_duration
- Type
- uint64
- Category
- required
- Description
zero_window_size_events
- Type
- uint64
- Category
- required
- Description
server_flow_control
- Type
- uint64
- Category
- required
- Description
rtt_valid_connections
- Type
- uint64
- Category
- required
- Description
conn_dropped_before_est
- Type
- uint64
- Category
- required
- Description
conn_dropped_after_est
- Type
- uint64
- Category
- required
- Description
connection_dropped_user_limit
- Type
- uint64
- Category
- required
- Description
- Number of times connection limit is reached
packet_dropped_user_bandwidth_limit
- Type
- uint64
- Category
- required
- Description
- Number of times bandwidth limit is reached
dos_syn_flood
- Type
- uint64
- Category
- required
- Description
- DoS attack: Syn Flood
dos_bad_rst_flood
- Type
- uint64
- Category
- required
- Description
- DoS attack: Bad Rst Flood
dos_malformed_flood
- Type
- uint64
- Category
- required
- Description
- DoS attack: Malformed Packet Flood
dos_fake_session
- Type
- uint64
- Category
- required
- Description
- DoS attack: Fake Session
dos_zero_window_stress
- Type
- uint64
- Category
- required
- Description
- DoS attack: Zero Window Stress
dos_small_window_stress
- Type
- uint64
- Category
- required
- Description
- DoS attack: Small Window Stress
dos_http_timeout
- Type
- uint64
- Category
- required
- Description
- DoS attack: HTTP Timeout
dos_http_error
- Type
- uint64
- Category
- required
- Description
- DoS attack: HTTP Error
dos_http_abort
- Type
- uint64
- Category
- required
- Description
- DoS attack: HTTP Abort
dos_ssl_error
- Type
- uint64
- Category
- required
- Description
- DoS attack: HTTP SSL Error
dos_app_error
- Type
- uint64
- Category
- required
- Description
- DoS attack: HTTP App Error
dos_rx_bytes
- Type
- uint64
- Category
- optional
- Description
- DoS attack: RX bandwidth
dos_tx_bytes
- Type
- uint64
- Category
- optional
- Description
- DoS attack: TX bandwidth
dos_total_req
- Type
- uint64
- Category
- optional
- Description
- Total request used for l7 dos normalization
dos_req
- Type
- uint64
- Category
- optional
- Description
- Requests considered as DoS
dos_conn
- Type
- uint64
- Category
- optional
- Description
- Connecitons considered as DoS
dos_non_syn_flood
- Type
- uint64
- Category
- optional
- Description
- DoS attack: Non SYN packet flood
dos_slow_uri
- Type
- uint64
- Category
- optional
- Description
- DoS attack: Slow Uri
dos_conn_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Connections dropped due to VS rate limit
dos_req_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to VS rate limit
dos_conn_ip_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Connections dropped due to IP rate limit
dos_req_ip_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to source IP rate limit
dos_req_uri_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to URI rate limit
dos_req_ip_uri_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requeats dropped due to IP&URI rate limit
dos_req_ip_rl_drop_bad
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to source IP rate limit for bad requests
dos_req_uri_rl_drop_bad
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to URI rate limit for bad requests
dos_req_ip_uri_rl_drop_bad
- Type
- uint64
- Category
- optional
- Description
- Requeats dropped due to IP&URI rate limit for bad requests
dos_req_ip_scan_bad_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to bad IP rate limit
dos_req_ip_scan_unknown_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to unknown IP rate limit
dos_req_uri_scan_bad_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to bad URI rate limit
dos_req_uri_scan_unknown_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to unknown URI rate limit
dos_req_hdr_rl_drop
- Type
- uint64
- Category
- optional
- Description
- Requests dropped due to header or cookie rate limit
lossy_req
- Type
- uint64
- Category
- optional
- Description
- Total request used for l7 dos normalization
rx_pkts_dropped
- Type
- uint64
- Category
- optional
- Description
- Number of packets dropped by virtual service. Include policy drops
rx_bytes_dropped
- Type
- uint64
- Category
- optional
- Description
- Number of bytes dropped by virtual service due to policy
pkts_policy_drops
- Type
- uint64
- Category
- optional
- Description
- Number of pkts dropped by virtual service due to policy like l4 security connection limits, rate limits
bytes_policy_drops
- Type
- uint64
- Category
- optional
- Description
- Number of bytes dropped by virtual service due to policy like l4 security connection limits, rate limits
num_active_se
- Type
- uint64
- Category
- optional
- Description
- Number of active SEs
VserverL7Stats
node_obj_id
- Type
- string
- Category
- required
- Description
get_reqs
- Type
- uint64
- Category
- required
- Description
post_reqs
- Type
- uint64
- Category
- required
- Description
other_reqs
- Type
- uint64
- Category
- required
- Description
finished_sessions
- Type
- uint64
- Category
- required
- Description
reqs_finished_sessions
- Type
- uint64
- Category
- required
- Description
concurrent_sessions
- Type
- uint64
- Category
- required
- Description
resp_1xx
- Type
- uint64
- Category
- required
- Description
resp_2xx
- Type
- uint64
- Category
- required
- Description
resp_3xx
- Type
- uint64
- Category
- required
- Description
resp_4xx
- Type
- uint64
- Category
- required
- Description
resp_4xx_avi_errors
- Type
- uint64
- Category
- required
- Description
resp_5xx
- Type
- uint64
- Category
- required
- Description
resp_5xx_avi_errors
- Type
- uint64
- Category
- required
- Description
get_client_txn_latency_bucket1
- Type
- uint64
- Category
- required
- Description
get_client_txn_latency_bucket2
- Type
- uint64
- Category
- required
- Description
post_client_txn_latency_bucket1
- Type
- uint64
- Category
- required
- Description
post_client_txn_latency_bucket2
- Type
- uint64
- Category
- required
- Description
other_client_txn_latency_bucket1
- Type
- uint64
- Category
- required
- Description
other_client_txn_latency_bucket2
- Type
- uint64
- Category
- required
- Description
total_requests
- Type
- uint64
- Category
- required
- Description
complete_responses
- Type
- uint64
- Category
- required
- Description
total_responses
- Type
- uint64
- Category
- required
- Description
error_responses
- Type
- uint64
- Category
- required
- Description
get_client_txn_latency
- Type
- uint64
- Category
- required
- Description
post_client_txn_latency
- Type
- uint64
- Category
- required
- Description
other_client_txn_latency
- Type
- uint64
- Category
- required
- Description
client_data_transfer_time
- Type
- uint64
- Category
- required
- Description
cache_hits
- Type
- uint64
- Category
- required
- Description
cache_bytes
- Type
- uint64
- Category
- required
- Description
cacheable_hits
- Type
- uint64
- Category
- required
- Description
cacheable_bytes
- Type
- uint64
- Category
- required
- Description
pre_compression_bytes
- Type
- uint64
- Category
- required
- Description
post_compression_bytes
- Type
- uint64
- Category
- required
- Description
saved_compression_bytes
- Type
- uint64
- Category
- required
- Description
compressed_reqs
- Type
- uint64
- Category
- required
- Description
compressed_at_origin_reqs
- Type
- uint64
- Category
- required
- Description
compressible_reqs
- Type
- uint64
- Category
- required
- Description
compression_skipped_reqs
- Type
- uint64
- Category
- required
- Description
rum_active_sampled_reqs
- Type
- uint64
- Category
- required
- Description
rum_passive_sampled_reqs
- Type
- uint64
- Category
- required
- Description
rum_not_sampled_reqs
- Type
- uint64
- Category
- required
- Description
rum_failed_sampled_reqs
- Type
- uint64
- Category
- required
- Description
ssl_handshakes_new
- Type
- uint64
- Category
- required
- Description
ssl_handshakes_reused
- Type
- uint64
- Category
- required
- Description
ssl_handshake_protocol_errors
- Type
- uint64
- Category
- required
- Description
ssl_handshake_network_errors
- Type
- uint64
- Category
- required
- Description
ssl_handshakes_timedout
- Type
- uint64
- Category
- required
- Description
ssl_ver_ssl30
- Type
- uint64
- Category
- required
- Description
ssl_ver_tls10
- Type
- uint64
- Category
- required
- Description
ssl_ver_tls11
- Type
- uint64
- Category
- required
- Description
ssl_ver_tls12
- Type
- uint64
- Category
- required
- Description
ssl_auth_rsa
- Type
- uint64
- Category
- required
- Description
ssl_auth_ecdsa
- Type
- uint64
- Category
- required
- Description
ssl_auth_dsa
- Type
- uint64
- Category
- required
- Description
ssl_kx_rsa
- Type
- uint64
- Category
- required
- Description
ssl_kx_dh
- Type
- uint64
- Category
- required
- Description
ssl_kx_ecdh
- Type
- uint64
- Category
- required
- Description
ssl_enc_rc4
- Type
- uint64
- Category
- required
- Description
ssl_enc_3des
- Type
- uint64
- Category
- required
- Description
ssl_enc_aes128
- Type
- uint64
- Category
- required
- Description
ssl_enc_aes256
- Type
- uint64
- Category
- required
- Description
ssl_mac_md5
- Type
- uint64
- Category
- required
- Description
ssl_mac_sha1
- Type
- uint64
- Category
- required
- Description
ssl_mac_sha256
- Type
- uint64
- Category
- required
- Description
ssl_mac_sha384
- Type
- uint64
- Category
- required
- Description
ssl_mac_aead
- Type
- uint64
- Category
- required
- Description
client_close_error
- Type
- uint64
- Category
- optional
- Description
application_error
- Type
- uint64
- Category
- optional
- Description
timeout_error
- Type
- uint64
- Category
- optional
- Description
no_available_pool_error
- Type
- uint64
- Category
- optional
- Description
conn_accept_error
- Type
- uint64
- Category
- optional
- Description
server_timeout_error
- Type
- uint64
- Category
- optional
- Description
persist_change
- Type
- uint64
- Category
- optional
- Description
lb_failure_error
- Type
- uint64
- Category
- optional
- Description
server_connect_error
- Type
- uint64
- Category
- optional
- Description
internal_error
- Type
- uint64
- Category
- optional
- Description
ssl_handshakes_pfs
- Type
- uint64
- Category
- optional
- Description
ssl_rsa_pfs
- Type
- uint64
- Category
- optional
- Description
ssl_ecdsa_pfs
- Type
- uint64
- Category
- optional
- Description
ssl_open_sessions
- Type
- uint64
- Category
- optional
- Description
VsPlacementResolutionInfo
ip
- Type
- IpAddr
- Category
- optional
- Description
pool_uuid
- Type
- string
- Category
- optional
- Description
networks
- Type
- DiscoveredNetwork
- Category
- repeated
- Description
VirtualServiceAuthStats
auth_counter
- Type
- uint64
- Category
- optional
- Description
auth_ignored_config
- Type
- uint64
- Category
- optional
- Description
auth_prompt_unauthorized
- Type
- uint64
- Category
- optional
- Description
auth_credentials_unauthorized
- Type
- uint64
- Category
- optional
- Description
auth_timed_out
- Type
- uint64
- Category
- optional
- Description
auth_internal_error
- Type
- uint64
- Category
- optional
- Description
server_stats
- Type
- VirtualServiceAuthServerStats
- Category
- repeated
- Description
VirtualServiceAuthServerStats
alias
- Type
- string
- Category
- optional
- Description
auth_cached_allow
- Type
- uint64
- Category
- optional
- Description
auth_cached_deny
- Type
- uint64
- Category
- optional
- Description
auth_user_search_failed
- Type
- uint64
- Category
- optional
- Description
auth_user_search_success
- Type
- uint64
- Category
- optional
- Description
auth_group_search_failed
- Type
- uint64
- Category
- optional
- Description
auth_group_search_success
- Type
- uint64
- Category
- optional
- Description
auth_login_failed
- Type
- uint64
- Category
- optional
- Description
auth_login_success
- Type
- uint64
- Category
- optional
- Description
auth_server_skipped
- Type
- uint64
- Category
- optional
- Description
auth_internal_error
- Type
- uint64
- Category
- optional
- Description
auth_waiting
- Type
- uint64
- Category
- optional
- Description
VipRuntimeDetail
vip_id
- Type
- string
- Category
- optional
- Description
- This field is used to uniquely identify the vip.
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
service_engine
- Type
- VipSeAssigned
- Category
- repeated
- Description
config_status
- Type
- ConfigurationStatus
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
l7_virtual_service_stats_runtime
- Type
- L7VirtualServiceStatsRuntime
- Category
- repeated
- Description
fel4stats
- Type
- VserverL4Stats
- Category
- repeated
- Description
fel7stats
- Type
- VserverL7Stats
- Category
- repeated
- Description
vs_type
- Type
- string
- Category
- optional
- Description
migrate_in_progress
- Type
- bool
- Category
- optional
- Description
- When true, it indicates vip is in process of migrate.
- Default
- False
scalein_in_progress
- Type
- bool
- Category
- optional
- Description
- When true, it indicates vip is in process of scalein.
- Default
- False
scaleout_in_progress
- Type
- bool
- Category
- optional
- Description
- When true, it indicates vip is in process of scaleout.
- Default
- False
user_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
progress_percent
- Type
- int32
- Category
- optional
- Description
- Default
- 0
last_scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
vip_placement_resolution_info
- Type
- VipPlacementResolutionInfo
- Category
- optional
- Description
num_se_requested
- Type
- uint32
- Category
- optional
- Description
num_se_assigned
- Type
- uint32
- Category
- optional
- Description
migrate_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
migrate_scalein_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
virtual_service_auth_stats
- Type
- VirtualServiceAuthStats
- Category
- repeated
- Description
first_se_assigned_time
- Type
- TimeStamp
- Category
- optional
- Description
microservice_uuid
- Type
- string
- Category
- optional
- Description
- Microservice representing the virtual service
VserverDNSStats
node_obj_id
- Type
- string
- Category
- required
- Description
req_type_a
- Type
- uint64
- Category
- required
- Description
req_type_aaaa
- Type
- uint64
- Category
- required
- Description
req_type_ns
- Type
- uint64
- Category
- optional
- Description
req_type_srv
- Type
- uint64
- Category
- optional
- Description
req_type_mx
- Type
- uint64
- Category
- optional
- Description
req_type_other
- Type
- uint64
- Category
- optional
- Description
resp_type_a
- Type
- uint64
- Category
- optional
- Description
resp_type_aaaa
- Type
- uint64
- Category
- optional
- Description
resp_type_ns
- Type
- uint64
- Category
- optional
- Description
resp_type_srv
- Type
- uint64
- Category
- optional
- Description
resp_type_cname
- Type
- uint64
- Category
- optional
- Description
resp_type_mx
- Type
- uint64
- Category
- optional
- Description
resp_type_other
- Type
- uint64
- Category
- optional
- Description
invalid_queries
- Type
- uint64
- Category
- optional
- Description
domain_lookup_failures
- Type
- uint64
- Category
- optional
- Description
unsupported_queries
- Type
- uint64
- Category
- optional
- Description
udp_passthrough_queries
- Type
- uint64
- Category
- optional
- Description
tcp_passthrough_queries
- Type
- uint64
- Category
- optional
- Description
gslbpool_member_not_available
- Type
- uint64
- Category
- optional
- Description
local_responses
- Type
- uint64
- Category
- optional
- Description
- Number of responses made by the Avi Load balancer from it's DNS table
udp_passthrough_errors
- Type
- uint64
- Category
- optional
- Description
- UDP passthrough errored queries - Avi sent errors or dropped requests when server timed out, had a port unreachable or responded with an error
local_nxdomains
- Type
- uint64
- Category
- optional
- Description
- Number of NXdomain responses made by the Avi Load balancer for entries not found in it's dns table
udp_queries
- Type
- uint64
- Category
- optional
- Description
- Number of UDP queries
tcp_queries
- Type
- uint64
- Category
- optional
- Description
- Number of TCP queries
errored_queries
- Type
- uint64
- Category
- optional
- Description
- Total number of errored queries
udp_passthrough_resp_time
- Type
- uint64
- Category
- optional
- Description
- Total time taken for DNS responses
tcp_passthrough_errors
- Type
- uint64
- Category
- optional
- Description
- TCP passthrough errored queries - Avi sent errors or dropped requests when server timed out, had a port unreachable or responded with an error
Actions
API
POST /api/virtualservice/<key>/stats/clear
CLI
clear virtualservice <key> stats
NetworkSecurityPolicyDetail
API
GET /api/virtualservice/<key>/networksecuritypolicy/detail/<key>
CLI
show virtualservice <key> networksecuritypolicy detail
Data
NetworkSecurityPolicyDetail
policy
- Type
- NetworkSecurityPolicy
- Category
- optional
- Description
match_ms
- Type
- bool
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- required
- Description
proc_id
- Type
- string
- Category
- required
- Description
NetworkSecurityPolicy
uuid
- Type
- string
- Category
- required
- Description
name
- Type
- string
- Category
- optional
- Description
rules
- Type
- NetworkSecurityRule
- Category
- repeated
- Description
created_by
- Type
- string
- Category
- optional
- Description
- Creator name
cloud_config_cksum
- Type
- string
- Category
- optional
- Description
- Checksum of cloud configuration for Network Sec Policy. Internally set by cloud connector
description
- Type
- string
- Category
- optional
- Description
tenant_ref
- Type
- Reference to Tenant
- Category
- optional
- Description
NetworkSecurityRule
name
- Type
- string
- Category
- required
- Description
index
- Type
- uint32
- Category
- required
- Description
enable
- Type
- bool
- Category
- required
- Description
match
- Type
- NetworkSecurityMatchTarget
- Category
- required
- Description
action
- Type
- enum
- Category
- required
- Description
- Choices
- NETWORK_SECURITY_POLICY_ACTION_TYPE_ALLOW, NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY, NETWORK_SECURITY_POLICY_ACTION_TYPE_RATE_LIMIT
log
- Type
- bool
- Category
- optional
- Description
- Default
- False
rl_param
- Type
- NetworkSecurityPolicyActionRLParam
- Category
- optional
- Description
age
- Type
- uint32
- Category
- optional
- Description
- Time in minutes after which rule will be deleted.
- Units
- min
- Default
- 0
created_by
- Type
- string
- Category
- optional
- Description
- Creator name
NetworkSecurityMatchTarget
client_ip
- Type
- IpAddrMatch
- Category
- optional
- Description
vs_port
- Type
- PortMatch
- Category
- optional
- Description
microservice
- Type
- MicroServiceMatch
- Category
- optional
- Description
MicroServiceMatch
match_criteria
- Type
- enum
- Category
- required
- Description
- Criterion to use for Micro Service matching the HTTP request
- Choices
- IS_IN, IS_NOT_IN
group_ref
- Type
- Reference to MicroServiceGroup
- Category
- optional
- Description
- UUID of Micro Service group(s)
NetworkSecurityPolicyActionRLParam
max_rate
- Type
- uint32
- Category
- required
- Description
- Maximum number of connections or requests or packets per second.
burst_size
- Type
- uint32
- Category
- required
- Description
- Maximum number of connections or requests or packets to be rate limited instantaneously.
- Default
- 0
GslbServiceInternal
API
CLI
show virtualservice <key> gslbserviceinternal filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [gs_uuid]
Data
GslbServiceInternal
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
- Name for the Gslb Service.
vs_internal
- Type
- VirtualServiceInternal
- Category
- optional
- Description
pool_detail
- Type
- PoolRuntimeDetail
- Category
- repeated
- Description
pool_internal
- Type
- PoolInternal
- Category
- repeated
- Description
server_detail
- Type
- ServerRuntimeDetail
- Category
- repeated
- Description
server_internal
- Type
- ServerInternal
- Category
- repeated
- Description
PoolRuntimeDetail
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
pool_stats
- Type
- PoolStats
- Category
- optional
- Description
num_servers
- Type
- Unknown
- Category
- required
- Description
num_servers_enabled
- Type
- Unknown
- Category
- required
- Description
num_servers_up
- Type
- Unknown
- Category
- required
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
vrf_uuid
- Type
- string
- Category
- optional
- Description
vrf_id
- Type
- uint32
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
uuid
- Type
- string
- Category
- optional
- Description
PoolStats
total_connections
- Type
- uint64
- Category
- optional
- Description
failed_requests
- Type
- uint64
- Category
- optional
- Description
current_connections
- Type
- uint64
- Category
- optional
- Description
persistence_objs
- Type
- uint64
- Category
- optional
- Description
pre_closed_connections
- Type
- uint64
- Category
- optional
- Description
bad_connections
- Type
- uint64
- Category
- optional
- Description
pool_load
- Type
- int32
- Category
- optional
- Description
persist_alloc_fails
- Type
- uint64
- Category
- optional
- Description
lb_fail_persistent_server_invalid
- Type
- uint32
- Category
- optional
- Description
lb_fail_persistent_server_down
- Type
- uint32
- Category
- optional
- Description
lb_fail_server_down
- Type
- uint32
- Category
- optional
- Description
lb_fail_add_pending
- Type
- uint32
- Category
- optional
- Description
lb_fail_slow_start_max_conn
- Type
- uint32
- Category
- optional
- Description
lb_fail_max_conn
- Type
- uint32
- Category
- optional
- Description
lb_fail_no_lport
- Type
- uint32
- Category
- optional
- Description
lb_fail_suspect_state
- Type
- uint32
- Category
- optional
- Description
inlhm_skip_bypassed
- Type
- uint32
- Category
- optional
- Description
lb_fail_max_conn_rate
- Type
- uint32
- Category
- optional
- Description
lb_fail_capest_rand_max_conn
- Type
- uint32
- Category
- optional
- Description
request_queue_num_adds
- Type
- uint64
- Category
- optional
- Description
request_queue_num_dels
- Type
- uint64
- Category
- optional
- Description
request_queue_num_flushes
- Type
- uint64
- Category
- optional
- Description
request_queue_num_dispatched
- Type
- uint64
- Category
- optional
- Description
request_queue_num_full
- Type
- uint64
- Category
- optional
- Description
request_queue_num_evicted
- Type
- uint64
- Category
- optional
- Description
request_queue_num_freed_requests
- Type
- uint64
- Category
- optional
- Description
lb_fail_get_next
- Type
- uint32
- Category
- optional
- Description
ssl_open_sessions
- Type
- uint64
- Category
- optional
- Description
ssl_handshakes_full
- Type
- uint64
- Category
- optional
- Description
ssl_handshakes_reused
- Type
- uint64
- Category
- optional
- Description
ssl_handshakes_errors
- Type
- uint64
- Category
- optional
- Description
ssl_handshakes_timedout
- Type
- uint64
- Category
- optional
- Description
ssl_handshakes_failed
- Type
- uint64
- Category
- optional
- Description
PoolInternal
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
pool_config
- Type
- Pool
- Category
- optional
- Description
num_servers
- Type
- int32
- Category
- optional
- Description
ref_count
- Type
- int32
- Category
- optional
- Description
num_persistence_objs
- Type
- Unknown
- Category
- optional
- Description
lb_state
- Type
- PoolLbState
- Category
- optional
- Description
persistence_handle_internal
- Type
- PersistenceHandleInternal
- Category
- optional
- Description
pool_refcnt
- Type
- PoolRefCnt
- Category
- optional
- Description
max_concurrent_connections_per_server
- Type
- int32
- Category
- optional
- Description
graceful_disable_timeout
- Type
- int32
- Category
- optional
- Description
connection_ramp_duration
- Type
- int32
- Category
- optional
- Description
use_service_port
- Type
- bool
- Category
- optional
- Description
application_persistence_profile_uuid
- Type
- string
- Category
- optional
- Description
prst_id
- Type
- uint64
- Category
- optional
- Description
capacity_estimation
- Type
- bool
- Category
- optional
- Description
capacity_estimation_ttfb_thresh
- Type
- uint32
- Category
- optional
- Description
server_auto_scale
- Type
- bool
- Category
- optional
- Description
prst_hdr_name
- Type
- string
- Category
- optional
- Description
fewest_tasks_feedback_delay
- Type
- uint32
- Category
- optional
- Description
num_hms_deduped
- Type
- uint32
- Category
- optional
- Description
num_phms
- Type
- uint32
- Category
- optional
- Description
Pool
uuid
- Type
- string
- Category
- required
- Description
- UUID of the pool
name
- Type
- string
- Category
- required
- Description
- The name of the pool.
default_server_port
- Type
- int32
- Category
- optional
- Description
- Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The SSL checkbox enables Avi to server encryption.
- Default
- 80
graceful_disable_timeout
- Type
- int32
- Category
- optional
- Description
- Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled.
- Units
- min
- Default
- 1
connection_ramp_duration
- Type
- int32
- Category
- optional
- Description
- Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for LB algorithms that are least connection based.
- Units
- min
- Default
- 10
max_concurrent_connections_per_server
- Type
- int32
- Category
- optional
- Description
- The maximum number of concurrent connections allowed to each server within the pool. NOTE: applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied.
- Default
- 0
health_monitor_refs
- Type
- Reference to HealthMonitor
- Category
- repeated
- Description
- Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each Service Engine and mark a server up or down based on the response. The Passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses.
servers
- Type
- Server
- Category
- repeated
- Description
- The pool directs load balanced traffic to this list of destination servers. The servers can be configured by IP address, name, network or via IP Address Group
server_count
- Type
- int32
- Category
- optional
- Description
- Default
- 0
lb_algorithm
- Type
- enum
- Category
- optional
- Description
- The load balancing algorithm will pick a server within the pool's list of available servers.
- Default
- LB_ALGORITHM_LEAST_CONNECTIONS
- Choices
- LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER
lb_algorithm_hash
- Type
- enum
- Category
- optional
- Description
- Criteria used as a key for determining the hash between the client and server.
- Default
- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS
- Choices
- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER
lb_algorithm_consistent_hash_hdr
- Type
- string
- Category
- optional
- Description
- HTTP header name to be used for the hash key.
networks
- Type
- NetworkFilter
- Category
- repeated
- Description
- (internal-use) Networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by Avi, not editable by the user.
placement_networks
- Type
- PlacementNetwork
- Category
- repeated
- Description
- Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the Subnet using the following syntax: 10-1-1-0/24. Use static routes in VRF configuration when pool servers are not directly connected butroutable from the service engine.
application_persistence_profile_ref
- Type
- Reference to ApplicationPersistenceProfile
- Category
- optional
- Description
- Persistence will ensure the same user sticks to the same server for a desired duration of time.
ssl_profile_ref
- Type
- Reference to SSLProfile
- Category
- optional
- Description
- When enabled, Avi re-encrypts traffic to the backend servers. The specific SSL profile defines which ciphers and SSL versions will be supported.
inline_health_monitor
- Type
- bool
- Category
- optional
- Description
- The Passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the LB method, such as Round Robin.
- Default
- True
use_service_port
- Type
- bool
- Category
- optional
- Description
- Do not translate the client's destination port when sending the connection to the server. The pool or servers specified service port will still be used for health monitoring.
- Default
- False
fail_action
- Type
- FailAction
- Category
- optional
- Description
- Enable an action - Close Connection, HTTP Redirect, Local HTTP Response, or Backup Pool - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure.
capacity_estimation
- Type
- bool
- Category
- optional
- Description
- Inline estimation of capacity of servers.
- Default
- False
capacity_estimation_ttfb_thresh
- Type
- uint32
- Category
- optional
- Description
- The maximum time-to-first-byte of a server.
- Default
- 0
pki_profile_ref
- Type
- Reference to PKIProfile
- Category
- optional
- Description
- Avi will validate the SSL certificate present by a server against the selected PKI Profile.
ssl_key_and_certificate_ref
- Type
- Reference to SSLKeyAndCertificate
- Category
- optional
- Description
- Service Engines will present a client SSL certificate to the server.
server_auto_scale
- Type
- bool
- Category
- optional
- Description
- Server AutoScale. Not used anymore.
- Default
- False
prst_hdr_name
- Type
- string
- Category
- optional
- Description
- Header name for custom header persistence
apic_epg_name
- Type
- string
- Category
- optional
- Description
- Synchronize Cisco APIC EPG members with pool servers
autoscale_networks
- Type
- string
- Category
- repeated
- Description
- Network Ids for the launch configuration
autoscale_policy_ref
- Type
- Reference to ServerAutoScalePolicy
- Category
- optional
- Description
- Reference to Server Autoscale Policy
autoscale_launch_config_ref
- Type
- Reference to AutoScaleLaunchConfig
- Category
- optional
- Description
- If configured then Avi will trigger orchestration of pool server creation and deletion. It is only supported for container clouds like Mesos, Opensift, Kubernates, Docker etc.
vrf_ref
- Type
- Reference to VrfContext
- Category
- optional,readonly
- Description
- Virtual Routing Context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the Virtual Routing Conext of the Virtual Service, and this field is used only internally, and is set by pb-transform.
ipaddrgroup_ref
- Type
- Reference to IpAddrGroup
- Category
- optional
- Description
- Use list of servers from Ip Address Group
fewest_tasks_feedback_delay
- Type
- uint32
- Category
- optional
- Description
- Periodicity of feedback for fewest tasks server selection algorithm.
- Units
- sec
- Default
- 10
enabled
- Type
- bool
- Category
- optional
- Description
- Enable or disable the pool. Disabling will terminate all open connections and pause health monitors.
- Default
- True
max_conn_rate_per_server
- Type
- RateProfile
- Category
- optional
- Description
- Rate Limit connections to each server.
east_west
- Type
- bool
- Category
- optional
- Description
- Inherited config from VirtualService.
created_by
- Type
- string
- Category
- optional
- Description
- Creator name
cloud_config_cksum
- Type
- string
- Category
- optional
- Description
- Checksum of cloud configuration for Pool. Internally set by cloud connector
request_queue_enabled
- Type
- bool
- Category
- optional
- Description
- Enable request queue when pool is full
- Default
- False
request_queue_depth
- Type
- uint32
- Category
- optional
- Description
- Minimum number of requests to be queued when pool is full.
- Default
- 128
ab_pool
- Type
- AbPool
- Category
- optional
- Description
- A/B pool configuration.
server_reselect
- Type
- HTTPServerReselect
- Category
- optional
- Description
- Server reselect configuration for HTTP requests.
a_pool
- Type
- string
- Category
- optional
- Description
- Name of container cloud application that constitutes A pool in a A-B pool configuration, if different from VS app
ab_priority
- Type
- uint32
- Category
- optional
- Description
- Priority of this pool in a A-B pool pair. Internally used
host_check_enabled
- Type
- bool
- Category
- optional
- Description
- Enable common name check for server certificate. If enabled and no explicit domain name is specified, Avi will use the incoming host header to do the match.
- Default
- False
domain_name
- Type
- string
- Category
- repeated
- Description
- Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled.
sni_enabled
- Type
- bool
- Category
- optional
- Description
- Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake.
- Default
- True
server_name
- Type
- string
- Category
- optional
- Description
- Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections if SNI is enabled. If no value is specified, Avi will use the incoming host header instead.
rewrite_host_header_to_sni
- Type
- bool
- Category
- optional
- Description
- If SNI server name is specified, rewrite incoming host header to the SNI server name.
- Default
- False
rewrite_host_header_to_server_name
- Type
- bool
- Category
- optional
- Description
- Rewrite incoming Host Header to server name of the server to which the request is proxied. Enabling this feature rewrites Host Header for requests to all servers in the pool.
- Default
- False
nsx_securitygroup
- Type
- string
- Category
- repeated
- Description
- A list of NSX Service Groups where the Servers for the Pool are created
external_autoscale_groups
- Type
- string
- Category
- repeated
- Description
- Names of external auto-scale groups for pool servers. Currently available only for AWS
description
- Type
- string
- Category
- optional
- Description
- A description of the pool.
tenant_ref
- Type
- Reference to Tenant
- Category
- optional
- Description
cloud_ref
- Type
- Reference to Cloud
- Category
- optional,readonly
- Description
- Default
- /api/cloud?name=Default-Cloud
Server
ip
- Type
- IpAddr
- Category
- required
- Description
- IP Address of the server. Required if there is no resolvable host name.
port
- Type
- int32
- Category
- optional
- Description
- Optionally specify the servers port number. This will override the pool's default server port attribute.
hostname
- Type
- string
- Category
- optional
- Description
- DNS resolvable name of the server. May be used in place of the IP address.
enabled
- Type
- bool
- Category
- optional
- Description
- Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed.
- Default
- True
ratio
- Type
- int32
- Category
- optional
- Description
- Ratio of selecting eligible servers in the pool
- Default
- 1
vm_ref
- Type
- Reference to VIMgrVMRuntime
- Category
- optional
- Description
- (internal-use) This field is used internally by Avi, not editable by the user.
nw_ref
- Type
- Reference to VIMgrNWRuntime
- Category
- optional
- Description
- (internal-use) This field is used internally by Avi, not editable by the user.
discovered_network_ref
- Type
- Reference to Network
- Category
- repeated
- Description
- (internal-use) Discovered network for this server. This field is deprecated.
external_uuid
- Type
- string
- Category
- optional
- Description
- UUID identifying VM in OpenStack and other external compute
discovered_subnet
- Type
- IpAddrPrefix
- Category
- repeated
- Description
- (internal-use) Discovered subnet for this server. This field is deprecated.
verify_network
- Type
- bool
- Category
- optional
- Description
- Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network
- Default
- False
discovered_networks
- Type
- DiscoveredNetwork
- Category
- repeated
- Description
- (internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user.
resolve_server_by_dns
- Type
- bool
- Category
- optional
- Description
- Auto resolve server's IP using DNS name
- Default
- False
prst_hdr_val
- Type
- string
- Category
- optional
- Description
- Header value for custom header persistence.
mac_address
- Type
- string
- Category
- optional
- Description
- MAC address of server.
static
- Type
- bool
- Category
- optional
- Description
- If statically learned.
- Default
- False
server_node
- Type
- string
- Category
- optional
- Description
- Hostname of the node where the server VM or container resides
availability_zone
- Type
- string
- Category
- optional
- Description
- Availability-zone of the server VM.
rewrite_host_header
- Type
- bool
- Category
- optional
- Description
- Rewrite incoming Host Header to server name.
- Default
- False
external_orchestration_id
- Type
- string
- Category
- optional
- Description
- UID of server in external orchestration systems
description
- Type
- string
- Category
- optional
- Description
- A description of the Server.
location
- Type
- GeoLocation
- Category
- optional,readonly
- Description
- (internal-use) Geographic location of the server.Currently only for internal usage.
autoscaling_group_name
- Type
- string
- Category
- optional,readonly
- Description
- Name of autoscaling group this server belongs to.
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.
NetworkFilter
network_ref
- Type
- Reference to VIMgrNWRuntime
- Category
- required
- Description
server_filter
- Type
- string
- Category
- optional
- Description
FailAction
type
- Type
- enum
- Category
- required
- Description
- Enables a response to client when pool experiences a failure. By default TCP connection is closed.
- Default
- FAIL_ACTION_CLOSE_CONN
- Choices
- FAIL_ACTION_HTTP_REDIRECT, FAIL_ACTION_HTTP_LOCAL_RSP, FAIL_ACTION_CLOSE_CONN, FAIL_ACTION_BACKUP_POOL
redirect
- Type
- FailActionHTTPRedirect
- Category
- optional
- Description
- URL to redirect HTTP requests to when pool experiences a failure
local_rsp
- Type
- FailActionHTTPLocalResponse
- Category
- optional
- Description
- Local response to HTTP requests when pool experiences a failure
backup_pool
- Type
- FailActionBackupPool
- Category
- optional
- Description
- Backup Pool when pool experiences a failure
FailActionHTTPRedirect
protocol
- Type
- enum
- Category
- optional
- Description
- Default
- HTTPS
- Choices
- HTTP, HTTPS
host
- Type
- string
- Category
- required
- Description
path
- Type
- string
- Category
- optional
- Description
query
- Type
- string
- Category
- optional
- Description
status_code
- Type
- enum
- Category
- optional
- Description
- Default
- HTTP_REDIRECT_STATUS_CODE_302
- Choices
- HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307
FailActionHTTPLocalResponse
status_code
- Type
- enum
- Category
- optional
- Description
- Default
- FAIL_HTTP_STATUS_CODE_503
- Choices
- FAIL_HTTP_STATUS_CODE_200, FAIL_HTTP_STATUS_CODE_503
file
- Type
- HTTPLocalFile
- Category
- optional
- Description
FailActionBackupPool
backup_pool_ref
- Type
- Reference to Pool
- Category
- required
- Description
- Specifies the UUID of the Pool acting as backup pool.
AbPool
pool_ref
- Type
- Reference to Pool
- Category
- required
- Description
- Pool configured as B pool for A/B testing
ratio
- Type
- uint32
- Category
- optional
- Description
- Ratio of traffic diverted to the B pool, for A/B testing
- Default
- 0
HTTPServerReselect
enabled
- Type
- bool
- Category
- required
- Description
- Enable HTTP request reselect when server responds with specific response codes.
- Default
- False
svr_resp_code
- Type
- HTTPReselectRespCode
- Category
- optional
- Description
- Server response codes which will trigger an HTTP request retry.
num_retries
- Type
- uint32
- Category
- optional
- Description
- Number of times to retry an HTTP request when server responds with configured status codes.
- Default
- 4
retry_nonidempotent
- Type
- bool
- Category
- optional
- Description
- Allow retry of non-idempotent HTTP requests.
- Default
- False
HTTPReselectRespCode
codes
- Type
- int32
- Category
- repeated
- Description
- HTTP response code to be matched.
ranges
- Type
- HTTPStatusRange
- Category
- repeated
- Description
- HTTP response code ranges to match.
resp_code_block
- Type
- enum
- Category
- repeated
- Description
- Block of HTTP response codes to match for server reselect.
- Choices
- HTTP_RSP_4XX, HTTP_RSP_5XX
PoolLbState
ref_count
- Type
- int32
- Category
- optional
- Description
PersistenceHandleInternal
redis_sync
- Type
- int32
- Category
- required
- Description
aging_mode
- Type
- int32
- Category
- required
- Description
key_type
- Type
- int32
- Category
- required
- Description
vs_uuid
- Type
- string
- Category
- required
- Description
num_local_create_races
- Type
- uint32
- Category
- optional
- Description
num_redis_create_races
- Type
- uint32
- Category
- optional
- Description
num_unknown_srv_from_redis
- Type
- uint32
- Category
- optional
- Description
num_malloc_failures
- Type
- uint32
- Category
- optional
- Description
num_start_ageing_val_null
- Type
- uint32
- Category
- optional
- Description
num_too_early_delete
- Type
- uint32
- Category
- optional
- Description
num_redis_eol_truncate_events
- Type
- uint32
- Category
- optional
- Description
num_delete_nonexistent
- Type
- uint32
- Category
- optional
- Description
num_redis_recvd
- Type
- uint32
- Category
- optional
- Description
num_redis_sent_dp
- Type
- uint32
- Category
- optional
- Description
num_redis_sent_ag
- Type
- uint32
- Category
- optional
- Description
num_create_srv_null
- Type
- uint32
- Category
- optional
- Description
num_start_ageing_srv_null
- Type
- uint32
- Category
- optional
- Description
num_malloc_failures_dp
- Type
- uint32
- Category
- optional
- Description
PoolRefCnt
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
refcnt
- Type
- int32
- Category
- optional
- Description
server_refcnt
- Type
- ServerRefCnt
- Category
- repeated
- Description
phm_refcnt
- Type
- HealthMonitorRefCnt
- Category
- repeated
- Description
ServerRefCnt
ip
- Type
- IpAddr
- Category
- optional
- Description
port
- Type
- int32
- Category
- optional
- Description
refcnt
- Type
- int32
- Category
- optional
- Description
shm_refcnt
- Type
- HealthMonitorRefCnt
- Category
- repeated
- Description
HealthMonitorRefCnt
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
refcnt
- Type
- int32
- Category
- optional
- Description
ServerRuntimeDetail
ip_addr
- Type
- IpAddr
- Category
- required
- Description
port
- Type
- int32
- Category
- required
- Description
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
server_l4stats
- Type
- ServerL4Stats
- Category
- optional
- Description
server_l7stats
- Type
- ServerL7Stats
- Category
- optional
- Description
l7cp_stats
- Type
- ConnpoolStatsBase
- Category
- optional
- Description
app_info
- Type
- AppInfo
- Category
- repeated
- Description
proc_id
- Type
- string
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
capest_data
- Type
- CapestData
- Category
- repeated
- Description
capacity
- Type
- uint32
- Category
- optional
- Description
capest_scale_hist
- Type
- float
- Category
- repeated
- Description
capest_rand_max_conn_hist
- Type
- uint32
- Category
- repeated
- Description
other_ips
- Type
- IpAddr
- Category
- repeated
- Description
- Secondary/public ip addresses
ServerL4Stats
node_obj_id
- Type
- string
- Category
- required
- Description
conn_duration
- Type
- uint64
- Category
- required
- Description
dup_ack_retransmits
- Type
- uint64
- Category
- required
- Description
sack_retransmits
- Type
- uint64
- Category
- required
- Description
timeout_retransmits
- Type
- uint64
- Category
- required
- Description
out_of_orders
- Type
- uint64
- Category
- required
- Description
syns_sent
- Type
- uint64
- Category
- required
- Description
new_established_conns
- Type
- uint64
- Category
- required
- Description
complete_conns
- Type
- uint64
- Category
- required
- Description
finished_conns
- Type
- uint64
- Category
- required
- Description
open_conns
- Type
- uint64
- Category
- required
- Description
connections_dropped
- Type
- uint64
- Category
- required
- Description
lossy_connections
- Type
- uint64
- Category
- required
- Description
errored_connections
- Type
- uint64
- Category
- required
- Description
rx_pkts
- Type
- uint64
- Category
- required
- Description
rx_bytes
- Type
- uint64
- Category
- required
- Description
tx_pkts
- Type
- uint64
- Category
- required
- Description
tx_bytes
- Type
- uint64
- Category
- required
- Description
tx_goodput
- Type
- uint64
- Category
- required
- Description
rx_goodput
- Type
- uint64
- Category
- required
- Description
rx_pkts_absolute
- Type
- uint64
- Category
- required
- Description
rx_bytes_absolute
- Type
- uint64
- Category
- required
- Description
tx_pkts_absolute
- Type
- uint64
- Category
- required
- Description
tx_bytes_absolute
- Type
- uint64
- Category
- required
- Description
rx_zero_window_size_events
- Type
- uint64
- Category
- required
- Description
rx_tcp_resets
- Type
- uint64
- Category
- required
- Description
connection_setup_time
- Type
- uint64
- Category
- required
- Description
rtt
- Type
- uint64
- Category
- required
- Description
rtt_valid_connections
- Type
- uint64
- Category
- required
- Description
server_uptime
- Type
- uint64
- Category
- required
- Description
num_state_changes
- Type
- uint64
- Category
- required
- Description
health_check_failures
- Type
- uint64
- Category
- required
- Description
- Default
- 0
health_status
- Type
- uint64
- Category
- required
- Description
- Default
- 0
conn_dropped_before_syn_sent
- Type
- uint64
- Category
- required
- Description
conn_dropped_before_est
- Type
- uint64
- Category
- required
- Description
conn_dropped_after_est
- Type
- uint64
- Category
- required
- Description
lb_fail_count
- Type
- uint64
- Category
- required
- Description
- Number of times load balancing failed
server_count
- Type
- uint64
- Category
- required
- Description
lossy_req
- Type
- uint64
- Category
- optional
- Description
tx_zero_window_size_events
- Type
- uint64
- Category
- optional
- Description
capacity
- Type
- uint64
- Category
- optional
- Description
- This reflects capacity of the servers as measured from SE as C_i.
available_capacity
- Type
- uint64
- Category
- optional
- Description
- This reflects available capacity of the servers as measured from SE as C_i - L_i.
est_capacity
- Type
- uint64
- Category
- optional
- Description
- This reflects capacity of the servers as measured from SE as C_i.
ServerL7Stats
node_obj_id
- Type
- string
- Category
- required
- Description
get_reqs
- Type
- uint64
- Category
- required
- Description
post_reqs
- Type
- uint64
- Category
- required
- Description
other_reqs
- Type
- uint64
- Category
- required
- Description
finished_sessions
- Type
- uint64
- Category
- required
- Description
reqs_finished_sessions
- Type
- uint64
- Category
- required
- Description
concurrent_sessions
- Type
- uint64
- Category
- required
- Description
resp_1xx
- Type
- uint64
- Category
- required
- Description
resp_2xx
- Type
- uint64
- Category
- required
- Description
resp_3xx
- Type
- uint64
- Category
- required
- Description
resp_4xx
- Type
- uint64
- Category
- required
- Description
resp_4xx_errors
- Type
- uint64
- Category
- required
- Description
resp_5xx
- Type
- uint64
- Category
- required
- Description
resp_5xx_errors
- Type
- uint64
- Category
- required
- Description
get_resp_latency_bucket1
- Type
- uint64
- Category
- required
- Description
get_resp_latency_bucket2
- Type
- uint64
- Category
- required
- Description
post_resp_latency_bucket1
- Type
- uint64
- Category
- required
- Description
post_resp_latency_bucket2
- Type
- uint64
- Category
- required
- Description
other_resp_latency_bucket1
- Type
- uint64
- Category
- required
- Description
other_resp_latency_bucket2
- Type
- uint64
- Category
- required
- Description
get_resp_latency
- Type
- uint64
- Category
- required
- Description
post_resp_latency
- Type
- uint64
- Category
- required
- Description
other_resp_latency
- Type
- uint64
- Category
- required
- Description
timeouts
- Type
- uint64
- Category
- required
- Description
total_requests
- Type
- uint64
- Category
- required
- Description
complete_responses
- Type
- uint64
- Category
- required
- Description
total_responses
- Type
- uint64
- Category
- required
- Description
application_response_time
- Type
- uint64
- Category
- required
- Description
error_responses
- Type
- uint64
- Category
- required
- Description
lb_fail_count
- Type
- uint64
- Category
- required
- Description
- Number of times load balancing failed
server_count
- Type
- uint64
- Category
- required
- Description
ConnpoolStatsBase
free_size
- Type
- uint64
- Category
- required
- Description
num_requested
- Type
- uint64
- Category
- required
- Description
num_adds
- Type
- uint64
- Category
- required
- Description
num_dels
- Type
- uint64
- Category
- required
- Description
num_reused
- Type
- uint64
- Category
- required
- Description
num_error_evicts
- Type
- uint64
- Category
- required
- Description
bound_size
- Type
- uint64
- Category
- required
- Description
busy_size
- Type
- uint64
- Category
- required
- Description
AppInfo
app_hdr_name
- Type
- string
- Category
- required
- Description
app_hdr_value
- Type
- string
- Category
- required
- Description
CapestData
conns
- Type
- uint32
- Category
- required
- Description
ttfb
- Type
- uint32
- Category
- required
- Description
ServerInternal
ip_addr
- Type
- IpAddr
- Category
- required
- Description
port
- Type
- int32
- Category
- required
- Description
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
server_config
- Type
- Server
- Category
- optional
- Description
ref_count
- Type
- int32
- Category
- optional
- Description
server_stats
- Type
- ServerStats
- Category
- optional
- Description
server_l4stats
- Type
- ServerL4Stats
- Category
- optional
- Description
server_l7stats
- Type
- ServerL7Stats
- Category
- optional
- Description
slow_start
- Type
- ServerSlowStart
- Category
- optional
- Description
l7cp_stats
- Type
- ConnpoolStats
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
ck_prst_id
- Type
- uint32
- Category
- optional
- Description
vm_powered_on_count
- Type
- uint32
- Category
- optional
- Description
vm_powered_off_count
- Type
- uint32
- Category
- optional
- Description
vm_powered_on
- Type
- bool
- Category
- optional
- Description
ipv4_prst_id
- Type
- uint32
- Category
- optional
- Description
prst_hdr_val
- Type
- string
- Category
- optional
- Description
nat_ip_addr
- Type
- IpAddr
- Category
- optional
- Description
nat_port
- Type
- int32
- Category
- optional
- Description
nat_hostname
- Type
- string
- Category
- optional
- Description
local
- Type
- uint32
- Category
- optional
- Description
num_chash_unique_keys
- Type
- uint32
- Category
- optional
- Description
server_node_name
- Type
- string
- Category
- optional
- Description
gslb_site_name
- Type
- string
- Category
- optional
- Description
gslb_vs_name
- Type
- string
- Category
- optional
- Description
chash_arcs_sum
- Type
- uint32
- Category
- optional
- Description
gslb_failure_code
- Type
- enum
- Category
- optional
- Description
- Choices
- ARP_UNRESOLVED, CONNECTION_REFUSED, CONNECTION_TIMEOUT, RESPONSE_CODE_MISMATCH, PAYLOAD_CONTENT_MISMATCH, SERVER_UNREACHABLE, CONNECTION_RESET, CONNECTION_ERROR, HOST_ERROR, ADDRESS_ERROR, NO_PORT, PAYLOAD_TIMEOUT, NO_RESPONSE, NO_RESOURCES, SSL_ERROR, SSL_CERT_ERROR, PORT_UNREACHABLE, SCRIPT_ERROR, OTHER_ERROR, SERVER_DISABLED, REMOTE_STATE, MAINTENANCE_RESPONSE_CODE_MATCH, MAINTENANCE_PAYLOAD_CONTENT_MATCH, CHUNKED_RESPONSE_PAYLOAD_NOT_FOUND, GSLB_POOL_MEMBER_DOWN, GSLB_POOL_MEMBER_DISABLED, GSLB_POOL_MEMBER_STATE_UNKNOWN
gslb_site_unreachable
- Type
- bool
- Category
- optional
- Description
latitude
- Type
- uint32
- Category
- optional
- Description
longitude
- Type
- uint32
- Category
- optional
- Description
location
- Type
- string
- Category
- optional
- Description
tag
- Type
- string
- Category
- optional
- Description
real_latitude
- Type
- int32
- Category
- optional
- Description
real_longitude
- Type
- int32
- Category
- optional
- Description
loc_invalid
- Type
- bool
- Category
- optional
- Description
gslb_no_hm
- Type
- bool
- Category
- optional
- Description
max_conn_pc
- Type
- uint32
- Category
- optional
- Description
max_conn_se
- Type
- int32
- Category
- optional
- Description
ServerStats
current_connections
- Type
- uint64
- Category
- optional
- Description
total_connections
- Type
- uint64
- Category
- optional
- Description
pre_closed_connections
- Type
- uint64
- Category
- optional
- Description
bad_connections
- Type
- uint64
- Category
- optional
- Description
inlhm_skipped
- Type
- uint64
- Category
- optional
- Description
skipped_count
- Type
- uint64
- Category
- optional
- Description
response_time
- Type
- Unknown
- Category
- optional
- Description
response_time_var
- Type
- Unknown
- Category
- optional
- Description
inlhm_down_duration
- Type
- uint64
- Category
- optional
- Description
inlhm_good_ewma
- Type
- uint64
- Category
- optional
- Description
inlhm_bad_ewma
- Type
- uint64
- Category
- optional
- Description
no_lport
- Type
- uint64
- Category
- optional
- Description
inlhm_letthrough
- Type
- uint64
- Category
- optional
- Description
current_load
- Type
- uint64
- Category
- optional
- Description
inlhm_skip_bypassed
- Type
- uint64
- Category
- optional
- Description
fs_load_thresh
- Type
- Unknown
- Category
- optional
- Description
current_tasks
- Type
- uint64
- Category
- optional
- Description
current_tasks_fb
- Type
- uint64
- Category
- optional
- Description
rl_good_fb
- Type
- uint64
- Category
- optional
- Description
rl_bad_fb
- Type
- uint64
- Category
- optional
- Description
capest_rand_max_conn_skipped
- Type
- uint64
- Category
- optional
- Description
skipped_get_next_count
- Type
- uint64
- Category
- optional
- Description
ServerSlowStart
delta_max_conn
- Type
- uint32
- Category
- required
- Description
delta_time
- Type
- uint32
- Category
- required
- Description
count_limit
- Type
- uint32
- Category
- required
- Description
ref_count
- Type
- uint32
- Category
- required
- Description
ConnpoolStats
free_size
- Type
- uint64
- Category
- required
- Description
num_requested
- Type
- uint64
- Category
- required
- Description
num_adds
- Type
- uint64
- Category
- required
- Description
num_dels
- Type
- uint64
- Category
- required
- Description
num_reused
- Type
- uint64
- Category
- required
- Description
num_error_evicts
- Type
- uint64
- Category
- required
- Description
num_reuse_evicts
- Type
- uint64
- Category
- required
- Description
num_idle_evicts
- Type
- uint64
- Category
- required
- Description
num_full_evicts
- Type
- uint64
- Category
- required
- Description
bound_size
- Type
- uint64
- Category
- required
- Description
num_close_evicts
- Type
- uint64
- Category
- required
- Description
num_full_uncached
- Type
- uint64
- Category
- required
- Description
busy_size
- Type
- uint64
- Category
- required
- Description
num_lifetimes
- Type
- uint64
- Category
- required
- Description
GslbServiceHmonStat
API
CLI
show virtualservice <key> gslbservicehmonstat filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [gs_uuid]
Data
GslbServiceHmonStat
proc_id
- Type
- string
- Category
- optional
- Description
se_uuid
- Type
- string
- Category
- optional
- Description
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
- Name for the GSLB service.
groups
- Type
- GslbPoolHmon
- Category
- repeated
- Description
- GSLB service group runtime information
GslbPoolHmon
name
- Type
- string
- Category
- optional
- Description
- Name for the GSLB pool.
hmon
- Type
- HealthMonitorStatRuntime
- Category
- repeated
- Description
TrafficCloneRuntime
API
GET /api/virtualservice/<key>/traffic_clone_stats/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> traffic_clone_stats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
TrafficCloneRuntime
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
clone_srvr_stats
- Type
- CloneServerStats
- Category
- repeated
- Description
CloneServerStats
ip
- Type
- IpAddr
- Category
- optional
- Description
num_total_pkts_cloned
- Type
- uint64
- Category
- optional
- Description
num_mbuf_alloc_failed
- Type
- uint64
- Category
- optional
- Description
num_driver_failures
- Type
- uint64
- Category
- optional
- Description
num_succeeded
- Type
- uint64
- Category
- optional
- Description
NetworkSecurityPolicyStats
API
GET /api/virtualservice/<key>/networksecuritypolicystats/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> networksecuritypolicystats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
NetworkSecurityPolicyStats
se_uuid
- Type
- string
- Category
- required
- Description
proc_id
- Type
- string
- Category
- required
- Description
uuid
- Type
- string
- Category
- required
- Description
name
- Type
- string
- Category
- required
- Description
rule_stats
- Type
- RuleStats
- Category
- repeated
- Description
RuleStats
index
- Type
- int32
- Category
- required
- Description
name
- Type
- string
- Category
- required
- Description
hits
- Type
- uint64
- Category
- required
- Description
evaluated
- Type
- uint64
- Category
- required
- Description
action_hits
- Type
- uint64
- Category
- optional
- Description
- Default
- 0
VirtualServiceRuntimeSummary
API
GET /api/virtualservice/<key>/runtime/<key>
CLI
show virtualservice <key> summary
Data
VirtualServiceRuntimeSummary
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
one_plus_one_ha
- Type
- bool
- Category
- optional
- Description
- Default
- False
service_engine
- Type
- VipSeAssigned
- Category
- repeated
- Description
config_status
- Type
- ConfigurationStatus
- Category
- optional
- Description
migrate_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
scalein_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
scaleout_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
user_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
progress_percent
- Type
- int32
- Category
- optional
- Description
- Default
- 0
last_scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
vs_placement_resolution_info
- Type
- VsPlacementResolutionInfo
- Category
- optional
- Description
num_se_requested
- Type
- uint32
- Category
- optional
- Description
num_se_assigned
- Type
- uint32
- Category
- optional
- Description
recommendation
- Type
- string
- Category
- optional
- Description
se_create_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
percent_ses_up
- Type
- int32
- Category
- optional
- Description
- Default
- 0
upgrade_in_progress
- Type
- bool
- Category
- optional
- Description
- Default
- False
migrate_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
migrate_scalein_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
vh_child_vs_ref
- Type
- Reference to VirtualService
- Category
- repeated
- Description
type
- Type
- enum
- Category
- optional
- Description
- Default
- VS_TYPE_NORMAL
- Choices
- VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD
first_se_assigned_time
- Type
- TimeStamp
- Category
- optional
- Description
east_west
- Type
- bool
- Category
- optional
- Description
- Default
- False
vip_summary
- Type
- VipRuntimeSummary
- Category
- repeated
- Description
VipRuntimeSummary
vip_id
- Type
- string
- Category
- required
- Description
- This field is used to uniquely identify the vip.
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
service_engine
- Type
- VipSeAssigned
- Category
- repeated
- Description
config_status
- Type
- ConfigurationStatus
- Category
- optional
- Description
migrate_in_progress
- Type
- bool
- Category
- optional
- Description
- When true, it indicates vip is in process of migrate.
- Default
- False
scalein_in_progress
- Type
- bool
- Category
- optional
- Description
- When true, it indicates vip is in process of scalein.
- Default
- False
scaleout_in_progress
- Type
- bool
- Category
- optional
- Description
- When true, it indicates vip is in process of scaleout.
- Default
- False
user_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
progress_percent
- Type
- int32
- Category
- optional
- Description
- Default
- 0
last_scale_status
- Type
- ScaleStatus
- Category
- optional
- Description
vip_placement_resolution_info
- Type
- VipPlacementResolutionInfo
- Category
- optional
- Description
num_se_requested
- Type
- uint32
- Category
- optional
- Description
num_se_assigned
- Type
- uint32
- Category
- optional
- Description
recommendation
- Type
- string
- Category
- optional
- Description
percent_ses_up
- Type
- int32
- Category
- optional
- Description
- Default
- 0
migrate_scaleout_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
migrate_scalein_pending
- Type
- bool
- Category
- optional
- Description
- Default
- False
first_se_assigned_time
- Type
- TimeStamp
- Category
- optional
- Description
ClientInternal
API
GET /api/virtualservice/<key>/client/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> client filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
ClientInternal
uuid
- Type
- string
- Category
- optional
- Description
client_entry
- Type
- ClientInternalEntry
- Category
- repeated
- Description
ClientInternalEntry
client_ip
- Type
- IpAddr
- Category
- optional
- Description
ms_uuid
- Type
- string
- Category
- optional
- Description
ms_name
- Type
- string
- Category
- optional
- Description
task_id
- Type
- string
- Category
- optional
- Description
container_id
- Type
- string
- Category
- optional
- Description
Actions
API
POST /api/virtualservice/<key>/client/clear
CLI
clear virtualservice <key> client
VsCandidateSeHostList
API
CLI
show virtualservice <key> candidate-se-host-list filter [check_hosts] [vip_id]
Data
VsCandidateSeHostList
se
- Type
- VsCandidateSe
- Category
- repeated
- Description
can_spawn_new_se
- Type
- bool
- Category
- optional
- Description
host
- Type
- VsCandidateHost
- Category
- repeated
- Description
VsCandidateSe
se_ref
- Type
- Reference to ServiceEngine
- Category
- optional
- Description
recommended
- Type
- bool
- Category
- optional
- Description
- Default
- False
DnsTable
API
GET /api/virtualservice/<key>/dnstable/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> dnstable filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
DnsTable
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
num_dns_entries
- Type
- uint32
- Category
- optional
- Description
sub_domains
- Type
- string
- Category
- repeated
- Description
dns_entries
- Type
- DnsTableEntry
- Category
- repeated
- Description
DnsTableEntry
fqdn
- Type
- string
- Category
- required
- Description
rsp
- Type
- DnsResponseEntry
- Category
- repeated
- Description
ttl
- Type
- uint32
- Category
- optional
- Description
num_dns_ip
- Type
- uint32
- Category
- optional
- Description
service_name
- Type
- string
- Category
- optional
- Description
tenant_uuid
- Type
- string
- Category
- optional
- Description
tenant_name
- Type
- string
- Category
- optional
- Description
entry_type
- Type
- enum
- Category
- optional
- Description
- Choices
- DNS_ENTRY_PASS_THROUGH, DNS_ENTRY_GSLB, DNS_ENTRY_VIRTUALSERVICE, DNS_ENTRY_STATIC
record_type
- Type
- enum
- Category
- optional
- Description
- Choices
- DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY
wildcard
- Type
- bool
- Category
- optional
- Description
algorithm
- Type
- enum
- Category
- optional
- Description
- Choices
- DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH
DnsResponseEntry
ip
- Type
- IpAddr
- Category
- optional
- Description
srv
- Type
- DnsResponseSrvEntry
- Category
- optional
- Description
cname
- Type
- string
- Category
- optional
- Description
ns
- Type
- DnsResponseNsEntry
- Category
- optional
- Description
group_name
- Type
- string
- Category
- optional
- Description
oper_status
- Type
- OperationalStatus
- Category
- optional
- Description
enabled
- Type
- bool
- Category
- optional
- Description
DnsResponseSrvEntry
priority
- Type
- uint32
- Category
- optional
- Description
weight
- Type
- uint32
- Category
- optional
- Description
port
- Type
- uint32
- Category
- optional
- Description
target
- Type
- string
- Category
- optional
- Description
DnsResponseNsEntry
nsname
- Type
- string
- Category
- optional
- Description
ip
- Type
- IpAddr
- Category
- optional
- Description
GeoLocationInfo
API
CLI
show virtualservice <key> geolocationinfo filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [ip] [mask] [start_ip]
Data
GeoLocationInfo
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
entries
- Type
- GeoLocationInfoEntry
- Category
- repeated
- Description
GeoLocationInfoEntry
ip
- Type
- IpAddr
- Category
- optional
- Description
mask
- Type
- uint32
- Category
- optional
- Description
location
- Type
- GeoLocation
- Category
- optional
- Description
scaled_latitude
- Type
- uint32
- Category
- optional
- Description
scaled_longitude
- Type
- uint32
- Category
- optional
- Description
GslbSiteInternal
API
GET /api/virtualservice/<key>/gslbsiteinternal/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> gslbsiteinternal filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
GslbSiteInternal
se_uuid
- Type
- string
- Category
- optional
- Description
- UUID of SE reporting this message.
proc_id
- Type
- string
- Category
- optional
- Description
- Process ID of process reporting this message.
sites
- Type
- GslbSiteEntry
- Category
- repeated
- Description
- List of sites.
my_cluster_uuid
- Type
- string
- Category
- optional
- Description
- Local controller cluster Id.
send_interval
- Type
- uint32
- Category
- optional
- Description
- Frequency with which group members communicate.
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.
GslbSiteEntry
uuid
- Type
- string
- Category
- optional
- Description
- GSLB Site cluster UUID.
name
- Type
- string
- Category
- optional
- Description
- GSLB Site name.
enabled
- Type
- bool
- Category
- optional
- Description
- Field to indicate if site is enabled.
ratio
- Type
- uint32
- Category
- optional
- Description
- Ratio of the members belonging to this site.
is_leader
- Type
- bool
- Category
- optional
- Description
- Flag to indicate if this site is the leader site.
is_third_party
- Type
- bool
- Category
- optional
- Description
- Flag to indicate if this site is a third-party site.
no_hm
- Type
- bool
- Category
- optional
- Description
- Flag to indicate if members of this site should not be health-monitored.
location
- Type
- GeoLocation
- Category
- optional
- Description
- Location
ConnectionDumpRuntime
API
GET /api/virtualservice/<key>/connections/<key>
Query Params: ConnectionFilter
CLI
show virtualservice <key> connections filter [conn_type] [ip_addr] [port] [ip_mask]
Data
ConnectionDumpRuntime
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
connection
- Type
- ConnectionEntry
- Category
- repeated
- Description
ConnectionEntry
client_src_ip
- Type
- string
- Category
- optional
- Description
client_src_port
- Type
- uint32
- Category
- optional
- Description
client_dst_ip
- Type
- string
- Category
- optional
- Description
client_dst_port
- Type
- uint32
- Category
- optional
- Description
server_src_ip
- Type
- string
- Category
- optional
- Description
server_src_port
- Type
- uint32
- Category
- optional
- Description
server_dst_ip
- Type
- string
- Category
- optional
- Description
server_dst_port
- Type
- uint32
- Category
- optional
- Description
client_vrf_id
- Type
- uint32
- Category
- optional
- Description
server_vrf_id
- Type
- uint32
- Category
- optional
- Description
downstream_buf_bytes
- Type
- uint64
- Category
- optional
- Description
upstream_buf_bytes
- Type
- uint64
- Category
- optional
- Description
Actions
API
POST /api/virtualservice/<key>/connections/clear
CLI
clear virtualservice <key> connections
Data
ConnectionClearFilter
ip_addr
- Type
- string
- Category
- optional
- Description
- IP address in dotted decimal notation
port
- Type
- uint32
- Category
- optional
- Description
- Port number
CltrackInternal
API
GET /api/virtualservice/<key>/cltrack/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> cltrack filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
CltrackInternal
uuid
- Type
- string
- Category
- optional
- Description
cltrack_entry
- Type
- CltrackInternalEntry
- Category
- repeated
- Description
CltrackInternalEntry
client_ip
- Type
- IpAddr
- Category
- optional
- Description
in_progress_cnt
- Type
- int32
- Category
- optional
- Description
local_eol
- Type
- uint32
- Category
- optional
- Description
config
- Type
- bool
- Category
- optional
- Description
ms_uuid
- Type
- string
- Category
- optional
- Description
ms_name
- Type
- string
- Category
- optional
- Description
task_id
- Type
- string
- Category
- optional
- Description
container_id
- Type
- string
- Category
- optional
- Description
fg_retries
- Type
- int32
- Category
- optional
- Description
bg_retries
- Type
- int32
- Category
- optional
- Description
current
- Type
- CltrackInternalMetricsEntry
- Category
- optional
- Description
total
- Type
- CltrackInternalMetricsEntry
- Category
- optional
- Description
CltrackInternalMetricsEntry
new_conns
- Type
- uint64
- Category
- optional
- Description
completed_conns
- Type
- uint64
- Category
- optional
- Description
dropped_conns
- Type
- uint64
- Category
- optional
- Description
bandwidth
- Type
- uint64
- Category
- optional
- Description
total_requests
- Type
- uint64
- Category
- optional
- Description
complete_responses
- Type
- uint64
- Category
- optional
- Description
error_responses
- Type
- uint64
- Category
- optional
- Description
client_end2end_latency
- Type
- uint64
- Category
- optional
- Description
http_timeout
- Type
- uint64
- Category
- optional
- Description
policy_drops
- Type
- uint64
- Category
- optional
- Description
Actions
API
POST /api/virtualservice/<key>/cltrack/clear
CLI
clear virtualservice <key> cltrack
HTTPPolicySetStats
API
GET /api/virtualservice/<key>/httppolicysetstats/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> httppolicyset stats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
HTTPPolicySetStats
se_uuid
- Type
- string
- Category
- required
- Description
proc_id
- Type
- string
- Category
- required
- Description
http_policy_set_stat
- Type
- HTTPPolicySetStat
- Category
- repeated
- Description
HTTPSecurityPolicyStat
rule_stats
- Type
- RuleStats
- Category
- repeated
- Description
HTTPRequestPolicyStat
rule_stats
- Type
- RuleStats
- Category
- repeated
- Description
HTTPResponsePolicyStat
rule_stats
- Type
- RuleStats
- Category
- repeated
- Description
Actions
API
POST /api/virtualservice/<key>/httppolicysetstats/clear
CLI
clear virtualservice <key> httppolicyset stats
VirtualServiceAuthStats
API
GET /api/virtualservice/<key>/authstats/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> authstats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
Actions
API
POST /api/virtualservice/<key>/authstats/clear
CLI
clear virtualservice <key> authstats
UdpStatRuntime
API
CLI
show virtualservice <key> udpstat filter [type] [service_port] [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
UdpStatRuntime
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
udps_ipackets
- Type
- uint64
- Category
- required
- Description
udps_hdrops
- Type
- uint64
- Category
- required
- Description
udps_badsum
- Type
- uint64
- Category
- required
- Description
udps_nosum
- Type
- uint64
- Category
- required
- Description
udps_badlen
- Type
- uint64
- Category
- required
- Description
udps_noport
- Type
- uint64
- Category
- required
- Description
udps_noportbcast
- Type
- uint64
- Category
- required
- Description
udps_fullsock
- Type
- uint64
- Category
- required
- Description
udpps_pcbcachemiss
- Type
- uint64
- Category
- required
- Description
udpps_pcbhashmiss
- Type
- uint64
- Category
- required
- Description
udps_opackets
- Type
- uint64
- Category
- required
- Description
udps_fastout
- Type
- uint64
- Category
- required
- Description
udps_noportmcast
- Type
- uint64
- Category
- required
- Description
udps_filtermcast
- Type
- uint64
- Category
- required
- Description
udps_pktsfrag
- Type
- uint64
- Category
- required
- Description
udps_badpkts
- Type
- uint64
- Category
- required
- Description
udps_errored_conns
- Type
- uint64
- Category
- required
- Description
udps_timedout_conns
- Type
- uint64
- Category
- required
- Description
udps_finished_conns
- Type
- uint64
- Category
- required
- Description
udps_rxpkts
- Type
- uint64
- Category
- required
- Description
udps_rxbytes
- Type
- uint64
- Category
- required
- Description
udps_txpkts
- Type
- uint64
- Category
- required
- Description
udps_txbytes
- Type
- uint64
- Category
- required
- Description
udps_port_unreach_pkts
- Type
- uint64
- Category
- required
- Description
udps_dns_invalid_qd
- Type
- uint64
- Category
- optional
- Description
udps_dns_rx_responses
- Type
- uint64
- Category
- optional
- Description
udps_dns_pass_through
- Type
- uint64
- Category
- optional
- Description
udps_dns_domain_drops
- Type
- uint64
- Category
- optional
- Description
udps_dns_unsupported_queries
- Type
- uint64
- Category
- optional
- Description
udps_dns_gs_down
- Type
- uint64
- Category
- optional
- Description
udps_dns_no_valid_gs_member
- Type
- uint64
- Category
- optional
- Description
udps_dns_no_record
- Type
- uint64
- Category
- optional
- Description
udps_dns_query_a
- Type
- uint64
- Category
- optional
- Description
udps_dns_query_aaaa
- Type
- uint64
- Category
- optional
- Description
udps_dns_query_ns
- Type
- uint64
- Category
- optional
- Description
udps_dns_query_srv
- Type
- uint64
- Category
- optional
- Description
udps_dns_query_others
- Type
- uint64
- Category
- optional
- Description
udps_dns_response_a
- Type
- uint64
- Category
- optional
- Description
udps_dns_response_aaaa
- Type
- uint64
- Category
- optional
- Description
udps_dns_response_ns
- Type
- uint64
- Category
- optional
- Description
udps_dns_response_srv
- Type
- uint64
- Category
- optional
- Description
udps_dns_response_cname
- Type
- uint64
- Category
- optional
- Description
udps_dns_response_others
- Type
- uint64
- Category
- optional
- Description
udps_dns_local_responses
- Type
- uint64
- Category
- optional
- Description
udps_dns_pass_through_errors
- Type
- uint64
- Category
- optional
- Description
udps_dns_response_nxdomain
- Type
- uint64
- Category
- optional
- Description
udps_started_conns
- Type
- uint64
- Category
- optional
- Description
udps_dns_query_mx
- Type
- uint64
- Category
- optional
- Description
udps_dns_response_mx
- Type
- uint64
- Category
- optional
- Description
udps_dns_invalid_edns_option
- Type
- uint64
- Category
- optional
- Description
udps_dns_query_cname
- Type
- uint64
- Category
- optional
- Description
L7VirtualServiceStatsRuntime
API
GET /api/virtualservice/<key>/httpstats/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> httpstats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
DnsPolicyStats
API
GET /api/virtualservice/<key>/dnspolicystats/<key>
Query Params: SeParamsFilter
CLI
show virtualservice <key> dnspolicy stats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
DnsPolicyStats
se_uuid
- Type
- string
- Category
- required
- Description
proc_id
- Type
- string
- Category
- required
- Description
dns_policy_stat
- Type
- DnsPolicyStat
- Category
- repeated
- Description
DnsPolicyStat
uuid
- Type
- string
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
rule_stats
- Type
- DnsPolicyRuleStats
- Category
- repeated
- Description
DnsPolicyRuleStats
index
- Type
- int32
- Category
- optional
- Description
name
- Type
- string
- Category
- optional
- Description
evaluated
- Type
- uint64
- Category
- optional
- Description
hits
- Type
- uint64
- Category
- optional
- Description
Actions
API
POST /api/virtualservice/<key>/dnspolicystats/clear
CLI
clear virtualservice <key> dnspolicy stats
TcpStatRuntime
API
CLI
show virtualservice <key> tcpstat filter [type] [service_port] [primary_only] [disable_aggregate] [se_uuid] [all_se]
Data
TcpStatRuntime
se_uuid
- Type
- string
- Category
- optional
- Description
proc_id
- Type
- string
- Category
- optional
- Description
connection_stats
- Type
- ConnectionStats
- Category
- optional
- Description
rx_stats
- Type
- RxStats
- Category
- optional
- Description
tx_stats
- Type
- TxStats
- Category
- optional
- Description
retransmit_stats
- Type
- RetransmitStats
- Category
- optional
- Description
syncache_stats
- Type
- SyncacheStats
- Category
- optional
- Description
connections_dropped
- Type
- ConnectionDropStats
- Category
- optional
- Description
packets_dropped
- Type
- PacketDropStats
- Category
- optional
- Description
timeout
- Type
- TimeoutStats
- Category
- optional
- Description
sack_stats
- Type
- SackStats
- Category
- optional
- Description
ecn_stats
- Type
- EcnStats
- Category
- optional
- Description
misc_stats
- Type
- MiscStats
- Category
- optional
- Description
dns_stats
- Type
- TcpDnsStats
- Category
- optional
- Description
ConnectionStats
connections_initiated
- Type
- uint64
- Category
- required
- Description
connections_accepted
- Type
- uint64
- Category
- required
- Description
connections_established
- Type
- uint64
- Category
- required
- Description
connections_closed
- Type
- uint64
- Category
- required
- Description
RxStats
total_packets_received
- Type
- uint64
- Category
- required
- Description
packets_received_in_sequence
- Type
- uint64
- Category
- required
- Description
bytes_received_in_sequence
- Type
- uint64
- Category
- required
- Description
ack_packets_received
- Type
- uint64
- Category
- required
- Description
ack_byte_received
- Type
- uint64
- Category
- required
- Description
ack_too_much_packets_received
- Type
- uint64
- Category
- required
- Description
window_update_packet_received
- Type
- uint64
- Category
- required
- Description
window_probe_packets_received
- Type
- uint64
- Category
- required
- Description
after_window_data_packets_received
- Type
- uint64
- Category
- required
- Description
after_window_data_bytes_received
- Type
- uint64
- Category
- required
- Description
ignored_rst_packet_in_window
- Type
- uint64
- Category
- required
- Description
TxStats
total_packets_sent
- Type
- uint64
- Category
- required
- Description
data_packets_sent
- Type
- uint64
- Category
- required
- Description
data_bytes_sent
- Type
- uint64
- Category
- required
- Description
ack_only_packet
- Type
- uint64
- Category
- required
- Description
urg_only_packets_sent
- Type
- uint64
- Category
- required
- Description
delayed_acks_sent
- Type
- uint64
- Category
- required
- Description
keepalive_probes_sent
- Type
- uint64
- Category
- required
- Description
window_probes_sent
- Type
- uint64
- Category
- required
- Description
window_update_only_packets_sent
- Type
- uint64
- Category
- required
- Description
data_packets_retransmitted
- Type
- uint64
- Category
- required
- Description
data_bytes_retransmitted
- Type
- uint64
- Category
- required
- Description
unnecessary_packet_retransmit
- Type
- uint64
- Category
- required
- Description
RetransmitStats
dup_ack_packets_received
- Type
- uint64
- Category
- required
- Description
complete_duplicate_packets_received
- Type
- uint64
- Category
- required
- Description
complete_duplicate_bytes_received
- Type
- uint64
- Category
- required
- Description
partial_duplicate_packets_received
- Type
- uint64
- Category
- required
- Description
partial_duplicate_bytes_received
- Type
- uint64
- Category
- required
- Description
out_of_order_packets_received
- Type
- uint64
- Category
- required
- Description
out_of_order_bytes_received
- Type
- uint64
- Category
- required
- Description
SyncacheStats
entry_added_to_syncache
- Type
- uint64
- Category
- required
- Description
entry_completed
- Type
- uint64
- Category
- required
- Description
entry_aborted
- Type
- uint64
- Category
- required
- Description
entry_staled
- Type
- uint64
- Category
- required
- Description
entry_retransmitted
- Type
- uint64
- Category
- required
- Description
entry_removed_by_badack
- Type
- uint64
- Category
- required
- Description
entry_removed_by_reset
- Type
- uint64
- Category
- required
- Description
entry_dropped_reply_failed
- Type
- uint64
- Category
- required
- Description
zone_failures
- Type
- uint64
- Category
- required
- Description
duplicate_syn_packet
- Type
- uint64
- Category
- required
- Description
icmp_unreachable_received
- Type
- uint64
- Category
- required
- Description
syn_cookie_sent
- Type
- uint64
- Category
- required
- Description
syn_cookie_received
- Type
- uint64
- Category
- required
- Description
bucket_overflow
- Type
- uint64
- Category
- required
- Description
cache_overflow
- Type
- uint64
- Category
- required
- Description
ConnectionDropStats
connections_dropped_before_established
- Type
- uint64
- Category
- required
- Description
connections_dropped_after_established
- Type
- uint64
- Category
- required
- Description
listen_queue_overflow_drops
- Type
- uint64
- Category
- required
- Description
retransmit_timeout_drops
- Type
- uint64
- Category
- required
- Description
persist_timeout_drops
- Type
- uint64
- Category
- required
- Description
keepalive_timeout_drops
- Type
- uint64
- Category
- required
- Description
fin_wait_2_timeout_drops
- Type
- uint64
- Category
- required
- Description
num_resets_received
- Type
- uint64
- Category
- required
- Description
num_resets_sent
- Type
- uint64
- Category
- required
- Description
PacketDropStats
bad_syn
- Type
- uint64
- Category
- required
- Description
bad_offset
- Type
- uint64
- Category
- required
- Description
bad_checksum
- Type
- uint64
- Category
- required
- Description
paws
- Type
- uint64
- Category
- required
- Description
too_short
- Type
- uint64
- Category
- required
- Description
lack_of_memory
- Type
- uint64
- Category
- required
- Description
received_after_close
- Type
- uint64
- Category
- required
- Description
bad_packets
- Type
- uint64
- Category
- required
- Description
TimeoutStats
retransmit_timeout
- Type
- uint64
- Category
- required
- Description
persist_timeout
- Type
- uint64
- Category
- required
- Description
keepalive_timeout
- Type
- uint64
- Category
- required
- Description
SackStats
sack_recovery_episodes
- Type
- uint64
- Category
- required
- Description
sack_retransmit_segments
- Type
- uint64
- Category
- required
- Description
sack_retransmit_bytes
- Type
- uint64
- Category
- required
- Description
sack_blocks_received
- Type
- uint64
- Category
- required
- Description
sack_blocks_sent
- Type
- uint64
- Category
- required
- Description
scoreboard_overflows
- Type
- uint64
- Category
- required
- Description
EcnStats
ecn_congestion_experienced
- Type
- uint64
- Category
- required
- Description
ecn_capable_transport_0
- Type
- uint64
- Category
- required
- Description
ecn_capable_transport_1
- Type
- uint64
- Category
- required
- Description
ecn_successful_handshakes
- Type
- uint64
- Category
- required
- Description
times_ecn_reduced_cwnd
- Type
- uint64
- Category
- required
- Description
MiscStats
rtt_attempts
- Type
- uint64
- Category
- required
- Description
rtt_updated
- Type
- uint64
- Category
- required
- Description
times_rtt_initialized_from_route
- Type
- uint64
- Category
- required
- Description
times_rttvar_initialized_from_route
- Type
- uint64
- Category
- required
- Description
times_ssthresh_initialized_from_route
- Type
- uint64
- Category
- required
- Description
times_hdr_predict_ok_for_acks
- Type
- uint64
- Category
- required
- Description
times_hdr_predict_ok_for_data_pkts
- Type
- uint64
- Category
- required
- Description
resends_due_to_mtu_discovery
- Type
- uint64
- Category
- required
- Description
total_matching_signature_received
- Type
- uint64
- Category
- required
- Description
total_bad_signature_received
- Type
- uint64
- Category
- required
- Description
mismatching_signature_received
- Type
- uint64
- Category
- required
- Description
no_signature_expected_by_socket
- Type
- uint64
- Category
- required
- Description
no_signature_expected_by_segment
- Type
- uint64
- Category
- required
- Description
times_cached_rtt_in_route_updated
- Type
- uint64
- Category
- required
- Description
times_cached_rttvar_in_route_updated
- Type
- uint64
- Category
- required
- Description
times_cached_ssthresh_updated
- Type
- uint64
- Category
- required
- Description
tcps_pcbcachemiss
- Type
- uint64
- Category
- required
- Description
entry_added_to_hostcache
- Type
- uint64
- Category
- required
- Description
hostcache_bucket_overflow
- Type
- uint64
- Category
- required
- Description
avg_minmss_too_low_drops
- Type
- uint64
- Category
- required
- Description
mbuf_failures
- Type
- uint64
- Category
- required
- Description
connections_using_auto_gateway
- Type
- uint64
- Category
- required
- Description
TcpDnsStats
invalid_qd
- Type
- uint64
- Category
- optional
- Description
invalid_edns_option
- Type
- uint64
- Category
- optional
- Description
rx_responses
- Type
- uint64
- Category
- optional
- Description
pass_through
- Type
- uint64
- Category
- optional
- Description
notimp
- Type
- uint64
- Category
- optional
- Description
domain_drops
- Type
- uint64
- Category
- optional
- Description
unsupported_queries
- Type
- uint64
- Category
- optional
- Description
gs_down
- Type
- uint64
- Category
- optional
- Description
no_valid_gs_member
- Type
- uint64
- Category
- optional
- Description
no_record
- Type
- uint64
- Category
- optional
- Description
query_a
- Type
- uint64
- Category
- optional
- Description
query_cname
- Type
- uint64
- Category
- optional
- Description
query_aaaa
- Type
- uint64
- Category
- optional
- Description
query_ns
- Type
- uint64
- Category
- optional
- Description
query_srv
- Type
- uint64
- Category
- optional
- Description
query_mx
- Type
- uint64
- Category
- optional
- Description
query_others
- Type
- uint64
- Category
- optional
- Description
response_a
- Type
- uint64
- Category
- optional
- Description
response_cname
- Type
- uint64
- Category
- optional
- Description
response_aaaa
- Type
- uint64
- Category
- optional
- Description
response_ns
- Type
- uint64
- Category
- optional
- Description
response_srv
- Type
- uint64
- Category
- optional
- Description
response_mx
- Type
- uint64
- Category
- optional
- Description
response_others
- Type
- uint64
- Category
- optional
- Description
local_responses
- Type
- uint64
- Category
- optional
- Description
response_nxdomain
- Type
- uint64
- Category
- optional
- Description
pass_through_errors
- Type
- uint64
- Category
- optional
- Description
responses
- Type
- uint64
- Category
- optional
- Description
Filters
SeParamsFilter
primary_only
- Type
- bool
- Category
- optional
- Description
- Only from primary se
disable_aggregate
- Type
- enum
- Category
- optional
- Description
- Do not aggregate at SE or CORE level
- Choices
- SE, CORE
se_uuid
- Type
- string
- Category
- optional
- Description
- Only from this se
all_se
- Type
- bool
- Category
- optional
- Description
- Report from all SEs overriding disable_aggregate field. If there are more than max scale out SEs, then this filter pops an error message to use a specific SE
- Default
- False
CpsDoserFilter
cps_doser_ip
- Type
- IpAddr
- Category
- optional
- Description
cps_doser_mask
- Type
- int32
- Category
- optional
- Description
cps_doser_end_ip
- Type
- IpAddr
- Category
- optional
- Description
CandidateSeHostFilter
check_hosts
- Type
- bool
- Category
- optional
- Description
- Default
- True
vip_id
- Type
- string
- Category
- optional
- Description
- Default
GeoLocationFilter
ip
- Type
- IpAddr
- Category
- optional
- Description
mask
- Type
- uint32
- Category
- optional
- Description
start_ip
- Type
- IpAddr
- Category
- optional
- Description
ConnectionFilter
conn_type
- Type
- enum
- Category
- optional
- Description
- frontend, backend, or both
- Choices
- BOTH, FRONTEND, BACKEND
ip_addr
- Type
- string
- Category
- optional
- Description
- Ip address of either src or dst in dotted decimal
port
- Type
- uint32
- Category
- optional
- Description
- Src port or Dst Port
ip_mask
- Type
- string
- Category
- optional
- Description
- Ip mask in dotted decimal
UdpStatFilter
type
- Type
- enum
- Category
- optional
- Description
- Choices
- BOTH, FRONTEND, BACKEND
service_port
- Type
- uint32
- Category
- optional
- Description
GsFilter
gs_uuid
- Type
- string
- Category
- optional
- Description
- Filter by GSLB service
TcpStatFilter
type
- Type
- enum
- Category
- optional
- Description
- Choices
- BOTH, FRONTEND, BACKEND
service_port
- Type
- uint32
- Category
- optional
- Description
VstypeFilter
vservertype
- Type
- string
- Category
- optional
- Description
- l7, l4, or l4fast