VirtualService

Description

API


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

CLI


    configure virtualservice &ltkey>
    show virtualservice &ltkey>

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
        }
    ], 
    "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

{
    "subnet": {
        "mask": 24, 
        "ip_addr": {
            "type": "V4", 
            "addr": "10.10.10.0"
        }
    }, 
    "auto_allocate_ip": true, 
    "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

{
    "subnet": {
        "mask": 24, 
        "ip_addr": {
            "type": "V4", 
            "addr": "10.10.10.0"
        }
    }, 
    "name": "production_vs", 
    "network_ref": "/api/network/network-042975ea-376d-4e59-b8da-1b299be51eb1", 
    "auto_allocate_ip": true, 
    "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 Virtual Service.

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

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

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

analytics_policy

Type
AnalyticsPolicy
Category
optional
Description

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
If auto_allocate_ip is True, then the subnet for the Virtual Service IP address allocation.

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
Discovered networks providing reachability for client facing Virtual Service IP.

discovered_subnet

Type
IpAddrPrefix
Category
repeated
Description
Discovered subnets providing reachability for client facing Virtual Service IP.

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
Discovered networks providing reachability for client facing Virtual Service IP.

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. (1-2-4-8)
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_VH_PARENT, VS_TYPE_VH_CHILD, VS_TYPE_NORMAL

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.

cloud_type

Type
enum
Category
optional
Description
Default
CLOUD_VCENTER
Choices
CLOUD_VCENTER, CLOUD_DOCKER_UCP, CLOUD_APIC, CLOUD_OPENSTACK, CLOUD_MESOS, CLOUD_RANCHER, CLOUD_VCA, CLOUD_LINUXSERVER, CLOUD_AWS, CLOUD_NONE

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
CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS

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

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
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
Default
ACTIVE_STANDBY_SE_1
Choices
ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2

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

PerformanceLimits

max_concurrent_connections

Type
int32
Category
optional
Description
The maximum number of concurrent client conections allowed to the Virtual Service.

max_throughput

Type
int32
Category
optional
Description
The maximum throughput per second for all clients allowed through the client side of the Virtual Service.

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
PASSIVE, ACTIVE, NO_INSIGHTS

metrics_realtime_update

Type
MetricsRealTimeUpdate
Category
optional
Description
Settings to turn on realtime metrics and set duration for realtime updates

analytics_profile_ref

Type
Reference to AnalyticsProfile
Category
optional
Description
Analytics preferences and settings.

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

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
Default
30

IpAddrMatch

match_criteria

Type
enum
Category
required
Description
Criterion to use for IP address matching the HTTP request
Choices
IS_NOT_IN, IS_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
REGEX_MATCH, DOES_NOT_END_WITH, ENDS_WITH, CONTAINS, EQUALS, DOES_NOT_BEGIN_WITH, DOES_NOT_EQUAL, REGEX_DOES_NOT_MATCH, DOES_NOT_CONTAIN, BEGINS_WITH

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

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

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_RESET_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_DROP_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_NONE, 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_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_404

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_302, HTTP_REDIRECT_STATUS_CODE_301, 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_PATH, URI_TOKEN_TYPE_REGEX, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_HOST

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
required
Description

Actions

API


    POST /api/virtualservice/&ltkey>/switchover

CLI


    switchover virtualservice &ltkey>

Data

VsSwitchoverParams

se_uuid

Type
string
Category
optional
Description

API


    POST /api/virtualservice/&ltkey>/migrate

CLI


    migrate virtualservice &ltkey>

Data

VsMigrateParams

from_se_ref

Type
Reference to ServiceEngine
Category
optional
Description

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

new_vcpus

Type
uint32
Category
optional
Description

API


    POST /api/virtualservice/&ltkey>/scalein

CLI


    scalein virtualservice &ltkey>

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

API


    POST /api/virtualservice/&ltkey>/initialplacement

CLI


    initialplacement virtualservice &ltkey>

Data

VsInitialPlacementParams

se_placement_params

Type
VsSeInitialPlacementParams
Category
repeated
Description

VsSeInitialPlacementParams

to_new_se

Type
bool
Category
optional
Description
Default
False

to_se_ref

Type
Reference to ServiceEngine
Category
optional
Description

to_host_ref

Type
Reference to VIMgrHostRuntime
Category
optional
Description

API


    POST /api/virtualservice/&ltkey>/resync

CLI


    resync virtualservice &ltkey>

Data

VsResyncParams

se_ref

Type
Reference to ServiceEngine
Category
repeated
Description

API


    POST /api/virtualservice/&ltkey>/rotatekeys

CLI


    rotatekeys virtualservice &ltkey>

API


    POST /api/virtualservice/&ltkey>/apicplacement

CLI


    apicplacement virtualservice &ltkey>

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/&ltkey>/scaleout

CLI


    scaleout virtualservice &ltkey>

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

References

HTTPPolicySet VirtualService Network NetworkSecurityPolicy Cloud SSLKeyAndCertificate NetworkProfile ServiceEngineGroup AnalyticsProfile IpAddrGroup ApplicationProfile SSLProfile Tenant VSDataScriptSet MicroService AuthProfile StringGroup Pool VrfContext

Sub Objects

KeyvalSummaryInternal

API


    GET /api/virtualservice/&ltkey>/keyvalsummary/&ltkey>

CLI


    show virtualservice &ltkey> 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

KeyvalCacheInternal

core_num

Type
uint32
Category
optional
Description

num_hits_creates

Type
uint32
Category
optional
Description

num_creates_skipped

Type
uint32
Category
optional
Description

VsDosStatRuntime

API


    GET /api/virtualservice/&ltkey>/dosstat/&ltkey>
	Query Params: SeParamsFilter	CpsDoserFilter

CLI


    show virtualservice &ltkey> 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

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

VirtualServiceAuthStats

API


    GET /api/virtualservice/&ltkey>/authstats/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> authstats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

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

Actions

API


    POST /api/virtualservice/&ltkey>/authstats/clear

CLI


    clear virtualservice &ltkey> authstats

UdpStatRuntime

API


    GET /api/virtualservice/&ltkey>/udpstat/&ltkey>
	Query Params: UdpStatFilter	SeParamsFilter

CLI


    show virtualservice &ltkey> 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

HTTPPolicySetStats

API


    GET /api/virtualservice/&ltkey>/httppolicysetstats/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> 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

HTTPPolicySetStat

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

security_policy_stat

Type
HTTPSecurityPolicyStat
Category
optional
Description

request_policy_stat

Type
HTTPRequestPolicyStat
Category
optional
Description

response_policy_stat

Type
HTTPResponsePolicyStat
Category
optional
Description

HTTPSecurityPolicyStat

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

HTTPRequestPolicyStat

rule_stats

Type
RuleStats
Category
repeated
Description

HTTPResponsePolicyStat

rule_stats

Type
RuleStats
Category
repeated
Description

Actions

API


    POST /api/virtualservice/&ltkey>/httppolicysetstats/clear

CLI


    clear virtualservice &ltkey> httppolicyset stats

SeConsumerProto

API


    GET /api/virtualservice/&ltkey>/placement/&ltkey>

CLI


    show virtualservice &ltkey> 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
AWAITING_VNIC_ADD, AWAITING_SE_CREATE, AWAITING_QUERY_HOST, AWAITING_SE_BOOTUP, IDLE, AWAITING_VNIC_IP

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

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

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

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

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

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_mac

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

last_attach_ip_fail_ticks

Type
uint32
Category
optional
Description

floating_intf_ip

Type
IpAddr
Category
repeated
Description

SeResourceVnic

mac_addr

Type
string
Category
required
Description

virtual_network_id

Type
string
Category
optional
Description

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_BACKEND, RM_VNIC_FRONTEND

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

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_FAST_PATH, PROTOCOL_TYPE_TCP_PROXY, 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

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

PlacementHistory

ref

Type
Reference to ServiceEngine
Category
optional
Description

op

Type
enum
Category
optional
Description
Choices
PLACEMENT_OP_BOOTUP_FAIL, PLACEMENT_OP_CREATE_SE, PLACEMENT_OP_BOOTUP_SUCCESS, PLACEMENT_OP_CREATE_SE_FAIL, PLACEMENT_OP_VNIC_IP_FAIL, PLACEMENT_OP_BIND_SE, PLACEMENT_OP_MOD_VNIC_SUCCESS, PLACEMENT_OP_MOD_VNIC_FAIL, PLACEMENT_OP_SWITCHOVER_PRIMARY, PLACEMENT_OP_CREATE_SE_SUCCESS, PLACEMENT_OP_UNBIND_SE, PLACEMENT_OP_MOD_VNIC

reason

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

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

CreateInfo

name

Type
string
Category
optional
Description

host_ref

Type
Reference to VIMgrHostRuntime
Category
optional
Description

status

Type
enum
Category
optional
Description
Choices
SEVM_CREATE_FAIL_OVF_ERROR, SEVM_CREATE_NO_HOST, SEVM_CREATE_FAIL_ABORTED, SEVM_VINFRA_UNININITIALIZED, SEVM_NO_SOURCE_CLONE, SEVM_CREATE_FAIL_NO_MEM, SEVM_VCENTER_CONN_FAIL, SEVM_CREATE_FAILURE, SEVM_CREATE_ACCESS_ERROR, SEVM_CREATE_FAIL_NO_CPU, SEVM_FLAVOR_UNAVAIL, SEVM_VNIC_FAILURE_QUESTION, SEVM_DELETE_FAILURE, SEVM_SUCCESS, SEVM_CREATE_FAIL_DUPLICATE_NAME, SEVM_CREATE_FAIL_NO_MGMT_NW, SEVM_CREATE_NO_IMAGE, SEVM_CREATE_FAIL_NO_LEASE, SEVM_SET_MGMT_IP_FAILED, SEVM_CREATE_FAIL_NO_HW_INFO, SEVM_CREATE_FAIL_NO_MGMT_NW_PORTS, SEVM_CREATE_FAIL_NO_PROGRESS, SEVM_VINFRA_FAILURE, SEVM_INVALID_DATA, SEVM_CREATE_NO_HOST_VM_NETWORK, SEVM_VNIC_MAC_ADDR_ERROR, SEVM_VNIC_FAILURE, SEVM_NO_AVAILABILITY_ZONE, SEVM_TIMED_OUT, SEVM_VNIC_NO_IPS_AVAILABLE, SEVM_CREATE_LIMIT_REACHED, SEVM_VNIC_NO_PG_PORTS, SEVM_DELETED, SEVM_CREATE_FAIL_POWER_ON, SEVM_VNIC_NO_VM

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

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_CREATE_FAIL_OVF_ERROR, SEVM_CREATE_NO_HOST, SEVM_CREATE_FAIL_ABORTED, SEVM_VINFRA_UNININITIALIZED, SEVM_NO_SOURCE_CLONE, SEVM_CREATE_FAIL_NO_MEM, SEVM_VCENTER_CONN_FAIL, SEVM_CREATE_FAILURE, SEVM_CREATE_ACCESS_ERROR, SEVM_CREATE_FAIL_NO_CPU, SEVM_FLAVOR_UNAVAIL, SEVM_VNIC_FAILURE_QUESTION, SEVM_DELETE_FAILURE, SEVM_SUCCESS, SEVM_CREATE_FAIL_DUPLICATE_NAME, SEVM_CREATE_FAIL_NO_MGMT_NW, SEVM_CREATE_NO_IMAGE, SEVM_CREATE_FAIL_NO_LEASE, SEVM_SET_MGMT_IP_FAILED, SEVM_CREATE_FAIL_NO_HW_INFO, SEVM_CREATE_FAIL_NO_MGMT_NW_PORTS, SEVM_CREATE_FAIL_NO_PROGRESS, SEVM_VINFRA_FAILURE, SEVM_INVALID_DATA, SEVM_CREATE_NO_HOST_VM_NETWORK, SEVM_VNIC_MAC_ADDR_ERROR, SEVM_VNIC_FAILURE, SEVM_NO_AVAILABILITY_ZONE, SEVM_TIMED_OUT, SEVM_VNIC_NO_IPS_AVAILABLE, SEVM_CREATE_LIMIT_REACHED, SEVM_VNIC_NO_PG_PORTS, SEVM_DELETED, SEVM_CREATE_FAIL_POWER_ON, SEVM_VNIC_NO_VM

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

VsPlacementResolutionInfo

ip

Type
IpAddr
Category
optional
Description

pool_uuid

Type
string
Category
optional
Description

networks

Type
DiscoveredNetwork
Category
repeated
Description

ConnectionDumpRuntime

API


    GET /api/virtualservice/&ltkey>/connections/&ltkey>
	Query Params: ConnectionFilter

CLI


    show virtualservice &ltkey> 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

Actions

API


    POST /api/virtualservice/&ltkey>/connections/clear

CLI


    clear virtualservice &ltkey> connections

Data

ConnectionClearFilter

ip_addr

Type
string
Category
optional
Description
IP address in dotted decimal notation

port

Type
uint32
Category
optional
Description
Port number

ClientSummaryInternal

API


    GET /api/virtualservice/&ltkey>/clientsummary/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> 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

VirtualServiceRuntimeSummary

API


    GET /api/virtualservice/&ltkey>/runtime/&ltkey>

CLI


    show virtualservice &ltkey> summary

Data

VirtualServiceRuntimeSummary

oper_status

Type
OperationalStatus
Category
optional
Description

one_plus_one_ha

Type
bool
Category
optional
Description
Default
False

service_engine

Type
VsSeAssigned
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

manual_placement

Type
bool
Category
optional
Description
Default
False

recommendation

Type
string
Category
optional
Description

se_create_in_progress

Type
bool
Category
optional
Description
Default
False

num_static_se_pending

Type
int32
Category
optional
Description
Default
0

initial_placement_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

assigned_static_se_ref

Type
Reference to ServiceEngine
Category
repeated
Description

requested_static_se_ref

Type
Reference to ServiceEngine
Category
repeated
Description

vh_child_vs_ref

Type
Reference to VirtualService
Category
repeated
Description

type

Type
enum
Category
optional
Description
Default
VS_TYPE_NORMAL
Choices
VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD, VS_TYPE_NORMAL

first_se_assigned_time

Type
TimeStamp
Category
optional
Description

east_west

Type
bool
Category
optional
Description
Default
False

OperationalStatus

state

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

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

VsSeAssigned

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

ConfigurationStatus

state

Type
enum
Category
required
Description
Default
CONFIG_UP
Choices
CONFIG_SE_PROCESSING, CONFIG_PROCESSING, CONFIG_ERROR_DISABLED, CONFIG_UP, CONFIG_RESOURCES, CONFIG_DISABLED, CONFIG_PARTITIONED, CONFIG_INACTIVE, CONFIG_CREATING, CONFIG_UPGRADING, CONFIG_UNUSED, CONFIG_AWAIT_MANUAL_PLACEMENT, CONFIG_INITIALIZING, CONFIG_DOWN, CONFIG_UNKNOWN

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

ScaleStatus

state

Type
enum
Category
optional
Description
Choices
SCALEOUT_SUCCESS, MIGRATE_SUCCESS, MIGRATE_SCALEOUT_ROLLBACK, SCALEIN_ERROR, SCALEOUT_ERROR, SCALEIN_SUCCESS, SCALEOUT_AWAITING_SE_ASSIGNMENT, MIGRATE_SCALEOUT_SUCCESS, SCALEOUT_PROCESSING, MIGRATE_SCALEOUT_RESOURCES, MIGRATE_SCALEOUT_ERROR, SCALEOUT_CREATING_SE, MIGRATE_ERROR, MIGRATE_SCALEIN_AWAITING_SE_PROGRAMMING, SCALEIN_WAIT_FOR_SE_READY, SCALEIN_AWAITING_SE_PROGRAMMING, SCALEOUT_ERROR_DISABLED, MIGRATE_SCALEOUT_AWAITING_SE_PROGRAMMING, MIGRATE_SCALEIN_SUCCESS, MIGRATE_SCALEIN_WAIT_FOR_SE_READY, MIGRATE_SCALEOUT_AWAITING_SE_ASSIGNMENT, MIGRATE_SCALEOUT_CREATING_SE, SCALEOUT_ROLLBACK, SCALEOUT_RESOURCES, SCALEOUT_AWAITING_SE_PROGRAMMING, MIGRATE_SCALEIN_AWAITING_SE_RELEASE, MIGRATE_SCALEOUT_WAIT_FOR_SE_READY, SCALEIN_AWAITING_SE_PRE_RELEASE, SCALEOUT_WAIT_FOR_SE_READY, SCALEIN_AWAITING_SE_RELEASE, MIGRATE_SCALEIN_AWAITING_SE_PRE_RELEASE, MIGRATE_SCALEIN_ERROR

reason

Type
string
Category
repeated
Description

reason_code

Type
uint64
Category
optional
Description

start_time

Type
TimeStamp
Category
optional
Description

end_time

Type
TimeStamp
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

vs_placement_resolution_info

Type
VsPlacementResolutionInfo
Category
optional
Description

VirtualServiceInternal

API


    GET /api/virtualservice/&ltkey>/runtime/internal/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> 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

VirtualServiceRuntime

uuid

Type
string
Category
required
Description

fsm_state_name

Type
string
Category
optional
Description
Default
VsFsmMap::Inactive

fsm_state_id

Type
string
Category
optional
Description
Default
0

last_req_type

Type
enum
Category
optional
Description
Default
OTHER
Choices
SE_DISCONNECT, SE_RECONNECT, MIGRATE_SCALEIN, READ, CREATE, ROTATE_KEYS, SCALE_IN, UPDATE, REFRESH, SE_REMOVED, UPDATE_LOGMGR_MAP, OTHER, INITIAL_PLACEMENT, RESTART, WARM_RESTART, MIGRATE_SCALEOUT, SCALE_OUT, COLD_RESTART, DELETE

last_req_rc

Type
Unknown
Category
optional
Description
Default
0

datapath_debug

Type
DebugVirtualService
Category
optional
Description

scaleout_in_progress

Type
bool
Category
optional
Description
Default
False

scalein_in_progress

Type
bool
Category
optional
Description
Default
False

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

migrate_in_progress

Type
bool
Category
optional
Description
Default
False

marked_for_delete

Type
bool
Category
optional
Description
Default
False

migrate_request

Type
VsMigrateParams
Category
optional
Description

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

scale_history

Type
ScaleStatus
Category
repeated
Description

metrics_mgr_port

Type
enum
Category
optional
Description
Choices
METRICS_MGR_PORT_1, METRICS_MGR_PORT_0, METRICS_MGR_PORT_3, METRICS_MGR_PORT_2

prev_metrics_mgr_port

Type
enum
Category
optional
Description
Choices
METRICS_MGR_PORT_1, METRICS_MGR_PORT_0, METRICS_MGR_PORT_3, METRICS_MGR_PORT_2

manual_placement

Type
bool
Category
optional
Description
Default
False

se_create_in_progress

Type
bool
Category
optional
Description
Default
False

initial_placement_in_progress

Type
bool
Category
optional
Description
Default
False

scalein_request

Type
VsScaleinParams
Category
optional
Description

upgrade_in_progress

Type
bool
Category
optional
Description
Default
False

first_time_placement

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

initial_placement_request

Type
VsInitialPlacementParams
Category
optional
Description

initial_placement_se_params_index

Type
int32
Category
optional
Description

assigned_static_se_ref

Type
Reference to ServiceEngine
Category
repeated
Description

requested_static_se_ref

Type
Reference to ServiceEngine
Category
repeated
Description

vh_child_vs_ref

Type
Reference to VirtualService
Category
repeated
Description

se_list

Type
SeList
Category
repeated
Description

requested_resource

Type
VirtualServiceResource
Category
optional
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_VH_PARENT, VS_TYPE_VH_CHILD, VS_TYPE_NORMAL

supp_runtime_status

Type
OperationalStatus
Category
optional
Description

first_se_assigned_time

Type
TimeStamp
Category
optional
Description

east_west

Type
bool
Category
optional
Description
Default
False

num_additional_se

Type
int32
Category
optional
Description
Default
0

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
Health Monitor debug options.
Default
DEBUG_VS_HM_NONE
Choices
DEBUG_VS_HM_NONE, DEBUG_VS_HM_INCLUDE, DEBUG_VS_HM_ONLY

tenant_ref

Type
Reference to Tenant
Category
optional
Description

DebugVsDataplane

flag

Type
enum
Category
required
Description
Choices
DEBUG_VS_UDP, DEBUG_VS_HTTP_ALL, DEBUG_VS_TCP_REXMT, DEBUG_VS_TCP_CONNECTION, DEBUG_VS_PROXY_CONNECTION, DEBUG_VS_TCP_PKT, DEBUG_VS_TCP_TIMER, DEBUG_VS_EVENTS, DEBUG_VS_HM_EXT, DEBUG_VS_HTTP_RULES, DEBUG_VS_PROXY_ERR, DEBUG_VS_TCP_APP_PKT, DEBUG_VS_HM, DEBUG_VS_CONFIG, DEBUG_VS_TCP_RETRANSMIT, DEBUG_VS_TCP_ALL, DEBUG_VS_TCP_APP, DEBUG_VS_TCP_PKT_ERROR, DEBUG_VS_ALL, DEBUG_VS_HTTP_CORE, DEBUG_VS_HM_ERR, DEBUG_VS_PROXY_PKT, DEBUG_VS_SSL, DEBUG_VS_HM_PKT, DEBUG_VS_ERROR, DEBUG_VS_TCP_CONN_ERROR, DEBUG_VS_NONE, DEBUG_VS_CREDIT, DEBUG_VS_UDP_PKT

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.
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_BE, VNIC_TYPE_INT_PRIMARY, VNIC_TYPE_INT, VNIC_TYPE_FE, VNIC_TYPE_INT_SECONDARY

lif

Type
string
Category
optional
Description

SeList

se_ref

Type
Reference to ServiceEngine
Category
required
Description

is_primary

Type
bool
Category
required
Description

is_standby

Type
bool
Category
optional
Description

is_connected

Type
bool
Category
required
Description

delete_in_progress

Type
bool
Category
required
Description

vcpus

Type
int32
Category
required
Description

memory

Type
int32
Category
required
Description

vip_intf_mac

Type
string
Category
required
Description

vip_subnet_mask

Type
int32
Category
required
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

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

TLSTicket

name

Type
string
Category
required
Description

aes_key

Type
Unknown
Category
required
Description

hmac_key

Type
Unknown
Category
required
Description

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

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

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

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

ClientInternal

API


    GET /api/virtualservice/&ltkey>/client/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> 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/&ltkey>/client/clear

CLI


    clear virtualservice &ltkey> client

VsCandidateSeHostList

API


    GET /api/virtualservice/&ltkey>/candidatesehostlist/&ltkey>
	Query Params: CandidateSeHostFilter

CLI


    show virtualservice &ltkey> candidate-se-host-list filter [check_hosts]

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

VsCandidateHost

host_ref

Type
Reference to VIMgrHostRuntime
Category
optional
Description

recommended

Type
bool
Category
optional
Description
Default
False

L7VirtualServiceStatsRuntime

API


    GET /api/virtualservice/&ltkey>/httpstats/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> httpstats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

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

VirtualServiceRuntimeDetail

API


    GET /api/virtualservice/&ltkey>/runtime/detail/&ltkey>
	Query Params: SeParamsFilter	TcpStatFilter	VstypeFilter

CLI


    show virtualservice &ltkey> 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
VsSeAssigned
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

manual_placement

Type
bool
Category
optional
Description
Default
False

se_create_in_progress

Type
bool
Category
optional
Description
Default
False

num_static_se_pending

Type
int32
Category
optional
Description
Default
0

initial_placement_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

assigned_static_se_ref

Type
Reference to ServiceEngine
Category
repeated
Description

requested_static_se_ref

Type
Reference to ServiceEngine
Category
repeated
Description

vh_child_vs_ref

Type
Reference to VirtualService
Category
repeated
Description

type

Type
enum
Category
optional
Description
Default
VS_TYPE_NORMAL
Choices
VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD, VS_TYPE_NORMAL

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

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

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

Actions

API


    POST /api/virtualservice/&ltkey>/stats/clear

CLI


    clear virtualservice &ltkey> stats

KeyvalInternal

API


    GET /api/virtualservice/&ltkey>/keyval/&ltkey>

CLI


    show virtualservice &ltkey> 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/&ltkey>/keyval/clear

CLI


    clear virtualservice &ltkey> keyval

HTTPPolicySetInternal

API


    GET /api/virtualservice/&ltkey>/httppolicyset/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> 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_NOT_IN, IS_IN

ports

Type
uint32
Category
repeated
Description
TCP port(s) listening for HTTP/HTTPS

ProtocolMatch

match_criteria

Type
enum
Category
required
Description
Criterion to use for protocol matching the HTTP request
Choices
IS_NOT_IN, IS_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_NOT_IN, IS_IN

methods

Type
enum
Category
repeated
Description
Configure HTTP method(s)
Choices
HTTP_METHOD_HEAD, HTTP_METHOD_OPTIONS, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_GET, 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_NOT_IN, IS_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
REGEX_MATCH, DOES_NOT_END_WITH, ENDS_WITH, CONTAINS, EQUALS, DOES_NOT_BEGIN_WITH, DOES_NOT_EQUAL, REGEX_DOES_NOT_MATCH, DOES_NOT_CONTAIN, BEGINS_WITH

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_ENDS_WITH, HDR_EQUALS, HDR_DOES_NOT_EXIST, HDR_EXISTS, HDR_DOES_NOT_END_WITH, HDR_DOES_NOT_EQUAL, HDR_DOES_NOT_CONTAIN, HDR_CONTAINS, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH

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_ENDS_WITH, HDR_EQUALS, HDR_DOES_NOT_EXIST, HDR_EXISTS, HDR_DOES_NOT_END_WITH, HDR_DOES_NOT_EQUAL, HDR_DOES_NOT_CONTAIN, HDR_CONTAINS, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH

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_ENDS_WITH, HDR_EQUALS, HDR_DOES_NOT_EXIST, HDR_EXISTS, HDR_DOES_NOT_END_WITH, HDR_DOES_NOT_EQUAL, HDR_DOES_NOT_CONTAIN, HDR_CONTAINS, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH

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_SEND_RESPONSE, HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS, HTTP_SECURITY_ACTION_RATE_LIMIT, HTTP_SECURITY_ACTION_ALLOW, HTTP_SECURITY_ACTION_CLOSE_CONN

status_code

Type
enum
Category
optional
Description
HTTP status code to use for local response
Choices
HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_404

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_REPLACE_HDR, HTTP_ADD_HDR, HTTP_REMOVE_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_SSL_CLIENT_SERIAL, HTTP_POLICY_VAR_SSL_CIPHER, HTTP_POLICY_VAR_SSL_CLIENT_FINGERPRINT, HTTP_POLICY_VAR_USER_NAME, HTTP_POLICY_VAR_HTTP_HDR, HTTP_POLICY_VAR_VS_PORT, HTTP_POLICY_VAR_SSL_CLIENT_SUBJECT, HTTP_POLICY_VAR_SSL_SERVER_NAME, HTTP_POLICY_VAR_CLIENT_IP, HTTP_POLICY_VAR_VS_IP, HTTP_POLICY_VAR_SSL_CLIENT_RAW, HTTP_POLICY_VAR_SSL_CLIENT_ISSUER, HTTP_POLICY_VAR_SSL_PROTOCOL

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_LOCAL, HTTP_SWITCHING_SELECT_POOL

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_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_404

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

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_ENDS_WITH, HDR_EQUALS, HDR_DOES_NOT_EXIST, HDR_EXISTS, HDR_DOES_NOT_END_WITH, HDR_DOES_NOT_EQUAL, HDR_DOES_NOT_CONTAIN, HDR_CONTAINS, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH

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_NOT_IN, IS_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

NetworkSecurityPolicyStats

API


    GET /api/virtualservice/&ltkey>/networksecuritypolicystats/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey>  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

NetworkSecurityPolicyDetail

API


    GET /api/virtualservice/&ltkey>/networksecuritypolicy/detail/&ltkey>

CLI


    show virtualservice &ltkey>  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

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_RATE_LIMIT, NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY, NETWORK_SECURITY_POLICY_ACTION_TYPE_ALLOW

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

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_NOT_IN, IS_IN

group_ref

Type
Reference to MicroServiceGroup
Category
optional
Description
UUID of Micro Service group(s)

NetworkSecurityPolicyActionRLParam

max_rate

Type
uint32
Category
required
Description

burst_size

Type
uint32
Category
required
Description
Default
0

CltrackSummaryInternal

API


    GET /api/virtualservice/&ltkey>/cltracksummary/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> 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

CltrackInternal

API


    GET /api/virtualservice/&ltkey>/cltrack/&ltkey>
	Query Params: SeParamsFilter

CLI


    show virtualservice &ltkey> 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/&ltkey>/cltrack/clear

CLI


    clear virtualservice &ltkey> cltrack

TcpStatRuntime

API


    GET /api/virtualservice/&ltkey>/tcpstat/&ltkey>
	Query Params: TcpStatFilter	SeParamsFilter

CLI


    show virtualservice &ltkey> 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

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

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
CORE, SE

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

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

CandidateSeHostFilter

check_hosts

Type
bool
Category
optional
Description
Default
True

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