W3cubDocs

/Ansible

avi_serviceenginegroup - Module for setup of ServiceEngineGroup Avi RESTful Object

New in version 2.4.

Synopsis

Requirements (on host that executes module)

  • avisdk

Options

parameter required default choices comments
active_standby
no
Service engines in active/standby mode for ha failover.
Default value when not specified in API or module is interpreted by Avi Controller as False.
advertise_backend_networks
no
Advertise reach-ability of backend server networks via adc through bgp for default gateway feature.
Default value when not specified in API or module is interpreted by Avi Controller as False.
aggressive_failure_detection
no
Enable aggressive failover configuration for ha.
Default value when not specified in API or module is interpreted by Avi Controller as False.
algo
no
In compact placement, virtual services are placed on existing ses until max_vs_per_se limit is reached.
Enum options - PLACEMENT_ALGO_PACKED, PLACEMENT_ALGO_DISTRIBUTED.
Default value when not specified in API or module is interpreted by Avi Controller as PLACEMENT_ALGO_PACKED.
api_version
no
Avi API version of to use for Avi API and objects.
auto_rebalance
no
If set, virtual services will be automatically migrated when load on an se is less than minimum or more than maximum thresholds.
Only alerts are generated when the auto_rebalance is not set.
Default value when not specified in API or module is interpreted by Avi Controller as False.
auto_rebalance_interval
no
Frequency of rebalance, if 'auto rebalance' is enabled.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
auto_redistribute_active_standby_load
no
Redistribution of virtual services from the takeover se to the replacement se can cause momentary traffic loss.
If the auto-redistribute load option is left in its default off state, any desired rebalancing requires calls to rest api.
Default value when not specified in API or module is interpreted by Avi Controller as False.
buffer_se
no
Excess service engine capacity provisioned for ha failover.
Default value when not specified in API or module is interpreted by Avi Controller as 1.
cloud_ref
no
It is a reference to an object of type cloud.
connection_memory_percentage
no
Percentage of memory for connection state.
This will come at the expense of memory used for http in-memory cache.
Allowed values are 10-90.
Default value when not specified in API or module is interpreted by Avi Controller as 50.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
cpu_reserve
no
Boolean flag to set cpu_reserve.
Default value when not specified in API or module is interpreted by Avi Controller as False.
cpu_socket_affinity
no
Allocate all the cpu cores for the service engine virtual machines on the same cpu socket.
Applicable only for vcenter cloud.
Default value when not specified in API or module is interpreted by Avi Controller as False.
custom_tag
no
Custom tag will be used to create the tags for se instance in aws.
Note this is not the same as the prefix for se name.
dedicated_dispatcher_core
no
Dedicate the core that handles packet receive/transmit from the network to just the dispatching function.
Don't use it for tcp/ip and ssl functions.
Default value when not specified in API or module is interpreted by Avi Controller as False.
description
no
User defined description for the object.
disk_per_se
no
Amount of disk space for each of the service engine virtual machines.
Default value when not specified in API or module is interpreted by Avi Controller as 10.
distribute_load_active_standby
no
Use both the active and standby service engines for virtual service placement in the legacy active standby ha mode.
Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_routing
no
Enable routing for this serviceenginegroup .
Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_vip_on_all_interfaces
no
Enable vip on all interfaces of se.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as True.
enable_vmac
no
Use virtual mac address for interfaces on which floating interface ips are placed.
Default value when not specified in API or module is interpreted by Avi Controller as False.
extra_config_multiplier
no
Multiplier for extra config to support large vs/pool config.
Default value when not specified in API or module is interpreted by Avi Controller as 0.0.
extra_shared_config_memory
no
Extra config memory to support large geo db configuration.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as 0.
floating_intf_ip
no
If serviceenginegroup is configured for legacy 1+1 active standby ha mode, floating ip's will be advertised only by the active se in the pair.
Virtual services in this group must be disabled/enabled for any changes to the floating ip's to take effect.
Only active se hosting vs tagged with active standby se 1 tag will advertise this floating ip when manual load distribution is enabled.
floating_intf_ip_se_2
no
If serviceenginegroup is configured for legacy 1+1 active standby ha mode, floating ip's will be advertised only by the active se in the pair.
Virtual services in this group must be disabled/enabled for any changes to the floating ip's to take effect.
Only active se hosting vs tagged with active standby se 2 tag will advertise this floating ip when manual load distribution is enabled.
ha_mode
no
High availability mode for all the virtual services using this service engine group.
Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY.
Default value when not specified in API or module is interpreted by Avi Controller as HA_MODE_SHARED.
hardwaresecuritymodulegroup_ref
no
It is a reference to an object of type hardwaresecuritymodulegroup.
hm_on_standby
no
Enable active health monitoring from the standby se for all placed virtual services.
Default value when not specified in API or module is interpreted by Avi Controller as True.
host_attribute_key
no
Key of a (key, value) pair identifying a set of hosts.
Currently used to separate north-south and east-west se sizing requirements.
This is useful in container ecosystems where ses on east-west traffic nodes are typically smaller than those on north-south traffic nodes.
host_attribute_value
no
Value of a (key, value) pair identifying a set of hosts.
Currently used to separate north-south and east-west se sizing requirements.
This is useful in container ecosystems where ses on east-west traffic nodes are typically smaller than those on north-south traffic nodes.
hypervisor
no
Override default hypervisor.
Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN.
instance_flavor
no
Instance/flavor type for se instance.
iptables
no
Iptable rules.
least_load_core_selection
no
Select core with least load for new flow.
Default value when not specified in API or module is interpreted by Avi Controller as True.
log_disksz
no
Maximum disk capacity (in mb) to be allocated to an se.
This is exclusively used for debug and log data.
Default value when not specified in API or module is interpreted by Avi Controller as 10000.
max_cpu_usage
no
When cpu usage on an se exceeds this threshold, virtual services hosted on this se may be rebalanced to other ses to reduce load.
A new se may be created as part of this process.
Allowed values are 40-90.
Default value when not specified in API or module is interpreted by Avi Controller as 80.
max_scaleout_per_vs
no
Maximum number of active service engines for the virtual service.
Allowed values are 1-64.
Default value when not specified in API or module is interpreted by Avi Controller as 4.
max_se
no
Maximum number of services engines in this group.
Allowed values are 0-1000.
Default value when not specified in API or module is interpreted by Avi Controller as 10.
max_vs_per_se
no
Maximum number of virtual services that can be placed on a single service engine.
Allowed values are 1-1000.
Default value when not specified in API or module is interpreted by Avi Controller as 10.
mem_reserve
no
Boolean flag to set mem_reserve.
Default value when not specified in API or module is interpreted by Avi Controller as True.
memory_per_se
no
Amount of memory for each of the service engine virtual machines.
Default value when not specified in API or module is interpreted by Avi Controller as 2048.
mgmt_network_ref
no
Management network to use for avi service engines.
It is a reference to an object of type network.
mgmt_subnet
no
Management subnet to use for avi service engines.
min_cpu_usage
no
When cpu usage on an se falls below the minimum threshold, virtual services hosted on the se may be consolidated onto other underutilized ses.
After consolidation, unused service engines may then be eligible for deletion.
Allowed values are 20-60.
Default value when not specified in API or module is interpreted by Avi Controller as 30.
min_scaleout_per_vs
no
Minimum number of active service engines for the virtual service.
Allowed values are 1-64.
Default value when not specified in API or module is interpreted by Avi Controller as 1.
name
yes
Name of the object.
num_flow_cores_sum_changes_to_ignore
no
Number of changes in num flow cores sum to ignore.
Default value when not specified in API or module is interpreted by Avi Controller as 8.
openstack_availability_zone
no
Field deprecated in 17.1.1.
openstack_availability_zones
no
Field introduced in 17.1.1.
openstack_mgmt_network_name
no
Avi management network name.
openstack_mgmt_network_uuid
no
Management network uuid.
os_reserved_memory
no
Amount of extra memory to be reserved for use by the operating system on a service engine.
Default value when not specified in API or module is interpreted by Avi Controller as 0.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
per_app
no
Per-app se mode is designed for deploying dedicated load balancers per app (vs).
In this mode, each se is limited to a max of 2 vss.
Vcpus in per-app ses count towards licensing usage at 25% rate.
Default value when not specified in API or module is interpreted by Avi Controller as False.
placement_mode
no
If placement mode is 'auto', virtual services are automatically placed on service engines.
Enum options - PLACEMENT_MODE_AUTO.
Default value when not specified in API or module is interpreted by Avi Controller as PLACEMENT_MODE_AUTO.
realtime_se_metrics
no
Enable or disable real time se metrics.
se_deprovision_delay
no
Duration to preserve unused service engine virtual machines before deleting them.
If traffic to a virtual service were to spike up abruptly, this se would still be available to be utilized again rather than creating a new se.
If this value is set to 0, controller will never delete any ses and administrator has to manually cleanup unused ses.
Allowed values are 0-525600.
Default value when not specified in API or module is interpreted by Avi Controller as 120.
se_dos_profile
no
Dosthresholdprofile settings for serviceenginegroup.
se_name_prefix
no
Prefix to use for virtual machine name of service engines.
Default value when not specified in API or module is interpreted by Avi Controller as Avi.
se_thread_multiplier
no
Multiplier for se threads based on vcpu.
Allowed values are 1-10.
Default value when not specified in API or module is interpreted by Avi Controller as 1.
se_tunnel_mode
no
Determines if dsr from secondary se is active or not 0 automatically determine based on hypervisor type 1 disable dsr
unconditionally ~[0,1] enable dsr unconditionally.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as 0.
se_vs_hb_max_pkts_in_batch
no
Maximum number of aggregated vs heartbeat packets to send in a batch.
Allowed values are 1-256.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as 8.
se_vs_hb_max_vs_in_pkt
no
Maximum number of virtualservices for which heartbeat messages are aggregated in one packet.
Allowed values are 1-1024.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as 256.
service_ip_subnets
no
Subnets assigned to the se group.
Required for vs group placement.
Field introduced in 17.1.1.
state
no present
  • absent
  • present
The state that should be applied on the entity.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Unique object identifier of the object.
vcenter_clusters
no
Vcenterclusters settings for serviceenginegroup.
vcenter_datastore_mode
no
Enum options - vcenter_datastore_any, vcenter_datastore_local, vcenter_datastore_shared.
Default value when not specified in API or module is interpreted by Avi Controller as VCENTER_DATASTORE_ANY.
vcenter_datastores
no
List of vcenterdatastore.
vcenter_datastores_include
no
Boolean flag to set vcenter_datastores_include.
Default value when not specified in API or module is interpreted by Avi Controller as False.
vcenter_folder
no
Folder to place all the service engine virtual machines in vcenter.
Default value when not specified in API or module is interpreted by Avi Controller as AviSeFolder.
vcenter_hosts
no
Vcenterhosts settings for serviceenginegroup.
vcpus_per_se
no
Number of vcpus for each of the service engine virtual machines.
Default value when not specified in API or module is interpreted by Avi Controller as 1.
vs_host_redundancy
no
Ensure primary and secondary service engines are deployed on different physical hosts.
Default value when not specified in API or module is interpreted by Avi Controller as True.
vs_scalein_timeout
no
Time to wait for the scaled in se to drain existing flows before marking the scalein done.
Default value when not specified in API or module is interpreted by Avi Controller as 30.
vs_scalein_timeout_for_upgrade
no
During se upgrade, time to wait for the scaled-in se to drain existing flows before marking the scalein done.
Default value when not specified in API or module is interpreted by Avi Controller as 30.
vs_scaleout_timeout
no
Time to wait for the scaled out se to become ready before marking the scaleout done.
Default value when not specified in API or module is interpreted by Avi Controller as 30.

Examples

- name: Example to create ServiceEngineGroup object
  avi_serviceenginegroup:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_serviceenginegroup

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj ServiceEngineGroup (api/serviceenginegroup) object success, changed dict

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/avi_serviceenginegroup_module.html