OpenStackConfiguration

OpenStackConfiguration
OpenStackConfiguration
JSON Example
{
    "admin_tenant": "string",
    "admin_tenant_uuid": "string",
    "allowed_address_pairs": false,
    "anti_affinity": false,
    "auth_url": "string",
    "config_drive": false,
    "contrail_disable_policy": false,
    "contrail_endpoint": "string",
    "contrail_plugin": false,
    "custom_se_image_properties": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "enable_os_object_caching": false,
    "enable_tagging": false,
    "external_networks": false,
    "free_floatingips": false,
    "hypervisor": "string",
    "hypervisor_properties": [
        {
            "hypervisor": "string",
            "image_properties": [
                {
                    "name": "string",
                    "value": "string"
                }
            ]
        }
    ],
    "img_format": "string",
    "import_keystone_tenants": false,
    "insecure": false,
    "keystone_host": "string",
    "map_admin_to_cloudadmin": false,
    "mgmt_network_name": "string",
    "mgmt_network_uuid": "string",
    "name_owner": false,
    "neutron_rbac": false,
    "password": "string",
    "privilege": "string",
    "prov_name": [
        "string"
    ],
    "provider_vip_networks": [
        {
            "os_network_uuid": "string",
            "os_tenant_uuids": [
                "string"
            ]
        }
    ],
    "region": "string",
    "role_mapping": [
        {
            "avi_role": "string",
            "os_role": "string"
        }
    ],
    "security_groups": false,
    "tenant_se": false,
    "use_admin_url": false,
    "use_internal_endpoints": false,
    "use_keystone_auth": false,
    "username": "string",
    "vip_port_in_admin_tenant": false
}
string
admin_tenant
Required

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.

string
admin_tenant_uuid
Optional

admin-tenant's UUID in OpenStack. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
allowed_address_pairs
Optional
Constraints: default: true

If false, allowed-address-pairs extension will not be used. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
anti_affinity
Optional
Constraints: default: true

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.

string
auth_url
Optional

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.

boolean
config_drive
Optional
Constraints: default: true

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.

boolean
contrail_disable_policy
Optional

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.

string
contrail_endpoint
Optional

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.

boolean
contrail_plugin
Optional

Enable Contrail plugin mode. (deprecated). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of Property
custom_se_image_properties
Optional

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.

boolean
enable_os_object_caching
Optional

When enabled, frequently used objects like networks, subnets, routers etc. are cached to improve performance and reduce load on OpenStack Controllers. Suitable for OpenStack environments where Neutron resources are not frequently created, updated, or deleted.The cache is refreshed when cloud GC API is issued. Field introduced in 21.1.5, 22.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable_tagging
Optional

When set to True, OpenStack resources created by Avi are tagged with Avi Cloud UUID. Field introduced in 21.1.5, 22.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
external_networks
Optional

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.

boolean
free_floatingips
Optional

Free unused floating IPs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
hypervisor
Optional
Constraints: default: KVM

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

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.

string
img_format
Optional
Constraints: default: OS_IMG_FMT_AUTO

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.

boolean
import_keystone_tenants
Optional
Constraints: default: true

Import keystone tenants list into Avi. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
insecure
Optional
Constraints: default: true

Allow self-signed certificates when communicating with https service endpoints. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
keystone_host
Optional

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.

boolean
map_admin_to_cloudadmin
Optional

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.

string
mgmt_network_name
Required

Avi Management network name or cidr. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
mgmt_network_uuid
Optional

Management network UUID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
name_owner
Optional
Constraints: default: true

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.

boolean
neutron_rbac
Optional
Constraints: default: true

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.

string
password
Optional

The password Avi Vantage will use when authenticating to Keystone. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
privilege
Required

Access privilege. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
prov_name
Optional

LBaaS provider name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

provider_vip_networks
Optional

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.

string
region
Optional

Region name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

role_mapping
Optional

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.

boolean
security_groups
Optional
Constraints: default: true

If false, security-groups extension will not be used. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
tenant_se
Optional
Constraints: default: true

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.

boolean
use_admin_url
Optional
Constraints: default: true

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.

boolean
use_internal_endpoints
Optional

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.

boolean
use_keystone_auth
Optional
Constraints: default: true

Use keystone for user authentication. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
username
Required

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.

boolean
vip_port_in_admin_tenant
Optional

When set to True, VIP ports are created in OpenStack tenant configured as admin_tenant in cloud. Otherwise, default behavior is to create VIP ports in user tenant. Field introduced in 21.1.5, 22.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Property Of