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: 22.1.1
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. get /cloud/{uuid}/placement/ineligible/
  15. get /cloud/{uuid}/placement/summary/
  16. put /cloud/{uuid}
  17. 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.
skip_default (optional)
Query Parameter — Default values are not set.
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
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "autoscale_polling_interval" : 123,
    "maintenance_mode" : true,
    "vtype" : "aeiou",
    "dns_resolvers" : [ {
      "min_ttl" : 123,
      "fixed_ttl" : 123,
      "nameserver_ips" : [ {
        "addr" : "aeiou",
        "type" : "aeiou"
      } ],
      "use_mgmt" : true,
      "resolver_name" : "aeiou"
    } ],
    "ipam_provider_ref" : "aeiou",
    "state_based_dns_registration" : true,
    "aws_configuration" : {
      "access_key_id" : "aeiou",
      "use_sns_sqs" : true,
      "iam_assume_role" : "aeiou",
      "vpc_id" : "aeiou",
      "ebs_encryption" : {
        "mode" : "aeiou",
        "master_key" : "aeiou"
      },
      "secret_access_key" : "aeiou",
      "vpc" : "aeiou",
      "publish_vip_to_public_zone" : true,
      "zones" : [ {
        "availability_zone" : "aeiou",
        "mgmt_network_name" : "aeiou",
        "mgmt_network_uuid" : "aeiou"
      } ],
      "ttl" : 123,
      "asg_poll_interval" : 123,
      "route53_integration" : true,
      "s3_encryption" : "",
      "sqs_encryption" : "",
      "use_iam_roles" : true,
      "region" : "aeiou",
      "free_elasticips" : true
    },
    "east_west_ipam_provider_ref" : "aeiou",
    "gcp_configuration" : {
      "encryption_keys" : {
        "gcs_bucket_kms_key_id" : "aeiou",
        "gcs_objects_kms_key_id" : "aeiou",
        "se_image_kms_key_id" : "aeiou",
        "se_disk_kms_key_id" : "aeiou"
      },
      "gcs_bucket_name" : "aeiou",
      "firewall_target_tags" : [ "aeiou" ],
      "network_config" : {
        "inband" : {
          "vpc_network_name" : "aeiou",
          "vpc_project_id" : "aeiou",
          "vpc_subnet_name" : "aeiou"
        },
        "two_arm" : {
          "backend_data_vpc_network_name" : "aeiou",
          "backend_data_vpc_subnet_name" : "aeiou",
          "frontend_data_vpc_project_id" : "aeiou",
          "frontend_data_vpc_subnet_name" : "aeiou",
          "management_vpc_project_id" : "aeiou",
          "management_vpc_network_name" : "aeiou",
          "management_vpc_subnet_name" : "aeiou",
          "frontend_data_vpc_network_name" : "aeiou",
          "backend_data_vpc_project_id" : "aeiou"
        },
        "one_arm" : {
          "management_vpc_project_id" : "aeiou",
          "data_vpc_subnet_name" : "aeiou",
          "management_vpc_network_name" : "aeiou",
          "management_vpc_subnet_name" : "aeiou",
          "data_vpc_network_name" : "aeiou",
          "data_vpc_project_id" : "aeiou"
        },
        "config" : "aeiou"
      },
      "region_name" : "aeiou",
      "se_project_id" : "aeiou",
      "cloud_credentials_ref" : "aeiou",
      "zones" : [ "aeiou" ],
      "gcp_service_account_email" : "aeiou",
      "gcs_project_id" : "aeiou",
      "vip_allocation_strategy" : {
        "mode" : "aeiou",
        "routes" : {
          "match_se_group_subnet" : true,
          "route_priority" : 123
        },
        "ilb" : {
          "cloud_router_names" : [ "aeiou" ]
        }
      }
    },
    "uuid" : "aeiou",
    "_last_modified" : "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,
      "enable_event_subscription" : true,
      "coredump_directory" : "aeiou",
      "docker_registry_se" : {
        "registry" : "aeiou",
        "password" : "aeiou",
        "private" : true,
        "oshift_registry" : {
          "registry_vip" : "",
          "registry_namespace" : "aeiou",
          "registry_service" : "aeiou"
        },
        "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"
    },
    "dns_provider_ref" : "aeiou",
    "configpb_attributes" : {
      "version" : 123
    },
    "metrics_polling_interval" : 123,
    "proxy_configuration" : {
      "password" : "aeiou",
      "port" : 123,
      "host" : "aeiou",
      "username" : "aeiou"
    },
    "enable_vip_on_all_interfaces" : true,
    "license_type" : "aeiou",
    "vmc_deployment" : true,
    "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"
    },
    "ip6_autocfg_enabled" : true,
    "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,
      "contrail_disable_policy" : true,
      "provider_vip_networks" : [ {
        "os_network_uuid" : "aeiou",
        "os_tenant_uuids" : [ "aeiou" ]
      } ],
      "allowed_address_pairs" : true,
      "hypervisor_properties" : [ {
        "image_properties" : [ "" ],
        "hypervisor" : "aeiou"
      } ],
      "privilege" : "aeiou",
      "custom_se_image_properties" : [ {
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "mgmt_network_uuid" : "aeiou",
      "contrail_plugin" : true,
      "anti_affinity" : true,
      "password" : "aeiou",
      "hypervisor" : "aeiou",
      "tenant_se" : true,
      "img_format" : "aeiou",
      "insecure" : true,
      "mgmt_network_name" : "aeiou",
      "admin_tenant_uuid" : "aeiou",
      "free_floatingips" : 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,
      "prov_name" : [ "aeiou" ],
      "map_admin_to_cloudadmin" : true,
      "neutron_rbac" : true,
      "admin_tenant" : "aeiou",
      "role_mapping" : [ {
        "os_role" : "aeiou",
        "avi_role" : "aeiou"
      } ],
      "use_admin_url" : true,
      "auth_url" : "aeiou",
      "region" : "aeiou",
      "username" : "aeiou"
    },
    "nsxt_configuration" : {
      "domain_id" : "aeiou",
      "data_network_config" : {
        "tz_type" : "aeiou",
        "tier1_segment_config" : {
          "segment_config_mode" : "aeiou",
          "automatic" : {
            "nsxt_segment_subnet" : "",
            "num_se_per_segment" : 123,
            "tier1_lr_ids" : [ "aeiou" ]
          },
          "manual" : {
            "tier1_lrs" : [ {
              "locale_service" : "aeiou",
              "segment_id" : "aeiou",
              "tier1_lr_id" : "aeiou"
            } ]
          }
        },
        "transport_zone" : "aeiou",
        "vlan_segments" : [ "aeiou" ]
      },
      "management_network_config" : {
        "tz_type" : "aeiou",
        "overlay_segment" : "",
        "vlan_segment" : "aeiou",
        "transport_zone" : "aeiou"
      },
      "enforcementpoint_id" : "aeiou",
      "nsxt_url" : "aeiou",
      "nsxt_credentials_ref" : "aeiou",
      "automate_dfw_rules" : true,
      "site_id" : "aeiou"
    },
    "se_group_template_ref" : "aeiou",
    "ntp_configuration" : {
      "ntp_servers" : [ {
        "key_number" : 123,
        "server" : ""
      } ],
      "ntp_authentication_keys" : [ {
        "key_number" : 123,
        "key" : "aeiou",
        "algorithm" : "aeiou"
      } ],
      "ntp_server_list" : [ "" ]
    },
    "dns_resolution_on_se" : true,
    "tenant_ref" : "aeiou",
    "azure_configuration" : {
      "subscription_id" : "aeiou",
      "use_enhanced_ha" : true,
      "use_standard_alb" : true,
      "des_id" : "aeiou",
      "resource_group" : "aeiou",
      "use_azure_dns" : true,
      "availability_zones" : [ "aeiou" ],
      "use_managed_disks" : true,
      "location" : "aeiou",
      "cloud_credentials_ref" : "aeiou",
      "network_info" : [ {
        "management_network_id" : "aeiou",
        "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",
      "content_lib" : {
        "name" : "aeiou",
        "id" : "aeiou"
      },
      "deactivate_vm_discovery" : true,
      "use_content_lib" : true,
      "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,
      "se_sys_disk_size_GB" : 123,
      "se_log_disk_path" : "aeiou"
    },
    "markers" : [ {
      "values" : [ "aeiou" ],
      "key" : "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" : {
        "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"
      },
      "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,
      "enable_event_subscription" : true,
      "coredump_directory" : "aeiou",
      "docker_registry_se" : "",
      "rancher_servers" : [ "aeiou" ],
      "se_exclude_attributes" : [ "" ],
      "access_key" : "aeiou",
      "east_west_placement_subnet" : ""
    },
    "license_tier" : "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 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
{
  "autoscale_polling_interval" : 123,
  "maintenance_mode" : true,
  "vtype" : "aeiou",
  "dns_resolvers" : [ {
    "min_ttl" : 123,
    "fixed_ttl" : 123,
    "nameserver_ips" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "use_mgmt" : true,
    "resolver_name" : "aeiou"
  } ],
  "ipam_provider_ref" : "aeiou",
  "state_based_dns_registration" : true,
  "aws_configuration" : {
    "access_key_id" : "aeiou",
    "use_sns_sqs" : true,
    "iam_assume_role" : "aeiou",
    "vpc_id" : "aeiou",
    "ebs_encryption" : {
      "mode" : "aeiou",
      "master_key" : "aeiou"
    },
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "publish_vip_to_public_zone" : true,
    "zones" : [ {
      "availability_zone" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    } ],
    "ttl" : 123,
    "asg_poll_interval" : 123,
    "route53_integration" : true,
    "s3_encryption" : "",
    "sqs_encryption" : "",
    "use_iam_roles" : true,
    "region" : "aeiou",
    "free_elasticips" : true
  },
  "east_west_ipam_provider_ref" : "aeiou",
  "gcp_configuration" : {
    "encryption_keys" : {
      "gcs_bucket_kms_key_id" : "aeiou",
      "gcs_objects_kms_key_id" : "aeiou",
      "se_image_kms_key_id" : "aeiou",
      "se_disk_kms_key_id" : "aeiou"
    },
    "gcs_bucket_name" : "aeiou",
    "firewall_target_tags" : [ "aeiou" ],
    "network_config" : {
      "inband" : {
        "vpc_network_name" : "aeiou",
        "vpc_project_id" : "aeiou",
        "vpc_subnet_name" : "aeiou"
      },
      "two_arm" : {
        "backend_data_vpc_network_name" : "aeiou",
        "backend_data_vpc_subnet_name" : "aeiou",
        "frontend_data_vpc_project_id" : "aeiou",
        "frontend_data_vpc_subnet_name" : "aeiou",
        "management_vpc_project_id" : "aeiou",
        "management_vpc_network_name" : "aeiou",
        "management_vpc_subnet_name" : "aeiou",
        "frontend_data_vpc_network_name" : "aeiou",
        "backend_data_vpc_project_id" : "aeiou"
      },
      "one_arm" : {
        "management_vpc_project_id" : "aeiou",
        "data_vpc_subnet_name" : "aeiou",
        "management_vpc_network_name" : "aeiou",
        "management_vpc_subnet_name" : "aeiou",
        "data_vpc_network_name" : "aeiou",
        "data_vpc_project_id" : "aeiou"
      },
      "config" : "aeiou"
    },
    "region_name" : "aeiou",
    "se_project_id" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "zones" : [ "aeiou" ],
    "gcp_service_account_email" : "aeiou",
    "gcs_project_id" : "aeiou",
    "vip_allocation_strategy" : {
      "mode" : "aeiou",
      "routes" : {
        "match_se_group_subnet" : true,
        "route_priority" : 123
      },
      "ilb" : {
        "cloud_router_names" : [ "aeiou" ]
      }
    }
  },
  "uuid" : "aeiou",
  "_last_modified" : "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,
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : {
      "registry" : "aeiou",
      "password" : "aeiou",
      "private" : true,
      "oshift_registry" : {
        "registry_vip" : "",
        "registry_namespace" : "aeiou",
        "registry_service" : "aeiou"
      },
      "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"
  },
  "dns_provider_ref" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "metrics_polling_interval" : 123,
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "enable_vip_on_all_interfaces" : true,
  "license_type" : "aeiou",
  "vmc_deployment" : true,
  "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"
  },
  "ip6_autocfg_enabled" : true,
  "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,
    "contrail_disable_policy" : true,
    "provider_vip_networks" : [ {
      "os_network_uuid" : "aeiou",
      "os_tenant_uuids" : [ "aeiou" ]
    } ],
    "allowed_address_pairs" : true,
    "hypervisor_properties" : [ {
      "image_properties" : [ "" ],
      "hypervisor" : "aeiou"
    } ],
    "privilege" : "aeiou",
    "custom_se_image_properties" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "mgmt_network_uuid" : "aeiou",
    "contrail_plugin" : true,
    "anti_affinity" : true,
    "password" : "aeiou",
    "hypervisor" : "aeiou",
    "tenant_se" : true,
    "img_format" : "aeiou",
    "insecure" : true,
    "mgmt_network_name" : "aeiou",
    "admin_tenant_uuid" : "aeiou",
    "free_floatingips" : 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,
    "prov_name" : [ "aeiou" ],
    "map_admin_to_cloudadmin" : true,
    "neutron_rbac" : true,
    "admin_tenant" : "aeiou",
    "role_mapping" : [ {
      "os_role" : "aeiou",
      "avi_role" : "aeiou"
    } ],
    "use_admin_url" : true,
    "auth_url" : "aeiou",
    "region" : "aeiou",
    "username" : "aeiou"
  },
  "nsxt_configuration" : {
    "domain_id" : "aeiou",
    "data_network_config" : {
      "tz_type" : "aeiou",
      "tier1_segment_config" : {
        "segment_config_mode" : "aeiou",
        "automatic" : {
          "nsxt_segment_subnet" : "",
          "num_se_per_segment" : 123,
          "tier1_lr_ids" : [ "aeiou" ]
        },
        "manual" : {
          "tier1_lrs" : [ {
            "locale_service" : "aeiou",
            "segment_id" : "aeiou",
            "tier1_lr_id" : "aeiou"
          } ]
        }
      },
      "transport_zone" : "aeiou",
      "vlan_segments" : [ "aeiou" ]
    },
    "management_network_config" : {
      "tz_type" : "aeiou",
      "overlay_segment" : "",
      "vlan_segment" : "aeiou",
      "transport_zone" : "aeiou"
    },
    "enforcementpoint_id" : "aeiou",
    "nsxt_url" : "aeiou",
    "nsxt_credentials_ref" : "aeiou",
    "automate_dfw_rules" : true,
    "site_id" : "aeiou"
  },
  "se_group_template_ref" : "aeiou",
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "dns_resolution_on_se" : true,
  "tenant_ref" : "aeiou",
  "azure_configuration" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "use_standard_alb" : true,
    "des_id" : "aeiou",
    "resource_group" : "aeiou",
    "use_azure_dns" : true,
    "availability_zones" : [ "aeiou" ],
    "use_managed_disks" : true,
    "location" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "network_info" : [ {
      "management_network_id" : "aeiou",
      "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",
    "content_lib" : {
      "name" : "aeiou",
      "id" : "aeiou"
    },
    "deactivate_vm_discovery" : true,
    "use_content_lib" : true,
    "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,
    "se_sys_disk_size_GB" : 123,
    "se_log_disk_path" : "aeiou"
  },
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "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" : {
      "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"
    },
    "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,
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "rancher_servers" : [ "aeiou" ],
    "se_exclude_attributes" : [ "" ],
    "access_key" : "aeiou",
    "east_west_placement_subnet" : ""
  },
  "license_tier" : "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 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.
skip_default (optional)
Query Parameter — Default values are not set.
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
{
  "autoscale_polling_interval" : 123,
  "maintenance_mode" : true,
  "vtype" : "aeiou",
  "dns_resolvers" : [ {
    "min_ttl" : 123,
    "fixed_ttl" : 123,
    "nameserver_ips" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "use_mgmt" : true,
    "resolver_name" : "aeiou"
  } ],
  "ipam_provider_ref" : "aeiou",
  "state_based_dns_registration" : true,
  "aws_configuration" : {
    "access_key_id" : "aeiou",
    "use_sns_sqs" : true,
    "iam_assume_role" : "aeiou",
    "vpc_id" : "aeiou",
    "ebs_encryption" : {
      "mode" : "aeiou",
      "master_key" : "aeiou"
    },
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "publish_vip_to_public_zone" : true,
    "zones" : [ {
      "availability_zone" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    } ],
    "ttl" : 123,
    "asg_poll_interval" : 123,
    "route53_integration" : true,
    "s3_encryption" : "",
    "sqs_encryption" : "",
    "use_iam_roles" : true,
    "region" : "aeiou",
    "free_elasticips" : true
  },
  "east_west_ipam_provider_ref" : "aeiou",
  "gcp_configuration" : {
    "encryption_keys" : {
      "gcs_bucket_kms_key_id" : "aeiou",
      "gcs_objects_kms_key_id" : "aeiou",
      "se_image_kms_key_id" : "aeiou",
      "se_disk_kms_key_id" : "aeiou"
    },
    "gcs_bucket_name" : "aeiou",
    "firewall_target_tags" : [ "aeiou" ],
    "network_config" : {
      "inband" : {
        "vpc_network_name" : "aeiou",
        "vpc_project_id" : "aeiou",
        "vpc_subnet_name" : "aeiou"
      },
      "two_arm" : {
        "backend_data_vpc_network_name" : "aeiou",
        "backend_data_vpc_subnet_name" : "aeiou",
        "frontend_data_vpc_project_id" : "aeiou",
        "frontend_data_vpc_subnet_name" : "aeiou",
        "management_vpc_project_id" : "aeiou",
        "management_vpc_network_name" : "aeiou",
        "management_vpc_subnet_name" : "aeiou",
        "frontend_data_vpc_network_name" : "aeiou",
        "backend_data_vpc_project_id" : "aeiou"
      },
      "one_arm" : {
        "management_vpc_project_id" : "aeiou",
        "data_vpc_subnet_name" : "aeiou",
        "management_vpc_network_name" : "aeiou",
        "management_vpc_subnet_name" : "aeiou",
        "data_vpc_network_name" : "aeiou",
        "data_vpc_project_id" : "aeiou"
      },
      "config" : "aeiou"
    },
    "region_name" : "aeiou",
    "se_project_id" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "zones" : [ "aeiou" ],
    "gcp_service_account_email" : "aeiou",
    "gcs_project_id" : "aeiou",
    "vip_allocation_strategy" : {
      "mode" : "aeiou",
      "routes" : {
        "match_se_group_subnet" : true,
        "route_priority" : 123
      },
      "ilb" : {
        "cloud_router_names" : [ "aeiou" ]
      }
    }
  },
  "uuid" : "aeiou",
  "_last_modified" : "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,
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : {
      "registry" : "aeiou",
      "password" : "aeiou",
      "private" : true,
      "oshift_registry" : {
        "registry_vip" : "",
        "registry_namespace" : "aeiou",
        "registry_service" : "aeiou"
      },
      "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"
  },
  "dns_provider_ref" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "metrics_polling_interval" : 123,
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "enable_vip_on_all_interfaces" : true,
  "license_type" : "aeiou",
  "vmc_deployment" : true,
  "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"
  },
  "ip6_autocfg_enabled" : true,
  "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,
    "contrail_disable_policy" : true,
    "provider_vip_networks" : [ {
      "os_network_uuid" : "aeiou",
      "os_tenant_uuids" : [ "aeiou" ]
    } ],
    "allowed_address_pairs" : true,
    "hypervisor_properties" : [ {
      "image_properties" : [ "" ],
      "hypervisor" : "aeiou"
    } ],
    "privilege" : "aeiou",
    "custom_se_image_properties" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "mgmt_network_uuid" : "aeiou",
    "contrail_plugin" : true,
    "anti_affinity" : true,
    "password" : "aeiou",
    "hypervisor" : "aeiou",
    "tenant_se" : true,
    "img_format" : "aeiou",
    "insecure" : true,
    "mgmt_network_name" : "aeiou",
    "admin_tenant_uuid" : "aeiou",
    "free_floatingips" : 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,
    "prov_name" : [ "aeiou" ],
    "map_admin_to_cloudadmin" : true,
    "neutron_rbac" : true,
    "admin_tenant" : "aeiou",
    "role_mapping" : [ {
      "os_role" : "aeiou",
      "avi_role" : "aeiou"
    } ],
    "use_admin_url" : true,
    "auth_url" : "aeiou",
    "region" : "aeiou",
    "username" : "aeiou"
  },
  "nsxt_configuration" : {
    "domain_id" : "aeiou",
    "data_network_config" : {
      "tz_type" : "aeiou",
      "tier1_segment_config" : {
        "segment_config_mode" : "aeiou",
        "automatic" : {
          "nsxt_segment_subnet" : "",
          "num_se_per_segment" : 123,
          "tier1_lr_ids" : [ "aeiou" ]
        },
        "manual" : {
          "tier1_lrs" : [ {
            "locale_service" : "aeiou",
            "segment_id" : "aeiou",
            "tier1_lr_id" : "aeiou"
          } ]
        }
      },
      "transport_zone" : "aeiou",
      "vlan_segments" : [ "aeiou" ]
    },
    "management_network_config" : {
      "tz_type" : "aeiou",
      "overlay_segment" : "",
      "vlan_segment" : "aeiou",
      "transport_zone" : "aeiou"
    },
    "enforcementpoint_id" : "aeiou",
    "nsxt_url" : "aeiou",
    "nsxt_credentials_ref" : "aeiou",
    "automate_dfw_rules" : true,
    "site_id" : "aeiou"
  },
  "se_group_template_ref" : "aeiou",
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "dns_resolution_on_se" : true,
  "tenant_ref" : "aeiou",
  "azure_configuration" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "use_standard_alb" : true,
    "des_id" : "aeiou",
    "resource_group" : "aeiou",
    "use_azure_dns" : true,
    "availability_zones" : [ "aeiou" ],
    "use_managed_disks" : true,
    "location" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "network_info" : [ {
      "management_network_id" : "aeiou",
      "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",
    "content_lib" : {
      "name" : "aeiou",
      "id" : "aeiou"
    },
    "deactivate_vm_discovery" : true,
    "use_content_lib" : true,
    "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,
    "se_sys_disk_size_GB" : 123,
    "se_log_disk_path" : "aeiou"
  },
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "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" : {
      "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"
    },
    "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,
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "rancher_servers" : [ "aeiou" ],
    "se_exclude_attributes" : [ "" ],
    "access_key" : "aeiou",
    "east_west_placement_subnet" : ""
  },
  "license_tier" : "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 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
{
  "autoscale_polling_interval" : 123,
  "maintenance_mode" : true,
  "vtype" : "aeiou",
  "dns_resolvers" : [ {
    "min_ttl" : 123,
    "fixed_ttl" : 123,
    "nameserver_ips" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "use_mgmt" : true,
    "resolver_name" : "aeiou"
  } ],
  "ipam_provider_ref" : "aeiou",
  "state_based_dns_registration" : true,
  "aws_configuration" : {
    "access_key_id" : "aeiou",
    "use_sns_sqs" : true,
    "iam_assume_role" : "aeiou",
    "vpc_id" : "aeiou",
    "ebs_encryption" : {
      "mode" : "aeiou",
      "master_key" : "aeiou"
    },
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "publish_vip_to_public_zone" : true,
    "zones" : [ {
      "availability_zone" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    } ],
    "ttl" : 123,
    "asg_poll_interval" : 123,
    "route53_integration" : true,
    "s3_encryption" : "",
    "sqs_encryption" : "",
    "use_iam_roles" : true,
    "region" : "aeiou",
    "free_elasticips" : true
  },
  "east_west_ipam_provider_ref" : "aeiou",
  "gcp_configuration" : {
    "encryption_keys" : {
      "gcs_bucket_kms_key_id" : "aeiou",
      "gcs_objects_kms_key_id" : "aeiou",
      "se_image_kms_key_id" : "aeiou",
      "se_disk_kms_key_id" : "aeiou"
    },
    "gcs_bucket_name" : "aeiou",
    "firewall_target_tags" : [ "aeiou" ],
    "network_config" : {
      "inband" : {
        "vpc_network_name" : "aeiou",
        "vpc_project_id" : "aeiou",
        "vpc_subnet_name" : "aeiou"
      },
      "two_arm" : {
        "backend_data_vpc_network_name" : "aeiou",
        "backend_data_vpc_subnet_name" : "aeiou",
        "frontend_data_vpc_project_id" : "aeiou",
        "frontend_data_vpc_subnet_name" : "aeiou",
        "management_vpc_project_id" : "aeiou",
        "management_vpc_network_name" : "aeiou",
        "management_vpc_subnet_name" : "aeiou",
        "frontend_data_vpc_network_name" : "aeiou",
        "backend_data_vpc_project_id" : "aeiou"
      },
      "one_arm" : {
        "management_vpc_project_id" : "aeiou",
        "data_vpc_subnet_name" : "aeiou",
        "management_vpc_network_name" : "aeiou",
        "management_vpc_subnet_name" : "aeiou",
        "data_vpc_network_name" : "aeiou",
        "data_vpc_project_id" : "aeiou"
      },
      "config" : "aeiou"
    },
    "region_name" : "aeiou",
    "se_project_id" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "zones" : [ "aeiou" ],
    "gcp_service_account_email" : "aeiou",
    "gcs_project_id" : "aeiou",
    "vip_allocation_strategy" : {
      "mode" : "aeiou",
      "routes" : {
        "match_se_group_subnet" : true,
        "route_priority" : 123
      },
      "ilb" : {
        "cloud_router_names" : [ "aeiou" ]
      }
    }
  },
  "uuid" : "aeiou",
  "_last_modified" : "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,
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : {
      "registry" : "aeiou",
      "password" : "aeiou",
      "private" : true,
      "oshift_registry" : {
        "registry_vip" : "",
        "registry_namespace" : "aeiou",
        "registry_service" : "aeiou"
      },
      "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"
  },
  "dns_provider_ref" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "metrics_polling_interval" : 123,
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "enable_vip_on_all_interfaces" : true,
  "license_type" : "aeiou",
  "vmc_deployment" : true,
  "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"
  },
  "ip6_autocfg_enabled" : true,
  "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,
    "contrail_disable_policy" : true,
    "provider_vip_networks" : [ {
      "os_network_uuid" : "aeiou",
      "os_tenant_uuids" : [ "aeiou" ]
    } ],
    "allowed_address_pairs" : true,
    "hypervisor_properties" : [ {
      "image_properties" : [ "" ],
      "hypervisor" : "aeiou"
    } ],
    "privilege" : "aeiou",
    "custom_se_image_properties" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "mgmt_network_uuid" : "aeiou",
    "contrail_plugin" : true,
    "anti_affinity" : true,
    "password" : "aeiou",
    "hypervisor" : "aeiou",
    "tenant_se" : true,
    "img_format" : "aeiou",
    "insecure" : true,
    "mgmt_network_name" : "aeiou",
    "admin_tenant_uuid" : "aeiou",
    "free_floatingips" : 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,
    "prov_name" : [ "aeiou" ],
    "map_admin_to_cloudadmin" : true,
    "neutron_rbac" : true,
    "admin_tenant" : "aeiou",
    "role_mapping" : [ {
      "os_role" : "aeiou",
      "avi_role" : "aeiou"
    } ],
    "use_admin_url" : true,
    "auth_url" : "aeiou",
    "region" : "aeiou",
    "username" : "aeiou"
  },
  "nsxt_configuration" : {
    "domain_id" : "aeiou",
    "data_network_config" : {
      "tz_type" : "aeiou",
      "tier1_segment_config" : {
        "segment_config_mode" : "aeiou",
        "automatic" : {
          "nsxt_segment_subnet" : "",
          "num_se_per_segment" : 123,
          "tier1_lr_ids" : [ "aeiou" ]
        },
        "manual" : {
          "tier1_lrs" : [ {
            "locale_service" : "aeiou",
            "segment_id" : "aeiou",
            "tier1_lr_id" : "aeiou"
          } ]
        }
      },
      "transport_zone" : "aeiou",
      "vlan_segments" : [ "aeiou" ]
    },
    "management_network_config" : {
      "tz_type" : "aeiou",
      "overlay_segment" : "",
      "vlan_segment" : "aeiou",
      "transport_zone" : "aeiou"
    },
    "enforcementpoint_id" : "aeiou",
    "nsxt_url" : "aeiou",
    "nsxt_credentials_ref" : "aeiou",
    "automate_dfw_rules" : true,
    "site_id" : "aeiou"
  },
  "se_group_template_ref" : "aeiou",
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "dns_resolution_on_se" : true,
  "tenant_ref" : "aeiou",
  "azure_configuration" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "use_standard_alb" : true,
    "des_id" : "aeiou",
    "resource_group" : "aeiou",
    "use_azure_dns" : true,
    "availability_zones" : [ "aeiou" ],
    "use_managed_disks" : true,
    "location" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "network_info" : [ {
      "management_network_id" : "aeiou",
      "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",
    "content_lib" : {
      "name" : "aeiou",
      "id" : "aeiou"
    },
    "deactivate_vm_discovery" : true,
    "use_content_lib" : true,
    "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,
    "se_sys_disk_size_GB" : 123,
    "se_log_disk_path" : "aeiou"
  },
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "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" : {
      "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"
    },
    "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,
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "rancher_servers" : [ "aeiou" ],
    "se_exclude_attributes" : [ "" ],
    "access_key" : "aeiou",
    "east_west_placement_subnet" : ""
  },
  "license_tier" : "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 Cloud

401

log in failed

Up
get /cloud/{uuid}/placement/ineligible/
(cloudUuidPlacementIneligibleGet)

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}/placement/summary/
(cloudUuidPlacementSummaryGet)

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}
(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
{
  "autoscale_polling_interval" : 123,
  "maintenance_mode" : true,
  "vtype" : "aeiou",
  "dns_resolvers" : [ {
    "min_ttl" : 123,
    "fixed_ttl" : 123,
    "nameserver_ips" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "use_mgmt" : true,
    "resolver_name" : "aeiou"
  } ],
  "ipam_provider_ref" : "aeiou",
  "state_based_dns_registration" : true,
  "aws_configuration" : {
    "access_key_id" : "aeiou",
    "use_sns_sqs" : true,
    "iam_assume_role" : "aeiou",
    "vpc_id" : "aeiou",
    "ebs_encryption" : {
      "mode" : "aeiou",
      "master_key" : "aeiou"
    },
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "publish_vip_to_public_zone" : true,
    "zones" : [ {
      "availability_zone" : "aeiou",
      "mgmt_network_name" : "aeiou",
      "mgmt_network_uuid" : "aeiou"
    } ],
    "ttl" : 123,
    "asg_poll_interval" : 123,
    "route53_integration" : true,
    "s3_encryption" : "",
    "sqs_encryption" : "",
    "use_iam_roles" : true,
    "region" : "aeiou",
    "free_elasticips" : true
  },
  "east_west_ipam_provider_ref" : "aeiou",
  "gcp_configuration" : {
    "encryption_keys" : {
      "gcs_bucket_kms_key_id" : "aeiou",
      "gcs_objects_kms_key_id" : "aeiou",
      "se_image_kms_key_id" : "aeiou",
      "se_disk_kms_key_id" : "aeiou"
    },
    "gcs_bucket_name" : "aeiou",
    "firewall_target_tags" : [ "aeiou" ],
    "network_config" : {
      "inband" : {
        "vpc_network_name" : "aeiou",
        "vpc_project_id" : "aeiou",
        "vpc_subnet_name" : "aeiou"
      },
      "two_arm" : {
        "backend_data_vpc_network_name" : "aeiou",
        "backend_data_vpc_subnet_name" : "aeiou",
        "frontend_data_vpc_project_id" : "aeiou",
        "frontend_data_vpc_subnet_name" : "aeiou",
        "management_vpc_project_id" : "aeiou",
        "management_vpc_network_name" : "aeiou",
        "management_vpc_subnet_name" : "aeiou",
        "frontend_data_vpc_network_name" : "aeiou",
        "backend_data_vpc_project_id" : "aeiou"
      },
      "one_arm" : {
        "management_vpc_project_id" : "aeiou",
        "data_vpc_subnet_name" : "aeiou",
        "management_vpc_network_name" : "aeiou",
        "management_vpc_subnet_name" : "aeiou",
        "data_vpc_network_name" : "aeiou",
        "data_vpc_project_id" : "aeiou"
      },
      "config" : "aeiou"
    },
    "region_name" : "aeiou",
    "se_project_id" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "zones" : [ "aeiou" ],
    "gcp_service_account_email" : "aeiou",
    "gcs_project_id" : "aeiou",
    "vip_allocation_strategy" : {
      "mode" : "aeiou",
      "routes" : {
        "match_se_group_subnet" : true,
        "route_priority" : 123
      },
      "ilb" : {
        "cloud_router_names" : [ "aeiou" ]
      }
    }
  },
  "uuid" : "aeiou",
  "_last_modified" : "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,
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : {
      "registry" : "aeiou",
      "password" : "aeiou",
      "private" : true,
      "oshift_registry" : {
        "registry_vip" : "",
        "registry_namespace" : "aeiou",
        "registry_service" : "aeiou"
      },
      "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"
  },
  "dns_provider_ref" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "metrics_polling_interval" : 123,
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "enable_vip_on_all_interfaces" : true,
  "license_type" : "aeiou",
  "vmc_deployment" : true,
  "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"
  },
  "ip6_autocfg_enabled" : true,
  "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,
    "contrail_disable_policy" : true,
    "provider_vip_networks" : [ {
      "os_network_uuid" : "aeiou",
      "os_tenant_uuids" : [ "aeiou" ]
    } ],
    "allowed_address_pairs" : true,
    "hypervisor_properties" : [ {
      "image_properties" : [ "" ],
      "hypervisor" : "aeiou"
    } ],
    "privilege" : "aeiou",
    "custom_se_image_properties" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "mgmt_network_uuid" : "aeiou",
    "contrail_plugin" : true,
    "anti_affinity" : true,
    "password" : "aeiou",
    "hypervisor" : "aeiou",
    "tenant_se" : true,
    "img_format" : "aeiou",
    "insecure" : true,
    "mgmt_network_name" : "aeiou",
    "admin_tenant_uuid" : "aeiou",
    "free_floatingips" : 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,
    "prov_name" : [ "aeiou" ],
    "map_admin_to_cloudadmin" : true,
    "neutron_rbac" : true,
    "admin_tenant" : "aeiou",
    "role_mapping" : [ {
      "os_role" : "aeiou",
      "avi_role" : "aeiou"
    } ],
    "use_admin_url" : true,
    "auth_url" : "aeiou",
    "region" : "aeiou",
    "username" : "aeiou"
  },
  "nsxt_configuration" : {
    "domain_id" : "aeiou",
    "data_network_config" : {
      "tz_type" : "aeiou",
      "tier1_segment_config" : {
        "segment_config_mode" : "aeiou",
        "automatic" : {
          "nsxt_segment_subnet" : "",
          "num_se_per_segment" : 123,
          "tier1_lr_ids" : [ "aeiou" ]
        },
        "manual" : {
          "tier1_lrs" : [ {
            "locale_service" : "aeiou",
            "segment_id" : "aeiou",
            "tier1_lr_id" : "aeiou"
          } ]
        }
      },
      "transport_zone" : "aeiou",
      "vlan_segments" : [ "aeiou" ]
    },
    "management_network_config" : {
      "tz_type" : "aeiou",
      "overlay_segment" : "",
      "vlan_segment" : "aeiou",
      "transport_zone" : "aeiou"
    },
    "enforcementpoint_id" : "aeiou",
    "nsxt_url" : "aeiou",
    "nsxt_credentials_ref" : "aeiou",
    "automate_dfw_rules" : true,
    "site_id" : "aeiou"
  },
  "se_group_template_ref" : "aeiou",
  "ntp_configuration" : {
    "ntp_servers" : [ {
      "key_number" : 123,
      "server" : ""
    } ],
    "ntp_authentication_keys" : [ {
      "key_number" : 123,
      "key" : "aeiou",
      "algorithm" : "aeiou"
    } ],
    "ntp_server_list" : [ "" ]
  },
  "dns_resolution_on_se" : true,
  "tenant_ref" : "aeiou",
  "azure_configuration" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "use_standard_alb" : true,
    "des_id" : "aeiou",
    "resource_group" : "aeiou",
    "use_azure_dns" : true,
    "availability_zones" : [ "aeiou" ],
    "use_managed_disks" : true,
    "location" : "aeiou",
    "cloud_credentials_ref" : "aeiou",
    "network_info" : [ {
      "management_network_id" : "aeiou",
      "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",
    "content_lib" : {
      "name" : "aeiou",
      "id" : "aeiou"
    },
    "deactivate_vm_discovery" : true,
    "use_content_lib" : true,
    "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,
    "se_sys_disk_size_GB" : 123,
    "se_log_disk_path" : "aeiou"
  },
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "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" : {
      "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"
    },
    "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,
    "enable_event_subscription" : true,
    "coredump_directory" : "aeiou",
    "docker_registry_se" : "",
    "rancher_servers" : [ "aeiou" ],
    "se_exclude_attributes" : [ "" ],
    "access_key" : "aeiou",
    "east_west_placement_subnet" : ""
  },
  "license_tier" : "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 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. AwsConfiguration
  2. AwsEncryption
  3. AwsZoneConfig
  4. AzureConfiguration
  5. AzureNetworkInfo
  6. Cloud
  7. CloudApiResponse
  8. CloudStackConfiguration
  9. ConfigPbAttributes
  10. ContentLibConfig
  11. CustomTag
  12. DataNetworkConfig
  13. DnsResolver
  14. DockerConfiguration
  15. DockerRegistry
  16. FeProxyRoutePublishConfig
  17. GCPConfiguration
  18. GCPEncryptionKeys
  19. GCPInBandManagement
  20. GCPNetworkConfig
  21. GCPOneArmMode
  22. GCPTwoArmMode
  23. GCPVIPAllocation
  24. GCPVIPILB
  25. GCPVIPRoutes
  26. HostAttributes
  27. IngAttribute
  28. IpAddr
  29. IpAddrPrefix
  30. LinuxServerConfiguration
  31. LinuxServerHost
  32. ManagementNetworkConfig
  33. MarathonConfiguration
  34. MarathonSeDeployment
  35. MesosAttribute
  36. MesosConfiguration
  37. MesosSeResources
  38. NTPAuthenticationKey
  39. NTPConfiguration
  40. NTPServer
  41. NsxtConfiguration
  42. NsxtTier1SegmentAutomaticMode
  43. NsxtTier1SegmentConfig
  44. NsxtTier1SegmentManualMode
  45. NuageSDNController
  46. OShiftK8SConfiguration
  47. OpenStackConfiguration
  48. OpenStackHypervisorProperties
  49. OpenStackRoleMapping
  50. OpenStackVipNetwork
  51. OshiftDockerRegistryMetaData
  52. OshiftSharedVirtualService
  53. PodToleration
  54. PortRange
  55. Property
  56. ProxyConfiguration
  57. RancherConfiguration
  58. RoleFilterMatchLabel
  59. RouteInfo
  60. Tier1LogicalRouterInfo
  61. vCenterConfiguration
  62. vCloudAirConfiguration

AwsConfiguration Up

access_key_id (optional)
String AWS access key ID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
ebs_encryption (optional)
AwsEncryption EBS encryption mode and the master key to be used for encrypting SE AMI, Volumes, and Snapshots. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
free_elasticips (optional)
Boolean Free unused elastic IP addresses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
iam_assume_role (optional)
String IAM assume role for cross-account access. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
publish_vip_to_public_zone (optional)
Boolean If enabled and the virtual service is not floating ip capable, vip will be published to both private and public zones. Field introduced in 17.2.10. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
region (optional)
String AWS region. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
route53_integration (optional)
Boolean If enabled, create/update DNS entries in Amazon Route 53 zones. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
s3_encryption (optional)
AwsEncryption 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
secret_access_key (optional)
String AWS secret access key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sqs_encryption (optional)
AwsEncryption Server Side Encryption to be used for encrypting SQS Queues. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ttl (optional)
Integer Default TTL for all records. Allowed values are 1-172800. Field introduced in 17.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
use_iam_roles (optional)
Boolean Use IAM roles instead of access and secret key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_sns_sqs (optional)
Boolean Use SNS/SQS based notifications for monitoring Auto Scaling Groups. Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vpc (optional)
String VPC name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vpc_id
String VPC ID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
zones (optional)
array[AwsZoneConfig] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

AwsEncryption Up

master_key (optional)
String AWS KMS ARN ID of the master key for encryption. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mode (optional)
String AWS encryption mode. Enum options - AWS_ENCRYPTION_MODE_NONE, AWS_ENCRYPTION_MODE_SSE_KMS. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

AwsZoneConfig Up

availability_zone
String Availability zone. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mgmt_network_name
String Name or CIDR of the network in the Availability Zone that will be used as management network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mgmt_network_uuid (optional)
String UUID of the network in the Availability Zone that will be used as management network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

AzureConfiguration Up

availability_zones (optional)
array[String] Availability zones to be used in Azure. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
des_id (optional)
String Disks Encryption Set resource-id (des_id) to encrypt se image and managed disk using customer-managed-keys. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
location (optional)
String Azure location where this cloud will be located. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_info (optional)
array[AzureNetworkInfo] Azure virtual network and subnet information. Field introduced in 17.2.1. Minimum of 1 items required. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subscription_id (optional)
String Subscription Id for the Azure subscription. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_azure_dns (optional)
Boolean Azure is the DNS provider. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_managed_disks (optional)
Boolean Use Azure managed disks for SE storage. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_standard_alb (optional)
Boolean Use Standard SKU Azure Load Balancer. By default Basic SKU Load Balancer is used. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

AzureNetworkInfo Up

management_network_id (optional)
String Id of the Azure subnet used as management network for the Service Engines. If set, Service Engines will have a dedicated management NIC, otherwise, they operate in inband mode. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_network_id (optional)
String Id of the Azure subnet where Avi Controller will create the Service Engines. . Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
virtual_network_id (optional)
String Virtual network where Virtual IPs will belong. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Cloud Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
autoscale_polling_interval (optional)
Integer CloudConnector polling interval in seconds for external autoscale groups, minimum 60 seconds. Allowed values are 60-3600. Field introduced in 18.2.2. Unit is SECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 60), Basic edition(Allowed values- 60), Enterprise with Cloud Services edition. format: int32
aws_configuration (optional)
AwsConfiguration Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
azure_configuration (optional)
AzureConfiguration Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
cloudstack_configuration (optional)
CloudStackConfiguration Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
custom_tags (optional)
array[CustomTag] Custom tags for all Avi created resources in the cloud infrastructure. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dhcp_enabled (optional)
Boolean Select the IP address management scheme. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dns_provider_ref (optional)
String DNS Profile for the cloud. It is a reference to an object of type IpamDnsProviderProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
dns_resolution_on_se (optional)
Boolean By default, pool member FQDNs are resolved on the Controller. When this is set, pool member FQDNs are instead resolved on Service Engines in this cloud. This is useful in scenarios where pool member FQDNs can only be resolved from Service Engines and not from the Controller. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
dns_resolvers (optional)
array[DnsResolver] DNS resolver for the cloud. Field introduced in 20.1.5. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
docker_configuration (optional)
DockerConfiguration Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
east_west_dns_provider_ref (optional)
String DNS Profile for East-West services. It is a reference to an object of type IpamDnsProviderProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enable_vip_on_all_interfaces (optional)
Boolean Enable VIP on all data interfaces for the Cloud. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_vip_static_routes (optional)
Boolean Use static routes for VIP side network resolution during VirtualService placement. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
gcp_configuration (optional)
GCPConfiguration Google Cloud Platform Configuration. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip6_autocfg_enabled (optional)
Boolean Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipam_provider_ref (optional)
String Ipam Profile for the cloud. It is a reference to an object of type IpamDnsProviderProfile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
license_tier (optional)
String Specifies the default license tier which would be used by new SE Groups. This field by default inherits the value from system configuration. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS, ENTERPRISE_WITH_CLOUD_SERVICES. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
linuxserver_configuration (optional)
LinuxServerConfiguration Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
maintenance_mode (optional)
Boolean Cloud is in maintenance mode. Field introduced in 20.1.7,21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
metrics_polling_interval (optional)
Integer Cloud metrics collector polling interval in seconds. Field introduced in 22.1.1. Unit is SECONDS. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
mtu (optional)
Integer MTU setting for the cloud. Unit is BYTES. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nsxt_configuration (optional)
NsxtConfiguration NSX-T Cloud Platform Configuration. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
ntp_configuration (optional)
NTPConfiguration NTP Configuration for the cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
openstack_configuration (optional)
OpenStackConfiguration Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
prefer_static_routes (optional)
Boolean Prefer static routes over interface routes during VirtualService placement. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
proxy_configuration (optional)
ProxyConfiguration Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
rancher_configuration (optional)
RancherConfiguration Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_group_template_ref (optional)
String The Service Engine Group to use as template. It is a reference to an object of type ServiceEngineGroup. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_configuration (optional)
vCloudAirConfiguration Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vcenter_configuration (optional)
vCenterConfiguration Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
vmc_deployment (optional)
Boolean This deployment is VMware on AWS cloud. Field introduced in 20.1.5, 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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, CLOUD_GCP, CLOUD_NSXT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- CLOUD_NONE,CLOUD_VCENTER), Basic edition(Allowed values- CLOUD_NONE,CLOUD_NSXT), Enterprise with Cloud Services edition.

CloudApiResponse Up

count
Integer format: int32
results
next (optional)

CloudStackConfiguration Up

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

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

ContentLibConfig Up

id (optional)
String Content Library Id. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Content Library name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

CustomTag Up

tag_key
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tag_val (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

DataNetworkConfig Up

tier1_segment_config (optional)
NsxtTier1SegmentConfig Nsxt tier1 segment configuration for Avi Service Engine data path. This should be set only when transport zone is of type OVERLAY. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
transport_zone
String Data transport zone path for Avi Service Engines. Example- /infra/sites/default/enforcement-points/default/transport-zones/xxx-xxx-xxxx. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
tz_type
String Data transport zone type overlay or vlan. Enum options - OVERLAY, VLAN. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
vlan_segments (optional)
array[String] Data vlan segments path to use for Avi Service Engines. Example- /infra/segments/vlanls. This should be set only when transport zone is of type VLAN. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

DnsResolver Up

fixed_ttl (optional)
Integer If configured, this value used for refreshing the DNS entries.Overrides both received_ttl and min_ttl. The entries are refreshed only on fixed_ttleven when received_ttl is less than fixed_ttl. Allowed values are 5-2147483647. Field introduced in 20.1.5. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
min_ttl (optional)
Integer If configured, the min_ttl overrides the ttl from responses when ttl < min_ttl,effectively ttl = max(recieved_ttl, min_ttl). Allowed values are 5-2147483647. Field introduced in 20.1.5. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
nameserver_ips (optional)
array[IpAddr] Name server IPv4 addresses. Field introduced in 20.1.5. Minimum of 1 items required. Maximum of 10 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
resolver_name
String Unique name for resolver config. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
use_mgmt (optional)
Boolean If enabled, DNS resolution is performed via management network. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

DockerConfiguration Up

app_sync_frequency (optional)
Integer Sync frequency in seconds with frameworks. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
container_port_match_http_service (optional)
Boolean Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_backend_service_sync (optional)
Boolean Disable auto service sync for back end services. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_frontend_service_sync (optional)
Boolean Disable auto service sync for front end services. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_se_creation (optional)
Boolean Disable SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
docker_registry_se (optional)
DockerRegistry Docker registry for ServiceEngine image. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
east_west_placement_subnet (optional)
IpAddrPrefix Match against this prefix when placing east-west VSs on SEs . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_event_subscription (optional)
Boolean Enable Docker event subscription. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
feproxy_container_port_as_service (optional)
Boolean For Front End proxies, use container port as service port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
feproxy_vips_enable_proxy_arp (optional)
Boolean Enable proxy ARP from Host interface for Front End proxies. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fleet_endpoint (optional)
String Optional fleet remote endpoint if fleet is used for SE deployment. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_container_ports (optional)
array[Integer] List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_deployment_method (optional)
String Use Fleet/SSH for SE deployment. Enum options - SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_exclude_attributes (optional)
array[MesosAttribute] Exclude hosts with attributes for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_include_attributes (optional)
array[MesosAttribute] Create SEs just on hosts with include attributes. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_spawn_rate (optional)
Integer New SE spawn rate per minute. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_volume (optional)
String Host volume to be used as a disk for Avi SE, This is a disruptive change. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ucp_nodes (optional)
array[String] List of Docker UCP nodes; In case of a load balanced UCP cluster, use Virtual IP of the cluster. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

DockerRegistry Up

oshift_registry (optional)
OshiftDockerRegistryMetaData Openshift integrated registry config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String Password for docker registry. Authorized 'regular user' password if registry is Openshift integrated registry. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
username (optional)
String Username for docker registry. Authorized 'regular user' if registry is Openshift integrated registry. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
publisher_port (optional)
Integer Listener port for publisher. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
subnet (optional)
Integer Subnet for publisher. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
token (optional)
String Token for tracking changes. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GCPConfiguration Up

cloud_credentials_ref (optional)
String Credentials to access Google Cloud Platform APIs. It is a reference to an object of type CloudConnectorUser. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
encryption_keys (optional)
GCPEncryptionKeys Encryption Keys for Google Cloud Services. Field introduced in 18.2.10, 20.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
firewall_target_tags (optional)
array[String] Firewall rule network target tags which will be applied on Service Engines to allow ingress and egress traffic for Service Engines. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
gcp_service_account_email (optional)
String Email of GCP Service Account to be associated to the Service Engines. Field introduced in 20.1.7, 21.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
gcs_bucket_name (optional)
String Google Cloud Storage Bucket Name where Service Engine image will be uploaded. This image will be deleted once the image is created in Google compute images. By default, a bucket will be created if this field is not specified. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
gcs_project_id (optional)
String Google Cloud Storage Project ID where Service Engine image will be uploaded. This image will be deleted once the image is created in Google compute images. By default, Service Engine Project ID will be used. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_config
GCPNetworkConfig Google Cloud Platform VPC Network configuration for the Service Engines. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
region_name
String Google Cloud Platform Region Name where Service Engines will be spawned. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_project_id
String Google Cloud Platform Project ID where Service Engines will be spawned. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vip_allocation_strategy
GCPVIPAllocation VIP allocation strategy defines how the VIPs will be created in Google Cloud. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
zones
array[String] Google Cloud Platform Zones where Service Engines will be distributed for HA. Field introduced in 18.2.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GCPEncryptionKeys Up

gcs_bucket_kms_key_id (optional)
String CMEK Resource ID to encrypt Google Cloud Storage Bucket. This Bucket is used to upload Service Engine raw image. Field introduced in 18.2.10, 20.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
gcs_objects_kms_key_id (optional)
String CMEK Resource ID to encrypt Service Engine raw image. The raw image is a Google Cloud Storage Object. Field introduced in 18.2.10, 20.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_disk_kms_key_id (optional)
String CMEK Resource ID to encrypt Service Engine Disks. Field introduced in 18.2.10, 20.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_image_kms_key_id (optional)
String CMEK Resource ID to encrypt Service Engine GCE Image. Field introduced in 18.2.10, 20.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

GCPInBandManagement Up

vpc_network_name
String Service Engine Network Name. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vpc_project_id (optional)
String Project ID of the Service Engine Network. By default, Service Engine Project ID will be used. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vpc_subnet_name
String Service Engine Network Subnet Name. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GCPNetworkConfig Up

config
String Config Mode for Google Cloud network configuration. Enum options - INBAND_MANAGEMENT, ONE_ARM_MODE, TWO_ARM_MODE. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
inband (optional)
GCPInBandManagement Configure InBand Management as Google Cloud network configuration. In this configuration the data network and management network for Service Engines will be same. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
one_arm (optional)
GCPOneArmMode Configure One Arm Mode as Google Cloud network configuration. In this configuration the data network and the management network for the Service Engines will be separated. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
two_arm (optional)
GCPTwoArmMode Configure Two Arm Mode as Google Cloud network configuration. In this configuration the frontend data network, backend data network and the management network for the Service Engines will be separated. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GCPOneArmMode Up

data_vpc_network_name
String Service Engine Data Network Name. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
data_vpc_project_id (optional)
String Project ID of the Service Engine Data Network. By default, Service Engine Project ID will be used. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
data_vpc_subnet_name
String Service Engine Data Network Subnet Name. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
management_vpc_network_name
String Service Engine Management Network Name. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
management_vpc_project_id (optional)
String Project ID of the Service Engine Management Network. By default, Service Engine Project ID will be used. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
management_vpc_subnet_name
String Service Engine Management Network Subnet Name. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GCPTwoArmMode Up

backend_data_vpc_network_name
String Service Engine Backend Data Network Name. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
backend_data_vpc_project_id (optional)
String Project ID of the Service Engine Backend Data Network. By default, Service Engine Project ID will be used. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
backend_data_vpc_subnet_name
String Service Engine Backend Data Network Subnet Name. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
frontend_data_vpc_network_name
String Service Engine Frontend Data Network Name. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
frontend_data_vpc_project_id (optional)
String Project ID of the Service Engine Frontend Data Network. By default, Service Engine Project ID will be used. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
frontend_data_vpc_subnet_name
String Service Engine Frontend Data Network Subnet Name. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
management_vpc_network_name
String Service Engine Management Network Name. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
management_vpc_project_id (optional)
String Project ID of the Service Engine Management Network. By default, Service Engine Project ID will be used. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
management_vpc_subnet_name
String Service Engine Management Network Subnet Name. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GCPVIPAllocation Up

ilb (optional)
GCPVIPILB Configure Google Cloud Internal LoadBalancer for VIP. The VIP will be auto allocated from a Google Cloud VPC Subnet. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mode
String VIP Allocation Mode. Enum options - ROUTES, ILB. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
routes (optional)
GCPVIPRoutes Configure Google Cloud VPC Routes for VIP. The VIP can either be a static IP or auto allocted from AVI Internal Network. The VIP should not overlap with any of the subnet ranges in Google Cloud VPC. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GCPVIPILB Up

cloud_router_names (optional)
array[String] Google Cloud Router Names to advertise BYOIP. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GCPVIPRoutes Up

match_se_group_subnet (optional)
Boolean Match SE group subnets for VIP placement. Default is to not match SE group subnets. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
route_priority (optional)
Integer Priority of the routes created in GCP. Field introduced in 20.1.7, 21.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

HostAttributes Up

attr_key
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attr_val (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IngAttribute Up

attribute (optional)
String Attribute to match. Field introduced in 17.2.15, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Attribute value. If not set, match any value. Field introduced in 17.2.15, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddr Up

addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrPrefix Up

ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

LinuxServerConfiguration Up

hosts (optional)
array[LinuxServerHost] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_log_disk_path (optional)
String SE Client Logs disk path for cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_log_disk_size_GB (optional)
Integer SE Client Log disk size for cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_sys_disk_path (optional)
String SE System Logs disk path for cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_sys_disk_size_GB (optional)
Integer SE System Logs disk size for cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

LinuxServerHost Up

host_attr (optional)
array[HostAttributes] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_ip
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
node_availability_zone (optional)
String Node's availability zone. ServiceEngines belonging to the availability zone will be rebooted during a manual DR failover. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ManagementNetworkConfig Up

overlay_segment (optional)
Tier1LogicalRouterInfo Management overlay segment to use for Avi Service Engines. This should be set only when transport zone is of type OVERLAY. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
transport_zone
String Management transport zone path for Avi Service Engines. Example- /infra/sites/default/enforcement-points/default/transport-zones/xxx-xxx-xxxx. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
tz_type
String Management transport zone type overlay or vlan. Enum options - OVERLAY, VLAN. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
vlan_segment (optional)
String Management vlan segment path to use for Avi Service Engines. Example- /infra/segments/vlanls. This should be set only when transport zone is of type VLAN. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

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

MarathonSeDeployment Up

docker_image (optional)
String Docker image to be used for Avi SE installation e.g. fedora, ubuntu. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_os (optional)
String Host OS distribution e.g. COREOS, UBUNTU, REDHAT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
resource_roles (optional)
array[String] Accepted resource roles for SEs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uris (optional)
array[String] URIs to be resolved for starting the application. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MesosAttribute Up

attribute
String Attribute to match. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Attribute value. If not set, match any value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
app_sync_frequency (optional)
Integer Sync frequency in seconds with frameworks. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
container_port_match_http_service (optional)
Boolean Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_backend_service_sync (optional)
Boolean Disable auto service sync for back end services. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_frontend_service_sync (optional)
Boolean Disable auto service sync for front end services. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_gs_sync (optional)
Boolean Disable auto sync for GSLB services. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_se_creation (optional)
Boolean Disable SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
docker_registry_se (optional)
DockerRegistry Docker registry for ServiceEngine image. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
east_west_placement_subnet (optional)
IpAddrPrefix Match against this prefix when placing east-west VSs on SEs (Mesos mode only). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_event_subscription (optional)
Boolean Enable Marathon event subscriptions. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
feproxy_bridge_name (optional)
String Name of second Linux bridge on Host providing connectivity for Front End proxies. This is a disruptive change. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
feproxy_container_port_as_service (optional)
Boolean For Front End proxies, use container port as service port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
feproxy_route_publish (optional)
FeProxyRoutePublishConfig Publish ECMP route to upstream router for VIP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
feproxy_vips_enable_proxy_arp (optional)
Boolean Enable proxy ARP from Host interface for Front End proxies. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fleet_endpoint (optional)
String Optional fleet remote endpoint if fleet is used for SE deployment. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_container_ports (optional)
array[Integer] List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
marathon_configurations (optional)
array[MarathonConfiguration] List of Marathon frameworks. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
marathon_se_deployment (optional)
MarathonSeDeployment Options for Marathon SE deployment. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mesos_url (optional)
String Mesos URL of the form http //host port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nuage_controller (optional)
NuageSDNController Nuage Overlay SDN Controller information. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_exclude_attributes (optional)
array[MesosAttribute] Exclude hosts with attributes for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_include_attributes (optional)
array[MesosAttribute] Create SEs just on hosts with include attributes. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_resources (optional)
array[MesosSeResources] Obsolete - ignored. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_spawn_rate (optional)
Integer New SE spawn rate per minute. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_volume (optional)
String Host volume to be used as a disk for Avi SE, This is a disruptive change. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_bridge_ip_as_vip (optional)
Boolean Use Bridge IP on each Host as VIP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vip (optional)
IpAddr VIP to be used by all East-West apps on all Hosts. Preferrably use an address from outside the subnet. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MesosSeResources Up

attribute_key
String Attribute (Fleet or Mesos) key of Hosts. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attribute_value
String Attribute (Fleet or Mesos) value of Hosts. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cpu (optional)
Float Obsolete - ignored. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: float
memory (optional)
Integer Obsolete - ignored. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

NTPAuthenticationKey Up

algorithm (optional)
String Message Digest Algorithm used for NTP authentication. Default is NTP_AUTH_ALGORITHM_MD5. Enum options - NTP_AUTH_ALGORITHM_MD5, NTP_AUTH_ALGORITHM_SHA1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String NTP Authentication key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key_number
Integer Key number to be assigned to the authentication-key. Allowed values are 1-65534. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

NTPConfiguration Up

ntp_authentication_keys (optional)
array[NTPAuthenticationKey] NTP Authentication keys. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ntp_server_list (optional)
array[IpAddr] List of NTP server hostnames or IP addresses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ntp_servers (optional)
array[NTPServer] List of NTP Servers. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NTPServer Up

key_number (optional)
Integer Key number from the list of trusted keys used to authenticate this server. Allowed values are 1-65534. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
server
IpAddr IP Address of the NTP Server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NsxtConfiguration Up

automate_dfw_rules (optional)
Boolean Automatically create DFW rules for VirtualService in NSX-T Manager. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Basic edition(Allowed values- false), Essentials, Enterprise with Cloud Services edition.
data_network_config
DataNetworkConfig Data network configuration for Avi Service Engines. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
domain_id (optional)
String Domain where NSGroup objects belongs to. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enforcementpoint_id (optional)
String Enforcement point is where the rules of a policy to apply. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
management_network_config
ManagementNetworkConfig Management network configuration for Avi Service Engines. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
nsxt_credentials_ref
String Credentials to access NSX-T manager. It is a reference to an object of type CloudConnectorUser. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nsxt_url
String NSX-T manager hostname or IP address. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
site_id (optional)
String Site where transport zone belongs to. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NsxtTier1SegmentAutomaticMode Up

nsxt_segment_subnet
IpAddrPrefix Uber IP subnet for the logical segments created automatically by Avi controller. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_se_per_segment (optional)
Integer The number of SE data vNic's that can be connected to the Avi logical segment. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
tier1_lr_ids (optional)
array[String] Tier1 logical router IDs. Field introduced in 20.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NsxtTier1SegmentConfig Up

automatic (optional)
NsxtTier1SegmentAutomaticMode Avi controller creates and manages logical segments for a Tier-1 LR. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
manual (optional)
NsxtTier1SegmentManualMode Avi Admin selects an available logical segment (created by NSX-T admin) associated with a Tier-1 LR. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
segment_config_mode
String Config Mode for selecting the placement logical segments for Avi ServiceEngine data path. Enum options - TIER1_SEGMENT_MANUAL, TIER1_SEGMENT_AUTOMATIC. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Basic edition(Allowed values- TIER1_SEGMENT_MANUAL), Essentials, Enterprise with Cloud Services edition.

NsxtTier1SegmentManualMode Up

tier1_lrs (optional)
array[Tier1LogicalRouterInfo] Tier1 logical router placement information. Field introduced in 20.1.1. Minimum of 1 items required. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NuageSDNController Up

nuage_organization (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nuage_password (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nuage_port (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
nuage_username (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nuage_vsd_host (optional)
String Nuage VSD host name or IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_domain (optional)
String Domain to be used for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_enterprise (optional)
String Enterprise to be used for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_network (optional)
String Network to be used for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_policy_group (optional)
String Policy Group to be used for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_user (optional)
String User to be used for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_zone (optional)
String Zone to be used for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

OShiftK8SConfiguration Up

app_sync_frequency (optional)
Integer Sync frequency in seconds with frameworks. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
auto_assign_fqdn (optional)
Boolean Auto assign FQDN to a virtual service if a valid FQDN is not configured. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
avi_bridge_subnet (optional)
IpAddrPrefix Avi Linux bridge subnet on OpenShift/K8s nodes. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cluster_tag (optional)
String Openshift/K8S Cluster ID used to uniquely map same named namespaces as tenants in Avi. In order to use more than one OpenShift/K8S cloud on this controller, cluster_tag has to be unique across these clouds. Changing cluster_tag is disruptive as all virtual services in the cloud will be recreated. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
container_port_match_http_service (optional)
Boolean Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. By default, ports 80, 8080, 443, 8443 are considered HTTP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_backend_service_sync (optional)
Boolean Disable auto service sync for back end services. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_frontend_service_sync (optional)
Boolean Disable auto service sync for front end services. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_gs_sync (optional)
Boolean Disable auto sync for GSLB services. Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_auto_se_creation (optional)
Boolean Disable SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
docker_endpoint (optional)
String Host Docker server UNIX socket endpoint. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
docker_registry_se (optional)
DockerRegistry Docker registry for ServiceEngine image. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
east_west_placement_subnet (optional)
IpAddrPrefix Match against this prefix when placing east-west VSs on SEs . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_event_subscription (optional)
Boolean Enable Kubernetes event subscription. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_route_ingress_hardening (optional)
Boolean Knob to turn on adding of HTTP drop rules for host and path combinations in incoming request header, specified as part of Ingress/Route spec. The default state is to enable this behavior. Note Toggling this knob only affects any new routes/ingresses, existing routes/ingresses present in Avi will continue to function as-is. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
feproxy_vips_enable_proxy_arp (optional)
Boolean Enable proxy ARP from Host interface for Front End proxies. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_container_ports (optional)
array[Integer] List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80, 8080, 443 and 8443. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ing_exclude_attributes (optional)
array[IngAttribute] Do not sync applications only for ingress that have these exclude attributes configured. Field introduced in 17.2.15, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ing_include_attributes (optional)
array[IngAttribute] Sync applications only for ingress objects that have these include attributes configured. Default values are populated for this field if not provided. The default value are 'attribute' 'kubernetes.io/ingress.class', 'value' 'avi'. Field introduced in 17.2.15, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
l4_health_monitoring (optional)
Boolean Perform Layer4 (TCP/UDP) health monitoring even for Layer7 (HTTP) Pools. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_shards (optional)
Integer Enables sharding of Routes and Ingresses to this number (if non zero) of virtual services in the admin tenant per SEGroup. Sharding is done by hashing on the namespace of the Ingress/Route object. This knob is valid only if shared_virtualservice_namespace flag is set. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
override_service_ports (optional)
Boolean Override Service Ports with well known ports (80/443) for http/https Route/Ingress VirtualServices. Field introduced in 17.2.12,18.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
persistent_volume_claim (optional)
String Persistent Volume Claim name to be used for persistent storage for Avi service engines. This could be used in scenarios where host based volumes are ephemeral. Refer https //kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims for more details on the usage of this field. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
routes (optional)
array[RouteInfo] Routes support adding routes to a particular namespace routing table in Openshift/K8s cluster. Each route is a combination of subnet and nexthop ip address or nexthop interface name, and a enum type is used to distinguish an entry in the host (default behaviour) or in the container/pod or in other namespace. This knob should be enabled in the following cases 1. Forwarding the network packets to the same network interface from where it came from in the OpenShift/K8s node. 2. OpenShift/K8s Node connected to the Internet via multiple network interfaces on different networks/ISPs.3. Handling North-South traffic originating from with in the node when the default gateway for outgoing traffic of vs is configured.4. Handling the container/pod traffic by adding the routes in the container/pod. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_deployment_method (optional)
String Use SSH/Pod for SE deployment. Enum options - SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_exclude_attributes (optional)
array[MesosAttribute] Exclude hosts with attributes for SE creation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_image_pull_secret (optional)
String OpenShift/K8S secret name to be used for private docker repos when deploying SE as a Pod. Reference Link https //kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/. Field introduced in 17.2.13,18.1.3,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_include_attributes (optional)
array[MesosAttribute] Create SEs just on hosts with include attributes. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_namespace (optional)
String Kubernetes namespace to be used for deploying Avi service engines. This namespace is used to create daemonsets, service accounts, etc. for Avi only use. Setting this value is a disruptive operation and assumes the namespace exists in kubernetes. 'default' namespace is picked if this field is unset. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_pod_tolerations (optional)
array[PodToleration] Match SE Pod tolerations against taints of OpenShift/K8S nodes https //kubernetes.io/docs/concepts/configuration/taint-and-toleration/. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_priority_class (optional)
String Priority class for AVI SEs when running as pods. User is expected to have the priority class (with this name) created in Kubernetes, beforehand. If the priority class doesn't exist while assigning this field, the SE pods may not start. If empty no priority class will be used for deploying SE pods (default behaviour). Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_restart_batch_size (optional)
Integer Restart ServiceEngines by batch on ServiceEngineGroup updates (cpu, memory..etc). Field introduced in 17.2.15, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_restart_force (optional)
Boolean Restart ServiceEngines forcely if VirtualServices failed to migrate to another SE. Field introduced in 17.2.15, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_volume (optional)
String Host volume to be used as a disk for Avi SE, This is a disruptive change. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
service_account_token (optional)
String Authorization token for service account instead of client certificate. One of client certificate or token is required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
shard_prefix (optional)
String Prefix to be used for Shard VS name when num_shards knob is non zero. Format for Shard VS name will be <shard_prefix>-<idx>-CloudName-SEGroupName. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sync_not_ready_addresses (optional)
Boolean Allow the not_ready_addresses in the kubernetes endpoint object to be added as servers in the AVI pool object. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_resource_definition_as_ssot (optional)
Boolean Use OpenShift/Kubernetes resource definition and annotations as single-source-of-truth. Any changes made in Avi Controller via UI or CLI will be overridden by values provided in annotations. Field introduced in 17.2.13, 18.1.4, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vip_default_gateway (optional)
IpAddr VirtualService default gateway if multiple nics are present in the host. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
admin_tenant_uuid (optional)
String admin-tenant's UUID in OpenStack. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
allowed_address_pairs (optional)
Boolean If false, allowed-address-pairs extension will not be used. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
auth_url (optional)
String Auth URL for connecting to keystone. If this is specified, any value provided for keystone_host is ignored. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
config_drive (optional)
Boolean If false, metadata service will be used instead of config-drive functionality to retrieve SE VM metadata. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
contrail_disable_policy (optional)
Boolean When set to True, the VIP and Data ports will be programmed to set virtual machine interface disable-policy. Please refer Contrail documentation for more on disable-policy. Field introduced in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
contrail_plugin (optional)
Boolean Enable Contrail plugin mode. (deprecated). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
custom_se_image_properties (optional)
array[Property] Custom image properties to be set on a Service Engine image. Only hw_vif_multiqueue_enabled property is supported. Other properties will be ignored. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
external_networks (optional)
Boolean If True, allow selection of networks marked as 'external' for management, vip or data networks. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
free_floatingips (optional)
Boolean Free unused floating IPs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hypervisor (optional)
String Default hypervisor type, only KVM is supported. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hypervisor_properties (optional)
array[OpenStackHypervisorProperties] Custom properties per hypervisor type. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
img_format (optional)
String If OS_IMG_FMT_RAW, use RAW images else use QCOW2 for KVM. Enum options - OS_IMG_FMT_AUTO, OS_IMG_FMT_QCOW2, OS_IMG_FMT_VMDK, OS_IMG_FMT_RAW, OS_IMG_FMT_FLAT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
import_keystone_tenants (optional)
Boolean Import keystone tenants list into Avi. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
insecure (optional)
Boolean Allow self-signed certificates when communicating with https service endpoints. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
keystone_host (optional)
String Keystone's hostname or IP address. (Deprecated) Use auth_url instead. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mgmt_network_name
String Avi Management network name or cidr. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mgmt_network_uuid (optional)
String Management network UUID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name_owner (optional)
Boolean If True, embed owner info in VIP port 'name', else embed owner info in 'device_id' field. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
neutron_rbac (optional)
Boolean If True, enable neutron rbac discovery of networks shared across tenants/projects. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String The password Avi Vantage will use when authenticating to Keystone. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
privilege
String Access privilege. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prov_name (optional)
array[String] LBaaS provider name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
provider_vip_networks (optional)
array[OpenStackVipNetwork] A tenant can normally use its own networks and any networks shared with it. In addition, this setting provides extra networks that are usable by tenants. Field introduced in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
region (optional)
String Region name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
security_groups (optional)
Boolean If false, security-groups extension will not be used. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_se (optional)
Boolean If true, then SEs will be created in the appropriate tenants, else SEs will be created in the admin_tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_admin_url (optional)
Boolean If admin URLs are either inaccessible or not to be accessed from Avi Controller, then set this to False. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_internal_endpoints (optional)
Boolean Use internalURL for OpenStack endpoints instead of the default publicURL endpoints. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_keystone_auth (optional)
Boolean Use keystone for user authentication. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

OpenStackHypervisorProperties Up

hypervisor
String Hypervisor type. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

OpenStackRoleMapping Up

avi_role
String Role name in Avi. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os_role
String Role name in OpenStack. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

OpenStackVipNetwork Up

os_network_uuid (optional)
String Neutron network UUID. Field introduced in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os_tenant_uuids (optional)
array[String] UUIDs of OpenStack tenants that should be allowed to use the specified Neutron network for VIPs. Use '*' to make this network available to all tenants. Field introduced in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

OshiftDockerRegistryMetaData Up

registry_namespace (optional)
String Namespace for the ServiceEngine image to be hosted in Openshift Integrated registry. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
registry_service (optional)
String Name of the Integrated registry Service in Openshift. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

OshiftSharedVirtualService Up

virtualservice_name
String Name of shared virtualservice. VirtualService will be created automatically by Cloud Connector. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PodToleration Up

effect (optional)
String Effect to match. Enum options - NO_SCHEDULE, PREFER_NO_SCHEDULE, NO_EXECUTE. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key (optional)
String Key to match. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
operator (optional)
String Operator to match. Enum options - EQUAL, EXISTS. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
toleration_seconds (optional)
Integer Pods that tolerate the taint with a specified toleration_seconds remain bound for the specified amount of time. Field introduced in 17.2.14, 18.1.5, 18.2.1. Unit is SECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
value (optional)
String Value to match. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PortRange Up

end
Integer TCP/UDP port range end (inclusive). Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
start
Integer TCP/UDP port range start (inclusive). Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

Property Up

name
String Property name. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Property value. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ProxyConfiguration Up

host
String Proxy hostname or IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String Password for proxy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port
Integer Proxy port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
username (optional)
String Username for proxy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

RancherConfiguration Up

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

RoleFilterMatchLabel Up

key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

RouteInfo Up

if_name (optional)
String Host interface name. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_namespace (optional)
String Network Namespace type used to add an route entry in a specific namespace. Enum options - LOCAL_NAMESPACE, HOST_NAMESPACE, OTHER_NAMESPACE. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nexthop (optional)
IpAddr Host nexthop ip address. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet
IpAddrPrefix Host subnet address. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Tier1LogicalRouterInfo Up

locale_service (optional)
String Locale-services configuration, holds T1 edge-cluster information. When VirtualService is enabled with preserve client IP, ServiceInsertion VirtualEndpoint will be created in this locale-service. By default Avi controller picks default locale-service on T1. If more than one locale-services are present, this will be used for resolving the same. Example locale-service path - /infra/tier-1s/London_Tier1Gateway1/locale-services/London_Tier1LocalServices-1. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
segment_id (optional)
String Overlay segment path. Example- /infra/segments/Seg-Web-T1-01. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tier1_lr_id
String Tier1 logical router path. Example- /infra/tier-1s/T1-01. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

vCenterConfiguration Up

content_lib (optional)
ContentLibConfig vCenter content library where Service Engine images are stored. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
datacenter (optional)
String Datacenter for virtual infrastructure discovery. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
deactivate_vm_discovery (optional)
Boolean If true, VM's on the vCenter will not be discovered.Set it to true if there are more than 10000 VMs in the datacenter. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
management_ip_subnet (optional)
IpAddrPrefix Management subnet to use for Avi Service Engines. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
management_network (optional)
String Management network to use for Avi Service Engines. It is a reference to an object of type VIMgrNWRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String The password Avi Vantage will use when authenticating with vCenter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
use_content_lib (optional)
Boolean If false, Service Engine image will not be pushed to content library. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Enterprise with Cloud Services edition.
username (optional)
String The username Avi Vantage will use when authenticating with vCenter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_template_se_location (optional)
String Avi Service Engine Template in vCenter to be used for creating Service Engines. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_url (optional)
String vCenter hostname or IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

vCloudAirConfiguration Up

privilege
String vCloudAir access mode. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_host
String vCloudAir host address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_instance
String vCloudAir instance ID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_mgmt_network
String vCloudAir management network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_orgnization
String vCloudAir orgnization ID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_password
String vCloudAir password. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_username
String vCloudAir username. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_vdc
String vCloudAir virtual data center name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.