Cloud


    POST /api/cloud
    PUT /api/cloud/<key>
    DELETE /api/cloud/<key>
    GET /api/cloud
    GET /api/cloud/<key>


    configure cloud <key>
    show cloud <key>

Cloud

uuid

Type: string
Category: required
Description

name

Type: string
Category: required
Description

vtype

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

vcenter_configuration

Type: vCenterConfiguration
Category: optional
Description

openstack_configuration

Type: OpenStackConfiguration
Category: optional
Description

aws_configuration

Type: AwsConfiguration
Category: optional
Description

apic_mode

Type: bool
Category: optional
Description
Default: False

apic_configuration

Type: APICConfiguration
Category: optional
Description

cloudstack_configuration

Type: CloudStackConfiguration
Category: optional
Description

vca_configuration

Type: vCloudAirConfiguration
Category: optional
Description

mesos_configuration

Type: MesosConfiguration
Category: optional
Description

proxy_configuration

Type: ProxyConfiguration
Category: optional
Description

linuxserver_configuration

Type: LinuxServerConfiguration
Category: optional
Description

docker_configuration

Type: DockerConfiguration
Category: optional
Description

rancher_configuration

Type: RancherConfiguration
Category: optional
Description

oshiftk8s_configuration

Type: OShiftK8SConfiguration
Category: optional
Description

dhcp_enabled

Type: bool
Category: optional
Description: Select the IP address management scheme
Default: False

mtu

Type: uint32
Category: optional
Description: MTU setting for the cloud
Default: 1500

prefer_static_routes

Type: bool
Category: optional
Description: Prefer static routes over interface routes during VirtualService placement.
Default: False

enable_vip_static_routes

Type: bool
Category: optional
Description: Use static routes for VIP side network resolution during VirtualService placement.
Default: False

obj_name_prefix

Type: string
Category: optional
Description: Default prefix for all automatically created objects in this cloud. This prefix can be overridden by the SE-Group template.

license_type

Type: enum
Category: optional
Description: If no license type is specified then default license enforcement for the cloud type is chosen. The default mappings are Container Cloud is Max Ses, OpenStack and VMware is cores and linux it is Sockets.
Choices: LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS

ipam_provider_ref

Type: Reference to IpamDnsProviderProfile
Category: optional
Description: Ipam Profile for the cloud.

dns_provider_ref

Type: Reference to IpamDnsProviderProfile
Category: optional
Description: DNS Profile for the cloud.

east_west_ipam_provider_ref

Type: Reference to IpamDnsProviderProfile
Category: optional
Description: Ipam Profile for East-West services. Warning - Please use virtual subnets in this IPAM profile that do not conflict with the underlay networks or any overlay networks in the cluster. For example in AWS and GCP, 169.254.0.0/16 is used for storing instance metadata. Hence, it should not be used in this profile.

east_west_dns_provider_ref

Type: Reference to IpamDnsProviderProfile
Category: optional
Description: DNS Profile for East-West services.

nsx_configuration

Type: NsxConfiguration
Category: optional
Description: Configuration parameters for NSX Manager

tenant_ref

Type: Reference to Tenant
Category: required
Description

vCenterConfiguration

username

Type: string
Category: optional
Description: The username Avi Vantage will use when authenticating with vCenter.

password

Type: string
Category: optional
Description: The password Avi Vantage will use when authenticating with vCenter.

vcenter_url

Type: string
Category: optional
Description: vCenter hostname or IP address.

privilege

Type: enum
Category: required
Description: Set the access mode to vCenter as either Read, which allows Avi to discover networks and servers, or Write, which also allows Avi to create Service Engines and configure their network properties.
Default: WRITE_ACCESS
Choices: NO_ACCESS, READ_ACCESS, WRITE_ACCESS

datacenter

Type: string
Category: optional
Description: Datacenter for virtual infrastructure discovery

management_network

Type: string
Category: optional
Description: Management network to use for Avi Service Engines

management_ip_subnet

Type: IpAddrPrefix
Category: optional
Description: Management subnet to use for Avi Service Engines

vcenter_template_se_location

Type: string
Category: optional
Description: Avi Service Engine Template in vCenter to be used for creating Service Engines

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

OpenStackConfiguration

username

Type: string
Category: required
Description: The username Avi Vantage will use when authenticating to Keystone. For Keystone v3, provide the user information in user@domain format, unless that user belongs to the Default domain.

password

Type: string
Category: optional
Description: The password Avi Vantage will use when authenticating to Keystone.

admin_tenant

Type: string
Category: required
Description: OpenStack admin tenant (or project) information. For Keystone v3, provide the project information in project@domain format. Domain need not be specified if the project belongs to the 'Default' domain.

keystone_host

Type: string
Category: optional
Description: Keystone's hostname or IP address. (Deprecated) Use auth_url instead.

mgmt_network_name

Type: string
Category: required
Description: Avi Management network name or cidr

privilege

Type: enum
Category: required
Description: Access privilege
Choices: NO_ACCESS, READ_ACCESS, WRITE_ACCESS

use_keystone_auth

Type: bool
Category: optional
Description: Use keystone for user authentication
Default: True

prov_name

Type: string
Category: repeated
Description: LBaaS provider name

mgmt_network_uuid

Type: string
Category: optional
Description: Management network UUID

region

Type: string
Category: optional
Description: Region name

hypervisor

Type: enum
Category: optional
Description: Default hypervisor type
Default: KVM
Choices: DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN

tenant_se

Type: bool
Category: optional
Description: If true, then SEs will be created in the appropriate tenants, else SEs will be created in the admin_tenant.
Default: True

import_keystone_tenants

Type: bool
Category: optional
Description: Import keystone tenants list into Avi
Default: True

anti_affinity

Type: bool
Category: optional
Description: If true, an anti-affinity policy will be applied to all SEs of a SE-Group, else no such policy will be applied.
Default: True

port_security

Type: bool
Category: optional
Description: If true, port-security extension (if detected) will be used instead of security-groups, allowed-address-pairs or interface-secondary-ips. If false, port-security extension is skipped
Default: False

security_groups

Type: bool
Category: optional
Description: If false, security-groups extension will not be used.
Default: True

allowed_address_pairs

Type: bool
Category: optional
Description: If false, allowed-address-pairs extension will not be used.
Default: True

free_floatingips

Type: bool
Category: optional
Description: Free unused floating IPs.
Default: False

img_format

Type: enum
Category: optional
Description: If OS_IMG_FMT_RAW, use RAW images else use QCOW2 or streamOptimized/flat VMDK as appropriate.
Default: OS_IMG_FMT_AUTO
Choices: OS_IMG_FMT_AUTO, OS_IMG_FMT_QCOW2, OS_IMG_FMT_VMDK, OS_IMG_FMT_RAW, OS_IMG_FMT_FLAT

use_admin_url

Type: bool
Category: optional
Description: If admin URLs are either inaccessible or not to be accessed from Avi Controller, then set this to False.
Default: True

role_mapping

Type: OpenStackRoleMapping
Category: repeated
Description: Defines the mapping from OpenStack role names to avi local role names. For an OpenStack role, this mapping is consulted only if there is no local Avi role with the same name as the OpenStack role. This is an ordered list and only the first matching entry is used. You can use '*' to match all OpenStack role names.

use_internal_endpoints

Type: bool
Category: optional
Description: Use internalURL for OpenStack endpoints instead of the default publicURL endpoints.
Default: False

admin_tenant_uuid

Type: string
Category: optional
Description: admin-tenant's UUID in OpenStack

config_drive

Type: bool
Category: optional
Description: If false, metadata service will be used instead of config-drive functionality to retrieve SE VM metadata.
Default: True

auth_url

Type: string
Category: optional
Description: Auth URL for connecting to keystone. If this is specified, any value provided for keystone_host is ignored.

insecure

Type: bool
Category: optional
Description: Allow self-signed certificates when communicating with https service endpoints.
Default: True

intf_sec_ips

Type: bool
Category: optional
Description: If True, interface-secondary-ips method will be used for VIP association.
Default: False

external_networks

Type: bool
Category: optional
Description: If True, allow selection of networks marked as 'external' for management, vip or data networks.
Default: False

neutron_rbac

Type: bool
Category: optional
Description: If True, enable neutron rbac discovery of networks shared across tenants/projects
Default: True

map_admin_to_cloudadmin

Type: bool
Category: optional
Description: If True, map Avi 'admin' tenant to the admin_tenant of the Cloud. Else map Avi 'admin' to OpenStack 'admin' tenant.
Default: False

usable_network_uuids

Type: string
Category: repeated
Description: A tenant can normally use its own networks and any networks shared with it. In addition, this field provides extra networks that are usable by all tenants. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation.

nuage_vsd_host

Type: string
Category: optional
Description: Nuage VSD host name or IP address

nuage_port

Type: uint32
Category: optional
Description
Default: 8443

nuage_username

Type: string
Category: optional
Description

nuage_password

Type: string
Category: optional
Description

nuage_organization

Type: string
Category: optional
Description

se_group_uuid

Type: string
Category: optional
Description: The Service Engine Group to use as template.

contrail_plugin

Type: bool
Category: optional
Description: Enable Contrail plugin mode. (deprecated)
Default: False

contrail_endpoint

Type: string
Category: optional
Description: Contrail VNC endpoint url (example http://10.10.10.100:8082). By default, 'http://' scheme and 8082 port will be used if not provided in the url

name_owner

Type: bool
Category: optional
Description: If True, embed owner info in VIP port 'name', else embed owner info in 'device_id' field
Default: True

OpenStackRoleMapping

os_role

Type: string
Category: required
Description: Role name in OpenStack

avi_role

Type: string
Category: required
Description: Role name in Avi

AwsConfiguration

access_key_id

Type: string
Category: optional
Description: AWS access key ID

secret_access_key

Type: string
Category: optional
Description: AWS secret access key

region

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

vpc

Type: string
Category: optional
Description: VPC name

vpc_id

Type: string
Category: required
Description: VPC ID

zones

Type: AwsZoneConfig
Category: repeated
Description

route53_integration

Type: bool
Category: optional
Description: If enabled, create/update DNS entries in Amazon Route 53 zones
Default: False

free_elasticips

Type: bool
Category: optional
Description: Free unused elastic IP addresses.
Default: True

use_iam_roles

Type: bool
Category: optional
Description: Use IAM roles instead of access and secret key.
Default: False

iam_assume_role

Type: string
Category: optional
Description: IAM assume role for cross-account access.

AwsZoneConfig

availability_zone

Type: string
Category: required
Description: Availability zone

mgmt_network_name

Type: string
Category: required
Description: Name or CIDR of the network in the Availability Zone that will be used as management network.

mgmt_network_uuid

Type: string
Category: optional
Description: UUID of the network in the Availability Zone that will be used as management network.

APICConfiguration

apic_name

Type: string
Category: repeated
Description: The hostname or IP address of the APIC controller.

apic_username

Type: string
Category: optional
Description: The username Avi Vantage will use when authenticating with APIC.

apic_password

Type: string
Category: optional
Description: The password Avi Vantage will use when authenticating with APIC.

apic_admin_tenant

Type: string
Category: optional
Description: Name of the Avi specific tenant created within APIC.
Default: common

apic_vendor

Type: string
Category: optional
Description
Default: Avi

apic_product

Type: string
Category: optional
Description
Default: ASP

deployment

Type: string
Category: optional
Description
Default

apic_domain

Type: string
Category: optional
Description: vCenter's virtual machine manager domain within APIC.

avi_controller_username

Type: string
Category: optional
Description: The username APIC will use when authenticating with Avi Vantage.
Default: admin

avi_controller_password

Type: string
Category: optional
Description: The password APIC will use when authenticating with Avi Vantage.

version

Type: string
Category: optional
Description: AVI Device Package Version
Default: 1.0

minor

Type: string
Category: optional
Description: AVI Device Package Minor Version
Default: 2

context_aware

Type: enum
Category: optional
Description: Context aware for supporting Service Graphs across VRFs
Default: SINGLE_CONTEXT
Choices: SINGLE_CONTEXT, MULTI_CONTEXT

managed_mode

Type: bool
Category: optional
Description: Use Managed Mode for APIC Service Insertion
Default: True

CloudStackConfiguration

api_url

Type: string
Category: required
Description: CloudStack API URL

access_key_id

Type: string
Category: required
Description: CloudStack API Key

secret_access_key

Type: string
Category: required
Description: CloudStack Secret Key

mgmt_network_name

Type: string
Category: required
Description: Avi Management network name

mgmt_network_uuid

Type: string
Category: optional
Description: Avi Management network name

cntr_public_ip

Type: string
Category: optional
Description: If controller's management IP is in a private network, a publicly accessible IP to reach the controller.

hypervisor

Type: enum
Category: optional
Description: Default hypervisor type
Default: KVM
Choices: DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN

vCloudAirConfiguration

vca_username

Type: string
Category: required
Description: vCloudAir username

vca_password

Type: string
Category: required
Description: vCloudAir password

vca_host

Type: string
Category: required
Description: vCloudAir host address

privilege

Type: enum
Category: required
Description: vCloudAir access mode
Default: WRITE_ACCESS
Choices: NO_ACCESS, READ_ACCESS, WRITE_ACCESS

vca_instance

Type: string
Category: required
Description: vCloudAir instance ID

vca_orgnization

Type: string
Category: required
Description: vCloudAir orgnization ID

vca_vdc

Type: string
Category: required
Description: vCloudAir virtual data center name

vca_mgmt_network

Type: string
Category: required
Description: vCloudAir management network

MesosConfiguration

marathon_configurations

Type: MarathonConfiguration
Category: repeated
Description: List of Marathon frameworks.

mesos_url

Type: string
Category: optional
Description: Mesos URL of the form http://host:port
Default: http://leader.mesos:5050

vip

Type: IpAddr
Category: optional
Description: VIP to be used by all East-West apps on all Hosts. Preferrably use an address from outside the subnet

use_bridge_ip_as_vip

Type: bool
Category: optional
Description: Use Bridge IP on each Host as VIP
Default: False

container_port_match_http_service

Type: bool
Category: optional
Description: Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService
Default: True

http_container_ports

Type: uint32
Category: repeated
Description: List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80

east_west_placement_subnet

Type: IpAddrPrefix
Category: optional
Description: Match against this prefix when placing east-west VSs on SEs (Mesos mode only)

se_deployment_method

Type: enum
Category: optional
Description: Use Fleet/SSH for deploying Service Engines
Default: MESOS_SE_CREATE_FLEET
Choices: MESOS_SE_CREATE_FLEET, MESOS_SE_CREATE_SSH, MESOS_SE_CREATE_MARATHON

use_controller_image

Type: bool
Category: optional
Description: If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se
Default: False

marathon_se_deployment

Type: MarathonSeDeployment
Category: optional
Description: Options for Marathon SE deployment

fleet_endpoint

Type: string
Category: optional
Description: Optional fleet remote endpoint if fleet is used for SE deployment

docker_registry_se

Type: DockerRegistry
Category: optional
Description: Docker registry for ServiceEngine image

se_spawn_rate

Type: uint32
Category: optional
Description: New SE spawn rate per minute
Default: 25

app_sync_frequency

Type: uint32
Category: optional
Description: Sync frequency in seconds with frameworks
Default: 60

disable_auto_se_creation

Type: bool
Category: optional
Description: Disable SE creation
Default: False

disable_auto_frontend_service_sync

Type: bool
Category: optional
Description: Disable auto service sync for front end services
Default: False

disable_auto_backend_service_sync

Type: bool
Category: optional
Description: Disable auto service sync for back end services
Default: False

use_container_ip_port

Type: bool
Category: optional
Description: Use container IP address:port for pool instead of host IP address:hostport. This mode is applicable if the container IP is reachable (not a private NATed IP) from other hosts in a routed environment for containers
Default: False

feproxy_route_publish

Type: FeProxyRoutePublishConfig
Category: optional
Description: Publish ECMP route to upstream router for VIP

feproxy_bridge_name

Type: string
Category: optional
Description: Name of second Linux bridge on Host providing connectivity for Front End proxies. This is a disruptive change
Default: cbr1

se_resources

Type: MesosSeResources
Category: repeated
Description: Obsolete - ignored

se_volume

Type: string
Category: optional
Description: Host volume to be used as a disk for Avi SE, This is a disruptive change
Default: /opt/avi/se

coredump_directory

Type: string
Category: optional
Description: Directory to mount to check for core dumps on Service Engines. This will be mapped read only to /var/crash on any new Service Engines. This is a disruptive change
Default: /var/lib/systemd/coredump

ssh_se_deployment

Type: SSHSeDeployment
Category: optional
Description: Parameters for SSH SE deployment

enable_event_subscription

Type: bool
Category: optional
Description: Enable Marathon event subscriptions
Default: True

nuage_controller

Type: NuageSDNController
Category: optional
Description: Nuage Overlay SDN Controller information

all_vses_are_feproxy

Type: bool
Category: optional
Description: Consider all Virtualservices as Front End Proxies. Front End proxies are placed on specific SEs as opposed to Back End proxies placed on all SEs. Applicable where each service has its own VIP and VIP is reachable from anywhere
Default: False

feproxy_container_port_as_service

Type: bool
Category: optional
Description: For Front End proxies, use container port as service port
Default: True

services_accessible_all_interfaces

Type: bool
Category: optional
Description: Make service ports accessible on all Host interfaces in addition to East-West VIP and/or bridge IP. Usually enabled AWS Mesos clusters to export East-West services on Host interface
Default: False

feproxy_vips_enable_proxy_arp

Type: bool
Category: optional
Description: Enable proxy ARP from Host interface for Front End proxies
Default: True

se_exclude_attributes

Type: MesosAttribute
Category: repeated
Description: Exclude hosts with attributes for SE creation

se_include_attributes

Type: MesosAttribute
Category: repeated
Description: Create SEs just on hosts with include attributes

ssh_user_ref

Type: Reference to CloudConnectorUser
Category: optional
Description: Cloud connector user uuid for SSH to hosts

node_availability_zone_label

Type: string
Category: optional
Description: Mesos Node label to be used as Mesos Node's availability zone in a dual availability zone deployment. ServiceEngines belonging to the availability zone will be rebooted during a manual DR failover

disable_auto_gs_sync

Type: bool
Category: optional
Description: Disable auto sync for GSLB services
Default: False

use_vips_for_east_west_services

Type: bool
Category: optional
Description: Use unique virtual IP address for every east west service in Mesos/Marathon. 'use_bridge_ip_as_vip' and 'vip' fields , if set, will not be used if this field is set.
Default: True

MarathonConfiguration

marathon_url

Type: string
Category: optional
Description: Marathon API URL of the form http://host:port
Default: http://leader.mesos:8080

marathon_username

Type: string
Category: optional
Description: Username for Marathon authentication

marathon_password

Type: string
Category: optional
Description: Password for Marathon authentication

public_port_range

Type: PortRange
Category: optional
Description: Public port range allocated to this Marathon framework instance

private_port_range

Type: PortRange
Category: optional
Description: Private port range allocated to this Marathon framework instance

framework_tag

Type: string
Category: optional
Description: Framework tag to be used in Virtualservice name. Default is framework name from Mesos. If this tag is altered atruntime, Virtualservices will be deleted and re-created

vs_name_tag_framework

Type: bool
Category: optional
Description: Tag VS name with framework name or framework_tag. Useful in deployments with multiple frameworks
Default: False

use_token_auth

Type: bool
Category: optional
Description: Use Token based authentication instead of basic authentication. Token is refreshed every 5 minutes.
Default: False

tenant

Type: string
Category: optional
Description: Tenant to pin this Marathon instance to. If set, a tenant object will be created in Avi bearing this name and all applications created in this marathon will be associated with this tenant regardless of, if any, tenant configuration in marathon label for this application.
Default: admin

PortRange

start

Type: uint32
Category: required
Description: TCP/UDP port range start (inclusive).

end

Type: uint32
Category: required
Description: TCP/UDP port range end (inclusive).

MarathonSeDeployment

host_os

Type: string
Category: optional
Description: Host OS distribution e.g. COREOS, UBUNTU, REDHAT
Default: COREOS

docker_image

Type: string
Category: optional
Description: Docker image to be used for Avi SE installation e.g. fedora, ubuntu
Default: fedora

uris

Type: string
Category: repeated
Description: URIs to be resolved for starting the application

resource_roles

Type: string
Category: repeated
Description: Accepted resource roles for SEs

DockerRegistry

registry

Type: string
Category: optional
Description: Avi ServiceEngine repository name. For private registry, it's registry:port/repository, for public registry, it's registry/repository, for openshift registry, it's registry:port//
Default: avinetworks/se

private

Type: bool
Category: optional
Description: Set if docker registry is private. Avi controller will not attempt to push SE image to the registry, unless se_repository_push is set
Default: False

username

Type: string
Category: optional
Description: Username for docker registry. Authorized 'regular user' if registry is Openshift integrated registry.

password

Type: string
Category: optional
Description: Password for docker registry. Authorized 'regular user' password if registry is Openshift integrated registry.

se_repository_push

Type: bool
Category: optional
Description: Avi Controller will push ServiceEngine image to docker repository
Default: False

oshift_registry

Type: OshiftDockerRegistryMetaData
Category: optional
Description: Openshift integrated registry config.

OshiftDockerRegistryMetaData

registry_service

Type: string
Category: optional
Description: Name of the Integrated registry Service in Openshift.
Default: docker-registry

registry_namespace

Type: string
Category: optional
Description: Namespace for the ServiceEngine image to be hosted in Openshift Integrated registry.
Default: default

registry_vip

Type: IpAddr
Category: optional
Description: Static VIP for 'docker-registry' service in Openshift if Avi is proxying for this service.This VIP should be outside the cluster IP subnet in Kubernetes and within the subnet configured (but outside the available pool of IPs) in the East West IPAM profile configuration for this Cloud. For example, if kubernetes cluster VIP range is 172.30.0.0/16 and subnet configured in East West IPAM profile is 172.50.0.0/16, then 172.50.0.2 can be used for this vip and IP pool can start from 172.50.0.3 onwards. Use this static VIP in '--insecure-registry :5000' docker config if using an insecure registry or add this to the list of IPs/hostnames when generating certificates if using a secure TLS registry.

FeProxyRoutePublishConfig

mode

Type: enum
Category: optional
Description: Publish ECMP route to upstream router for VIP
Default: FE_PROXY_ROUTE_PUBLISH_NONE
Choices: FE_PROXY_ROUTE_PUBLISH_NONE, FE_PROXY_ROUTE_PUBLISH_QUAGGA_WEBAPP

token

Type: string
Category: optional
Description: Token for tracking changes

subnet

Type: uint32
Category: optional
Description: Subnet for publisher
Default: 32

publisher_port

Type: uint32
Category: optional
Description: Listener port for publisher
Default: 80

MesosSeResources

attribute_key

Type: string
Category: required
Description: Attribute (Fleet or Mesos) key of Hosts

attribute_value

Type: string
Category: required
Description: Attribute (Fleet or Mesos) value of Hosts

cpu

Type: float
Category: optional
Description: Obsolete - ignored
Default: 2.0

memory

Type: uint32
Category: optional
Description: Obsolete - ignored
Default: 4096

SSHSeDeployment

ssh_user

Type: string
Category: optional
Description: Username for SSH access to hosts

sudo_user

Type: string
Category: optional
Description: Username for sudo

password

Type: string
Category: optional
Description: Password for ssh and/or sudo

host_os

Type: string
Category: optional
Description: Host OS distribution e.g. COREOS, UBUNTU, REDHAT
Default: COREOS

NuageSDNController

nuage_vsd_host

Type: string
Category: optional
Description: Nuage VSD host name or IP address

nuage_port

Type: uint32
Category: optional
Description
Default: 8443

nuage_username

Type: string
Category: optional
Description

nuage_password

Type: string
Category: optional
Description

nuage_organization

Type: string
Category: optional
Description

se_domain

Type: string
Category: optional
Description: Domain to be used for SE creation

se_zone

Type: string
Category: optional
Description: Zone to be used for SE creation

se_network

Type: string
Category: optional
Description: Network to be used for SE creation

se_enterprise

Type: string
Category: optional
Description: Enterprise to be used for SE creation

se_user

Type: string
Category: optional
Description: User to be used for SE creation

se_policy_group

Type: string
Category: optional
Description: Policy Group to be used for SE creation

MesosAttribute

attribute

Type: string
Category: required
Description: Attribute to match

value

Type: string
Category: optional
Description: Attribute value. If not set, match any value

ProxyConfiguration

host

Type: string
Category: required
Description: Proxy hostname or IP address

port

Type: uint32
Category: required
Description: Proxy port

username

Type: string
Category: optional
Description: Username for proxy

password

Type: string
Category: optional
Description: Password for proxy

LinuxServerConfiguration

ssh_attr

Type: SSHSeDeployment
Category: optional
Description: Parameters for SSH to hosts

docker_registry_se

Type: DockerRegistry
Category: optional
Description: Private docker registry for SE image storage

hosts

Type: LinuxServerHost
Category: repeated
Description

se_sys_disk_path

Type: string
Category: optional
Description: SE System Logs disk path for cloud

se_sys_disk_size_GB

Type: uint32
Category: optional
Description: SE System Logs disk size for cloud
Default: 10

se_log_disk_path

Type: string
Category: optional
Description: SE Client Logs disk path for cloud

se_log_disk_size_GB

Type: uint32
Category: optional
Description: SE Client Log disk size for cloud
Default: 5

se_inband_mgmt

Type: bool
Category: optional
Description: Flag to notify the SE's in this cloud have an inband management interface, this can be overridden at SE host level by setting host_attr attr_key as SE_INBAND_MGMT with value of true or false
Default: False

ssh_user_ref

Type: Reference to CloudConnectorUser
Category: optional
Description: Cloud connector user uuid for SSH to hosts

LinuxServerHost

host_ip

Type: IpAddr
Category: required
Description

host_attr

Type: HostAttributes
Category: repeated
Description

node_availability_zone

Type: string
Category: optional
Description: Node's availability zone. ServiceEngines belonging to the availability zone will be rebooted during a manual DR failover

HostAttributes

attr_key

Type: string
Category: required
Description

attr_val

Type: string
Category: optional
Description

DockerConfiguration

ucp_nodes

Type: string
Category: repeated
Description: List of Docker UCP nodes; In case of a load balanced UCP cluster, use Virtual IP of the cluster

client_tls_key_and_certificate_ref

Type: Reference to SSLKeyAndCertificate
Category: optional
Description: UUID of the client TLS cert and key

ca_tls_key_and_certificate_ref

Type: Reference to SSLKeyAndCertificate
Category: optional
Description: UUID of the UCP CA TLS cert and key

container_port_match_http_service

Type: bool
Category: optional
Description: Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService
Default: True

http_container_ports

Type: uint32
Category: repeated
Description: List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80

east_west_placement_subnet

Type: IpAddrPrefix
Category: optional
Description: Match against this prefix when placing east-west VSs on SEs

se_deployment_method

Type: enum
Category: optional
Description: Use Fleet/SSH for SE deployment
Default: SE_CREATE_SSH
Choices: SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD

fleet_endpoint

Type: string
Category: optional
Description: Optional fleet remote endpoint if fleet is used for SE deployment

docker_registry_se

Type: DockerRegistry
Category: optional
Description: Docker registry for ServiceEngine image

se_spawn_rate

Type: uint32
Category: optional
Description: New SE spawn rate per minute
Default: 25

app_sync_frequency

Type: uint32
Category: optional
Description: Sync frequency in seconds with frameworks
Default: 60

disable_auto_se_creation

Type: bool
Category: optional
Description: Disable SE creation
Default: False

disable_auto_frontend_service_sync

Type: bool
Category: optional
Description: Disable auto service sync for front end services
Default: False

disable_auto_backend_service_sync

Type: bool
Category: optional
Description: Disable auto service sync for back end services
Default: False

use_container_ip_port

Type: bool
Category: optional
Description: Use container IP address:port for pool instead of host IP address:hostport. This mode is applicable if the container IP is reachable (not a private NATed IP) from other hosts in a routed environment for containers
Default: False

se_volume

Type: string
Category: optional
Description: Host volume to be used as a disk for Avi SE, This is a disruptive change
Default: /opt/avi

coredump_directory

Type: string
Category: optional
Description: Directory to mount to check for core dumps on Service Engines. This will be mapped read only to /var/crash on any new Service Engines. This is a disruptive change
Default: /var/lib/systemd/coredump

ssh_se_deployment

Type: SSHSeDeployment
Category: optional
Description: Parameters for SSH SE deployment

enable_event_subscription

Type: bool
Category: optional
Description: Enable Docker event subscription
Default: True

feproxy_container_port_as_service

Type: bool
Category: optional
Description: For Front End proxies, use container port as service port
Default: False

services_accessible_all_interfaces

Type: bool
Category: optional
Description: Make service ports accessible on all Host interfaces in addition to East-West VIP and/or bridge IP. Usually enabled AWS clusters to export East-West services on Host interface
Default: False

feproxy_vips_enable_proxy_arp

Type: bool
Category: optional
Description: Enable proxy ARP from Host interface for Front End proxies
Default: True

se_exclude_attributes

Type: MesosAttribute
Category: repeated
Description: Exclude hosts with attributes for SE creation

se_include_attributes

Type: MesosAttribute
Category: repeated
Description: Create SEs just on hosts with include attributes

use_controller_image

Type: bool
Category: optional
Description: If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se
Default: False

ssh_user_ref

Type: Reference to CloudConnectorUser
Category: optional
Description: Cloud connector user uuid for SSH to hosts

RancherConfiguration

rancher_servers

Type: string
Category: repeated
Description: List of Rancher servers; In case of a load balanced Rancher multi cluster, use Virtual IP of the cluster

access_key

Type: string
Category: optional
Description: Access key

secret_key

Type: string
Category: optional
Description: Secret key

container_port_match_http_service

Type: bool
Category: optional
Description: Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService
Default: True

http_container_ports

Type: uint32
Category: repeated
Description: List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80

east_west_placement_subnet

Type: IpAddrPrefix
Category: optional
Description: Match against this prefix when placing east-west VSs on SEs

se_deployment_method

Type: enum
Category: optional
Description: Use Fleet/SSH for SE deployment
Default: SE_CREATE_SSH
Choices: SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD

fleet_endpoint

Type: string
Category: optional
Description: Optional fleet remote endpoint if fleet is used for SE deployment

docker_registry_se

Type: DockerRegistry
Category: optional
Description: Docker registry for ServiceEngine image

se_spawn_rate

Type: uint32
Category: optional
Description: New SE spawn rate per minute
Default: 25

app_sync_frequency

Type: uint32
Category: optional
Description: Sync frequency in seconds with frameworks
Default: 60

disable_auto_se_creation

Type: bool
Category: optional
Description: Disable SE creation
Default: False

disable_auto_frontend_service_sync

Type: bool
Category: optional
Description: Disable auto service sync for front end services
Default: False

disable_auto_backend_service_sync

Type: bool
Category: optional
Description: Disable auto service sync for back end services
Default: False

use_container_ip_port

Type: bool
Category: optional
Description: Use container IP address:port for pool instead of host IP address:hostport. This mode is applicable if the container IP is reachable (not a private NATed IP) from other hosts in a routed environment for containers
Default: False

se_volume

Type: string
Category: optional
Description: Host volume to be used as a disk for Avi SE, This is a disruptive change
Default: /opt/avi

coredump_directory

Type: string
Category: optional
Description: Directory to mount to check for core dumps on Service Engines. This will be mapped read only to /var/crash on any new Service Engines. This is a disruptive change
Default: /var/lib/systemd/coredump

ssh_se_deployment

Type: SSHSeDeployment
Category: optional
Description: Parameters for SSH SE deployment

enable_event_subscription

Type: bool
Category: optional
Description: Enable Docker event subscription
Default: True

feproxy_container_port_as_service

Type: bool
Category: optional
Description: For Front End proxies, use container port as service port
Default: False

services_accessible_all_interfaces

Type: bool
Category: optional
Description: Make service ports accessible on all Host interfaces in addition to East-West VIP and/or bridge IP. Usually enabled AWS clusters to export East-West services on Host interface
Default: False

feproxy_vips_enable_proxy_arp

Type: bool
Category: optional
Description: Enable proxy ARP from Host interface for Front End proxies
Default: True

se_exclude_attributes

Type: MesosAttribute
Category: repeated
Description: Exclude hosts with attributes for SE creation

se_include_attributes

Type: MesosAttribute
Category: repeated
Description: Create SEs just on hosts with include attributes

nuage_controller

Type: NuageSDNController
Category: optional
Description: Nuage Overlay SDN Controller information

use_controller_image

Type: bool
Category: optional
Description: If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se
Default: False

ssh_user_ref

Type: Reference to CloudConnectorUser
Category: optional
Description: Cloud connector user uuid for SSH to hosts

OShiftK8SConfiguration

master_nodes

Type: string
Category: repeated
Description: List of OpenShift/Kubernetes master nodes; In case of a load balanced OpenShift/K8S cluster, use Virtual IP of the cluster. Each node is of the form node:8443 or http://node:8080. If scheme is not provided, https is assumed

client_tls_key_and_certificate_ref

Type: Reference to SSLKeyAndCertificate
Category: optional
Description: UUID of the client TLS cert and key instead of service account token. One of client certificate or token is required

ca_tls_key_and_certificate_ref

Type: Reference to SSLKeyAndCertificate
Category: optional
Description: UUID of the UCP CA TLS cert and key

avi_bridge_subnet

Type: IpAddrPrefix
Category: optional
Description: Avi Linux bridge subnet on OpenShift/K8s nodes

container_port_match_http_service

Type: bool
Category: optional
Description: Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService
Default: True

http_container_ports

Type: uint32
Category: repeated
Description: List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80

east_west_placement_subnet

Type: IpAddrPrefix
Category: optional
Description: Match against this prefix when placing east-west VSs on SEs

se_deployment_method

Type: enum
Category: optional
Description: Use SSH/Pod for SE deployment
Default: SE_CREATE_SSH
Choices: SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD

fleet_endpoint

Type: string
Category: optional
Description: Optional fleet remote endpoint if fleet is used for SE deployment

docker_registry_se

Type: DockerRegistry
Category: optional
Description: Docker registry for ServiceEngine image

se_spawn_rate

Type: uint32
Category: optional
Description: New SE spawn rate per minute
Default: 25

app_sync_frequency

Type: uint32
Category: optional
Description: Sync frequency in seconds with frameworks
Default: 60

disable_auto_se_creation

Type: bool
Category: optional
Description: Disable SE creation
Default: False

disable_auto_frontend_service_sync

Type: bool
Category: optional
Description: Disable auto service sync for front end services
Default: False

disable_auto_backend_service_sync

Type: bool
Category: optional
Description: Disable auto service sync for back end services
Default: False

se_volume

Type: string
Category: optional
Description: Host volume to be used as a disk for Avi SE, This is a disruptive change
Default: /opt/avi

coredump_directory

Type: string
Category: optional
Description: Directory to mount to check for core dumps on Service Engines. This will be mapped read only to /var/crash on any new Service Engines. This is a disruptive change
Default: /var/lib/systemd/coredump

ssh_se_deployment

Type: SSHSeDeployment
Category: optional
Description: Parameters for SSH SE deployment

enable_event_subscription

Type: bool
Category: optional
Description: Enable Kubernetes event subscription
Default: True

feproxy_vips_enable_proxy_arp

Type: bool
Category: optional
Description: Enable proxy ARP from Host interface for Front End proxies
Default: True

se_exclude_attributes

Type: MesosAttribute
Category: repeated
Description: Exclude hosts with attributes for SE creation

se_include_attributes

Type: MesosAttribute
Category: repeated
Description: Create SEs just on hosts with include attributes

nuage_controller

Type: NuageSDNController
Category: optional
Description: Nuage Overlay SDN Controller information

use_service_cluster_ip_as_ew_vip

Type: bool
Category: optional
Description: Use Cluster IP of service as VIP for East-West services; This option requires that kube proxy is disabled on all nodes
Default: False

default_service_as_east_west_service

Type: bool
Category: optional
Description: If there is no explicit east_west_placement field in virtualservice configuration, treat service as a East-West service; default services such a OpenShift API server do not have virtualservice configuration
Default: True

sdn_overlay

Type: bool
Category: optional
Description: Cluster uses overlay based SDN. Enable this flag if cluster uses a overlay based SDN for OpenShift, Flannel, Weave, Nuage. Disable for routed mode
Default: True

use_controller_image

Type: bool
Category: optional
Description: If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se
Default: False

service_account_token

Type: string
Category: optional
Description: Authorization token for service account instead of client certificate. One of client certificate or token is required

use_scheduling_disabled_nodes

Type: bool
Category: optional
Description: Enable VirtualService placement on Service Engines on nodes with scheduling disabled. When false, Service Engines are disabled on nodes where scheduling is disabled
Default: False

l4_health_monitoring

Type: bool
Category: optional
Description: Perform Layer4 (TCP/UDP) health monitoring even for Layer7 (HTTP) Pools
Default: False

ssh_user_ref

Type: Reference to CloudConnectorUser
Category: optional
Description: Cloud connector user uuid for SSH to hosts

routes_share_virtualservice

Type: bool
Category: optional
Description: Routes use shared virtualservices. If configured, all OpenShift Routes will be created under a parent VirtualService. OpenShift Services will not trigger a VirtualService creation
Default: False

default_shared_virtualservice

Type: OshiftSharedVirtualService
Category: optional
Description: Default shared virtualservice that acts as the parent for all OpenShift Routes

node_availability_zone_label

Type: string
Category: optional
Description: OpenShift/K8S Node label to be used as OpenShift/K8S Node's availability zone in a dual availability zone deployment. ServiceEngines belonging to the availability zone will be rebooted during a manual DR failover

secure_egress_mode

Type: bool
Category: optional
Description: Allow Avi Vantage to create Security Context Constraints and Service Accounts which allow Egress Pods to run in privileged mode in an Openshift environment. Assumption is that credentials provided have cluster-admin role when this mode is enabled.
Default: False

OshiftSharedVirtualService

virtualservice_name

Type: string
Category: optional
Description: Name of shared virtualservice. VirtualService will be created automatically by Cloud Connector

NsxConfiguration

nsx_manager_name

Type: string
Category: optional
Description: The hostname or IP address of the NSX MGr.

nsx_manager_username

Type: string
Category: optional
Description: The username Avi Vantage will use when authenticating with NSX Mgr.

nsx_manager_password

Type: string
Category: optional
Description: The password Avi Vantage will use when authenticating with NSX Mgr.

avi_nsx_prefix

Type: string
Category: optional
Description: This prefix will be added to the names of all NSX objects created by Avi Controller. It should be unique across all the Avi Controller clusters

nsx_poll_time

Type: uint32
Category: optional
Description: The interval (in secs) with which Avi Controller polls the NSX Manager for updates
Default: 300


    POST /api/cloud-internals


    GET /api/cloud/<key>/status/<key>


    show cloud <key> status

CloudStatus

cc_id

Type: string
Category: optional
Description: Cloud Id

state

Type: enum
Category: optional
Description: Cloud State
Choices: CLOUD_STATE_UNKNOWN, CLOUD_STATE_IN_PROGRESS, CLOUD_STATE_FAILED, CLOUD_STATE_PLACEMENT_READY, CLOUD_STATE_DELETING, CLOUD_STATE_NOT_CONNECTED

reason

Type: string
Category: optional
Description: Reason message for the current state


    GET /api/cloud/<key>/autoscalegroupservers/<key>


    show cloud <key> autoscalegroupservers

cc_autoscale_servers_info_rsp

ret_status

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

ret_string

Type: string
Category: optional
Description

servers

Type: Server
Category: repeated
Description

Server

Type: IpAddr
Category: required
Description: IP Address of the server. Required if there is no resolvable host name.

port

Type: int32
Category: optional
Description: Optionally specify the servers port number. This will override the pool's default server port attribute.

hostname

Type: string
Category: optional
Description: DNS resolvable name of the server. May be used in place of the IP address.

enabled

Type: bool
Category: optional
Description: Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed.
Default: True

ratio

Type: int32
Category: optional
Description: Ratio of selecting eligible servers in the pool
Default: 1

vm_ref

Type: Reference to VIMgrVMRuntime
Category: optional
Description: (internal-use) This field is used internally by Avi, not editable by the user.

nw_ref

Type: Reference to VIMgrNWRuntime
Category: optional
Description: (internal-use) This field is used internally by Avi, not editable by the user.

discovered_network_ref

Type: Reference to Network
Category: repeated
Description: (internal-use) Discovered network for this server. This field is deprecated.

external_uuid

Type: string
Category: optional
Description: UUID identifying VM in OpenStack and other external compute

discovered_subnet

Type: IpAddrPrefix
Category: repeated
Description: (internal-use) Discovered subnet for this server. This field is deprecated.

verify_network

Type: bool
Category: optional
Description: Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network
Default: False

discovered_networks

Type: DiscoveredNetwork
Category: repeated
Description: (internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user.

resolve_server_by_dns

Type: bool
Category: optional
Description: Auto resolve server's IP using DNS name
Default: False

prst_hdr_val

Type: string
Category: optional
Description: Header value for custom header persistence.

mac_address

Type: string
Category: optional
Description: MAC address of server.

static

Type: bool
Category: optional
Description: If statically learned.
Default: False

server_node

Type: string
Category: optional
Description: Hostname of the node where the server VM or container resides

availability_zone

Type: string
Category: optional
Description: Availability-zone of the server VM.

rewrite_host_header

Type: bool
Category: optional
Description: Rewrite incoming Host Header to server name.
Default: False

external_orchestration_id

Type: string
Category: optional
Description: UID of server in external orchestration systems

description

Type: string
Category: optional
Description: A description of the Server.

location

Type: GeoLocation
Category: optional,readonly
Description: (internal-use) Geographic location of the server.Currently only for internal usage.

autoscaling_group_name

Type: string
Category: optional,readonly
Description: Name of autoscaling group this server belongs to.

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.

GeoLocation

latitude

Type: float
Category: optional
Description: Latitude of the location.

longitude

Type: float
Category: optional
Description: Longitude of the location.

name

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

tag

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


    GET /api/cloud/<key>/internals/<key>


    show cloud <key> internals

cc_internals_rsp

ret_status

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

ret_string

Type: string
Category: optional
Description

node_uuid

Type: string
Category: required
Description

mtu

Type: uint32
Category: optional
Description

num_rsp_unexp

Type: uint32
Category: optional
Description
Default: 0

num_rsp_miss

Type: uint32
Category: optional
Description
Default: 0

notifiers

Type: CC_Notifier
Category: repeated
Description

agents

Type: CC_AgentInternal
Category: repeated
Description

service_pid

Type: string
Category: required
Description

worker_pid

Type: string
Category: required
Description

reactor_main_pid

Type: string
Category: optional
Description

reactor_work_pids

Type: string
Category: repeated
Description

num_txq_full

Type: uint32
Category: optional
Description
Default: 0

num_rxq_tmo

Type: uint32
Category: optional
Description
Default: 0

num_rxq_full

Type: uint32
Category: optional
Description
Default: 0

up_time

Type: string
Category: optional
Description

CC_Notifier

table

Type: string
Category: required
Description

agents

Type: string
Category: repeated
Description

CC_AgentInternal

cc_id

Type: string
Category: required
Description

cc_type

Type: string
Category: optional
Description

cc_name

Type: string
Category: optional
Description

ret_status

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

ret_string

Type: string
Category: optional
Description

cc_status

Type: enum
Category: optional
Description
Choices: CLOUD_STATE_UNKNOWN, CLOUD_STATE_IN_PROGRESS, CLOUD_STATE_FAILED, CLOUD_STATE_PLACEMENT_READY, CLOUD_STATE_DELETING, CLOUD_STATE_NOT_CONNECTED

cc_state

Type: enum
Category: optional
Description
Choices: CC_STATE_UNKNOWN, CC_STATE_DECONFIG_IN_PROGRESS, CC_STATE_CONFIG_IN_PROGRESS, CC_STATE_INIT_IN_PROGRESS, CC_STATE_IMAGE_IN_PROGRESS, CC_STATE_INIT_COMPLETE, CC_STATE_IMAGE_COMPLETE, CC_STATE_IMAGE_FAILED, CC_STATE_HEALTH_OK, CC_STATE_CONFIG_FAILED, CC_STATE_INIT_FAILED, CC_STATE_HEALTH_FAILED, CC_STATE_PLACEMENT_READY

format

Type: CC_Format
Category: optional
Description

mtu

Type: uint32
Category: optional
Description

prefer_avi_rt

Type: bool
Category: optional
Description

init

Type: CC_Init
Category: optional
Description

images

Type: CC_Image
Category: repeated
Description

discovery

Type: CC_Discovery
Category: optional
Description

ports

Type: CC_Ports
Category: optional
Description

health

Type: CC_Health
Category: optional
Description

proxy

Type: ProxyConfiguration
Category: optional
Description

proxy_provider

Type: string
Category: optional
Description

cc_flags

Type: CC_AgentFlags
Category: optional
Description

config_genid

Type: string
Category: optional
Description

cc_threadid

Type: string
Category: required
Description

bgworkers

Type: CC_BGWorker
Category: repeated
Description

async

Type: CC_Async
Category: optional
Description

ipencap

Type: uint32
Category: optional
Description

up_time

Type: string
Category: optional
Description

version

Type: string
Category: optional
Description

openstack

Type: CC_OpenStack
Category: optional
Description

aws

Type: CC_AWS
Category: optional
Description

cloudstack

Type: CC_CloudStack
Category: optional
Description

vcloudair

Type: CC_VCloudAir
Category: optional
Description

mesos

Type: CC_Mesos
Category: optional
Description

linuxserver

Type: CC_LinuxServer
Category: optional
Description

docker

Type: CC_Docker
Category: optional
Description

rancher

Type: CC_Rancher
Category: optional
Description

oshift_k8s

Type: CC_OShiftK8S
Category: optional
Description

CC_Format

se_name_pfx

Type: string
Category: optional
Description

secgrp_pfx

Type: string
Category: optional
Description

img_pfx

Type: string
Category: optional
Description

secgrp_name

Type: string
Category: optional
Description

img_name

Type: string
Category: optional
Description

CC_Init

inited

Type: bool
Category: required
Description

configured

Type: bool
Category: optional
Description

l3_configured

Type: bool
Category: optional
Description

cluster_configured

Type: bool
Category: optional
Description

privilege

Type: string
Category: optional
Description

ctlr_vm_uuid

Type: string
Category: optional
Description

has_ctlr

Type: bool
Category: optional
Description

is_leader

Type: bool
Category: optional
Description

mgmt_ip

Type: string
Category: optional
Description

cluster_vip

Type: string
Category: optional
Description

cluster_ips

Type: string
Category: optional
Description

cluster_uuid

Type: string
Category: optional
Description

cluster_master

Type: string
Category: optional
Description

cluster_vip_port

Type: string
Category: optional
Description

cluster_vip_err

Type: string
Category: optional
Description

eth_ip

Type: string
Category: optional
Description

cluster_nodes

Type: string
Category: optional
Description

mgmt_node

Type: string
Category: optional
Description

CC_Image

Type: string
Category: optional
Description

hypervisor

Type: string
Category: optional
Description

tenant_uuid

Type: string
Category: optional
Description

name

Type: string
Category: optional
Description

err_msg

Type: string
Category: optional
Description

shares

Type: CC_RefCnt
Category: repeated
Description

file_name

Type: string
Category: optional
Description

file_size

Type: uint64
Category: optional
Description

file_ctime

Type: string
Category: optional
Description

file_mtime

Type: string
Category: optional
Description

CC_RefCnt

tenant_id

Type: string
Category: optional
Description

ref_cnt

Type: int32
Category: required
Description

CC_Discovery

poll

Type: CC_Cron
Category: optional
Description

ran_discovery

Type: bool
Category: optional
Description

tracked_tenants

Type: CC_Tenant
Category: repeated
Description

discovery_tenants

Type: CC_Tenant
Category: repeated
Description

failed_tenants

Type: CC_Tenant
Category: repeated
Description

CC_Cron

last

Type: string
Category: optional
Description

next

Type: string
Category: optional
Description

interval

Type: uint32
Category: optional
Description

average

Type: uint32
Category: optional
Description

last_ok

Type: string
Category: optional
Description

last_fail

Type: string
Category: optional
Description

last_fail_msg

Type: string
Category: optional
Description

CC_Tenant

name

Type: string
Category: required
Description

auuid

Type: string
Category: optional
Description

cuuid

Type: string
Category: optional
Description

role_id

Type: string
Category: optional
Description

role

Type: string
Category: optional
Description

tenant_se

Type: bool
Category: optional
Description

msg

Type: string
Category: optional
Description

CC_Ports

http_port

Type: uint32
Category: optional
Description

https_port

Type: uint32
Category: optional
Description

sysint_port

Type: uint32
Category: optional
Description

cntrl_ssh_port

Type: uint32
Category: optional
Description

CC_Health

last_ok

Type: string
Category: optional
Description

first_fail

Type: string
Category: optional
Description

last_fail

Type: string
Category: optional
Description

num_fails

Type: uint32
Category: optional
Description
Default: 0

last_fails

Type: uint32
Category: optional
Description
Default: 0

services

Type: CC_Service_Health
Category: repeated
Description

CC_Service_Health

name

Type: string
Category: required
Description

status

Type: string
Category: optional
Description

CC_AgentFlags

proxy_reinit

Type: bool
Category: optional
Description

upgrade_mode

Type: bool
Category: optional
Description

system_prov_mode

Type: bool
Category: optional
Description

task_abort

Type: bool
Category: optional
Description

task_breakout

Type: bool
Category: optional
Description

reconfig

Type: bool
Category: optional
Description

CC_BGWorker

thread_id

Type: string
Category: required
Description

task_queue_size

Type: uint32
Category: optional
Description

stop_req

Type: bool
Category: optional
Description

alive

Type: bool
Category: optional
Description

tasks

Type: CC_BGTask
Category: repeated
Description

CC_BGTask

task_id

Type: string
Category: required
Description

admin_state

Type: string
Category: required
Description

oper_state

Type: string
Category: required
Description

abort

Type: bool
Category: required
Description

added

Type: bool
Category: required
Description

bgworker

Type: string
Category: optional
Description

prempt

Type: bool
Category: optional
Description

poll_timer

Type: string
Category: optional
Description

poll_timer_id

Type: string
Category: optional
Description

CC_Async

tasks

Type: CC_AsyncTask
Category: repeated
Description

CC_AsyncTask

task_id

Type: string
Category: required
Description

function

Type: string
Category: required
Description

opaque_id

Type: string
Category: optional
Description

state

Type: string
Category: required
Description

thread_id

Type: string
Category: optional
Description

CC_OpenStack

cfg

Type: OpenStackConfiguration
Category: optional
Description

glance_url

Type: string
Category: optional
Description

auth_url

Type: string
Category: optional
Description

mgmt_nw

Type: CC_MgmtNw
Category: optional
Description

park_intfs

Type: CC_ParkIntf
Category: repeated
Description

access_err

Type: string
Category: optional
Description

mgmt_nw_err

Type: string
Category: optional
Description

tenant_access_err

Type: string
Category: optional
Description

admin_access

Type: bool
Category: optional
Description

os_tenant_id

Type: string
Category: optional
Description

os_user_id

Type: string
Category: optional
Description

os_role_id

Type: string
Category: optional
Description

os_role

Type: string
Category: optional
Description

create_vip_port

Type: bool
Category: optional
Description

disk_sz

Type: int32
Category: optional
Description

patch_state

Type: int32
Category: optional
Description

aapair_ext

Type: bool
Category: optional
Description

secgrp_ext

Type: bool
Category: optional
Description

portsec_ext

Type: bool
Category: optional
Description

svrgrp_ext

Type: bool
Category: optional
Description

schint_ext

Type: bool
Category: optional
Description

cfgdrv_ext

Type: bool
Category: optional
Description

metasvc_ext

Type: bool
Category: optional
Description

rbac_nw_ext

Type: bool
Category: optional
Description

nuage

Type: bool
Category: optional
Description

contrail

Type: bool
Category: optional
Description

nvp

Type: bool
Category: optional
Description

opflex

Type: bool
Category: optional
Description

ovs

Type: bool
Category: optional
Description

nsxv

Type: bool
Category: optional
Description

use_aapair_ext

Type: bool
Category: optional
Description

use_secgrp_ext

Type: bool
Category: optional
Description

use_portsec_ext

Type: bool
Category: optional
Description

use_anti_affinity

Type: bool
Category: optional
Description

use_svrgrp_ext

Type: bool
Category: optional
Description

use_schint_ext

Type: bool
Category: optional
Description

aapair_max

Type: int32
Category: optional
Description

use_intf_secips

Type: bool
Category: optional
Description

use_cfgdrv

Type: bool
Category: optional
Description

use_metasvc

Type: bool
Category: optional
Description

use_nuage

Type: bool
Category: optional
Description

use_contrail

Type: bool
Category: optional
Description

use_nvp

Type: bool
Category: optional
Description

use_nsxv

Type: bool
Category: optional
Description

ksmgmturl_state

Type: uint32
Category: optional
Description

gc_avi

Type: CC_Cron
Category: optional
Description

gc_cc

Type: CC_Cron
Category: optional
Description

use_extnet

Type: bool
Category: optional
Description

use_rbac_nw

Type: bool
Category: optional
Description

use_nameowner

Type: bool
Category: optional
Description

disc_cfgdrv

Type: bool
Category: optional
Description

disc_metasvc

Type: bool
Category: optional
Description

disc_aasg

Type: bool
Category: optional
Description

CC_MgmtNw

Type: string
Category: optional
Description

mgmt_nw_id

Type: string
Category: optional
Description

CC_ParkIntf

network_id

Type: string
Category: optional
Description

subnet_id

Type: string
Category: required
Description

intf_id

Type: string
Category: required
Description

intf_ip

Type: string
Category: optional
Description

other_ips

Type: string
Category: repeated
Description

tenant_id

Type: string
Category: optional
Description

message

Type: string
Category: optional
Description

CC_AWS

cfg

Type: AwsConfiguration
Category: optional
Description

vpc_id

Type: string
Category: optional
Description

mgmt_nws

Type: CC_MgmtNw
Category: repeated
Description

park_intfs

Type: CC_ParkIntf
Category: repeated
Description

vpc_cidr

Type: string
Category: optional
Description

mgmt_nw_err

Type: string
Category: optional
Description

access_err

Type: string
Category: optional
Description

iam_role

Type: string
Category: optional
Description

route53_err

Type: string
Category: optional
Description

iam_user

Type: string
Category: optional
Description

account_id

Type: string
Category: optional
Description

account_alias

Type: string
Category: optional
Description

stoken_expiry

Type: string
Category: optional
Description

htoken_expiry

Type: string
Category: optional
Description

asgconn_err

Type: string
Category: optional
Description

gc_cc

Type: CC_Cron
Category: optional
Description

CC_CloudStack

cfg

Type: CloudStackConfiguration
Category: optional
Description

mgmt_nw_err

Type: string
Category: optional
Description

access_err

Type: string
Category: optional
Description

version

Type: string
Category: optional
Description

CC_VCloudAir

cfg

Type: vCloudAirConfiguration
Category: optional
Description

mgmt_nw_err

Type: string
Category: optional
Description

access_err

Type: string
Category: optional
Description

CC_Mesos

cfg

Type: MesosConfiguration
Category: optional
Description

access_err

Type: string
Category: optional
Description

hosts

Type: CC_Host
Category: repeated
Description

sshinfo

Type: CC_SshInfo
Category: optional
Description

ipam_info

Type: CC_IpamInfo
Category: optional
Description

CC_Host

host

Type: string
Category: required
Description

state

Type: enum
Category: required
Description
Choices: CC_HOST_STATE_UNKNOWN, CC_HOST_IMAGE_IN_PROGRESS, CC_HOST_IMAGE_COMPLETE, CC_HOST_IMAGE_FAILED, CC_HOST_START_IN_PROGRESS, CC_HOST_START_FAILED, CC_HOST_SSH_FAILED, CC_HOST_SSH_OK, CC_HOST_STARTED, CC_HOST_STOP_IN_PROGRESS, CC_HOST_STOP_FAILED, CC_HOST_STOPPED, CC_HOST_ENABLED, CC_HOST_DISABLED, CC_HOST_UNUSED, CC_HOST_READY

reason

Type: string
Category: optional
Description

ssh_state

Type: enum
Category: required
Description
Choices: CC_HOST_STATE_UNKNOWN, CC_HOST_IMAGE_IN_PROGRESS, CC_HOST_IMAGE_COMPLETE, CC_HOST_IMAGE_FAILED, CC_HOST_START_IN_PROGRESS, CC_HOST_START_FAILED, CC_HOST_SSH_FAILED, CC_HOST_SSH_OK, CC_HOST_STARTED, CC_HOST_STOP_IN_PROGRESS, CC_HOST_STOP_FAILED, CC_HOST_STOPPED, CC_HOST_ENABLED, CC_HOST_DISABLED, CC_HOST_UNUSED, CC_HOST_READY

ssh_reason

Type: string
Category: optional
Description

host_ip

Type: string
Category: optional
Description

ssh_last_ts

Type: string
Category: optional
Description

CC_SshInfo

key_file

Type: string
Category: optional
Description

user_uuid

Type: string
Category: optional
Description

user_key

Type: string
Category: optional
Description

user_pwd

Type: string
Category: optional
Description

user_name

Type: string
Category: optional
Description

CC_IpamInfo

mode

Type: string
Category: optional
Description

ready

Type: bool
Category: optional
Description

err_msg

Type: string
Category: optional
Description

ipam_uuid

Type: string
Category: optional
Description

vpc_id

Type: string
Category: optional
Description

park_intfs

Type: CC_ParkIntf
Category: repeated
Description

os_subnet_id

Type: string
Category: optional
Description

os_subnet_cidr

Type: string
Category: optional
Description

os_tenant_id

Type: string
Category: optional
Description

CC_LinuxServer

cfg

Type: LinuxServerConfiguration
Category: optional
Description

access_err

Type: string
Category: optional
Description

inited_hosts

Type: string
Category: repeated
Description

uninited_hosts

Type: string
Category: repeated
Description

version_tag

Type: string
Category: optional
Description

hosts

Type: CC_Host
Category: repeated
Description

ipam_info

Type: CC_IpamInfo
Category: optional
Description

sshinfo

Type: CC_SshInfo
Category: optional
Description

CC_Docker

cfg

Type: DockerConfiguration
Category: optional
Description

access_err

Type: string
Category: optional
Description

hosts

Type: CC_Host
Category: repeated
Description

sshinfo

Type: CC_SshInfo
Category: optional
Description

ipam_info

Type: CC_IpamInfo
Category: optional
Description

CC_Rancher

cfg

Type: RancherConfiguration
Category: optional
Description

access_err

Type: string
Category: optional
Description

hosts

Type: CC_Host
Category: repeated
Description

sshinfo

Type: CC_SshInfo
Category: optional
Description

ipam_info

Type: CC_IpamInfo
Category: optional
Description

CC_OShiftK8S

cfg

Type: OShiftK8SConfiguration
Category: optional
Description

access_err

Type: string
Category: optional
Description

hosts

Type: CC_Host
Category: repeated
Description

sshinfo

Type: CC_SshInfo
Category: optional
Description

ipam_info

Type: CC_IpamInfo
Category: optional
Description


    GET /api/cloud/<key>/autoscalegroup/<key>


    show cloud <key> autoscalegroup

cc_autoscale_group_info_rsp

ret_status

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

ret_string

Type: string
Category: optional
Description

group_info

Type: cc_autoscale_group_info
Category: repeated
Description

cc_autoscale_group_info

group_name

Type: string
Category: optional
Description

group_uuid

Type: string
Category: optional
Description

default_size

Type: uint32
Category: optional
Description

min_size

Type: uint32
Category: optional
Description

max_size

Type: uint32
Category: optional
Description

zones

Type: string
Category: repeated
Description

servers

Type: Server
Category: repeated
Description


    GET /api/cloud/<key>/hosts/<key>


    show cloud <key> hosts


    PUT /api/cloud/<key>/gc/<key>


    exec cloud <key> gc

cc_rsp

ret_status

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

ret_string

Type: string
Category: optional
Description


    GET /api/cloud/<key>/health/<key>


    show cloud <key> health

Cloud

Description

API

CLI

Data

Cloud

vCenterConfiguration

IpAddrPrefix

IpAddr

OpenStackConfiguration

OpenStackRoleMapping

AwsConfiguration

AwsZoneConfig

APICConfiguration

CloudStackConfiguration

vCloudAirConfiguration

MesosConfiguration

MarathonConfiguration

PortRange

MarathonSeDeployment

DockerRegistry

OshiftDockerRegistryMetaData

FeProxyRoutePublishConfig

MesosSeResources

SSHSeDeployment

NuageSDNController

MesosAttribute

ProxyConfiguration

LinuxServerConfiguration

LinuxServerHost

HostAttributes

DockerConfiguration

RancherConfiguration

OShiftK8SConfiguration

OshiftSharedVirtualService

NsxConfiguration

Actions

API

CLI

References

Sub Objects

CloudStatus

API

CLI

Data

CloudStatus

cc_autoscale_servers_info_rsp

API

CLI

Data

cc_autoscale_servers_info_rsp

Server

DiscoveredNetwork

GeoLocation

cc_internals_rsp

API

CLI

Data

cc_internals_rsp

CC_Notifier

CC_AgentInternal

CC_Format

CC_Init

CC_Image

CC_RefCnt

CC_Discovery

CC_Cron

CC_Tenant

CC_Ports

CC_Health

CC_Service_Health

CC_AgentFlags

CC_BGWorker

CC_BGTask

CC_Async

CC_AsyncTask

CC_OpenStack

CC_MgmtNw

CC_ParkIntf

CC_AWS