Skip to content

Latest commit

 

History

History
1247 lines (1226 loc) · 56.5 KB

avi_cloud.rst

File metadata and controls

1247 lines (1226 loc) · 56.5 KB

vmware.alb.avi_cloud

Module for setup of Cloud Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
autoscale_polling_interval
int
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
aws_configuration
dict
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
azure_configuration
dict
- Field introduced in 17.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
cloudstack_configuration
dict
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
configpb_attributes
dict
- 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
list
- 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
bool
- Select the ip address management scheme.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
dns_provider_ref
str
- 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
bool
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
dns_resolvers
list
- 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
dict
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
east_west_dns_provider_ref
str
- 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
str
- 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
bool
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_vip_static_routes
bool
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
gcp_configuration
dict
- 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
bool
- Enable ipv6 auto configuration.
- Field introduced in 18.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
ipam_provider_ref
str
- 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
str
- 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
str
- 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
dict
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
maintenance_mode
bool
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
markers
list
- 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
int
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as 300.
mgmt_ip_v4_enabled
bool
- Enable ipv4 on the management interface of the serviceengine.
- Field introduced in 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
mgmt_ip_v6_enabled
bool
- Enable ipv6 on the management interface of the serviceengine.
- Field introduced in 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
mtu
int
- Mtu setting for the cloud.
- Unit is bytes.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 1500.
name
str
required: true
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
nsxt_configuration
dict
- 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
dict
- 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
str
- 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
dict
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
prefer_static_routes
bool
- Prefer static routes over interface routes during virtualservice placement.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
proxy_configuration
dict
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
rancher_configuration
dict
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
resolve_fqdn_to_ipv6
bool
- Resolve ipv6 address for pool member fqdns.
- Field introduced in 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
se_group_template_ref
str
- 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
bool
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
tenant_ref
str
- 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
str
- Avi controller URL of the object.
uuid
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
vca_configuration
dict
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
vcenter_configuration
dict
- Allowed in enterprise edition with any value, essentials, enterprise with cloud services edition.
vmc_deployment
bool
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
vtype
str
required: true
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as CLOUD_NONE.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - name: Create a VMware cloud with write access mode
      avi_cloud:
        avi_credentials: "{{ avi_credentials }}"
        apic_mode: false
        dhcp_enabled: true
        enable_vip_static_routes: false
        license_type: LIC_CORES
        mtu: 1500
        name: VCenter Cloud
        prefer_static_routes: false
        tenant_ref: /api/tenant?name=admin
        vcenter_configuration:
          datacenter_ref: /api/vimgrdcruntime/datacenter-2-10.10.20.100
          management_network: /api/vimgrnwruntime/dvportgroup-103-10.10.20.100
          password: password
          privilege: WRITE_ACCESS
          username: user
          vcenter_url: 192.168.15.18
        vtype: CLOUD_VCENTER

Authors