Avi Cloud Object API

##CLI## ``` - configure cloud - show cloud - show cloud internals ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /cloud
  2. post /cloud/list
  3. post /cloud
  4. get /cloud/{uuid}/autoscalegroup/
  5. get /cloud/{uuid}/autoscalegroupservers/
  6. delete /cloud/{uuid}
  7. patch /cloud/{uuid}/gc/
  8. put /cloud/{uuid}/gc/
  9. get /cloud/{uuid}
  10. get /cloud/{uuid}/health/
  11. get /cloud/{uuid}/hosts/
  12. get /cloud/{uuid}/internals/
  13. patch /cloud/{uuid}
  14. put /cloud/{uuid}
  15. get /cloud/{uuid}/status/
Up
get /cloud
(cloudGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

CloudApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "vtype" : "aeiou",
    "apic_configuration" : {
      "apic_admin_tenant" : "aeiou",
      "apic_vendor" : "aeiou",
      "avi_controller_username" : "aeiou",
      "minor" : "aeiou",
      "context_aware" : "aeiou",
      "apic_domain" : "aeiou",
      "apic_product" : "aeiou",
      "managed_mode" : true,
      "apic_username" : "aeiou",
      "version" : "aeiou",
      "apic_password" : "aeiou",
      "avi_controller_password" : "aeiou",
      "apic_name" : [ "aeiou" ],
      "deployment" : "aeiou"
    },
    "ipam_provider_ref" : "aeiou",
    "state_based_dns_registration" : true,
    "aws_configuration" : {
      "access_key_id" : "aeiou",
      "use_sns_sqs" : true,
      "iam_assume_role" : "aeiou",
      "wildcard_access" : true,
      "vpc_id" : "aeiou",
      "ebs_encryption" : {
        "mode" : "aeiou",
        "master_key" : "aeiou"
      },
      "secret_access_key" : "aeiou",
      "vpc" : "aeiou",
      "zones" : [ {
        "availability_zone" : "aeiou",
        "mgmt_network_name" : "aeiou",
        "mgmt_network_uuid" : "aeiou"
      } ],
      "ttl" : 123,
      "asg_poll_interval" : 123,
      "route53_integration" : true,
      "s3_encryption" : "",
      "use_iam_roles" : true,
      "region" : "aeiou",
      "free_elasticips" : true
    },
    "east_west_ipam_provider_ref" : "aeiou",
    "uuid" : "aeiou",
    "mesos_configuration" : {
      "feproxy_container_port_as_service" : true,
      "disable_auto_backend_service_sync" : true,
      "se_volume" : "aeiou",
      "node_availability_zone_label" : "aeiou",
      "http_container_ports" : [ "" ],
      "se_spawn_rate" : 123,
      "marathon_se_deployment" : {
        "uris" : [ "aeiou" ],
        "host_os" : "aeiou",
        "resource_roles" : [ "aeiou" ],
        "docker_image" : "aeiou"
      },
      "nuage_controller" : {
        "se_zone" : "aeiou",
        "nuage_username" : "aeiou",
        "nuage_password" : "aeiou",
        "nuage_organization" : "aeiou",
        "nuage_port" : 123,
        "se_domain" : "aeiou",
        "se_enterprise" : "aeiou",
        "se_policy_group" : "aeiou",
        "nuage_vsd_host" : "aeiou",
        "se_network" : "aeiou",
        "se_user" : "aeiou"
      },
      "feproxy_bridge_name" : "aeiou",
      "fleet_endpoint" : "aeiou",
      "all_vses_are_feproxy" : true,
      "ssh_user_ref" : "aeiou",
      "use_controller_image" : true,
      "use_container_ip_port" : true,
      "container_port_match_http_service" : true,
      "disable_auto_gs_sync" : true,
      "vip" : "",
      "disable_auto_se_creation" : true,
      "se_include_attributes" : [ "" ],
      "feproxy_route_publish" : {
        "mode" : "aeiou",
        "subnet" : 123,
        "publisher_port" : 123,
        "token" : "aeiou"
      },
      "se_deployment_method" : "aeiou",
      "services_accessible_all_interfaces" : true,
      "disable_auto_frontend_service_sync" : true,
      "use_vips_for_east_west_services" : true,
      "use_bridge_ip_as_vip" : true,
      "app_sync_frequency" : 123,
      "feproxy_vips_enable_proxy_arp" : true,
      "ssh_se_deployment" : "",
      "enable_event_subscription" : true,
      "marathon_configurations" : [ {
        "vs_name_tag_framework" : true,
        "marathon_url" : "aeiou",
        "public_port_range" : "",
        "marathon_username" : "aeiou",
        "use_token_auth" : true,
        "private_port_range" : {
          "start" : 123,
          "end" : 123
        },
        "framework_tag" : "aeiou",
        "marathon_password" : "aeiou",
        "tenant" : "aeiou"
      } ],
      "se_resources" : [ {
        "memory" : 123,
        "attribute_key" : "aeiou",
        "cpu" : 1.3579000000000001069366817318950779736042022705078125,
        "attribute_value" : "aeiou"
      } ],
      "coredump_directory" : "aeiou",
      "docker_registry_se" : "",
      "se_exclude_attributes" : [ "" ],
      "east_west_placement_subnet" : "",
      "mesos_url" : "aeiou"
    },
    "docker_configuration" : {
      "feproxy_container_port_as_service" : true,
      "disable_auto_backend_service_sync" : true,
      "se_volume" : "aeiou",
      "http_container_ports" : [ "" ],
      "se_spawn_rate" : 123,
      "ca_tls_key_and_certificate_ref" : "aeiou",
      "fleet_endpoint" : "aeiou",
      "client_tls_key_and_certificate_ref" : "aeiou",
      "ssh_user_ref" : "aeiou",
      "use_controller_image" : true,
      "use_container_ip_port" : true,
      "container_port_match_http_service" : true,
      "disable_auto_se_creation" : true,
      "se_include_attributes" : [ "" ],
      "se_deployment_method" : "aeiou",
      "services_accessible_all_interfaces" : true,
      "disable_auto_frontend_service_sync" : true,
      "ucp_nodes" : [ "aeiou" ],
      "app_sync_frequency" : 123,
      "feproxy_vips_enable_proxy_arp" : true,
      "ssh_se_deployment" : {
        "password" : "aeiou",
        "host_os" : "aeiou",
        "ssh_user" : "aeiou",
        "sudo_user" : "aeiou"
      },
      "enable_event_subscription" : true,
      "coredump_directory" : "aeiou",
      "docker_registry_se" : {
        "registry" : "aeiou",
        "password" : "aeiou",
        "private" : true,
        "oshift_registry" : {
          "registry_vip" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "registry_namespace" : "aeiou",
          "registry_service" : "aeiou"
        },
        "se_repository_push" : true,
        "username" : "aeiou"
      },
      "se_exclude_attributes" : [ {
        "attribute" : "aeiou",
        "value" : "aeiou"
      } ],
      "east_west_placement_subnet" : {
        "ip_addr" : "",
        "mask" : 123
      }
    },
    "vca_configuration" : {
      "vca_password" : "aeiou",
      "vca_instance" : "aeiou",
      "vca_orgnization" : "aeiou",
      "vca_username" : "aeiou",
      "vca_mgmt_network" : "aeiou",
      "vca_host" : "aeiou",
      "vca_vdc" : "aeiou",
      "privilege" : "aeiou"
    },
    "nsx_configuration" : {
      "nsx_manager_username" : "aeiou",
      "nsx_manager_name" : "aeiou",
      "avi_nsx_prefix" : "aeiou",
      "nsx_manager_password" : "aeiou",
      "nsx_poll_time" : 123
    },
    "dns_provider_ref" : "aeiou",
    "oshiftk8s_configuration" : {
      "l4_health_monitoring" : true,
      "disable_auto_backend_service_sync" : true,
      "se_volume" : "aeiou",
      "node_availability_zone_label" : "aeiou",
      "service_port_match_http_service" : true,
      "http_container_ports" : [ "" ],
      "se_spawn_rate" : 123,
      "ca_tls_key_and_certificate_ref" : "aeiou",
      "nuage_controller" : "",
      "service_account_token" : "aeiou",
      "fleet_endpoint" : "aeiou",
      "client_tls_key_and_certificate_ref" : "aeiou",
      "ssh_user_ref" : "aeiou",
      "master_nodes" : [ "aeiou" ],
      "use_controller_image" : true,
      "sdn_overlay" : true,
      "container_port_match_http_service" : true,
      "disable_auto_gs_sync" : true,
      "disable_auto_se_creation" : true,
      "se_include_attributes" : [ "" ],
      "use_service_cluster_ip_as_ew_vip" : true,
      "se_deployment_method" : "aeiou",
      "default_shared_virtualservice" : {
        "virtualservice_name" : "aeiou"
      },
      "disable_auto_frontend_service_sync" : true,
      "app_sync_frequency" : 123,
      "ns_include_attributes" : [ "" ],
      "feproxy_vips_enable_proxy_arp" : true,
      "ns_exclude_attributes" : [ "" ],
      "ssh_se_deployment" : "",
      "enable_event_subscription" : true,
      "secure_egress_mode" : true,
      "coredump_directory" : "aeiou",
      "docker_registry_se" : "",
      "routes_share_virtualservice" : true,
      "se_exclude_attributes" : [ "" ],
      "shared_virtualservice_namespace" : true,
      "east_west_placement_subnet" : "",
      "avi_bridge_subnet" : "",
      "default_service_as_east_west_service" : true,
      "use_scheduling_disabled_nodes" : true
    },
    "proxy_configuration" : {
      "password" : "aeiou",
      "port" : 123,
      "host" : "aeiou",
      "username" : "aeiou"
    },
    "apic_mode" : true,
    "license_type" : "aeiou",
    "cloudstack_configuration" : {
      "access_key_id" : "aeiou",
      "cntr_public_ip" : "aeiou",
      "api_url" : "aeiou",
      "hypervisor" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "secret_access_key" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    },
    "custom_tags" : [ {
      "tag_key" : "aeiou",
      "tag_val" : "aeiou"
    } ],
    "enable_vip_static_routes" : true,
    "east_west_dns_provider_ref" : "aeiou",
    "url" : "aeiou",
    "mtu" : 123,
    "dhcp_enabled" : true,
    "obj_name_prefix" : "aeiou",
    "openstack_configuration" : {
      "import_keystone_tenants" : true,
      "wildcard_access" : true,
      "allowed_address_pairs" : true,
      "hypervisor_properties" : [ {
        "image_properties" : [ {
          "name" : "aeiou",
          "value" : "aeiou"
        } ],
        "hypervisor" : "aeiou"
      } ],
      "nuage_password" : "aeiou",
      "privilege" : "aeiou",
      "mgmt_network_uuid" : "aeiou",
      "contrail_plugin" : true,
      "port_security" : true,
      "nuage_vsd_host" : "aeiou",
      "se_group_ref" : "aeiou",
      "usable_network_uuids" : [ "aeiou" ],
      "anti_affinity" : true,
      "password" : "aeiou",
      "hypervisor" : "aeiou",
      "nuage_username" : "aeiou",
      "tenant_se" : true,
      "img_format" : "aeiou",
      "insecure" : true,
      "mgmt_network_name" : "aeiou",
      "nuage_port" : 123,
      "admin_tenant_uuid" : "aeiou",
      "free_floatingips" : true,
      "use_nuagevip" : true,
      "name_owner" : true,
      "contrail_endpoint" : "aeiou",
      "use_keystone_auth" : true,
      "keystone_host" : "aeiou",
      "external_networks" : true,
      "use_internal_endpoints" : true,
      "security_groups" : true,
      "config_drive" : true,
      "intf_sec_ips" : true,
      "prov_name" : [ "aeiou" ],
      "map_admin_to_cloudadmin" : true,
      "neutron_rbac" : true,
      "nuage_virtualip" : true,
      "admin_tenant" : "aeiou",
      "nuage_organization" : "aeiou",
      "role_mapping" : [ {
        "os_role" : "aeiou",
        "avi_role" : "aeiou"
      } ],
      "use_admin_url" : true,
      "auth_url" : "aeiou",
      "region" : "aeiou",
      "username" : "aeiou"
    },
    "tenant_ref" : "aeiou",
    "azure_configuration" : {
      "subscription_id" : "aeiou",
      "use_enhanced_ha" : true,
      "resource_group" : "aeiou",
      "use_azure_dns" : true,
      "use_managed_disks" : true,
      "location" : "aeiou",
      "cloud_credentials_ref" : "aeiou",
      "network_info" : [ {
        "se_network_id" : "aeiou",
        "virtual_network_id" : "aeiou"
      } ]
    },
    "name" : "aeiou",
    "prefer_static_routes" : true,
    "vcenter_configuration" : {
      "password" : "aeiou",
      "management_ip_subnet" : "",
      "vcenter_template_se_location" : "aeiou",
      "datacenter" : "aeiou",
      "management_network" : "aeiou",
      "vcenter_url" : "aeiou",
      "privilege" : "aeiou",
      "username" : "aeiou"
    },
    "linuxserver_configuration" : {
      "ssh_user_ref" : "aeiou",
      "hosts" : [ {
        "host_ip" : "",
        "host_attr" : [ {
          "attr_val" : "aeiou",
          "attr_key" : "aeiou"
        } ],
        "node_availability_zone" : "aeiou",
        "se_group_ref" : "aeiou"
      } ],
      "se_inband_mgmt" : true,
      "se_sys_disk_path" : "aeiou",
      "se_log_disk_size_GB" : 123,
      "ssh_attr" : "",
      "se_sys_disk_size_GB" : 123,
      "docker_registry_se" : "",
      "se_log_disk_path" : "aeiou"
    },
    "rancher_configuration" : {
      "feproxy_container_port_as_service" : true,
      "disable_auto_backend_service_sync" : true,
      "se_volume" : "aeiou",
      "http_container_ports" : [ "" ],
      "se_spawn_rate" : 123,
      "nuage_controller" : "",
      "fleet_endpoint" : "aeiou",
      "secret_key" : "aeiou",
      "ssh_user_ref" : "aeiou",
      "use_controller_image" : true,
      "use_container_ip_port" : true,
      "container_port_match_http_service" : true,
      "disable_auto_se_creation" : true,
      "se_include_attributes" : [ "" ],
      "se_deployment_method" : "aeiou",
      "services_accessible_all_interfaces" : true,
      "disable_auto_frontend_service_sync" : true,
      "app_sync_frequency" : 123,
      "feproxy_vips_enable_proxy_arp" : true,
      "ssh_se_deployment" : "",
      "enable_event_subscription" : true,
      "coredump_directory" : "aeiou",
      "docker_registry_se" : "",
      "rancher_servers" : [ "aeiou" ],
      "se_exclude_attributes" : [ "" ],
      "access_key" : "aeiou",
      "east_west_placement_subnet" : ""
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CloudApiResponse

401

log in failed

Up
post /cloud/list
(cloudListPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — empty

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
post /cloud
(cloudPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — Cloud object creation

Return type

Cloud

Example data

Content-Type: application/json
{
  "vtype" : "aeiou",
  "apic_configuration" : {
    "apic_admin_tenant" : "aeiou",
    "apic_vendor" : "aeiou",
    "avi_controller_username" : "aeiou",
    "minor" : "aeiou",
    "context_aware" : "aeiou",
    "apic_domain" : "aeiou",
    "apic_product" : "aeiou",
    "managed_mode" : true,
    "apic_username" : "aeiou",
    "version" : "aeiou",
    "apic_password" : "aeiou",
    "avi_controller_password" : "aeiou",
    "apic_name" : [ "aeiou" ],
    "deployment" : "aeiou"
  },
  "ipam_provider_ref" : "aeiou",
  "state_based_dns_registration" : true,
  "aws_configuration" : {
    "access_key_id" : "aeiou",
    "use_sns_sqs" : true,
    "iam_assume_role" : "aeiou",
    "wildcard_access" : true,
    "vpc_id" : "aeiou",
    "ebs_encryption" : {
      "mode" : "aeiou",
      "master_key" : "aeiou"
    },
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "zones" : [ {
      "availability_zone" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    } ],
    "ttl" : 123,
    "asg_poll_interval" : 123,
    "route53_integration" : true,
    "s3_encryption" : "",
    "use_iam_roles" : true,
    "region" : "aeiou",
    "free_elasticips" : true
  },
  "east_west_ipam_provider_ref" : "aeiou",
  "uuid" : "aeiou",
  "mesos_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "node_availability_zone_label" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "marathon_se_deployment" : {
      "uris" : [ "aeiou" ],
      "host_os" : "aeiou",
      "resource_roles" : [ "aeiou" ],
      "docker_image" : "aeiou"
    },
    "nuage_controller" : {
      "se_zone" : "aeiou",
      "nuage_username" : "aeiou",
      "nuage_password" : "aeiou",
      "nuage_organization" : "aeiou",
      "nuage_port" : 123,
      "se_domain" : "aeiou",
      "se_enterprise" : "aeiou",
      "se_policy_group" : "aeiou",
      "nuage_vsd_host" : "aeiou",
      "se_network" : "aeiou",
      "se_user" : "aeiou"
    },
    "feproxy_bridge_name" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "all_vses_are_feproxy" : true,
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_gs_sync" : true,
    "vip" : "",
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "feproxy_route_publish" : {
      "mode" : "aeiou",
      "subnet" : 123,
      "publisher_port" : 123,
      "token" : "aeiou"
    },
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "use_vips_for_east_west_services" : true,
    "use_bridge_ip_as_vip" : true,
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "marathon_configurations" : [ {
      "vs_name_tag_framework" : true,
      "marathon_url" : "aeiou",
      "public_port_range" : "",
      "marathon_username" : "aeiou",
      "use_token_auth" : true,
      "private_port_range" : {
        "start" : 123,
        "end" : 123
      },
      "framework_tag" : "aeiou",
      "marathon_password" : "aeiou",
      "tenant" : "aeiou"
    } ],
    "se_resources" : [ {
      "memory" : 123,
      "attribute_key" : "aeiou",
      "cpu" : 1.3579000000000001069366817318950779736042022705078125,
      "attribute_value" : "aeiou"
    } ],
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "se_exclude_attributes" : [ "" ],
    "east_west_placement_subnet" : "",
    "mesos_url" : "aeiou"
  },
  "docker_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "ca_tls_key_and_certificate_ref" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "client_tls_key_and_certificate_ref" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "ucp_nodes" : [ "aeiou" ],
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : {
      "password" : "aeiou",
      "host_os" : "aeiou",
      "ssh_user" : "aeiou",
      "sudo_user" : "aeiou"
    },
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : {
      "registry" : "aeiou",
      "password" : "aeiou",
      "private" : true,
      "oshift_registry" : {
        "registry_vip" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "registry_namespace" : "aeiou",
        "registry_service" : "aeiou"
      },
      "se_repository_push" : true,
      "username" : "aeiou"
    },
    "se_exclude_attributes" : [ {
      "attribute" : "aeiou",
      "value" : "aeiou"
    } ],
    "east_west_placement_subnet" : {
      "ip_addr" : "",
      "mask" : 123
    }
  },
  "vca_configuration" : {
    "vca_password" : "aeiou",
    "vca_instance" : "aeiou",
    "vca_orgnization" : "aeiou",
    "vca_username" : "aeiou",
    "vca_mgmt_network" : "aeiou",
    "vca_host" : "aeiou",
    "vca_vdc" : "aeiou",
    "privilege" : "aeiou"
  },
  "nsx_configuration" : {
    "nsx_manager_username" : "aeiou",
    "nsx_manager_name" : "aeiou",
    "avi_nsx_prefix" : "aeiou",
    "nsx_manager_password" : "aeiou",
    "nsx_poll_time" : 123
  },
  "dns_provider_ref" : "aeiou",
  "oshiftk8s_configuration" : {
    "l4_health_monitoring" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "node_availability_zone_label" : "aeiou",
    "service_port_match_http_service" : true,
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "ca_tls_key_and_certificate_ref" : "aeiou",
    "nuage_controller" : "",
    "service_account_token" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "client_tls_key_and_certificate_ref" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "master_nodes" : [ "aeiou" ],
    "use_controller_image" : true,
    "sdn_overlay" : true,
    "container_port_match_http_service" : true,
    "disable_auto_gs_sync" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "use_service_cluster_ip_as_ew_vip" : true,
    "se_deployment_method" : "aeiou",
    "default_shared_virtualservice" : {
      "virtualservice_name" : "aeiou"
    },
    "disable_auto_frontend_service_sync" : true,
    "app_sync_frequency" : 123,
    "ns_include_attributes" : [ "" ],
    "feproxy_vips_enable_proxy_arp" : true,
    "ns_exclude_attributes" : [ "" ],
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "secure_egress_mode" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "routes_share_virtualservice" : true,
    "se_exclude_attributes" : [ "" ],
    "shared_virtualservice_namespace" : true,
    "east_west_placement_subnet" : "",
    "avi_bridge_subnet" : "",
    "default_service_as_east_west_service" : true,
    "use_scheduling_disabled_nodes" : true
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "apic_mode" : true,
  "license_type" : "aeiou",
  "cloudstack_configuration" : {
    "access_key_id" : "aeiou",
    "cntr_public_ip" : "aeiou",
    "api_url" : "aeiou",
    "hypervisor" : "aeiou",
    "mgmt_network_name" : "aeiou",
    "secret_access_key" : "aeiou",
    "mgmt_network_uuid" : "aeiou"
  },
  "custom_tags" : [ {
    "tag_key" : "aeiou",
    "tag_val" : "aeiou"
  } ],
  "enable_vip_static_routes" : true,
  "east_west_dns_provider_ref" : "aeiou",
  "url" : "aeiou",
  "mtu" : 123,
  "dhcp_enabled" : true,
  "obj_name_prefix" : "aeiou",
  "openstack_configuration" : {
    "import_keystone_tenants" : true,
    "wildcard_access" : true,
    "allowed_address_pairs" : true,
    "hypervisor_properties" : [ {
      "image_properties" : [ {
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "hypervisor" : "aeiou"
    } ],
    "nuage_password" : "aeiou",
    "privilege" : "aeiou",
    "mgmt_network_uuid" : "aeiou",
    "contrail_plugin" : true,
    "port_security" : true,
    "nuage_vsd_host" : "aeiou",
    "se_group_ref" : "aeiou",
    "usable_network_uuids" : [ "aeiou" ],
    "anti_affinity" : true,
    "password" : "aeiou",
    "hypervisor" : "aeiou",
    "nuage_username" : "aeiou",
    "tenant_se" : true,
    "img_format" : "aeiou",
    "insecure" : true,
    "mgmt_network_name" : "aeiou",
    "nuage_port" : 123,
    "admin_tenant_uuid" : "aeiou",
    "free_floatingips" : true,
    "use_nuagevip" : true,
    "name_owner" : true,
    "contrail_endpoint" : "aeiou",
    "use_keystone_auth" : true,
    "keystone_host" : "aeiou",
    "external_networks" : true,
    "use_internal_endpoints" : true,
    "security_groups" : true,
    "config_drive" : true,
    "intf_sec_ips" : true,
    "prov_name" : [ "aeiou" ],
    "map_admin_to_cloudadmin" : true,
    "neutron_rbac" : true,
    "nuage_virtualip" : true,
    "admin_tenant" : "aeiou",
    "nuage_organization" : "aeiou",
    "role_mapping" : [ {
      "os_role" : "aeiou",
      "avi_role" : "aeiou"
    } ],
    "use_admin_url" : true,
    "auth_url" : "aeiou",
    "region" : "aeiou",
    "username" : "aeiou"
  },
  "tenant_ref" : "aeiou",
  "azure_configuration" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "resource_group" : "aeiou",
    "use_azure_dns" : true,
    "use_managed_disks" : true,
    "location" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "network_info" : [ {
      "se_network_id" : "aeiou",
      "virtual_network_id" : "aeiou"
    } ]
  },
  "name" : "aeiou",
  "prefer_static_routes" : true,
  "vcenter_configuration" : {
    "password" : "aeiou",
    "management_ip_subnet" : "",
    "vcenter_template_se_location" : "aeiou",
    "datacenter" : "aeiou",
    "management_network" : "aeiou",
    "vcenter_url" : "aeiou",
    "privilege" : "aeiou",
    "username" : "aeiou"
  },
  "linuxserver_configuration" : {
    "ssh_user_ref" : "aeiou",
    "hosts" : [ {
      "host_ip" : "",
      "host_attr" : [ {
        "attr_val" : "aeiou",
        "attr_key" : "aeiou"
      } ],
      "node_availability_zone" : "aeiou",
      "se_group_ref" : "aeiou"
    } ],
    "se_inband_mgmt" : true,
    "se_sys_disk_path" : "aeiou",
    "se_log_disk_size_GB" : 123,
    "ssh_attr" : "",
    "se_sys_disk_size_GB" : 123,
    "docker_registry_se" : "",
    "se_log_disk_path" : "aeiou"
  },
  "rancher_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "nuage_controller" : "",
    "fleet_endpoint" : "aeiou",
    "secret_key" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "rancher_servers" : [ "aeiou" ],
    "se_exclude_attributes" : [ "" ],
    "access_key" : "aeiou",
    "east_west_placement_subnet" : ""
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Cloud

401

log in failed

Up
get /cloud/{uuid}/autoscalegroup/
(cloudUuidAutoscalegroupGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
get /cloud/{uuid}/autoscalegroupservers/
(cloudUuidAutoscalegroupserversGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
delete /cloud/{uuid}
(cloudUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
patch /cloud/{uuid}/gc/
(cloudUuidGcPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
put /cloud/{uuid}/gc/
(cloudUuidGcPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — empty

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
get /cloud/{uuid}
(cloudUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

Cloud

Example data

Content-Type: application/json
{
  "vtype" : "aeiou",
  "apic_configuration" : {
    "apic_admin_tenant" : "aeiou",
    "apic_vendor" : "aeiou",
    "avi_controller_username" : "aeiou",
    "minor" : "aeiou",
    "context_aware" : "aeiou",
    "apic_domain" : "aeiou",
    "apic_product" : "aeiou",
    "managed_mode" : true,
    "apic_username" : "aeiou",
    "version" : "aeiou",
    "apic_password" : "aeiou",
    "avi_controller_password" : "aeiou",
    "apic_name" : [ "aeiou" ],
    "deployment" : "aeiou"
  },
  "ipam_provider_ref" : "aeiou",
  "state_based_dns_registration" : true,
  "aws_configuration" : {
    "access_key_id" : "aeiou",
    "use_sns_sqs" : true,
    "iam_assume_role" : "aeiou",
    "wildcard_access" : true,
    "vpc_id" : "aeiou",
    "ebs_encryption" : {
      "mode" : "aeiou",
      "master_key" : "aeiou"
    },
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "zones" : [ {
      "availability_zone" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    } ],
    "ttl" : 123,
    "asg_poll_interval" : 123,
    "route53_integration" : true,
    "s3_encryption" : "",
    "use_iam_roles" : true,
    "region" : "aeiou",
    "free_elasticips" : true
  },
  "east_west_ipam_provider_ref" : "aeiou",
  "uuid" : "aeiou",
  "mesos_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "node_availability_zone_label" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "marathon_se_deployment" : {
      "uris" : [ "aeiou" ],
      "host_os" : "aeiou",
      "resource_roles" : [ "aeiou" ],
      "docker_image" : "aeiou"
    },
    "nuage_controller" : {
      "se_zone" : "aeiou",
      "nuage_username" : "aeiou",
      "nuage_password" : "aeiou",
      "nuage_organization" : "aeiou",
      "nuage_port" : 123,
      "se_domain" : "aeiou",
      "se_enterprise" : "aeiou",
      "se_policy_group" : "aeiou",
      "nuage_vsd_host" : "aeiou",
      "se_network" : "aeiou",
      "se_user" : "aeiou"
    },
    "feproxy_bridge_name" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "all_vses_are_feproxy" : true,
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_gs_sync" : true,
    "vip" : "",
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "feproxy_route_publish" : {
      "mode" : "aeiou",
      "subnet" : 123,
      "publisher_port" : 123,
      "token" : "aeiou"
    },
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "use_vips_for_east_west_services" : true,
    "use_bridge_ip_as_vip" : true,
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "marathon_configurations" : [ {
      "vs_name_tag_framework" : true,
      "marathon_url" : "aeiou",
      "public_port_range" : "",
      "marathon_username" : "aeiou",
      "use_token_auth" : true,
      "private_port_range" : {
        "start" : 123,
        "end" : 123
      },
      "framework_tag" : "aeiou",
      "marathon_password" : "aeiou",
      "tenant" : "aeiou"
    } ],
    "se_resources" : [ {
      "memory" : 123,
      "attribute_key" : "aeiou",
      "cpu" : 1.3579000000000001069366817318950779736042022705078125,
      "attribute_value" : "aeiou"
    } ],
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "se_exclude_attributes" : [ "" ],
    "east_west_placement_subnet" : "",
    "mesos_url" : "aeiou"
  },
  "docker_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "ca_tls_key_and_certificate_ref" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "client_tls_key_and_certificate_ref" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "ucp_nodes" : [ "aeiou" ],
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : {
      "password" : "aeiou",
      "host_os" : "aeiou",
      "ssh_user" : "aeiou",
      "sudo_user" : "aeiou"
    },
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : {
      "registry" : "aeiou",
      "password" : "aeiou",
      "private" : true,
      "oshift_registry" : {
        "registry_vip" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "registry_namespace" : "aeiou",
        "registry_service" : "aeiou"
      },
      "se_repository_push" : true,
      "username" : "aeiou"
    },
    "se_exclude_attributes" : [ {
      "attribute" : "aeiou",
      "value" : "aeiou"
    } ],
    "east_west_placement_subnet" : {
      "ip_addr" : "",
      "mask" : 123
    }
  },
  "vca_configuration" : {
    "vca_password" : "aeiou",
    "vca_instance" : "aeiou",
    "vca_orgnization" : "aeiou",
    "vca_username" : "aeiou",
    "vca_mgmt_network" : "aeiou",
    "vca_host" : "aeiou",
    "vca_vdc" : "aeiou",
    "privilege" : "aeiou"
  },
  "nsx_configuration" : {
    "nsx_manager_username" : "aeiou",
    "nsx_manager_name" : "aeiou",
    "avi_nsx_prefix" : "aeiou",
    "nsx_manager_password" : "aeiou",
    "nsx_poll_time" : 123
  },
  "dns_provider_ref" : "aeiou",
  "oshiftk8s_configuration" : {
    "l4_health_monitoring" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "node_availability_zone_label" : "aeiou",
    "service_port_match_http_service" : true,
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "ca_tls_key_and_certificate_ref" : "aeiou",
    "nuage_controller" : "",
    "service_account_token" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "client_tls_key_and_certificate_ref" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "master_nodes" : [ "aeiou" ],
    "use_controller_image" : true,
    "sdn_overlay" : true,
    "container_port_match_http_service" : true,
    "disable_auto_gs_sync" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "use_service_cluster_ip_as_ew_vip" : true,
    "se_deployment_method" : "aeiou",
    "default_shared_virtualservice" : {
      "virtualservice_name" : "aeiou"
    },
    "disable_auto_frontend_service_sync" : true,
    "app_sync_frequency" : 123,
    "ns_include_attributes" : [ "" ],
    "feproxy_vips_enable_proxy_arp" : true,
    "ns_exclude_attributes" : [ "" ],
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "secure_egress_mode" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "routes_share_virtualservice" : true,
    "se_exclude_attributes" : [ "" ],
    "shared_virtualservice_namespace" : true,
    "east_west_placement_subnet" : "",
    "avi_bridge_subnet" : "",
    "default_service_as_east_west_service" : true,
    "use_scheduling_disabled_nodes" : true
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "apic_mode" : true,
  "license_type" : "aeiou",
  "cloudstack_configuration" : {
    "access_key_id" : "aeiou",
    "cntr_public_ip" : "aeiou",
    "api_url" : "aeiou",
    "hypervisor" : "aeiou",
    "mgmt_network_name" : "aeiou",
    "secret_access_key" : "aeiou",
    "mgmt_network_uuid" : "aeiou"
  },
  "custom_tags" : [ {
    "tag_key" : "aeiou",
    "tag_val" : "aeiou"
  } ],
  "enable_vip_static_routes" : true,
  "east_west_dns_provider_ref" : "aeiou",
  "url" : "aeiou",
  "mtu" : 123,
  "dhcp_enabled" : true,
  "obj_name_prefix" : "aeiou",
  "openstack_configuration" : {
    "import_keystone_tenants" : true,
    "wildcard_access" : true,
    "allowed_address_pairs" : true,
    "hypervisor_properties" : [ {
      "image_properties" : [ {
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "hypervisor" : "aeiou"
    } ],
    "nuage_password" : "aeiou",
    "privilege" : "aeiou",
    "mgmt_network_uuid" : "aeiou",
    "contrail_plugin" : true,
    "port_security" : true,
    "nuage_vsd_host" : "aeiou",
    "se_group_ref" : "aeiou",
    "usable_network_uuids" : [ "aeiou" ],
    "anti_affinity" : true,
    "password" : "aeiou",
    "hypervisor" : "aeiou",
    "nuage_username" : "aeiou",
    "tenant_se" : true,
    "img_format" : "aeiou",
    "insecure" : true,
    "mgmt_network_name" : "aeiou",
    "nuage_port" : 123,
    "admin_tenant_uuid" : "aeiou",
    "free_floatingips" : true,
    "use_nuagevip" : true,
    "name_owner" : true,
    "contrail_endpoint" : "aeiou",
    "use_keystone_auth" : true,
    "keystone_host" : "aeiou",
    "external_networks" : true,
    "use_internal_endpoints" : true,
    "security_groups" : true,
    "config_drive" : true,
    "intf_sec_ips" : true,
    "prov_name" : [ "aeiou" ],
    "map_admin_to_cloudadmin" : true,
    "neutron_rbac" : true,
    "nuage_virtualip" : true,
    "admin_tenant" : "aeiou",
    "nuage_organization" : "aeiou",
    "role_mapping" : [ {
      "os_role" : "aeiou",
      "avi_role" : "aeiou"
    } ],
    "use_admin_url" : true,
    "auth_url" : "aeiou",
    "region" : "aeiou",
    "username" : "aeiou"
  },
  "tenant_ref" : "aeiou",
  "azure_configuration" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "resource_group" : "aeiou",
    "use_azure_dns" : true,
    "use_managed_disks" : true,
    "location" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "network_info" : [ {
      "se_network_id" : "aeiou",
      "virtual_network_id" : "aeiou"
    } ]
  },
  "name" : "aeiou",
  "prefer_static_routes" : true,
  "vcenter_configuration" : {
    "password" : "aeiou",
    "management_ip_subnet" : "",
    "vcenter_template_se_location" : "aeiou",
    "datacenter" : "aeiou",
    "management_network" : "aeiou",
    "vcenter_url" : "aeiou",
    "privilege" : "aeiou",
    "username" : "aeiou"
  },
  "linuxserver_configuration" : {
    "ssh_user_ref" : "aeiou",
    "hosts" : [ {
      "host_ip" : "",
      "host_attr" : [ {
        "attr_val" : "aeiou",
        "attr_key" : "aeiou"
      } ],
      "node_availability_zone" : "aeiou",
      "se_group_ref" : "aeiou"
    } ],
    "se_inband_mgmt" : true,
    "se_sys_disk_path" : "aeiou",
    "se_log_disk_size_GB" : 123,
    "ssh_attr" : "",
    "se_sys_disk_size_GB" : 123,
    "docker_registry_se" : "",
    "se_log_disk_path" : "aeiou"
  },
  "rancher_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "nuage_controller" : "",
    "fleet_endpoint" : "aeiou",
    "secret_key" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "rancher_servers" : [ "aeiou" ],
    "se_exclude_attributes" : [ "" ],
    "access_key" : "aeiou",
    "east_west_placement_subnet" : ""
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Cloud

401

log in failed

Up
get /cloud/{uuid}/health/
(cloudUuidHealthGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
get /cloud/{uuid}/hosts/
(cloudUuidHostsGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
get /cloud/{uuid}/internals/
(cloudUuidInternalsGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
patch /cloud/{uuid}
(cloudUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — Cloud object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

Cloud

Example data

Content-Type: application/json
{
  "vtype" : "aeiou",
  "apic_configuration" : {
    "apic_admin_tenant" : "aeiou",
    "apic_vendor" : "aeiou",
    "avi_controller_username" : "aeiou",
    "minor" : "aeiou",
    "context_aware" : "aeiou",
    "apic_domain" : "aeiou",
    "apic_product" : "aeiou",
    "managed_mode" : true,
    "apic_username" : "aeiou",
    "version" : "aeiou",
    "apic_password" : "aeiou",
    "avi_controller_password" : "aeiou",
    "apic_name" : [ "aeiou" ],
    "deployment" : "aeiou"
  },
  "ipam_provider_ref" : "aeiou",
  "state_based_dns_registration" : true,
  "aws_configuration" : {
    "access_key_id" : "aeiou",
    "use_sns_sqs" : true,
    "iam_assume_role" : "aeiou",
    "wildcard_access" : true,
    "vpc_id" : "aeiou",
    "ebs_encryption" : {
      "mode" : "aeiou",
      "master_key" : "aeiou"
    },
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "zones" : [ {
      "availability_zone" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    } ],
    "ttl" : 123,
    "asg_poll_interval" : 123,
    "route53_integration" : true,
    "s3_encryption" : "",
    "use_iam_roles" : true,
    "region" : "aeiou",
    "free_elasticips" : true
  },
  "east_west_ipam_provider_ref" : "aeiou",
  "uuid" : "aeiou",
  "mesos_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "node_availability_zone_label" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "marathon_se_deployment" : {
      "uris" : [ "aeiou" ],
      "host_os" : "aeiou",
      "resource_roles" : [ "aeiou" ],
      "docker_image" : "aeiou"
    },
    "nuage_controller" : {
      "se_zone" : "aeiou",
      "nuage_username" : "aeiou",
      "nuage_password" : "aeiou",
      "nuage_organization" : "aeiou",
      "nuage_port" : 123,
      "se_domain" : "aeiou",
      "se_enterprise" : "aeiou",
      "se_policy_group" : "aeiou",
      "nuage_vsd_host" : "aeiou",
      "se_network" : "aeiou",
      "se_user" : "aeiou"
    },
    "feproxy_bridge_name" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "all_vses_are_feproxy" : true,
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_gs_sync" : true,
    "vip" : "",
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "feproxy_route_publish" : {
      "mode" : "aeiou",
      "subnet" : 123,
      "publisher_port" : 123,
      "token" : "aeiou"
    },
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "use_vips_for_east_west_services" : true,
    "use_bridge_ip_as_vip" : true,
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "marathon_configurations" : [ {
      "vs_name_tag_framework" : true,
      "marathon_url" : "aeiou",
      "public_port_range" : "",
      "marathon_username" : "aeiou",
      "use_token_auth" : true,
      "private_port_range" : {
        "start" : 123,
        "end" : 123
      },
      "framework_tag" : "aeiou",
      "marathon_password" : "aeiou",
      "tenant" : "aeiou"
    } ],
    "se_resources" : [ {
      "memory" : 123,
      "attribute_key" : "aeiou",
      "cpu" : 1.3579000000000001069366817318950779736042022705078125,
      "attribute_value" : "aeiou"
    } ],
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "se_exclude_attributes" : [ "" ],
    "east_west_placement_subnet" : "",
    "mesos_url" : "aeiou"
  },
  "docker_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "ca_tls_key_and_certificate_ref" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "client_tls_key_and_certificate_ref" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "ucp_nodes" : [ "aeiou" ],
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : {
      "password" : "aeiou",
      "host_os" : "aeiou",
      "ssh_user" : "aeiou",
      "sudo_user" : "aeiou"
    },
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : {
      "registry" : "aeiou",
      "password" : "aeiou",
      "private" : true,
      "oshift_registry" : {
        "registry_vip" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "registry_namespace" : "aeiou",
        "registry_service" : "aeiou"
      },
      "se_repository_push" : true,
      "username" : "aeiou"
    },
    "se_exclude_attributes" : [ {
      "attribute" : "aeiou",
      "value" : "aeiou"
    } ],
    "east_west_placement_subnet" : {
      "ip_addr" : "",
      "mask" : 123
    }
  },
  "vca_configuration" : {
    "vca_password" : "aeiou",
    "vca_instance" : "aeiou",
    "vca_orgnization" : "aeiou",
    "vca_username" : "aeiou",
    "vca_mgmt_network" : "aeiou",
    "vca_host" : "aeiou",
    "vca_vdc" : "aeiou",
    "privilege" : "aeiou"
  },
  "nsx_configuration" : {
    "nsx_manager_username" : "aeiou",
    "nsx_manager_name" : "aeiou",
    "avi_nsx_prefix" : "aeiou",
    "nsx_manager_password" : "aeiou",
    "nsx_poll_time" : 123
  },
  "dns_provider_ref" : "aeiou",
  "oshiftk8s_configuration" : {
    "l4_health_monitoring" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "node_availability_zone_label" : "aeiou",
    "service_port_match_http_service" : true,
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "ca_tls_key_and_certificate_ref" : "aeiou",
    "nuage_controller" : "",
    "service_account_token" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "client_tls_key_and_certificate_ref" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "master_nodes" : [ "aeiou" ],
    "use_controller_image" : true,
    "sdn_overlay" : true,
    "container_port_match_http_service" : true,
    "disable_auto_gs_sync" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "use_service_cluster_ip_as_ew_vip" : true,
    "se_deployment_method" : "aeiou",
    "default_shared_virtualservice" : {
      "virtualservice_name" : "aeiou"
    },
    "disable_auto_frontend_service_sync" : true,
    "app_sync_frequency" : 123,
    "ns_include_attributes" : [ "" ],
    "feproxy_vips_enable_proxy_arp" : true,
    "ns_exclude_attributes" : [ "" ],
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "secure_egress_mode" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "routes_share_virtualservice" : true,
    "se_exclude_attributes" : [ "" ],
    "shared_virtualservice_namespace" : true,
    "east_west_placement_subnet" : "",
    "avi_bridge_subnet" : "",
    "default_service_as_east_west_service" : true,
    "use_scheduling_disabled_nodes" : true
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "apic_mode" : true,
  "license_type" : "aeiou",
  "cloudstack_configuration" : {
    "access_key_id" : "aeiou",
    "cntr_public_ip" : "aeiou",
    "api_url" : "aeiou",
    "hypervisor" : "aeiou",
    "mgmt_network_name" : "aeiou",
    "secret_access_key" : "aeiou",
    "mgmt_network_uuid" : "aeiou"
  },
  "custom_tags" : [ {
    "tag_key" : "aeiou",
    "tag_val" : "aeiou"
  } ],
  "enable_vip_static_routes" : true,
  "east_west_dns_provider_ref" : "aeiou",
  "url" : "aeiou",
  "mtu" : 123,
  "dhcp_enabled" : true,
  "obj_name_prefix" : "aeiou",
  "openstack_configuration" : {
    "import_keystone_tenants" : true,
    "wildcard_access" : true,
    "allowed_address_pairs" : true,
    "hypervisor_properties" : [ {
      "image_properties" : [ {
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "hypervisor" : "aeiou"
    } ],
    "nuage_password" : "aeiou",
    "privilege" : "aeiou",
    "mgmt_network_uuid" : "aeiou",
    "contrail_plugin" : true,
    "port_security" : true,
    "nuage_vsd_host" : "aeiou",
    "se_group_ref" : "aeiou",
    "usable_network_uuids" : [ "aeiou" ],
    "anti_affinity" : true,
    "password" : "aeiou",
    "hypervisor" : "aeiou",
    "nuage_username" : "aeiou",
    "tenant_se" : true,
    "img_format" : "aeiou",
    "insecure" : true,
    "mgmt_network_name" : "aeiou",
    "nuage_port" : 123,
    "admin_tenant_uuid" : "aeiou",
    "free_floatingips" : true,
    "use_nuagevip" : true,
    "name_owner" : true,
    "contrail_endpoint" : "aeiou",
    "use_keystone_auth" : true,
    "keystone_host" : "aeiou",
    "external_networks" : true,
    "use_internal_endpoints" : true,
    "security_groups" : true,
    "config_drive" : true,
    "intf_sec_ips" : true,
    "prov_name" : [ "aeiou" ],
    "map_admin_to_cloudadmin" : true,
    "neutron_rbac" : true,
    "nuage_virtualip" : true,
    "admin_tenant" : "aeiou",
    "nuage_organization" : "aeiou",
    "role_mapping" : [ {
      "os_role" : "aeiou",
      "avi_role" : "aeiou"
    } ],
    "use_admin_url" : true,
    "auth_url" : "aeiou",
    "region" : "aeiou",
    "username" : "aeiou"
  },
  "tenant_ref" : "aeiou",
  "azure_configuration" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "resource_group" : "aeiou",
    "use_azure_dns" : true,
    "use_managed_disks" : true,
    "location" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "network_info" : [ {
      "se_network_id" : "aeiou",
      "virtual_network_id" : "aeiou"
    } ]
  },
  "name" : "aeiou",
  "prefer_static_routes" : true,
  "vcenter_configuration" : {
    "password" : "aeiou",
    "management_ip_subnet" : "",
    "vcenter_template_se_location" : "aeiou",
    "datacenter" : "aeiou",
    "management_network" : "aeiou",
    "vcenter_url" : "aeiou",
    "privilege" : "aeiou",
    "username" : "aeiou"
  },
  "linuxserver_configuration" : {
    "ssh_user_ref" : "aeiou",
    "hosts" : [ {
      "host_ip" : "",
      "host_attr" : [ {
        "attr_val" : "aeiou",
        "attr_key" : "aeiou"
      } ],
      "node_availability_zone" : "aeiou",
      "se_group_ref" : "aeiou"
    } ],
    "se_inband_mgmt" : true,
    "se_sys_disk_path" : "aeiou",
    "se_log_disk_size_GB" : 123,
    "ssh_attr" : "",
    "se_sys_disk_size_GB" : 123,
    "docker_registry_se" : "",
    "se_log_disk_path" : "aeiou"
  },
  "rancher_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "nuage_controller" : "",
    "fleet_endpoint" : "aeiou",
    "secret_key" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "rancher_servers" : [ "aeiou" ],
    "se_exclude_attributes" : [ "" ],
    "access_key" : "aeiou",
    "east_west_placement_subnet" : ""
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Cloud

401

log in failed

Up
put /cloud/{uuid}
(cloudUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — Cloud object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

Cloud

Example data

Content-Type: application/json
{
  "vtype" : "aeiou",
  "apic_configuration" : {
    "apic_admin_tenant" : "aeiou",
    "apic_vendor" : "aeiou",
    "avi_controller_username" : "aeiou",
    "minor" : "aeiou",
    "context_aware" : "aeiou",
    "apic_domain" : "aeiou",
    "apic_product" : "aeiou",
    "managed_mode" : true,
    "apic_username" : "aeiou",
    "version" : "aeiou",
    "apic_password" : "aeiou",
    "avi_controller_password" : "aeiou",
    "apic_name" : [ "aeiou" ],
    "deployment" : "aeiou"
  },
  "ipam_provider_ref" : "aeiou",
  "state_based_dns_registration" : true,
  "aws_configuration" : {
    "access_key_id" : "aeiou",
    "use_sns_sqs" : true,
    "iam_assume_role" : "aeiou",
    "wildcard_access" : true,
    "vpc_id" : "aeiou",
    "ebs_encryption" : {
      "mode" : "aeiou",
      "master_key" : "aeiou"
    },
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "zones" : [ {
      "availability_zone" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    } ],
    "ttl" : 123,
    "asg_poll_interval" : 123,
    "route53_integration" : true,
    "s3_encryption" : "",
    "use_iam_roles" : true,
    "region" : "aeiou",
    "free_elasticips" : true
  },
  "east_west_ipam_provider_ref" : "aeiou",
  "uuid" : "aeiou",
  "mesos_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "node_availability_zone_label" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "marathon_se_deployment" : {
      "uris" : [ "aeiou" ],
      "host_os" : "aeiou",
      "resource_roles" : [ "aeiou" ],
      "docker_image" : "aeiou"
    },
    "nuage_controller" : {
      "se_zone" : "aeiou",
      "nuage_username" : "aeiou",
      "nuage_password" : "aeiou",
      "nuage_organization" : "aeiou",
      "nuage_port" : 123,
      "se_domain" : "aeiou",
      "se_enterprise" : "aeiou",
      "se_policy_group" : "aeiou",
      "nuage_vsd_host" : "aeiou",
      "se_network" : "aeiou",
      "se_user" : "aeiou"
    },
    "feproxy_bridge_name" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "all_vses_are_feproxy" : true,
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_gs_sync" : true,
    "vip" : "",
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "feproxy_route_publish" : {
      "mode" : "aeiou",
      "subnet" : 123,
      "publisher_port" : 123,
      "token" : "aeiou"
    },
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "use_vips_for_east_west_services" : true,
    "use_bridge_ip_as_vip" : true,
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "marathon_configurations" : [ {
      "vs_name_tag_framework" : true,
      "marathon_url" : "aeiou",
      "public_port_range" : "",
      "marathon_username" : "aeiou",
      "use_token_auth" : true,
      "private_port_range" : {
        "start" : 123,
        "end" : 123
      },
      "framework_tag" : "aeiou",
      "marathon_password" : "aeiou",
      "tenant" : "aeiou"
    } ],
    "se_resources" : [ {
      "memory" : 123,
      "attribute_key" : "aeiou",
      "cpu" : 1.3579000000000001069366817318950779736042022705078125,
      "attribute_value" : "aeiou"
    } ],
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "se_exclude_attributes" : [ "" ],
    "east_west_placement_subnet" : "",
    "mesos_url" : "aeiou"
  },
  "docker_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "ca_tls_key_and_certificate_ref" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "client_tls_key_and_certificate_ref" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "ucp_nodes" : [ "aeiou" ],
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : {
      "password" : "aeiou",
      "host_os" : "aeiou",
      "ssh_user" : "aeiou",
      "sudo_user" : "aeiou"
    },
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : {
      "registry" : "aeiou",
      "password" : "aeiou",
      "private" : true,
      "oshift_registry" : {
        "registry_vip" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "registry_namespace" : "aeiou",
        "registry_service" : "aeiou"
      },
      "se_repository_push" : true,
      "username" : "aeiou"
    },
    "se_exclude_attributes" : [ {
      "attribute" : "aeiou",
      "value" : "aeiou"
    } ],
    "east_west_placement_subnet" : {
      "ip_addr" : "",
      "mask" : 123
    }
  },
  "vca_configuration" : {
    "vca_password" : "aeiou",
    "vca_instance" : "aeiou",
    "vca_orgnization" : "aeiou",
    "vca_username" : "aeiou",
    "vca_mgmt_network" : "aeiou",
    "vca_host" : "aeiou",
    "vca_vdc" : "aeiou",
    "privilege" : "aeiou"
  },
  "nsx_configuration" : {
    "nsx_manager_username" : "aeiou",
    "nsx_manager_name" : "aeiou",
    "avi_nsx_prefix" : "aeiou",
    "nsx_manager_password" : "aeiou",
    "nsx_poll_time" : 123
  },
  "dns_provider_ref" : "aeiou",
  "oshiftk8s_configuration" : {
    "l4_health_monitoring" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "node_availability_zone_label" : "aeiou",
    "service_port_match_http_service" : true,
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "ca_tls_key_and_certificate_ref" : "aeiou",
    "nuage_controller" : "",
    "service_account_token" : "aeiou",
    "fleet_endpoint" : "aeiou",
    "client_tls_key_and_certificate_ref" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "master_nodes" : [ "aeiou" ],
    "use_controller_image" : true,
    "sdn_overlay" : true,
    "container_port_match_http_service" : true,
    "disable_auto_gs_sync" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "use_service_cluster_ip_as_ew_vip" : true,
    "se_deployment_method" : "aeiou",
    "default_shared_virtualservice" : {
      "virtualservice_name" : "aeiou"
    },
    "disable_auto_frontend_service_sync" : true,
    "app_sync_frequency" : 123,
    "ns_include_attributes" : [ "" ],
    "feproxy_vips_enable_proxy_arp" : true,
    "ns_exclude_attributes" : [ "" ],
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "secure_egress_mode" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "routes_share_virtualservice" : true,
    "se_exclude_attributes" : [ "" ],
    "shared_virtualservice_namespace" : true,
    "east_west_placement_subnet" : "",
    "avi_bridge_subnet" : "",
    "default_service_as_east_west_service" : true,
    "use_scheduling_disabled_nodes" : true
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "apic_mode" : true,
  "license_type" : "aeiou",
  "cloudstack_configuration" : {
    "access_key_id" : "aeiou",
    "cntr_public_ip" : "aeiou",
    "api_url" : "aeiou",
    "hypervisor" : "aeiou",
    "mgmt_network_name" : "aeiou",
    "secret_access_key" : "aeiou",
    "mgmt_network_uuid" : "aeiou"
  },
  "custom_tags" : [ {
    "tag_key" : "aeiou",
    "tag_val" : "aeiou"
  } ],
  "enable_vip_static_routes" : true,
  "east_west_dns_provider_ref" : "aeiou",
  "url" : "aeiou",
  "mtu" : 123,
  "dhcp_enabled" : true,
  "obj_name_prefix" : "aeiou",
  "openstack_configuration" : {
    "import_keystone_tenants" : true,
    "wildcard_access" : true,
    "allowed_address_pairs" : true,
    "hypervisor_properties" : [ {
      "image_properties" : [ {
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "hypervisor" : "aeiou"
    } ],
    "nuage_password" : "aeiou",
    "privilege" : "aeiou",
    "mgmt_network_uuid" : "aeiou",
    "contrail_plugin" : true,
    "port_security" : true,
    "nuage_vsd_host" : "aeiou",
    "se_group_ref" : "aeiou",
    "usable_network_uuids" : [ "aeiou" ],
    "anti_affinity" : true,
    "password" : "aeiou",
    "hypervisor" : "aeiou",
    "nuage_username" : "aeiou",
    "tenant_se" : true,
    "img_format" : "aeiou",
    "insecure" : true,
    "mgmt_network_name" : "aeiou",
    "nuage_port" : 123,
    "admin_tenant_uuid" : "aeiou",
    "free_floatingips" : true,
    "use_nuagevip" : true,
    "name_owner" : true,
    "contrail_endpoint" : "aeiou",
    "use_keystone_auth" : true,
    "keystone_host" : "aeiou",
    "external_networks" : true,
    "use_internal_endpoints" : true,
    "security_groups" : true,
    "config_drive" : true,
    "intf_sec_ips" : true,
    "prov_name" : [ "aeiou" ],
    "map_admin_to_cloudadmin" : true,
    "neutron_rbac" : true,
    "nuage_virtualip" : true,
    "admin_tenant" : "aeiou",
    "nuage_organization" : "aeiou",
    "role_mapping" : [ {
      "os_role" : "aeiou",
      "avi_role" : "aeiou"
    } ],
    "use_admin_url" : true,
    "auth_url" : "aeiou",
    "region" : "aeiou",
    "username" : "aeiou"
  },
  "tenant_ref" : "aeiou",
  "azure_configuration" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "resource_group" : "aeiou",
    "use_azure_dns" : true,
    "use_managed_disks" : true,
    "location" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "network_info" : [ {
      "se_network_id" : "aeiou",
      "virtual_network_id" : "aeiou"
    } ]
  },
  "name" : "aeiou",
  "prefer_static_routes" : true,
  "vcenter_configuration" : {
    "password" : "aeiou",
    "management_ip_subnet" : "",
    "vcenter_template_se_location" : "aeiou",
    "datacenter" : "aeiou",
    "management_network" : "aeiou",
    "vcenter_url" : "aeiou",
    "privilege" : "aeiou",
    "username" : "aeiou"
  },
  "linuxserver_configuration" : {
    "ssh_user_ref" : "aeiou",
    "hosts" : [ {
      "host_ip" : "",
      "host_attr" : [ {
        "attr_val" : "aeiou",
        "attr_key" : "aeiou"
      } ],
      "node_availability_zone" : "aeiou",
      "se_group_ref" : "aeiou"
    } ],
    "se_inband_mgmt" : true,
    "se_sys_disk_path" : "aeiou",
    "se_log_disk_size_GB" : 123,
    "ssh_attr" : "",
    "se_sys_disk_size_GB" : 123,
    "docker_registry_se" : "",
    "se_log_disk_path" : "aeiou"
  },
  "rancher_configuration" : {
    "feproxy_container_port_as_service" : true,
    "disable_auto_backend_service_sync" : true,
    "se_volume" : "aeiou",
    "http_container_ports" : [ "" ],
    "se_spawn_rate" : 123,
    "nuage_controller" : "",
    "fleet_endpoint" : "aeiou",
    "secret_key" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "use_controller_image" : true,
    "use_container_ip_port" : true,
    "container_port_match_http_service" : true,
    "disable_auto_se_creation" : true,
    "se_include_attributes" : [ "" ],
    "se_deployment_method" : "aeiou",
    "services_accessible_all_interfaces" : true,
    "disable_auto_frontend_service_sync" : true,
    "app_sync_frequency" : 123,
    "feproxy_vips_enable_proxy_arp" : true,
    "ssh_se_deployment" : "",
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "rancher_servers" : [ "aeiou" ],
    "se_exclude_attributes" : [ "" ],
    "access_key" : "aeiou",
    "east_west_placement_subnet" : ""
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Cloud

401

log in failed

Up
get /cloud/{uuid}/status/
(cloudUuidStatusGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. APICConfiguration
  2. AwsConfiguration
  3. AwsZoneConfig
  4. aws_encryption
  5. AzureConfiguration
  6. AzureNetworkInfo
  7. Cloud
  8. CloudApiResponse
  9. CloudStackConfiguration
  10. CustomTag
  11. DockerConfiguration
  12. DockerRegistry
  13. FeProxyRoutePublishConfig
  14. HostAttributes
  15. IpAddr
  16. IpAddrPrefix
  17. LinuxServerConfiguration
  18. LinuxServerHost
  19. MarathonConfiguration
  20. MarathonSeDeployment
  21. MesosAttribute
  22. MesosConfiguration
  23. MesosSeResources
  24. NsxConfiguration
  25. NuageSDNController
  26. OShiftK8SConfiguration
  27. OpenStackConfiguration
  28. OpenStackHypervisorProperties
  29. OpenStackRoleMapping
  30. OshiftDockerRegistryMetaData
  31. OshiftSharedVirtualService
  32. PortRange
  33. Property
  34. ProxyConfiguration
  35. RancherConfiguration
  36. SSHSeDeployment
  37. vCenterConfiguration
  38. vCloudAirConfiguration

APICConfiguration Up

apic_admin_tenant (optional)
String Name of the Avi specific tenant created within APIC.
apic_domain (optional)
String vCenter's virtual machine manager domain within APIC.
apic_name (optional)
array[String] The hostname or IP address of the APIC controller.
apic_password (optional)
String The password Avi Vantage will use when authenticating with APIC.
apic_product (optional)
String apic_product of APICConfiguration.
apic_username (optional)
String The username Avi Vantage will use when authenticating with APIC.
apic_vendor (optional)
String apic_vendor of APICConfiguration.
avi_controller_password (optional)
String The password APIC will use when authenticating with Avi Vantage.
avi_controller_username (optional)
String The username APIC will use when authenticating with Avi Vantage.
context_aware (optional)
String Context aware for supporting Service Graphs across VRFs. Enum options - SINGLE_CONTEXT, MULTI_CONTEXT.
deployment (optional)
String deployment of APICConfiguration.
managed_mode (optional)
Boolean Use Managed Mode for APIC Service Insertion. Field introduced in 17.1.1.
minor (optional)
String AVI Device Package Minor Version.
version (optional)
String AVI Device Package Version.

AwsConfiguration Up

access_key_id (optional)
String AWS access key ID.
asg_poll_interval (optional)
Integer Time interval between periodic polling of all Auto Scaling Groups. Allowed values are 60-1800. Field introduced in 17.1.3. format: int32
ebs_encryption (optional)
aws_encryption EBS encryption mode and the master key to be used for encrypting SE AMI, Volumes, and Snapshots. Field introduced in 17.2.3.
free_elasticips (optional)
Boolean Free unused elastic IP addresses.
iam_assume_role (optional)
String IAM assume role for cross-account access.
region (optional)
String AWS region.
route53_integration (optional)
Boolean If enabled, create/update DNS entries in Amazon Route 53 zones.
s3_encryption (optional)
aws_encryption S3 encryption mode and the master key to be used for encrypting S3 buckets during SE AMI upload. Only SSE-KMS mode is supported. Field introduced in 17.2.3.
secret_access_key (optional)
String AWS secret access key.
ttl (optional)
Integer Default TTL for all records. Allowed values are 1-172800. Field introduced in 17.1.3. format: int32
use_iam_roles (optional)
Boolean Use IAM roles instead of access and secret key.
use_sns_sqs (optional)
Boolean Use SNS/SQS based notifications for monitoring Auto Scaling Groups. Field introduced in 17.1.3.
vpc (optional)
String VPC name.
vpc_id
String VPC ID.
wildcard_access (optional)
Boolean If enabled, program SE security group with ingress rule to allow SSH (port 22) access from 0.0.0.0/0. Field deprecated in 17.1.5. Field introduced in 17.1.3.
zones (optional)
array[AwsZoneConfig] Placeholder for description of property zones of obj type AwsConfiguration field type str type object

AwsZoneConfig Up

availability_zone
String Availability zone.
mgmt_network_name
String Name or CIDR of the network in the Availability Zone that will be used as management network.
mgmt_network_uuid (optional)
String UUID of the network in the Availability Zone that will be used as management network.

aws_encryption Up

master_key (optional)
String AWS KMS ARN ID of the master key for encryption. Field introduced in 17.2.3.
mode (optional)
String AWS encryption mode. Enum options - AWS_ENCRYPTION_MODE_NONE, AWS_ENCRYPTION_MODE_SSE_KMS. Field introduced in 17.2.3.

AzureConfiguration Up

cloud_credentials_ref (optional)
String Credentials to access azure cloud. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.2.1.
location (optional)
String Azure location where this cloud will be located. Field introduced in 17.2.1.
network_info (optional)
array[AzureNetworkInfo] Azure virtual network and subnet information. Field introduced in 17.2.1.
resource_group (optional)
String Azure resource group dedicated for Avi Controller. Avi Controller will create all its resources in this resource group. Field introduced in 17.2.1.
subscription_id (optional)
String Subscription Id for the Azure subscription. Field introduced in 17.2.1.
use_azure_dns (optional)
Boolean Azure is the DNS provider. Field introduced in 17.2.1.
use_enhanced_ha (optional)
Boolean Use Azure's enhanced HA features. This needs a public IP to be associated with the VIP. . Field introduced in 17.2.1.
use_managed_disks (optional)
Boolean Use Azure managed disks for SE storage. Field introduced in 17.2.2.

AzureNetworkInfo Up

se_network_id (optional)
String Id of the Azure subnet where Avi Controller will create the Service Engines. . Field introduced in 17.2.1.
virtual_network_id (optional)
String Virtual network where Virtual IPs will belong. Field introduced in 17.2.1.

Cloud Up

apic_configuration (optional)
APICConfiguration Placeholder for description of property apic_configuration of obj type Cloud field type str type object
apic_mode (optional)
Boolean Placeholder for description of property apic_mode of obj type Cloud field type str type boolean
aws_configuration (optional)
AwsConfiguration Placeholder for description of property aws_configuration of obj type Cloud field type str type object
azure_configuration (optional)
AzureConfiguration Field introduced in 17.2.1.
cloudstack_configuration (optional)
CloudStackConfiguration Placeholder for description of property cloudstack_configuration of obj type Cloud field type str type object
custom_tags (optional)
array[CustomTag] Custom tags for all Avi created resources in the cloud infrastructure. Field introduced in 17.1.5.
dhcp_enabled (optional)
Boolean Select the IP address management scheme.
dns_provider_ref (optional)
String DNS Profile for the cloud. It is a reference to an object of type IpamDnsProviderProfile.
docker_configuration (optional)
DockerConfiguration Placeholder for description of property docker_configuration of obj type Cloud field type str type object
east_west_dns_provider_ref (optional)
String DNS Profile for East-West services. It is a reference to an object of type IpamDnsProviderProfile.
east_west_ipam_provider_ref (optional)
String 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. It is a reference to an object of type IpamDnsProviderProfile.
enable_vip_static_routes (optional)
Boolean Use static routes for VIP side network resolution during VirtualService placement.
ipam_provider_ref (optional)
String Ipam Profile for the cloud. It is a reference to an object of type IpamDnsProviderProfile.
license_type (optional)
String 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. Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS.
linuxserver_configuration (optional)
LinuxServerConfiguration Placeholder for description of property linuxserver_configuration of obj type Cloud field type str type object
mesos_configuration (optional)
MesosConfiguration Placeholder for description of property mesos_configuration of obj type Cloud field type str type object
mtu (optional)
Integer MTU setting for the cloud. format: int32
name
String Name of the object.
nsx_configuration (optional)
NsxConfiguration Configuration parameters for NSX Manager. Field introduced in 17.1.1.
obj_name_prefix (optional)
String Default prefix for all automatically created objects in this cloud. This prefix can be overridden by the SE-Group template.
openstack_configuration (optional)
OpenStackConfiguration Placeholder for description of property openstack_configuration of obj type Cloud field type str type object
oshiftk8s_configuration (optional)
OShiftK8SConfiguration Placeholder for description of property oshiftk8s_configuration of obj type Cloud field type str type object
prefer_static_routes (optional)
Boolean Prefer static routes over interface routes during VirtualService placement.
proxy_configuration (optional)
ProxyConfiguration Placeholder for description of property proxy_configuration of obj type Cloud field type str type object
rancher_configuration (optional)
RancherConfiguration Placeholder for description of property rancher_configuration of obj type Cloud field type str type object
state_based_dns_registration (optional)
Boolean DNS records for VIPs are added/deleted based on the operational state of the VIPs. Field introduced in 17.1.12.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.
vca_configuration (optional)
vCloudAirConfiguration Placeholder for description of property vca_configuration of obj type Cloud field type str type object
vcenter_configuration (optional)
vCenterConfiguration Placeholder for description of property vcenter_configuration of obj type Cloud field type str type object
vtype
String Cloud type. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE.

CloudApiResponse Up

count
Integer format: int32
results

CloudStackConfiguration Up

access_key_id
String CloudStack API Key.
api_url
String CloudStack API URL.
cntr_public_ip (optional)
String If controller's management IP is in a private network, a publicly accessible IP to reach the controller.
hypervisor (optional)
String Default hypervisor type. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN.
mgmt_network_name
String Avi Management network name.
mgmt_network_uuid (optional)
String Avi Management network name.
secret_access_key
String CloudStack Secret Key.

CustomTag Up

tag_key
String tag_key of CustomTag.
tag_val (optional)
String tag_val of CustomTag.

DockerConfiguration Up

app_sync_frequency (optional)
Integer Sync frequency in seconds with frameworks. format: int32
ca_tls_key_and_certificate_ref (optional)
String UUID of the UCP CA TLS cert and key. It is a reference to an object of type SSLKeyAndCertificate.
client_tls_key_and_certificate_ref (optional)
String UUID of the client TLS cert and key. It is a reference to an object of type SSLKeyAndCertificate.
container_port_match_http_service (optional)
Boolean Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService.
coredump_directory (optional)
String 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.
disable_auto_backend_service_sync (optional)
Boolean Disable auto service sync for back end services.
disable_auto_frontend_service_sync (optional)
Boolean Disable auto service sync for front end services.
disable_auto_se_creation (optional)
Boolean Disable SE creation.
docker_registry_se (optional)
DockerRegistry Docker registry for ServiceEngine image.
east_west_placement_subnet (optional)
IpAddrPrefix Match against this prefix when placing east-west VSs on SEs .
enable_event_subscription (optional)
Boolean Enable Docker event subscription.
feproxy_container_port_as_service (optional)
Boolean For Front End proxies, use container port as service port.
feproxy_vips_enable_proxy_arp (optional)
Boolean Enable proxy ARP from Host interface for Front End proxies.
fleet_endpoint (optional)
String Optional fleet remote endpoint if fleet is used for SE deployment.
http_container_ports (optional)
array[Integer] List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80.
se_deployment_method (optional)
String Use Fleet/SSH for SE deployment. Enum options - SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD.
se_exclude_attributes (optional)
array[MesosAttribute] Exclude hosts with attributes for SE creation.
se_include_attributes (optional)
array[MesosAttribute] Create SEs just on hosts with include attributes.
se_spawn_rate (optional)
Integer New SE spawn rate per minute. format: int32
se_volume (optional)
String Host volume to be used as a disk for Avi SE, This is a disruptive change.
services_accessible_all_interfaces (optional)
Boolean 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.
ssh_se_deployment (optional)
SSHSeDeployment Parameters for SSH SE deployment. Field deprecated in 17.1.1.
ssh_user_ref (optional)
String Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1.
ucp_nodes (optional)
array[String] List of Docker UCP nodes; In case of a load balanced UCP cluster, use Virtual IP of the cluster.
use_container_ip_port (optional)
Boolean 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.
use_controller_image (optional)
Boolean If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se.

DockerRegistry Up

oshift_registry (optional)
OshiftDockerRegistryMetaData Openshift integrated registry config.
password (optional)
String Password for docker registry. Authorized 'regular user' password if registry is Openshift integrated registry.
private (optional)
Boolean Set if docker registry is private. Avi controller will not attempt to push SE image to the registry, unless se_repository_push is set.
registry (optional)
String 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/namespace/repo.
se_repository_push (optional)
Boolean Avi Controller will push ServiceEngine image to docker repository.
username (optional)
String Username for docker registry. Authorized 'regular user' if registry is Openshift integrated registry.

FeProxyRoutePublishConfig Up

mode (optional)
String Publish ECMP route to upstream router for VIP. Enum options - FE_PROXY_ROUTE_PUBLISH_NONE, FE_PROXY_ROUTE_PUBLISH_QUAGGA_WEBAPP.
publisher_port (optional)
Integer Listener port for publisher. format: int32
subnet (optional)
Integer Subnet for publisher. format: int32
token (optional)
String Token for tracking changes.

HostAttributes Up

attr_key
String attr_key of HostAttributes.
attr_val (optional)
String attr_val of HostAttributes.

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.

IpAddrPrefix Up

ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32

LinuxServerConfiguration Up

docker_registry_se (optional)
DockerRegistry Private docker registry for SE image storage. Field deprecated in 17.1.2.
hosts (optional)
array[LinuxServerHost] Placeholder for description of property hosts of obj type LinuxServerConfiguration field type str type object
se_inband_mgmt (optional)
Boolean 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.
se_log_disk_path (optional)
String SE Client Logs disk path for cloud.
se_log_disk_size_GB (optional)
Integer SE Client Log disk size for cloud. format: int32
se_sys_disk_path (optional)
String SE System Logs disk path for cloud.
se_sys_disk_size_GB (optional)
Integer SE System Logs disk size for cloud. format: int32
ssh_attr (optional)
SSHSeDeployment Parameters for SSH to hosts. Field deprecated in 17.1.1.
ssh_user_ref (optional)
String Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1.

LinuxServerHost Up

host_attr (optional)
array[HostAttributes] Placeholder for description of property host_attr of obj type LinuxServerHost field type str type object
host_ip
IpAddr Placeholder for description of property host_ip of obj type LinuxServerHost field type str type object
node_availability_zone (optional)
String Node's availability zone. ServiceEngines belonging to the availability zone will be rebooted during a manual DR failover.
se_group_ref (optional)
String The SE Group association for the SE. If None, then 'Default-Group' SEGroup is associated with the SE. It is a reference to an object of type ServiceEngineGroup. Field introduced in 17.2.1.

MarathonConfiguration Up

framework_tag (optional)
String 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.
marathon_password (optional)
String Password for Marathon authentication.
marathon_url (optional)
String Marathon API URL of the form http //host port.
marathon_username (optional)
String Username for Marathon authentication.
private_port_range (optional)
PortRange Private port range allocated to this Marathon framework instance.
public_port_range (optional)
PortRange Public port range allocated to this Marathon framework instance.
tenant (optional)
String 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.
use_token_auth (optional)
Boolean Use Token based authentication instead of basic authentication. Token is refreshed every 5 minutes.
vs_name_tag_framework (optional)
Boolean Tag VS name with framework name or framework_tag. Useful in deployments with multiple frameworks.

MarathonSeDeployment Up

docker_image (optional)
String Docker image to be used for Avi SE installation e.g. fedora, ubuntu.
host_os (optional)
String Host OS distribution e.g. COREOS, UBUNTU, REDHAT.
resource_roles (optional)
array[String] Accepted resource roles for SEs.
uris (optional)
array[String] URIs to be resolved for starting the application.

MesosAttribute Up

attribute
String Attribute to match.
value (optional)
String Attribute value. If not set, match any value.

MesosConfiguration Up

all_vses_are_feproxy (optional)
Boolean 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.
app_sync_frequency (optional)
Integer Sync frequency in seconds with frameworks. format: int32
container_port_match_http_service (optional)
Boolean Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService.
coredump_directory (optional)
String 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.
disable_auto_backend_service_sync (optional)
Boolean Disable auto service sync for back end services.
disable_auto_frontend_service_sync (optional)
Boolean Disable auto service sync for front end services.
disable_auto_gs_sync (optional)
Boolean Disable auto sync for GSLB services. Field introduced in 17.1.2.
disable_auto_se_creation (optional)
Boolean Disable SE creation.
docker_registry_se (optional)
DockerRegistry Docker registry for ServiceEngine image.
east_west_placement_subnet (optional)
IpAddrPrefix Match against this prefix when placing east-west VSs on SEs (Mesos mode only).
enable_event_subscription (optional)
Boolean Enable Marathon event subscriptions.
feproxy_bridge_name (optional)
String Name of second Linux bridge on Host providing connectivity for Front End proxies. This is a disruptive change.
feproxy_container_port_as_service (optional)
Boolean For Front End proxies, use container port as service port.
feproxy_route_publish (optional)
FeProxyRoutePublishConfig Publish ECMP route to upstream router for VIP.
feproxy_vips_enable_proxy_arp (optional)
Boolean Enable proxy ARP from Host interface for Front End proxies.
fleet_endpoint (optional)
String Optional fleet remote endpoint if fleet is used for SE deployment.
http_container_ports (optional)
array[Integer] List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80.
marathon_configurations (optional)
array[MarathonConfiguration] List of Marathon frameworks.
marathon_se_deployment (optional)
MarathonSeDeployment Options for Marathon SE deployment.
mesos_url (optional)
String Mesos URL of the form http //host port.
node_availability_zone_label (optional)
String 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.
nuage_controller (optional)
NuageSDNController Nuage Overlay SDN Controller information.
se_deployment_method (optional)
String Use Fleet/SSH for deploying Service Engines. Enum options - MESOS_SE_CREATE_FLEET, MESOS_SE_CREATE_SSH, MESOS_SE_CREATE_MARATHON.
se_exclude_attributes (optional)
array[MesosAttribute] Exclude hosts with attributes for SE creation.
se_include_attributes (optional)
array[MesosAttribute] Create SEs just on hosts with include attributes.
se_resources (optional)
array[MesosSeResources] Obsolete - ignored.
se_spawn_rate (optional)
Integer New SE spawn rate per minute. format: int32
se_volume (optional)
String Host volume to be used as a disk for Avi SE, This is a disruptive change.
services_accessible_all_interfaces (optional)
Boolean 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.
ssh_se_deployment (optional)
SSHSeDeployment Parameters for SSH SE deployment. Field deprecated in 17.1.1.
ssh_user_ref (optional)
String Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1.
use_bridge_ip_as_vip (optional)
Boolean Use Bridge IP on each Host as VIP.
use_container_ip_port (optional)
Boolean 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.
use_controller_image (optional)
Boolean If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se.
use_vips_for_east_west_services (optional)
Boolean 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.
vip (optional)
IpAddr VIP to be used by all East-West apps on all Hosts. Preferrably use an address from outside the subnet.

MesosSeResources Up

attribute_key
String Attribute (Fleet or Mesos) key of Hosts.
attribute_value
String Attribute (Fleet or Mesos) value of Hosts.
cpu (optional)
Float Obsolete - ignored. format: float
memory (optional)
Integer Obsolete - ignored. format: int32

NsxConfiguration Up

avi_nsx_prefix
String 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. Field introduced in 17.1.1.
nsx_manager_name
String The hostname or IP address of the NSX MGr. Field introduced in 17.1.1.
nsx_manager_password
String The password Avi Vantage will use when authenticating with NSX Mgr. Field introduced in 17.1.1.
nsx_manager_username
String The username Avi Vantage will use when authenticating with NSX Mgr. Field introduced in 17.1.1.
nsx_poll_time
Integer The interval (in secs) with which Avi Controller polls the NSX Manager for updates. Field introduced in 17.1.1. format: int32

NuageSDNController Up

nuage_organization (optional)
String nuage_organization of NuageSDNController.
nuage_password (optional)
String nuage_password of NuageSDNController.
nuage_port (optional)
Integer Number of nuage_port. format: int32
nuage_username (optional)
String nuage_username of NuageSDNController.
nuage_vsd_host (optional)
String Nuage VSD host name or IP address.
se_domain (optional)
String Domain to be used for SE creation.
se_enterprise (optional)
String Enterprise to be used for SE creation.
se_network (optional)
String Network to be used for SE creation.
se_policy_group (optional)
String Policy Group to be used for SE creation.
se_user (optional)
String User to be used for SE creation.
se_zone (optional)
String Zone to be used for SE creation.

OShiftK8SConfiguration Up

app_sync_frequency (optional)
Integer Sync frequency in seconds with frameworks. format: int32
avi_bridge_subnet (optional)
IpAddrPrefix Avi Linux bridge subnet on OpenShift/K8s nodes.
ca_tls_key_and_certificate_ref (optional)
String UUID of the UCP CA TLS cert and key. It is a reference to an object of type SSLKeyAndCertificate.
client_tls_key_and_certificate_ref (optional)
String UUID of the client TLS cert and key instead of service account token. One of client certificate or token is required. It is a reference to an object of type SSLKeyAndCertificate.
container_port_match_http_service (optional)
Boolean Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Set either service_port_match_http_service or container_port_match_http_service.
coredump_directory (optional)
String 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_service_as_east_west_service (optional)
Boolean 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_shared_virtualservice (optional)
OshiftSharedVirtualService Deprecated. Field deprecated in 17.1.9. Field introduced in 17.1.1.
disable_auto_backend_service_sync (optional)
Boolean Disable auto service sync for back end services.
disable_auto_frontend_service_sync (optional)
Boolean Disable auto service sync for front end services.
disable_auto_gs_sync (optional)
Boolean Disable auto sync for GSLB services. Field introduced in 17.1.3.
disable_auto_se_creation (optional)
Boolean Disable SE creation.
docker_registry_se (optional)
DockerRegistry Docker registry for ServiceEngine image.
east_west_placement_subnet (optional)
IpAddrPrefix Match against this prefix when placing east-west VSs on SEs .
enable_event_subscription (optional)
Boolean Enable Kubernetes event subscription.
feproxy_vips_enable_proxy_arp (optional)
Boolean Enable proxy ARP from Host interface for Front End proxies.
fleet_endpoint (optional)
String Optional fleet remote endpoint if fleet is used for SE deployment.
http_container_ports (optional)
array[Integer] List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80.
l4_health_monitoring (optional)
Boolean Perform Layer4 (TCP/UDP) health monitoring even for Layer7 (HTTP) Pools.
master_nodes (optional)
array[String] 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.
node_availability_zone_label (optional)
String 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.
ns_exclude_attributes (optional)
array[MesosAttribute] Syncing of applications is disabled only for namespaces/projects that have these exclude attributes configured. If there are apps synced already for these namespaces, they will be removed from Avi. Field introduced in 17.1.9,17.2.3.
ns_include_attributes (optional)
array[MesosAttribute] Sync applications only for namespaces/projects that have these include attributes configured. Field introduced in 17.1.9,17.2.3.
nuage_controller (optional)
NuageSDNController Nuage Overlay SDN Controller information.
routes_share_virtualservice (optional)
Boolean Deprecated. Field deprecated in 17.1.9. Field introduced in 17.1.1.
sdn_overlay (optional)
Boolean Cluster uses overlay based SDN. Enable this flag if cluster uses a overlay based SDN for OpenShift, Flannel, Weave, Nuage. Disable for routed mode.
se_deployment_method (optional)
String Use SSH/Pod for SE deployment. Enum options - SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD.
se_exclude_attributes (optional)
array[MesosAttribute] Exclude hosts with attributes for SE creation.
se_include_attributes (optional)
array[MesosAttribute] Create SEs just on hosts with include attributes.
se_spawn_rate (optional)
Integer New SE spawn rate per minute. format: int32
se_volume (optional)
String Host volume to be used as a disk for Avi SE, This is a disruptive change.
secure_egress_mode (optional)
Boolean Allow Avi Vantage to create SecurityContextConstraints and ServiceAccounts which allow Egress Pods to run in privileged mode in an Openshift environment. Enabling this would exclude egress services from 'disable_auto_backend_service_sync' (if set) behaviour. Note Access credentials must have cluster-admin role privileges. Field introduced in 17.1.1.
service_account_token (optional)
String Authorization token for service account instead of client certificate. One of client certificate or token is required.
service_port_match_http_service (optional)
Boolean Perform service port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Set either service_port_match_http_service or container_port_match_http_service.
shared_virtualservice_namespace (optional)
Boolean Projects/Namespaces use a shared virtualservice for http/https Routes and Ingress objects unless overriden by the avi_virtualservice dedicated|shared annotation. Field introduced in 17.1.9,17.2.3.
ssh_se_deployment (optional)
SSHSeDeployment Parameters for SSH SE deployment. Field deprecated in 17.1.1.
ssh_user_ref (optional)
String Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1.
use_controller_image (optional)
Boolean If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se.
use_scheduling_disabled_nodes (optional)
Boolean Enable VirtualService placement on Service Engines on nodes with scheduling disabled. When false, Service Engines are disabled on nodes where scheduling is disabled.
use_service_cluster_ip_as_ew_vip (optional)
Boolean Use Cluster IP of service as VIP for East-West services; This option requires that kube proxy is disabled on all nodes.

OpenStackConfiguration Up

admin_tenant
String 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.
admin_tenant_uuid (optional)
String admin-tenant's UUID in OpenStack.
allowed_address_pairs (optional)
Boolean If false, allowed-address-pairs extension will not be used. .
anti_affinity (optional)
Boolean If true, an anti-affinity policy will be applied to all SEs of a SE-Group, else no such policy will be applied.
auth_url (optional)
String Auth URL for connecting to keystone. If this is specified, any value provided for keystone_host is ignored.
config_drive (optional)
Boolean If false, metadata service will be used instead of config-drive functionality to retrieve SE VM metadata.
contrail_endpoint (optional)
String 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.
contrail_plugin (optional)
Boolean Enable Contrail plugin mode. (deprecated).
external_networks (optional)
Boolean If True, allow selection of networks marked as 'external' for management, vip or data networks.
free_floatingips (optional)
Boolean Free unused floating IPs.
hypervisor (optional)
String Default hypervisor type. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN.
hypervisor_properties (optional)
array[OpenStackHypervisorProperties] Custom properties per hypervisor type. Field introduced in 17.2.1.
img_format (optional)
String If OS_IMG_FMT_RAW, use RAW images else use QCOW2 or streamOptimized/flat VMDK as appropriate. . Enum options - OS_IMG_FMT_AUTO, OS_IMG_FMT_QCOW2, OS_IMG_FMT_VMDK, OS_IMG_FMT_RAW, OS_IMG_FMT_FLAT.
import_keystone_tenants (optional)
Boolean Import keystone tenants list into Avi.
insecure (optional)
Boolean Allow self-signed certificates when communicating with https service endpoints.
intf_sec_ips (optional)
Boolean If True, interface-secondary-ips method will be used for VIP association.
keystone_host (optional)
String Keystone's hostname or IP address. (Deprecated) Use auth_url instead.
map_admin_to_cloudadmin (optional)
Boolean If True, map Avi 'admin' tenant to the admin_tenant of the Cloud. Else map Avi 'admin' to OpenStack 'admin' tenant.
mgmt_network_name
String Avi Management network name or cidr.
mgmt_network_uuid (optional)
String Management network UUID.
name_owner (optional)
Boolean If True, embed owner info in VIP port 'name', else embed owner info in 'device_id' field.
neutron_rbac (optional)
Boolean If True, enable neutron rbac discovery of networks shared across tenants/projects.
nuage_organization (optional)
String nuage_organization of OpenStackConfiguration.
nuage_password (optional)
String nuage_password of OpenStackConfiguration.
nuage_port (optional)
Integer Number of nuage_port. format: int32
nuage_username (optional)
String nuage_username of OpenStackConfiguration.
nuage_virtualip (optional)
Boolean Applicable only if allowed-address-pairs is disabled or unusable. VIP placement uses Nuage virtualIp if true, else redirectionTarget. Field introduced in 17.2.3.
nuage_vsd_host (optional)
String Nuage VSD host name or IP address.
password (optional)
String The password Avi Vantage will use when authenticating to Keystone.
port_security (optional)
Boolean 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.
privilege
String Access privilege. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS.
prov_name (optional)
array[String] LBaaS provider name.
region (optional)
String Region name.
role_mapping (optional)
array[OpenStackRoleMapping] 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.
se_group_ref (optional)
String The Service Engine Group to use as template. It is a reference to an object of type ServiceEngineGroup.
security_groups (optional)
Boolean If false, security-groups extension will not be used. .
tenant_se (optional)
Boolean If true, then SEs will be created in the appropriate tenants, else SEs will be created in the admin_tenant.
usable_network_uuids (optional)
array[String] 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. . Field introduced in 17.1.1.
use_admin_url (optional)
Boolean If admin URLs are either inaccessible or not to be accessed from Avi Controller, then set this to False.
use_internal_endpoints (optional)
Boolean Use internalURL for OpenStack endpoints instead of the default publicURL endpoints.
use_keystone_auth (optional)
Boolean Use keystone for user authentication.
use_nuagevip (optional)
Boolean If True, use nuage vip as device_owner of VIP ports, else use neutron LOADBALANCER. Field introduced in 17.2.1.
username
String 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.
wildcard_access (optional)
Boolean If enabled, program SE security group with ingress rule to allow SSH (port 22) access from 0.0.0.0/0. Field deprecated in 17.1.5. Field introduced in 17.1.3.

OpenStackHypervisorProperties Up

hypervisor
String Hypervisor type. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Field introduced in 17.2.1.
image_properties (optional)
array[Property] Custom properties to be associated with the SE image in Glance for this hypervisor type. Field introduced in 17.2.1.

OpenStackRoleMapping Up

avi_role
String Role name in Avi.
os_role
String Role name in OpenStack.

OshiftDockerRegistryMetaData Up

registry_namespace (optional)
String Namespace for the ServiceEngine image to be hosted in Openshift Integrated registry.
registry_service (optional)
String Name of the Integrated registry Service in Openshift.
registry_vip (optional)
IpAddr 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 <this-vip> 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.

OshiftSharedVirtualService Up

virtualservice_name
String Name of shared virtualservice. VirtualService will be created automatically by Cloud Connector. Field introduced in 17.1.1.

PortRange Up

end
Integer TCP/UDP port range end (inclusive). Allowed values are 1-65535. format: int32
start
Integer TCP/UDP port range start (inclusive). Allowed values are 1-65535. format: int32

Property Up

name
String Property name. Field introduced in 17.2.1.
value (optional)
String Property value. Field introduced in 17.2.1.

ProxyConfiguration Up

host
String Proxy hostname or IP address.
password (optional)
String Password for proxy.
port
Integer Proxy port. format: int32
username (optional)
String Username for proxy.

RancherConfiguration Up

access_key (optional)
String Access key.
app_sync_frequency (optional)
Integer Sync frequency in seconds with frameworks. format: int32
container_port_match_http_service (optional)
Boolean Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService.
coredump_directory (optional)
String 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.
disable_auto_backend_service_sync (optional)
Boolean Disable auto service sync for back end services.
disable_auto_frontend_service_sync (optional)
Boolean Disable auto service sync for front end services.
disable_auto_se_creation (optional)
Boolean Disable SE creation.
docker_registry_se (optional)
DockerRegistry Docker registry for ServiceEngine image.
east_west_placement_subnet (optional)
IpAddrPrefix Match against this prefix when placing east-west VSs on SEs .
enable_event_subscription (optional)
Boolean Enable Docker event subscription.
feproxy_container_port_as_service (optional)
Boolean For Front End proxies, use container port as service port.
feproxy_vips_enable_proxy_arp (optional)
Boolean Enable proxy ARP from Host interface for Front End proxies.
fleet_endpoint (optional)
String Optional fleet remote endpoint if fleet is used for SE deployment.
http_container_ports (optional)
array[Integer] List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80.
nuage_controller (optional)
NuageSDNController Nuage Overlay SDN Controller information.
rancher_servers (optional)
array[String] List of Rancher servers; In case of a load balanced Rancher multi cluster, use Virtual IP of the cluster.
se_deployment_method (optional)
String Use Fleet/SSH for SE deployment. Enum options - SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD.
se_exclude_attributes (optional)
array[MesosAttribute] Exclude hosts with attributes for SE creation.
se_include_attributes (optional)
array[MesosAttribute] Create SEs just on hosts with include attributes.
se_spawn_rate (optional)
Integer New SE spawn rate per minute. format: int32
se_volume (optional)
String Host volume to be used as a disk for Avi SE, This is a disruptive change.
secret_key (optional)
String Secret key.
services_accessible_all_interfaces (optional)
Boolean 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.
ssh_se_deployment (optional)
SSHSeDeployment Parameters for SSH SE deployment. Field deprecated in 17.1.1.
ssh_user_ref (optional)
String Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1.
use_container_ip_port (optional)
Boolean 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.
use_controller_image (optional)
Boolean If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se.

SSHSeDeployment Up

host_os (optional)
String Host OS distribution e.g. COREOS, UBUNTU, REDHAT. Field deprecated in 17.1.1.
password (optional)
String Password for ssh and/or sudo. Field deprecated in 17.1.1.
ssh_user (optional)
String Username for SSH access to hosts. Field deprecated in 17.1.1.
sudo_user (optional)
String Username for sudo. Field deprecated in 17.1.1.

vCenterConfiguration Up

datacenter (optional)
String Datacenter for virtual infrastructure discovery.
management_ip_subnet (optional)
IpAddrPrefix Management subnet to use for Avi Service Engines.
management_network (optional)
String Management network to use for Avi Service Engines. It is a reference to an object of type VIMgrNWRuntime.
password (optional)
String The password Avi Vantage will use when authenticating with vCenter.
privilege
String 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. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS.
username (optional)
String The username Avi Vantage will use when authenticating with vCenter.
vcenter_template_se_location (optional)
String Avi Service Engine Template in vCenter to be used for creating Service Engines.
vcenter_url (optional)
String vCenter hostname or IP address.

vCloudAirConfiguration Up

privilege
String vCloudAir access mode. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS.
vca_host
String vCloudAir host address.
vca_instance
String vCloudAir instance ID.
vca_mgmt_network
String vCloudAir management network.
vca_orgnization
String vCloudAir orgnization ID.
vca_password
String vCloudAir password.
vca_username
String vCloudAir username.
vca_vdc
String vCloudAir virtual data center name.