VIMgrVcenterRuntime

Description

API


    GET /api/vimgrvcenterruntime
    GET /api/vimgrvcenterruntime/<key>

CLI


    show vinfra vcenter <key>

Data

VIMgrVcenterRuntime

type

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

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

vcenter_url

Type
string
Category
required
Description

username

Type
string
Category
required
Description

password

Type
string
Category
required
Description

datacenter_refs

Type
Reference to VIMgrDCRuntime
Category
repeated
Description

privilege

Type
enum
Category
optional
Description
Choices
NO_ACCESS, READ_ACCESS, WRITE_ACCESS

inventory_state

Type
enum
Category
optional
Description
Choices
VCENTER_DISCOVERY_BAD_CREDENTIALS, VCENTER_DISCOVERY_RETRIEVING_DC, VCENTER_DISCOVERY_WAITING_DC, VCENTER_DISCOVERY_RETRIEVING_NW, VCENTER_DISCOVERY_ONGOING, VCENTER_DISCOVERY_RESYNCING, VCENTER_DISCOVERY_COMPLETE, VCENTER_DISCOVERY_DELETING_VCENTER, VCENTER_DISCOVERY_FAILURE, VCENTER_DISCOVERY_COMPLETE_NO_MGMT_NW, VCENTER_DISCOVERY_COMPLETE_PER_TENANT_IP_ROUTE, VCENTER_DISCOVERY_MAKING_SE_OVA, VCENTER_DISCOVERY_RESYNC_FAILED

discovered_datacenter

Type
string
Category
optional
Description

progress

Type
Unknown
Category
optional
Description

num_dcs

Type
Unknown
Category
optional
Description

num_hosts

Type
Unknown
Category
optional
Description

num_clusters

Type
Unknown
Category
optional
Description

num_vms

Type
Unknown
Category
optional
Description

num_nws

Type
Unknown
Category
optional
Description

num_vcenter_req_pending

Type
Unknown
Category
optional
Description

disc_start_time

Type
string
Category
optional
Description

disc_end_time

Type
string
Category
optional
Description

management_network

Type
string
Category
optional
Description

inventory_progress

Type
string
Category
optional
Description

apic_mode

Type
bool
Category
optional
Description
Default
False

vcenter_template_se_location

Type
string
Category
optional
Description

api_version

Type
string
Category
optional
Description

vcenter_fullname

Type
string
Category
optional
Description

vcenter_connected

Type
bool
Category
optional
Description
Default
False

tenant_ref

Type
Reference to Tenant
Category
optional
Description
Default
/api/tenant?name=admin

cloud_ref

Type
Reference to Cloud
Category
optional
Description
Default
/api/cloud?name=Default-Cloud

Actions

API


    POST /api/vimgrvcenterruntime/spawn

CLI


    vinfra spawn

Data

VICreateSEReq

se_params

Type
VISeVmOvaParams
Category
required
Description

cookie

Type
string
Category
optional
Description

vcenter_admin

Type
VIAdminCredentials
Category
optional
Description

vcenter_vnic_portgroups

Type
string
Category
repeated
Description

se_grp_uuid

Type
string
Category
optional
Description

tenant_uuid

Type
string
Category
optional
Description

cloud_uuid

Type
string
Category
optional
Description

VISeVmOvaParams

sevm_name

Type
string
Category
required
Description

controller_ip_addr

Type
string
Category
required
Description

rm_cookie

Type
string
Category
optional
Description

vcenter_host

Type
string
Category
optional
Description

vcenter_ovf_path

Type
string
Category
optional
Description

vcenter_num_se_cores

Type
int32
Category
optional
Description
Default
2

vcenter_cpu_reserv

Type
bool
Category
optional
Description
Default
False

vcenter_num_mem

Type
uint64
Category
optional
Description
Default
2048

vcenter_mem_reserv

Type
bool
Category
optional
Description
Default
False

vcenter_vm_folder

Type
string
Category
optional
Description

vcenter_se_mgmt_nw

Type
string
Category
optional
Description

vcenter_ds_info

Type
VcenterDatastore
Category
repeated
Description

vcenter_ds_include

Type
bool
Category
optional
Description

vcenter_ds_mode

Type
enum
Category
optional
Description
Choices
VCENTER_DATASTORE_ANY, VCENTER_DATASTORE_LOCAL, VCENTER_DATASTORE_SHARED

vcenter_internal

Type
string
Category
optional
Description
Default
UNIFIED ADMIN

mode

Type
enum
Category
optional
Description
Choices
APIC_MODE, NON_APIC_MODE

se_auth_token

Type
string
Category
optional
Description

vcenter_se_disk_size_KB

Type
int32
Category
optional
Description
Default
10485760

controller_cluster_uuid

Type
string
Category
optional
Description

single_socket_affinity

Type
bool
Category
optional
Description

VcenterDatastore

datastore_name

Type
string
Category
required
Description

VIAdminCredentials

vcenter_url

Type
string
Category
required
Description

name

Type
string
Category
optional
Description
Default
root

password

Type
string
Category
optional
Description
Default
vmware

vi_mgr_token

Type
string
Category
optional
Description

privilege

Type
enum
Category
optional
Description
Choices
NO_ACCESS, READ_ACCESS, WRITE_ACCESS

API


    POST /api/vimgrvcenterruntime/setvnic

CLI


    vinfra setvnic

Data

VISetvNicNwReq

sevm_uuid

Type
string
Category
required
Description

cloud_uuid

Type
string
Category
required
Description

vcenter_admin

Type
VIAdminCredentials
Category
optional
Description

dc_uuid

Type
string
Category
optional
Description

vcenter_vnic_info

Type
VIVmVnicInfo
Category
repeated
Description

vcenter_sevm_mor

Type
string
Category
optional
Description

rm_cookie

Type
string
Category
optional
Description

VIVmVnicInfo

mac_addr

Type
string
Category
required
Description

vcenter_vnic_nw

Type
enum
Category
optional
Description
Choices
VNIC_VSWITCH, VNIC_DVS

vcenter_portgroup

Type
string
Category
optional
Description

API


    POST /api/vimgrvcenterruntime/vcenter/status

CLI


    vcenterstatus cloud

Data

VcenterCloudStatusReq

cloud_uuid

Type
string
Category
required
Description

API


    POST /api/vimgrvcenterruntime/verify/login

CLI


    verifylogin vcenter

Data

VcenterLogin

vcenter_url

Type
string
Category
optional
Description

username

Type
string
Category
optional
Description
Default
root

password

Type
string
Category
optional
Description
Default
vmware

cloud_uuid

Type
string
Category
optional
Description

start_ts

Type
uint64
Category
optional
Description

API


    POST /api/vimgrvcenterruntime/modifyvnic

CLI


    vinfra modifyvnic

Data

API


    POST /api/vimgrvcenterruntime/setmgmtip

CLI


    vinfra mgmtip

Data

VISetMgmtIpSEReq

cloud_uuid

Type
string
Category
required
Description

sevm_uuid

Type
string
Category
required
Description

ip_params

Type
VISeVmIpConfParams
Category
required
Description

all_vnic_connected

Type
bool
Category
optional
Description
Default
False

power_on

Type
bool
Category
optional
Description
Default
True

admin

Type
VIAdminCredentials
Category
optional
Description

dc_uuid

Type
string
Category
optional
Description

rm_cookie

Type
string
Category
optional
Description

VISeVmIpConfParams

mgmt_ip_type

Type
enum
Category
required
Description
Choices
VNIC_IP_TYPE_DHCP, VNIC_IP_TYPE_STATIC

mgmt_ip_addr

Type
string
Category
optional
Description

mgmt_net_mask

Type
string
Category
optional
Description

default_gw

Type
string
Category
optional
Description

API


    POST /api/vimgrvcenterruntime/controller/ipsubnet

CLI


    controller ip subnets

API


    POST /api/vimgrvcenterruntime/remove

CLI


    vinfra remove

Data

VIDeleteSEReq

sevm_uuid

Type
string
Category
required
Description

segroup_uuid

Type
string
Category
optional
Description

vcenter_admin

Type
VIAdminCredentials
Category
optional
Description

cloud_uuid

Type
string
Category
optional
Description

API


    POST /api/vimgrvcenterruntime/fault/inject

CLI


    faultinject vcenter

Data

VIFaultInjection

api

Type
enum
Category
required
Description
Choices
INITIAL_VALUE, CREATE_SE, MODIFY_VNIC, VM_MONITOR, RESOURCE_MONITOR, PERF_MONITOR, SET_MGMT_IP, MODIFY_MGMT_IP, SIM_VM_BULK_NOTIF, RESYNC_ERROR, DISC_PGNAME_ERR, DISC_DCDETAILS_ERR, DISC_DC_ERR, DISC_HOST_ERR, DISC_CLUSTER_ERR, DISC_PG_ERR, DISC_VM_ERR, HOST_PWR_STATE_ERR, HOST_CONN_STATE_ERR, HOST_MM_ERR, HOST_QUARANTINED_ERR, HOST_CTLR_ACCESS_ERR, HOST_NO_MGMT_ERR, HOST_NO_CPU_ERR, HOST_NO_MEM_ERR, HOST_NO_DISK_ERR, CREATE_SE_VIMGR, DELETE_SE_VIMGR, SLOW_VCENTER_ACCESS, CLEAR_ALL_FAULTS

status

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

count

Type
int32
Category
required
Description

API


    POST /api/vimgrvcenterruntime/modifymgmtip

CLI


    vinfra modifymgmtip

Data

API


    POST /api/vimgrvcenterruntime/retrieve/portgroups

CLI


    show vcenter portgroups

Data

VIRetrievePGNames

vcenter_url

Type
string
Category
optional
Description

username

Type
string
Category
optional
Description
Default
root

password

Type
string
Category
optional
Description
Default
vmware

datacenter

Type
string
Category
optional
Description

cloud_uuid

Type
string
Category
optional
Description

API


    POST /api/vimgrvcenterruntime/aws/verify/login

CLI


    verifylogin aws

Data

AWSLogin

access_key_id

Type
string
Category
optional
Description

secret_access_key

Type
string
Category
optional
Description

region

Type
string
Category
optional
Description
AWS region
Default
us-west-1

vpc_id

Type
string
Category
optional
Description

use_iam_roles

Type
bool
Category
optional
Description

iam_assume_role

Type
string
Category
optional
Description

API


    POST /api/vimgrvcenterruntime/<key>/getnetworks

CLI


    getnetworks vcenter <key>

API


    POST /api/vimgrvcenterruntime/openstack/verify/login

CLI


    verifylogin openstack

Data

OpenstackLogin

username

Type
string
Category
required
Description

password

Type
string
Category
required
Description

admin_tenant

Type
string
Category
optional
Description
Default
admin

keystone_host

Type
string
Category
optional
Description

region

Type
string
Category
optional
Description

auth_url

Type
string
Category
optional
Description

API


    POST /api/vimgrvcenterruntime/initiate/rediscover

CLI


    rediscover vcenter

Data

RediscoverVcenterParam

cloud

Type
string
Category
required
Description

API


    POST /api/vimgrvcenterruntime/generate/event

CLI


    genevent vcenter

Data

EventGenParams

virtualservice

Type
string
Category
optional
Description

events

Type
enum
Category
repeated
Description
Choices
VINFRA_DISC_DC, VINFRA_DISC_HOST, VINFRA_DISC_CLUSTER, VINFRA_DISC_VM, VINFRA_DISC_NW, MGMT_NW_NAME_CHANGED, DISCOVERY_DATACENTER_DEL, VM_ADDED, VM_REMOVED, VINFRA_DISC_COMPLETE, VCENTER_ADDRESS_ERROR, SE_GROUP_CLUSTER_DEL, SE_GROUP_MGMT_NW_DEL, MGMT_NW_DEL, VCENTER_BAD_CREDENTIALS, ESX_HOST_UNREACHABLE, SERVER_DELETED, SE_GROUP_HOST_DEL, VINFRA_DISC_FAILURE, ESX_HOST_POWERED_DOWN, VCENTER_VERSION_NOT_SUPPORTED, VCENTER_CONNECTIVITY_FAIL, VCENTER_CONNECTIVITY_SUCCESS, VCENTER_ACCESS_SLOW, SE_FATAL_ERROR, SE_HEARTBEAT_FAILURE, SE_MARKED_DOWN, SE_VM_DELETED, SE_VM_PURGED, SE_UP, SE_POWERED_DOWN, SE_REBOOTED, SE_HEALTH_CHECK_FAIL, SE_EXTERNAL_HM_RESTART, SE_DOWN, SE_VERSION_CHECK_FAILED, SE_UPGRADING, SE_ENABLE, SE_MIGRATE, CREATING_SE, CREATED_SE, CREATE_SE_FAIL, CREATE_SE_TIMEOUT, DELETING_SE, DELETED_SE, DELETE_SE_FAIL, ADD_NW_SE, DEL_NW_SE, VS_ADD_SE_INT, VS_REMOVED_SE_INT, VS_ADD_SE, VS_REMOVED_SE, ADD_NW_FAIL, RM_DEL_NETWORK_FAIL, REBOOT_SE, MODIFY_NW, MODIFY_NW_FAIL, VS_SE_BOOTUP_FAIL, VS_SE_IP_FAIL, NO_HOST_AVAIL, VS_SWITCHOVER, VS_SWITCHOVER_FAIL, ADD_VIP_VNIC, DEL_VIP_VNIC, VS_FSM_INACTIVE, VS_FSM_AWAITING_SE_ASSIGNMENT, VS_FSM_ACTIVE, VS_FSM_ACTIVE_AWAITING_SE_TRANSITION, VS_FSM_DISABLED, NEW_PROBABLE_SRVR, VS_SCALEOUT_DONE, VS_SCALEOUT_DONE_AWAITING_MORE_SE, VS_SCALEOUT_ERR, VS_SCALEIN_DONE, VS_SCALEIN_DONE_AWAITING_MORE_SE, VS_SCALEIN_ERR, VS_MIGRATE_SCALEOUT_DONE, VS_MIGRATE_SCALEOUT_ERROR, VS_MIGRATE_SCALEIN_DONE, VS_MIGRATE_SCALEIN_ERROR, VS_MIGRATE_DONE, VS_FSM_UNEXPECTED_EVENT, VS_RPC_TO_RESMGR_FAILED_EVENT, VS_RPC_TO_SE_FAILED_EVENT, VS_RPC_FAILED_EVENT, VS_SCALEOUT_COMPLETE, VS_SCALEIN_COMPLETE, VS_MIGRATE_STARTED, VS_MIGRATE_COMPLETE, VS_SCALEOUT_FAILED, VS_SCALEIN_FAILED, VS_MIGRATE_FAILED, VS_AWAITING_SE, VS_INITIAL_PLACEMENT_FAILED, VS_FSM_ACTIVE_AWAITING_SCALEOUT_READY, UPGRADE_ALL_SE_START, UPGRADE_ALL_SE_DONE, UPGRADE_ALL_SE_NOT_NEEDED, UPGRADE_SE_START, UPGRADE_SE_DONE, UPGRADE_SE_NOT_NEEDED, UPGRADE_SE_VS_SCALEOUT, UPGRADE_SE_VS_SCALEIN, UPGRADE_SE_VS_MIGRATE, UPGRADE_SE_VS_DISRUPTED, REBALANCE_VS_SCALEOUT, REBALANCE_VS_SCALEIN, REBALANCE_VS_MIGRATE, DISABLE_SE_VS_MIGRATE, ROLLBACK_ALL_SE_START, ROLLBACK_ALL_SE_DONE, MIGRATE_SE_STARTED, MIGRATE_SE_RESTARTED, MIGRATE_SE_FINISHED, MIGRATE_SE_FAILED, MIGRATE_SE_VS_MIGRATE_STARTED, MIGRATE_SE_VS_MIGRATE_FINISHED, MIGRATE_SE_VS_MIGRATE_FAILED, SE_HM_EVENT_SHM_DOWN, SE_HM_EVENT_SHM_UP, SERVER_DOWN, SERVER_UP, POOL_DOWN, POOL_UP, VS_DOWN, VS_UP, SE_SERVER_DELETED, SE_SERVER_DISABLED, SE_POOL_DELETED, SE_SERVER_APP_CHANGED, VS_CONN_LIMIT, VS_THROUGHPUT_LIMIT, CONN_DROP_MAX_SYN_TBL, CONN_DROP_MAX_FLOW_TBL, CONN_DROP_MAX_PERSIST_TBL, CONN_DROP_POOL_LB_FAILURE, CONN_DROP_NO_CONN_MEM, CONN_DROP_NO_PKT_BUFF, PKT_DROP_NO_PKT_BUFF, PKT_BUFF_ALLOC_FAIL, CACHE_OBJ_ALLOC_FAIL, SE_CPU_HIGH, SE_MEM_HIGH, SE_PKT_BUFF_HIGH, SE_PERSIST_TBL_HIGH, SE_CONN_MEM_HIGH, SE_DISK_HIGH, SE_FLOW_TBL_HIGH, SE_SYN_TBL_HIGH, SE_DP_HB_FAILED, SE_VNIC_DHCP_IP_ALLOC_FAILURE, SE_VNIC_DUPLICATE_IP, SE_SYN_CACHE_USAGE_HIGH, VS_SE_HA_ACTIVE, VS_SE_HA_COMPROMISED, POOL_SE_HA_ACTIVE, POOL_SE_HA_COMPROMISED, SERVER_DOWN_HA_COMPROMISED, SERVER_UP_HA_ACTIVE, SE_VNIC_IP_ADDED, SE_VNIC_IP_REMOVED, GS_MEMBER_DOWN, GS_MEMBER_UP, GS_GROUP_DOWN, GS_GROUP_UP, GS_DOWN, GS_UP, VIP_DOWN, VIP_UP, SE_GEO_DB_FAILURE, VS_GEO_DB_FAILURE, SE_GEO_DB_SUCCESS, VS_GEO_DB_SUCCESS, SE_EV_SERVER_DOWN, SE_EV_SERVER_UP, SE_EV_POOL_DOWN, SE_EV_POOL_UP, SE_EV_VS_DOWN, SE_EV_VS_UP, SE_HM_EVENT_GHM_DOWN, SE_HM_EVENT_GHM_UP, SE_EV_GS_GROUP_DELETED, SE_EV_GS_MEMBER_DOWN, SE_EV_GS_MEMBER_UP, SE_EV_GS_GROUP_DOWN, SE_EV_GS_GROUP_UP, SE_EV_GS_DOWN, SE_EV_GS_UP, CONFIG_CREATE, CONFIG_UPDATE, CONFIG_DELETE, USER_LOGIN, USER_LOGOUT, CONFIG_ACTION, CONFIG_INTERNAL_CREATE, CONFIG_INTERNAL_UPDATE, USER_PASSWORD_CHANGE_REQUEST, USER_AUTHORIZED_BY_RULE, USER_NOT_AUTHORIZED_BY_ANY_RULE, SSL_CERT_EXPIRE, SSL_KEY_EXPORTED, SSL_CERT_RENEW, SSL_CERT_RENEW_FAILED, CONTROLLER_NODE_JOINED, CONTROLLER_NODE_LEFT, CONTROLLER_SERVICE_FAILURE, CONTROLLER_LEADER_FAILOVER, CONTROLLER_WARM_REBOOT, CONTROLLER_SERVICE_RESTORED, CONTROLLER_SERVICE_CRITICAL_FAILURE, CONTROLLER_NODE_SHUTDOWN, CONTROLLER_NODE_STARTED, CLUSTER_CONFIG_FAILED, SYSTEM_UPGRADE_STARTED, SYSTEM_UPGRADE_COMPLETE, SYSTEM_UPGRADE_ABORTED, SYSTEM_ROLLBACK_STARTED, SYSTEM_ROLLBACK_COMPLETE, SYSTEM_ROLLBACK_ABORTED, CONTROLLER_NODE_DB_REPLICATION_FAILED, METRIC_THRESHOLD_UP_VIOLATION, LICENSE_EXPIRY, ANOMALY, LICENSE_ADDITION_NOTIF, LICENSE_REMOVAL_NOTIF, METRICS_DB_DISK_FULL, OPENSTACK_ACCESS_FAILURE, OPENSTACK_ACCESS_SUCCESS, OPENSTACK_IMAGE_UPLOAD_FAILURE, OPENSTACK_IMAGE_UPLOAD_SUCCESS, OPENSTACK_SE_VM_CREATED, OPENSTACK_SE_VM_DELETED, OPENSTACK_SE_VM_DELETION_DETECTED, OPENSTACK_VNIC_ADDED, OPENSTACK_VNIC_REMOVED, OPENSTACK_IP_DETACHED, OPENSTACK_IP_ATTACHED, OPENSTACK_SE_CREATION_FAILURE, OPENSTACK_SE_DELETION_FAILURE, OPENSTACK_VNIC_ADDITION_FAILURE, OPENSTACK_VNIC_DELETION_FAILURE, OPENSTACK_IP_DETACH_FAILURE, OPENSTACK_IP_ATTACH_FAILURE, OPENSTACK_LBPROV_AUDIT_FAILURE, OPENSTACK_LBPROV_AUDIT_SUCCESS, OPENSTACK_LBPLUGIN_OP_FAILURE, OPENSTACK_LBPLUGIN_OP_SUCCESS, OPENSTACK_SYNC_SERVICES_SUCCESS, OPENSTACK_SYNC_SERVICES_FAILURE, OPENSTACK_TENANTS_DELETED, AWS_ACCESS_FAILURE, AWS_ACCESS_SUCCESS, AWS_IMAGE_UPLOAD_FAILURE, AWS_IMAGE_UPLOAD_SUCCESS, CLOUDSTACK_ACCESS_FAILURE, CLOUDSTACK_ACCESS_SUCCESS, CLOUDSTACK_IMAGE_UPLOAD_FAILURE, CLOUDSTACK_IMAGE_UPLOAD_SUCCESS, DOCKER_UCP_ACCESS_SUCCESS, DOCKER_UCP_ACCESS_FAILURE, DOCKER_UCP_IMAGE_UPLOAD_FAILURE, DOCKER_UCP_IMAGE_UPLOAD_SUCCESS, DOCKER_UCP_IMAGE_UPLOAD_IN_PROGRESS, VCA_ACCESS_FAILURE, VCA_ACCESS_SUCCESS, VCA_IMAGE_UPLOAD_FAILURE, VCA_IMAGE_UPLOAD_SUCCESS, LS_ACCESS_FAILURE, LS_ACCESS_SUCCESS, LS_IMAGE_UPLOAD_FAILURE, LS_IMAGE_UPLOAD_SUCCESS, MESOS_ACCESS_SUCCESS, MESOS_ACCESS_FAILURE, MESOS_IMAGE_UPLOAD_FAILURE, MESOS_IMAGE_UPLOAD_SUCCESS, MESOS_IMAGE_UPLOAD_IN_PROGRESS, MESOS_CREATED_SE, MESOS_CREATE_SE_FAIL, MESOS_DELETED_SE, MESOS_DELETE_SE_FAIL, MESOS_STOPPED_SE, MESOS_STOP_SE_FAIL, MESOS_STARTED_SE, MESOS_START_SE_FAIL, MESOS_UPDATED_HOSTS, CC_SE_CREATED, CC_SE_CREATION_FAILURE, CC_SE_DELETED, CC_SE_DELETION_FAILURE, CC_SE_DELETION_DETECTED, CC_VNIC_ADDED, CC_VNIC_ADDITION_FAILURE, CC_VNIC_DELETED, CC_VNIC_DELETION_FAILURE, CC_IP_ATTACHED, CC_IP_ATTACH_FAILURE, CC_IP_DETACHED, CC_IP_DETACH_FAILURE, CC_SYNC_SERVICES_SUCCESS, CC_SYNC_SERVICES_FAILURE, CC_UPDATE_VIP_FAILURE, CC_DELETE_VIP_FAILURE, CC_CONFIG_FAILURE, CC_DECONFIG_FAILURE, CC_GENERIC_FAILURE, CC_CLUSTER_VIP_CONFIG_SUCCESS, CC_CLUSTER_VIP_CONFIG_FAILURE, CC_CLUSTER_VIP_DECONFIG_SUCCESS, CC_CLUSTER_VIP_DECONFIG_FAILURE, CC_MARATHON_SERVICE_PORT_OUTSIDE_VALID_RANGE, CC_MARATHON_SERVICE_PORT_ALREADY_IN_USE, CC_VIP_DNS_REGISTER_FAILURE, CC_TENANT_INIT_FAILURE, CC_HEALTH_FAILURE, CC_HEALTH_OK, CC_SE_STARTED, CC_SE_START_FAILURE, CC_SE_STOPPED, CC_SE_STOP_FAILURE, CC_VIP_PARK_INTF_SUCCESS, CC_VIP_PARK_INTF_FAILURE, CC_VIP_DNS_DEREGISTER_FAILURE, CC_VIP_DNS_VALIDATION_FAILURE, CC_VIP_DNS_REGISTER_SUCCESS, CC_VIP_DNS_DEREGISTER_SUCCESS, VS_HEALTH_CHANGE, SE_HEALTH_CHANGE, POOL_HEALTH_CHANGE, SERVER_HEALTH_CHANGE, VS_HEALTH_DEGRADED, SE_HEALTH_DEGRADED, POOL_HEALTH_DEGRADED, SERVER_HEALTH_DEGRADED, DUPLICATE_SUBNETS, SUMMARIZED_SUBNETS, IP_POOL_ALMOST_EXHAUSTED, IP_POOL_EXHAUSTED, LICENSE_LIMIT_SERVERS, LICENSE_LIMIT_SE_VCPUS, LICENSE_LIMIT_THROUGHPUT, LICENSE_LIMIT_VS, LICENSE_LIMIT_HOSTS, LICENSE_LIMIT_SE_SOCKETS, LICENSE_EXPIRED, APIC_BAD_CREDENTIALS, APIC_CREATE_LIFS, APIC_DELETE_LIFS, APIC_CREATE_LIF_CONTEXTS, APIC_DELETE_LIF_CONTEXTS, APIC_CREATE_CDEV, APIC_DELETE_CDEV, APIC_ATTACH_CIF_TO_LIF, APIC_DETACH_CIF_FROM_LIF, APIC_VS_PLACEMENT, APIC_BIND_VNIC_TO_NETWORK, APIC_CREATE_TENANT, APIC_DELETE_TENANT, APIC_CREATE_NETWORK, APIC_DELETE_NETWORK, APIC_NETWORK_VRF_CHANGED, APIC_VS_NETWORK_RESOLVE_ERROR, CONTAINER_CLOUD_ACCESS_SUCCESS, CONTAINER_CLOUD_ACCESS_FAILURE, CONTAINER_CLOUD_IMAGE_UPLOAD_FAILURE, CONTAINER_CLOUD_IMAGE_UPLOAD_SUCCESS, CONTAINER_CLOUD_IMAGE_UPLOAD_IN_PROGRESS, CONTAINER_CLOUD_CREATED_SE, CONTAINER_CLOUD_CREATE_SE_FAIL, CONTAINER_CLOUD_DELETED_SE, CONTAINER_CLOUD_DELETE_SE_FAIL, CONTAINER_CLOUD_STOPPED_SE, CONTAINER_CLOUD_STOP_SE_FAIL, CONTAINER_CLOUD_STARTED_SE, CONTAINER_CLOUD_START_SE_FAIL, CONTAINER_CLOUD_UPDATED_HOSTS, CONTAINER_CLOUD_SERVICE_SUCCESS, CONTAINER_CLOUD_SERVICE_FAILURE, AVG_UPTIME_CHANGE, DOS_ATTACK, SE_DOS_ATTACK, SERVER_AUTOSCALE_OUT, SERVER_AUTOSCALE_IN, SERVER_AUTOSCALE_OUT_COMPLETE, SERVER_AUTOSCALE_IN_COMPLETE, SERVER_AUTOSCALE_FAILED, SERVER_AUTOSCALE_IN_FAILED, SERVER_AUTOSCALE_OUT_FAILED, SE_GATEWAY_HEARTBEAT_FAILED, SE_GATEWAY_HEARTBEAT_SUCCESS, SE_VNIC_DOWN_EVENT, SE_VNIC_TX_QUEUE_STALL, POOL_AUTO_DEPLOYMENT_FAILED, POOL_AUTO_DEPLOYMENT_SUCCESS, GSLB_SITE_OPER_STATUS, GSLB_DNS_STATUS, GSLB_SITE_EXCEPTION_STATUS, GSLB_GS_STATUS, SCHEDULER_ACTION_SUCCESS, SCHEDULER_ACTION_FAILURE, GCP_ACCESS_SUCCESS, GCP_ACCESS_FAIL, GCP_SE_DETECTED, GCP_API_FAIL, GCP_SUBNET_NOT_FOUND, GCP_SUBNET_ATTACH_FAIL, GCP_ROUTE_ADD_SUCCESS, GCP_ROUTE_DELETE_SUCCESS, GCP_ROUTE_ADD_FAIL, GCP_ROUTE_DELETE_FAIL, VIP_DNS_REGISTER_SUCCESS, VIP_DNS_REGISTER_FAILURE, VIP_DNS_DEREGISTER_SUCCESS, VIP_DNS_DEREGISTER_FAILURE, SYNC_DNS_RECORDS_SUCCESS, SYNC_DNS_RECORDS_FAILURE, FLUSH_DNS_RECORDS_SUCCESS, FLUSH_DNS_RECORDS_FAILURE

cluster

Type
string
Category
optional
Description

sslkeyandcertificate

Type
string
Category
optional
Description

pool

Type
string
Category
optional
Description

API


    POST /api/vimgrvcenterruntime/vcenter/diag

CLI


    vcenterdiag cloud

Data

VcenterInventoryDiagReq

cloud_uuid

Type
string
Category
required
Description

References

Cloud Tenant VIMgrDCRuntime

Sub Objects

VINetworkSubnetVMs

API


    GET /api/vimgrvcenterruntime/<key>/networksubnetvms/<key>
	Query Params: VINetworkSubnetFilter

CLI


    show vinfra vcenter <key> networksubnetvms filter [network_name] [ip_subnet] [mask]

Data

VINetworkSubnetVMs

vms

Type
NetworkSubnetVM
Category
repeated
Description

NetworkSubnetVM

name

Type
string
Category
required
Description

ip_addr

Type
string
Category
required
Description

VIDatastoreContents

API


    GET /api/vimgrvcenterruntime/<key>/redis/<key>
	Query Params: VIRedisDatastoreFilter

CLI


    show vinfra vcenter <key> redis filter [table] [name]

Data

VIDatastoreContents

num_objects

Type
Unknown
Category
required
Description

vcenter_info

Type
VIMgrVcenterRuntime
Category
repeated
Description

dc_info

Type
VIMgrDCRuntime
Category
repeated
Description

host_info

Type
VIMgrHostRuntime
Category
repeated
Description

cluster_info

Type
VIMgrClusterRuntime
Category
repeated
Description

nw_info

Type
VIMgrNWRuntime
Category
repeated
Description

vm_info

Type
VIMgrVMRuntime
Category
repeated
Description

sevm_info

Type
VIMgrSEVMRuntime
Category
repeated
Description

VIMgrDCRuntime

type

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

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

cluster_refs

Type
Reference to VIMgrClusterRuntime
Category
repeated
Description

host_refs

Type
Reference to VIMgrHostRuntime
Category
repeated
Description

sevm_refs

Type
Reference to VIMgrSEVMRuntime
Category
repeated
Description

nw_refs

Type
Reference to VIMgrNWRuntime
Category
repeated
Description

vm_refs

Type
Reference to VIMgrVMRuntime
Category
repeated
Description

vcenter_uuid

Type
string
Category
optional
Description

interested_vms

Type
VIMgrInterestedEntity
Category
repeated
Description

interested_nws

Type
VIMgrInterestedEntity
Category
repeated
Description

interested_hosts

Type
VIMgrInterestedEntity
Category
repeated
Description

inventory_state

Type
int32
Category
optional
Description

pending_vcenter_reqs

Type
int32
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description
Default
/api/tenant?name=admin

cloud_ref

Type
Reference to Cloud
Category
optional
Description
Default
/api/cloud?name=Default-Cloud

VIMgrInterestedEntity

interested_uuid

Type
string
Category
required
Description

VIMgrHostRuntime

type

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

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

cluster_name

Type
string
Category
optional
Description

cluster_uuid

Type
string
Category
optional
Description

num_cpu_packages

Type
int32
Category
optional
Description

num_cpu_cores

Type
int32
Category
optional
Description

num_cpu_threads

Type
int32
Category
optional
Description

cpu_hz

Type
Unknown
Category
optional
Description

mem

Type
Unknown
Category
optional
Description

pnics

Type
CdpLldpInfo
Category
repeated
Description

vm_refs

Type
Reference to VIMgrVMRuntime
Category
repeated
Description

mgmt_portgroup

Type
string
Category
optional
Description
Default

powerstate

Type
string
Category
optional
Description

maintenance_mode

Type
bool
Category
optional
Description

connection_state

Type
string
Category
optional
Description
Default
connected

quarantined

Type
bool
Category
optional
Description

quarantine_start_ts

Type
string
Category
optional
Description

quarantined_periods

Type
int32
Category
optional
Description
Default
1

cntlr_accessible

Type
bool
Category
optional
Description
Default
True

network_uuids

Type
string
Category
repeated
Description

se_fail_cnt

Type
int32
Category
optional
Description

se_success_cnt

Type
int32
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description
Default
/api/tenant?name=admin

cloud_ref

Type
Reference to Cloud
Category
optional
Description
Default
/api/cloud?name=Default-Cloud

CdpLldpInfo

switch_info_type

Type
enum
Category
optional
Description
Choices
CDP, LLDP, NOT_APPLICABLE

device

Type
string
Category
optional
Description

chassis

Type
string
Category
optional
Description

port

Type
string
Category
optional
Description

mgmtaddr

Type
string
Category
optional
Description

system_name

Type
string
Category
optional
Description

VIMgrClusterRuntime

type

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

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

datacenter_managed_object_id

Type
string
Category
optional
Description

datacenter_uuid

Type
string
Category
optional
Description

host_refs

Type
Reference to VIMgrHostRuntime
Category
repeated
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description
Default
/api/tenant?name=admin

cloud_ref

Type
Reference to Cloud
Category
optional
Description
Default
/api/cloud?name=Default-Cloud

VIMgrNWRuntime

type

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

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

datacenter_uuid

Type
string
Category
optional
Description

vlan

Type
int32
Category
optional
Description

dvs

Type
bool
Category
optional
Description

switch_name

Type
string
Category
optional
Description

num_ports

Type
int32
Category
optional
Description

auto_expand

Type
bool
Category
optional
Description

vlan_range

Type
VlanRange
Category
repeated
Description

MgmtNW

Type
bool
Category
optional
Description

interested_nw

Type
bool
Category
optional
Description

ip_subnet

Type
VIMgrIPSubnetRuntime
Category
repeated
Description

vm_refs

Type
Reference to VIMgrVMRuntime
Category
repeated
Description

host_refs

Type
Reference to VIMgrHostRuntime
Category
repeated
Description

availability_zone

Type
string
Category
optional
Description

vrf_context_ref

Type
Reference to VrfContext
Category
optional
Description
Default
/api/vrfcontext?name=global

apic_vrf_context

Type
string
Category
optional
Description

tenant_name

Type
string
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description
Default
/api/tenant?name=admin

cloud_ref

Type
Reference to Cloud
Category
optional
Description
Default
/api/cloud?name=Default-Cloud

VlanRange

start

Type
int32
Category
required
Description

end

Type
int32
Category
required
Description

VIMgrIPSubnetRuntime

prefix

Type
IpAddrPrefix
Category
required
Description

ref_count

Type
int32
Category
optional
Description

ip_subnet

Type
string
Category
optional
Description

se_ref_count

Type
int32
Category
optional
Description
Default
0

name

Type
string
Category
optional
Description

uuid

Type
string
Category
optional
Description

fip_available

Type
bool
Category
optional
Description
Indicates floating/elastic IP association possibility
Default
False

fip_subnet_uuids

Type
string
Category
repeated
Description
If fip_available is True, this is list of supported FIP subnets, possibly empty if Cloud does not support such a network list

primary

Type
bool
Category
optional
Description
True if prefix is primary IP on interface, else false
Default
False

IpAddrPrefix

ip_addr

Type
IpAddr
Category
required
Description

mask

Type
int32
Category
required
Description

IpAddr

addr

Type
string
Category
required
Description
IP address

type

Type
enum
Category
required
Description
Choices
V4, DNS

VIMgrVMRuntime

type

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

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

host

Type
string
Category
optional
Description

powerstate

Type
string
Category
optional
Description

connection_state

Type
string
Category
optional
Description

vcenter_datacenter_uuid

Type
string
Category
optional
Description

vcenter_vm_type

Type
enum
Category
optional
Description
Choices
VMTYPE_SE_VM, VMTYPE_POOL_SRVR

vcenter_vnic_discovered

Type
bool
Category
optional
Description

vcenter_vAppName

Type
string
Category
optional
Description

vcenter_vAppVendor

Type
string
Category
optional
Description

vcenter_template_vm

Type
bool
Category
optional
Description

vcenter_se_type

Type
enum
Category
optional
Description
Choices
VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN

creation_in_progress

Type
bool
Category
optional
Description

vcenter_rm_cookie

Type
string
Category
optional
Description

num_cpu

Type
int32
Category
optional
Description

cpu_shares

Type
int32
Category
optional
Description

cpu_reservation

Type
Unknown
Category
optional
Description

memory

Type
Unknown
Category
optional
Description

mem_shares

Type
int32
Category
optional
Description

memory_reservation

Type
Unknown
Category
optional
Description

vm_lb_weight

Type
int32
Category
optional
Description

controller_ip_addr

Type
string
Category
optional
Description

guest_nic

Type
VIMgrGuestNicRuntime
Category
repeated
Description

controller_vm

Type
bool
Category
optional
Description

se_ver

Type
int32
Category
optional
Description
Default
1

init_vnics

Type
int32
Category
optional
Description

controller_cluster_uuid

Type
string
Category
optional
Description

availability_zone

Type
string
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description
Default
/api/tenant?name=admin

cloud_ref

Type
Reference to Cloud
Category
optional
Description
Default
/api/cloud?name=Default-Cloud

VIMgrGuestNicRuntime

type

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

guest_ip

Type
VIMgrIPSubnetRuntime
Category
repeated
Description

mac_addr

Type
string
Category
required
Description

network_uuid

Type
string
Category
optional
Description

del_pending

Type
bool
Category
optional
Description
Default
False

network_name

Type
string
Category
optional
Description

avi_internal_network

Type
bool
Category
optional
Description

mgmt_vnic

Type
bool
Category
optional
Description

connected

Type
bool
Category
optional
Description

label

Type
string
Category
optional
Description
Default
Unknown

os_port_uuid

Type
string
Category
optional
Description

VIMgrSEVMRuntime

type

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

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

host

Type
string
Category
optional
Description

powerstate

Type
string
Category
optional
Description

connection_state

Type
string
Category
optional
Description

vcenter_datacenter_uuid

Type
string
Category
optional
Description

vcenter_vm_type

Type
enum
Category
optional
Description
Choices
VMTYPE_SE_VM, VMTYPE_POOL_SRVR

vcenter_vAppName

Type
string
Category
optional
Description

vcenter_vAppVendor

Type
string
Category
optional
Description

vcenter_template_vm

Type
bool
Category
optional
Description

vcenter_se_type

Type
enum
Category
optional
Description
Choices
VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN

creation_in_progress

Type
bool
Category
optional
Description

vcenter_rm_cookie

Type
string
Category
optional
Description

controller_ip_addr

Type
string
Category
optional
Description

guest_nic

Type
VIMgrGuestNicRuntime
Category
repeated
Description

init_vnics

Type
int32
Category
optional
Description

cloud_name

Type
string
Category
optional
Description

flavor

Type
string
Category
optional
Description
Default

hypervisor

Type
enum
Category
optional
Description
Choices
DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN

security_group_uuid

Type
string
Category
optional
Description

server_group_uuid

Type
string
Category
optional
Description

segroup_uuid

Type
string
Category
optional
Description

last_discovery

Type
uint32
Category
optional
Description

discovery_status

Type
uint32
Category
optional
Description

discovery_response

Type
string
Category
optional
Description

deletion_in_progress

Type
bool
Category
optional
Description

hostid

Type
string
Category
optional
Description

controller_cluster_uuid

Type
string
Category
optional
Description

availability_zone

Type
string
Category
optional
Description

host_ref

Type
Reference to VIMgrHostRuntime
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description
Default
/api/tenant?name=admin

cloud_ref

Type
Reference to Cloud
Category
optional
Description
Default
/api/cloud?name=Default-Cloud

VIDatastore

API


    GET /api/vimgrvcenterruntime/<key>/datastores/<key>
	Query Params: VIDatastoreFilter

CLI


    show vinfra vcenter <key> datastores filter [datacenter] [vcenter_url]

Data

VIDatastore

datacenter

Type
string
Category
required
Description

datastores

Type
DatastoreInfo
Category
repeated
Description

DatastoreInfo

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

host_names

Type
string
Category
repeated
Description

VISubfolders

API


    GET /api/vimgrvcenterruntime/<key>/subfolders/<key>
	Query Params: VISubfolderFilter

CLI


    show vinfra vcenter <key> folders filter [vcenter_url] [datacenter] [folder]

Data

VISubfolders

datacenter

Type
string
Category
required
Description

folder

Type
string
Category
required
Description

subfolders

Type
SubfolderInfo
Category
repeated
Description

SubfolderInfo

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

VIHostResources

API


    GET /api/vimgrvcenterruntime/<key>/hostresources/<key>
	Query Params: VIHostResourceFilter

CLI


    show vinfra vcenter <key> hostresources filter [datacenter]

Data

VIHostResources

hosts

Type
HostResourceInfo
Category
repeated
Description

HostResourceInfo

name

Type
string
Category
required
Description

managed_object_id

Type
string
Category
required
Description

host_scale

Type
int32
Category
optional
Description

num_ses

Type
int32
Category
optional
Description

se_fail_cnt

Type
int32
Category
optional
Description

se_success_cnt

Type
Unknown
Category
optional
Description

Filters

VINetworkSubnetFilter

network_name

Type
string
Category
required
Description

ip_subnet

Type
string
Category
required
Description

mask

Type
int32
Category
required
Description

VIRedisDatastoreFilter

table

Type
enum
Category
required
Description
Choices
VIMGRVCENTER, VIMGRDC, VIMGRHOST, VIMGRCLUSTER, VIMGRNW, VIMGRSEVM, VIMGRVM

name

Type
string
Category
optional
Description

VIDatastoreFilter

datacenter

Type
string
Category
required
Description

vcenter_url

Type
string
Category
required
Description

VISubfolderFilter

vcenter_url

Type
string
Category
required
Description

datacenter

Type
string
Category
required
Description

folder

Type
string
Category
required
Description

VIHostResourceFilter

datacenter

Type
string
Category
required
Description