Skip to content

Latest commit

 

History

History
5865 lines (5845 loc) · 284 KB

avi_serviceenginegroup.rst

File metadata and controls

5865 lines (5845 loc) · 284 KB

vmware.alb.avi_serviceenginegroup

Module for setup of Serviceenginegroup 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.
accelerated_networking
bool
- Enable accelerated networking option for azure se.
- Accelerated networking enables single root i/o virtualization (sr-iov) to a se vm.
- This improves networking performance.
- 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.
active_standby
bool
- Service engines in active/standby mode for ha failover.
- 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.
aggressive_failure_detection
bool
- Enable aggressive failover configuration for ha.
- 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.
algo
str
- 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.
- 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 PLACEMENT_ALGO_PACKED.
allow_burst
bool
- Allow ses to be created using burst license.
- Field introduced in 17.2.5.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
app_cache_percent
int
- A percent value of total se memory reserved for applicationcaching.
- This is an se bootup property and requires se restart.requires se reboot.
- Allowed values are 0 - 100.
- Special values are 0- disable.
- Field introduced in 18.2.3.
- Unit is percent.
- Allowed in enterprise edition with any value, essentials edition(allowed values- 0), basic edition(allowed values- 0), enterprise with cloud
- services edition.
- Special default for essentials edition is 0, basic edition is 0, enterprise is 10.
- Default value when not specified in API or module is interpreted by Avi Controller as 10.
app_cache_threshold
int
- The max memory that can be allocated for the app cache.
- This value will act as an upper bound on the cache size specified in app_cache_percent.
- Special values are 0- disable.
- Field introduced in 20.1.1.
- Unit is gb.
- 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 5.
app_learning_memory_percent
int
- A percent value of total se memory reserved for application learning.
- This is an se bootup property and requires se restart.
- Allowed values are 0 - 10.
- Field introduced in 18.2.3.
- Unit is percent.
- 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 0.
archive_shm_limit
int
- Amount of se memory in gb until which shared memory is collected in core archive.
- Field introduced in 17.1.3.
- Unit is gb.
- 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 8.
async_ssl
bool
- Ssl handshakes will be handled by dedicated ssl threads.requires se reboot.
- 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.
async_ssl_threads
int
- Number of async ssl threads per se_dp.requires se reboot.
- Allowed values are 1-16.
- 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 1.
auto_rebalance
bool
- 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.
- 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.
auto_rebalance_capacity_per_se
list
- Capacities of se for auto rebalance for each criteria.
- Field introduced in 17.2.4.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
auto_rebalance_criteria
list
- Set of criteria for se auto rebalance.
- Enum options - SE_AUTO_REBALANCE_CPU, SE_AUTO_REBALANCE_PPS, SE_AUTO_REBALANCE_MBPS, SE_AUTO_REBALANCE_OPEN_CONNS, SE_AUTO_REBALANCE_CPS.
- Field introduced in 17.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
auto_rebalance_interval
int
- Frequency of rebalance, if 'auto rebalance' is enabled.
- Unit is sec.
- 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 300.
auto_redistribute_active_standby_load
bool
- 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.
- 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.
availability_zone_refs
list
- Availability zones for virtual service high availability.
- It is a reference to an object of type availabilityzone.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
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.
baremetal_dispatcher_handles_flows
bool
- Control if dispatcher core also handles tcp flows in baremetal se.
- Field introduced in 21.1.3.
- 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 False.
bgp_peer_monitor_failover_enabled
bool
- Enable bgp peer monitoring based failover.
- Field introduced in 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.
bgp_state_update_interval
int
- Bgp peer state update interval.
- Allowed values are 5-100.
- Field introduced in 17.2.14,18.1.5,18.2.1.
- Unit is sec.
- 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 60.
buffer_se
int
- Excess service engine capacity provisioned for ha failover.
- 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 1.
cloud_ref
str
- It is a reference to an object of type cloud.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
compress_ip_rules_for_each_ns_subnet
bool
- Compress ip rules into a single subnet based ip rule for each north-south ipam subnet configured in pcap mode in openshift/kubernetes node.
- 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 True.
config_debugs_on_all_cores
bool
- Enable config debugs on all cores of se.
- Field introduced in 17.2.13,18.1.5,18.2.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.
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.
connection_memory_percentage
int
- 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.
- Unit is percent.
- 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 50.
core_shm_app_cache
bool
- Include shared memory for app cache in core file.requires se reboot.
- Field introduced in 18.2.8, 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.
core_shm_app_learning
bool
- Include shared memory for app learning in core file.requires se reboot.
- Field introduced in 18.2.8, 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.
cpu_reserve
bool
- 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.
cpu_socket_affinity
bool
- Allocate all the cpu cores for the service engine virtual machines on the same cpu socket.
- Applicable only for vcenter cloud.
- 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.
custom_securitygroups_data
list
- Custom security groups to be associated with data vnics for se instances in openstack and aws clouds.
- Field introduced in 17.1.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
custom_securitygroups_mgmt
list
- Custom security groups to be associated with management vnic for se instances in openstack and aws clouds.
- Field introduced in 17.1.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
custom_tag
list
- 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.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
data_network_id
str
- Subnet used to spin up the data nic for service engines, used only for azure cloud.
- Overrides the cloud level setting for service engine subnet.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
datascript_timeout
int
- Number of instructions before datascript times out.
- Allowed values are 0-100000000.
- Field introduced in 18.2.3.
- 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 1000000.
deactivate_ipv6_discovery
bool
- If activated, ipv6 address and route discovery are deactivated.requires se reboot.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
deactivate_kni_filtering_at_dispatcher
bool
- Deactivate filtering of packets to kni interface.
- To be used under surveillance of avi support.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
dedicated_dispatcher_core
bool
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
description
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
disable_avi_securitygroups
bool
- By default, avi creates and manages security groups along with custom sg provided by user.
- Set this to true to disallow avi to create and manage new security groups.
- Avi will only make use of custom security groups provided by user.
- This option is supported for aws and openstack cloud types.
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
disable_csum_offloads
bool
- Stop using tcp/udp and ip checksum offload features of nics.
- Field introduced in 17.1.14, 17.2.5, 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.
disable_flow_probes
bool
- Disable flow probes for scaled out vs'es.
- Field introduced in 20.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.
disable_gro
bool
- Disable generic receive offload (gro) in dpdk poll-mode driver packet receive path.
- Gro is on by default on nics that do not support lro (large receive offload) or do not gain performance boost from lro.
- Field introduced in 17.2.5, 18.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
disable_se_memory_check
bool
- If set, disable the config memory check done in service engine.
- Field introduced in 18.1.2.
- 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.
disable_tso
bool
- Disable tcp segmentation offload (tso) in dpdk poll-mode driver packet transmit path.
- Tso is on by default on nics that support it.
- Field introduced in 17.2.5, 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.
disk_per_se
int
- Amount of disk space for each of the service engine virtual machines.
- Unit is gb.
- 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 15.
distribute_load_active_standby
bool
- Use both the active and standby service engines for virtual service placement in the legacy active standby ha mode.
- 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.
distribute_queues
bool
- Distributes queue ownership among cores so multiple cores handle dispatcher duties.
- Requires se reboot.
- Deprecated from 18.2.8, instead use max_queues_per_vnic.
- Field introduced in 17.2.8.
- 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.
distribute_vnics
bool
- Distributes vnic ownership among cores so multiple cores handle dispatcher duties.requires se reboot.
- Field introduced in 18.2.5.
- 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.
downstream_send_timeout
int
- Timeout for downstream to become writable.
- Field introduced in 21.1.1.
- Unit is milliseconds.
- 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 3600000.
dp_aggressive_deq_interval_msec
int
- Dequeue interval for receive queue from se_dp in aggressive mode.
- Allowed values are 1-1000.
- Field introduced in 21.1.1.
- Unit is milliseconds.
- 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 1.
dp_aggressive_enq_interval_msec
int
- Enqueue interval for request queue to se_dp in aggressive mode.
- Allowed values are 1-1000.
- Field introduced in 21.1.1.
- Unit is milliseconds.
- 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 1.
dp_aggressive_hb_frequency
int
- Frequency of se - se hb messages when aggressive failure mode detection is enabled.
- Field introduced in 20.1.3.
- Unit is milliseconds.
- 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 100.
dp_aggressive_hb_timeout_count
int
- Consecutive hb failures after which failure is reported to controller,when aggressive failure mode detection is enabled.
- Field introduced in 20.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 10.
dp_deq_interval_msec
int
- Dequeue interval for receive queue from se_dp.
- Allowed values are 1-1000.
- Field introduced in 21.1.1.
- Unit is milliseconds.
- 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 20.
dp_enq_interval_msec
int
- Enqueue interval for request queue to se_dp.
- Allowed values are 1-1000.
- Field introduced in 21.1.1.
- Unit is milliseconds.
- 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 20.
dp_hb_frequency
int
- Frequency of se - se hb messages when aggressive failure mode detection is not enabled.
- Field introduced in 20.1.3.
- Unit is milliseconds.
- 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 100.
dp_hb_timeout_count
int
- Consecutive hb failures after which failure is reported to controller, when aggressive failure mode detection is not enabled.
- Field introduced in 20.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 10.
dpdk_gro_timeout_interval
int
- The timeout for gro coalescing interval.
- 0 indicates non-timer based gro.
- Allowed values are 0-900.
- Field introduced in 22.1.1.
- Unit is microseconds.
- 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 50.
enable_gratarp_permanent
bool
- Enable gratarp for vip_ip.
- Field introduced in 18.2.3.
- 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_hsm_log
bool
- Enable hsm luna engine logs.
- Field introduced in 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.
enable_hsm_priming
bool
- (this is a beta feature).
- Enable hsm key priming.
- If enabled, key handles on the hsm will be synced to se before processing client connections.
- Field introduced in 17.2.7, 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.
enable_multi_lb
bool
- Applicable only for azure cloud with basic sku lb.
- If set, additional azure lbs will be automatically created if resources in existing lb are exhausted.
- Field introduced in 17.2.10, 18.1.2.
- 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_pcap_tx_ring
bool
- Enable tx ring support in pcap mode of operation.
- Tso feature is not supported with tx ring enabled.
- Deprecated from 18.2.8, instead use pcap_tx_mode.
- Requires se reboot.
- Field introduced in 18.2.5.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ephemeral_portrange_end
int
- End local ephemeral port number for outbound connections.
- Field introduced in 17.2.13, 18.1.5, 18.2.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ephemeral_portrange_start
int
- Start local ephemeral port number for outbound connections.
- Field introduced in 17.2.13, 18.1.5, 18.2.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
extra_config_multiplier
float
- Multiplier for extra config to support large vs/pool config.
- 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 0.0.
extra_shared_config_memory
int
- Extra config memory to support large geo db configuration.
- Field introduced in 17.1.1.
- Unit is mb.
- 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 0.
flow_table_new_syn_max_entries
int
- Maximum number of flow table entries that have not completed tcp three-way handshake yet.
- Field introduced in 17.2.5.
- 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 0.
free_list_size
int
- Number of entries in the free list.
- Field introduced in 17.2.10, 18.1.2.
- 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 1024.
gcp_config
dict
- Google cloud platform, service engine group configuration.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
gratarp_permanent_periodicity
int
- Gratarp periodicity for vip-ip.
- Allowed values are 5-30.
- Field introduced in 18.2.3.
- Unit is min.
- 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 10.
grpc_channel_connect_timeout
int
- Timeout in seconds that se waits for a grpc channel to connect to server, before it retries.
- Allowed values are 5-45.
- Field introduced in 22.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 15.
ha_mode
str
- 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.
- Allowed in enterprise edition with any value, essentials edition(allowed values- ha_mode_legacy_active_standby), basic edition(allowed values-
- ha_mode_legacy_active_standby), enterprise with cloud services edition.
- Special default for essentials edition is ha_mode_legacy_active_standby, basic edition is ha_mode_legacy_active_standby, enterprise is
- ha_mode_shared.
- Default value when not specified in API or module is interpreted by Avi Controller as HA_MODE_SHARED.
handle_per_pkt_attack
bool
- Configuration to handle per packet attack handling.for example, dns reflection attack is a type of attack where a response packet is sent to the
- dns vs.this configuration tells if such packets should be dropped without further processing.
- Field introduced in 20.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 True.
hardwaresecuritymodulegroup_ref
str
- It is a reference to an object of type hardwaresecuritymodulegroup.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
heap_minimum_config_memory
int
- Minimum required heap memory to apply any configuration.
- Allowed values are 0-100.
- Field introduced in 18.1.2.
- Unit is mb.
- 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 8.
hm_on_standby
bool
- Enable active health monitoring from the standby se for all placed virtual services.
- Allowed in enterprise edition with any value, essentials edition(allowed values- false), basic edition(allowed values- false), enterprise with
- cloud services edition.
- Special default for essentials edition is false, basic edition is false, enterprise is true.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
host_attribute_key
str
- Key of a (key, value) pair identifying a label for a set of nodes usually in container clouds.
- Needs to be specified together with host_attribute_value.
- Ses can be configured differently including ha modes across different se groups.
- May also be used for isolation between different classes of virtualservices.
- Virtualservices' se group may be specified via annotations/labels.
- A openshift/kubernetes namespace maybe annotated with a matching se group label as openshift.io/node-selector apptype=prod.
- When multiple se groups are used in a cloud with host attributes specified,just a single se group can exist as a match-all se group without a
- host_attribute_key.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
host_attribute_value
str
- Value of a (key, value) pair identifying a label for a set of nodes usually in container clouds.
- Needs to be specified together with host_attribute_key.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
host_gateway_monitor
bool
- Enable the host gateway monitor when service engine is deployed as docker container.
- Disabled by default.
- Field introduced in 17.2.4.
- 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.
http_rum_console_log
bool
- Enable javascript console logs on the client browser when collecting client insights.
- Field introduced in 21.1.1.
- 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.
http_rum_min_content_length
int
- Minimum response size content length to sample for client insights.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition(allowed values- 64), basic edition(allowed values- 64), enterprise with cloud
- services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 64.
hybrid_rss_mode
bool
- Toggles se hybrid only mode of operation in dpdk mode with rss configured;where-in each se datapath instance operates as an independent
- standalonehybrid instance performing both dispatcher and proxy function.
- Requires reboot.
- Field introduced in 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.
hypervisor
str
- Override default hypervisor.
- Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ignore_docker_mac_change
bool
- Ignore docker mac change.
- Field introduced in 21.1.3.
- 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 True.
ignore_rtt_threshold
int
- Ignore rtt samples if it is above threshold.
- Field introduced in 17.1.6,17.2.2.
- Unit is milliseconds.
- 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 5000.
ingress_access_data
str
- Program se security group ingress rules to allow vip data access from remote cidr type.
- Enum options - SG_INGRESS_ACCESS_NONE, SG_INGRESS_ACCESS_ALL, SG_INGRESS_ACCESS_VPC.
- Field introduced in 17.1.5.
- 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 SG_INGRESS_ACCESS_ALL.
ingress_access_mgmt
str
- Program se security group ingress rules to allow ssh/icmp management access from remote cidr type.
- Enum options - SG_INGRESS_ACCESS_NONE, SG_INGRESS_ACCESS_ALL, SG_INGRESS_ACCESS_VPC.
- Field introduced in 17.1.5.
- 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 SG_INGRESS_ACCESS_ALL.
instance_flavor
str
- Instance/flavor name for se instance.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
instance_flavor_info
dict
- Additional information associated with instance_flavor.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
iptables
list
- Iptable rules.
- Maximum of 128 items allowed.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
l7_conns_per_core
int
- Number of l7 connections that can be cached per core.
- Field introduced in 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 16384.
l7_resvd_listen_conns_per_core
int
- Number of reserved l7 listener connections per core.
- Field introduced in 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 256.
labels
list
- Labels associated with this se group.
- Field introduced in 20.1.1.
- Maximum of 1 items allowed.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
lbaction_num_requests_to_dispatch
int
- Number of requests to dispatch from the request.
- Queue at a regular interval.
- Field introduced in 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 4.
lbaction_rq_per_request_max_retries
int
- Maximum retries per request in the request queue.
- Field introduced in 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 22.
least_load_core_selection
bool
- Select core with least load for new flow.
- 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 True.
license_tier
str
- Specifies the license tier which would be used.
- This field by default inherits the value from cloud.
- 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.
- Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH.
- Field introduced in 17.2.5.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
log_agent_compress_logs
bool
- Flag to indicate if log files are compressed upon full on the service engine.
- Field introduced in 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 True.
log_agent_debug_enabled
bool
- Enable debug logs by default on service engine.
- This includes all other debugging logs.
- Debug logs can also be explcitly enabled from the cli shell.
- Field introduced in 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.
log_agent_file_sz_appl
int
- Maximum application log file size before rollover.
- Field introduced in 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 4.
log_agent_file_sz_conn
int
- Maximum connection log file size before rollover.
- Field introduced in 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 4.
log_agent_file_sz_debug
int
- Maximum debug log file size before rollover.
- Field introduced in 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 4.
log_agent_file_sz_event
int
- Maximum event log file size before rollover.
- Field introduced in 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 4.
log_agent_log_storage_min_sz
int
- Minimum storage allocated for logs irrespective of memory and cores.
- Field introduced in 21.1.1.
- Unit is mb.
- 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 1024.
log_agent_max_concurrent_rsync
int
- Maximum concurrent rsync requests initiated from log-agent to the controller.
- Field introduced in 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 1024.
log_agent_max_storage_excess_percent
int
- Excess percentage threshold of disk size to trigger cleanup of logs on the service engine.
- Field introduced in 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 110.
log_agent_max_storage_ignore_percent
float
- Maximum storage on the disk not allocated for logs on the service engine.
- Field introduced in 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 20.0.
log_agent_min_storage_per_vs
int
- Minimum storage allocated to any given virtualservice on the service engine.
- Field introduced in 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 10.
log_agent_sleep_interval
int
- Internal timer to stall log-agent and prevent it from hogging cpu cycles on the service engine.
- Field introduced in 21.1.1.
- Unit is milliseconds.
- 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 10.
log_agent_trace_enabled
bool
- Enable trace logs by default on service engine.
- Configuration operations are logged along with other important logs by service engine.
- Field introduced in 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 True.
log_agent_unknown_vs_timer
int
- Timeout to purge unknown virtual service logs from the service engine.
- Field introduced in 21.1.1.
- Unit is sec.
- 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 1800.
log_disksz
int
- Maximum disk capacity (in mb) to be allocated to an se.
- This is exclusively used for debug and log data.
- Unit is mb.
- 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 10000.
log_malloc_failure
bool
- Se will log memory allocation related failure to the se_trace file, wherever available.
- Field introduced in 20.1.2.
- 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.
log_message_max_file_list_size
int
- Maximum number of file names in a log message.
- Field introduced in 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 64.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.7.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
max_concurrent_external_hm
int
- Maximum number of external health monitors that can run concurrently in a service engine.
- This helps control the cpu and memory use by external health monitors.
- Special values are 0- value will be internally calculated based on cpu and memory.
- Field introduced in 18.2.7.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
max_cpu_usage
int
- 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.
- Unit is percent.
- 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 80.
max_memory_per_mempool
int
- Max bytes that can be allocated in a single mempool.
- Field introduced in 18.1.5.
- Unit is mb.
- 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 64.
max_num_se_dps
int
- Configures the maximum number of se_dp processes that handles traffic.
- If not configured, defaults to the number of cpus on the se.
- If decreased, it will only take effect after se reboot.
- Allowed values are 1-128.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials edition(allowed values- 0), basic edition(allowed values- 0), enterprise with cloud
- services edition.
max_public_ips_per_lb
int
- Applicable to azure platform only.
- Maximum number of public ips per azure lb.
- Field introduced in 17.2.12, 18.1.2.
- 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 30.
max_queues_per_vnic
int
- Maximum number of queues per vnic setting to '0' utilises all queues that are distributed across dispatcher cores.
- Allowed values are 0,1,2,4,8,16.
- Field introduced in 18.2.7, 20.1.1.
- Allowed in enterprise edition with any value, essentials edition(allowed values- 1), basic edition(allowed values- 1), enterprise with cloud
- services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
max_rules_per_lb
int
- Applicable to azure platform only.
- Maximum number of rules per azure lb.
- Field introduced in 17.2.12, 18.1.2.
- 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 150.
max_scaleout_per_vs
int
- Maximum number of active service engines for the virtual service.
- Allowed values are 1-64.
- 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 4.
max_se
int
- Maximum number of services engines in this group.
- Allowed values are 0-1000.
- 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 10.
max_vs_per_se
int
- Maximum number of virtual services that can be placed on a single service engine.
- Allowed values are 1-1000.
- 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 10.
mem_reserve
bool
- 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 True.
memory_for_config_update
int
- Indicates the percent of memory reserved for config updates.
- Allowed values are 0-100.
- Field introduced in 18.1.2.
- Unit is percent.
- 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 15.
memory_per_se
int
- Amount of memory for each of the service engine virtual machines.
- Changes to this setting do not affect existing ses.
- 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 2048.
mgmt_network_ref
str
- Management network to use for avi service engines.
- It is a reference to an object of type network.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
mgmt_subnet
dict
- Management subnet to use for avi service engines.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
min_cpu_usage
int
- 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.
- Unit is percent.
- 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 30.
min_scaleout_per_vs
int
- Minimum number of active service engines for the virtual service.
- Allowed values are 1-64.
- 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 1.
min_se
int
- Minimum number of services engines in this group (relevant for se autorebalance only).
- Allowed values are 0-1000.
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
minimum_connection_memory
int
- Indicates the percent of memory reserved for connections.
- Allowed values are 0-100.
- Field introduced in 18.1.2.
- Unit is percent.
- 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 20.
n_log_streaming_threads
int
- Number of threads to use for log streaming.
- Allowed values are 1-100.
- Field introduced in 17.2.12, 18.1.2.
- 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 1.
name
str
required: true
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
non_significant_log_throttle
int
- This setting limits the number of non-significant logs generated per second per core on this se.
- Default is 100 logs per second.
- Set it to zero (0) to deactivate throttling.
- Field introduced in 17.1.3.
- Unit is per_second.
- 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 100.
ns_helper_deq_interval_msec
int
- Dequeue interval for receive queue from ns helper.
- Allowed values are 1-1000.
- Field introduced in 21.1.1.
- Unit is milliseconds.
- 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 20.
ntp_sync_fail_event
bool
- Toggle se ntp synchronization failure events generation.
- Disabled by default.
- Field introduced in 22.1.2.
- 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 False.
ntp_sync_status_interval
int
- Configures the interval at which se synchronization status with ntp server(s) is verified.
- A value of zero disables se ntp synchronization status validation.
- Allowed values are 120-900.
- Special values are 0- disable.
- Field introduced in 22.1.2.
- Unit is sec.
- 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 0.
num_dispatcher_cores
int
- Number of dispatcher cores (0,1,2,4,8 or 16).
- If set to 0, then number of dispatcher cores is deduced automatically.requires se reboot.
- Allowed values are 0,1,2,4,8,16.
- Field introduced in 17.2.12, 18.1.3, 18.2.1.
- Allowed in enterprise edition with any value, essentials edition(allowed values- 0), basic edition(allowed values- 0), enterprise with cloud
- services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
num_dispatcher_queues
int
- Number of queues to each dispatcher.
- Allowed values are 1-2.
- Field introduced in 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 1.
objsync_config
dict
- Configuration knobs for interse object distribution.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
objsync_port
int
- Tcp port on se management interface for interse object distribution.
- Supported only for externally managed security groups.
- Not supported on full access deployments.
- Requires se reboot.
- Field introduced in 20.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 9001.
openstack_availability_zones
list
- Field introduced in 17.1.1.
- Maximum of 5 items allowed.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
openstack_mgmt_network_name
str
- Avi management network name.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
openstack_mgmt_network_uuid
str
- Management network uuid.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
os_reserved_memory
int
- Amount of extra memory to be reserved for use by the operating system on a service engine.
- Unit is mb.
- 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 0.
per_app
bool
- 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.
- 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.
per_vs_admission_control
bool
- Enable/disable per vs level admission control.enabling this feature will cause the connection and packet throttling on a particular vs that has
- high packet buffer consumption.
- Field introduced in 20.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.
placement_mode
str
- If placement mode is 'auto', virtual services are automatically placed on service engines.
- Enum options - PLACEMENT_MODE_AUTO.
- 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 PLACEMENT_MODE_AUTO.
realtime_se_metrics
dict
- Enable or deactivate real time se metrics.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
reboot_on_panic
bool
- Reboot the vm or host on kernel panic.
- Field introduced in 18.2.5.
- 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 True.
replay_vrf_routes_interval
int
- Routes in vrf are replayed at the specified interval.
- This should be increased if there are large number of routes.
- Allowed values are 0-3000.
- Field introduced in 22.1.3.
- Unit is milliseconds.
- 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 1000.
resync_time_interval
int
- Time interval to re-sync se's time with wall clock time.
- Allowed values are 8-600000.
- Field introduced in 20.1.1.
- Unit is milliseconds.
- 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 65536.
sdb_flush_interval
int
- Sdb pipeline flush interval.
- Allowed values are 1-10000.
- Field introduced in 21.1.1.
- Unit is milliseconds.
- 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 100.
sdb_pipeline_size
int
- Sdb pipeline size.
- Allowed values are 1-10000.
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as 100.
sdb_scan_count
int
- Sdb scan count.
- Allowed values are 1-1000.
- 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.
- Default value when not specified in API or module is interpreted by Avi Controller as 1000.
se_bandwidth_type
str
- Select the se bandwidth for the bandwidth license.
- Enum options - SE_BANDWIDTH_UNLIMITED, SE_BANDWIDTH_25M, SE_BANDWIDTH_200M, SE_BANDWIDTH_1000M, SE_BANDWIDTH_10000M.
- Field introduced in 17.2.5.
- Allowed in enterprise edition with any value, essentials edition(allowed values- se_bandwidth_unlimited), basic edition(allowed values-
- se_bandwidth_unlimited), enterprise with cloud services edition.
se_delayed_flow_delete
bool
- Delay the cleanup of flowtable entry.
- To be used under surveillance of avi support.
- Field introduced in 20.1.2.
- 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.
se_deprovision_delay
int
- 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.
- Unit is min.
- 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 120.
se_dos_profile
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
se_dp_hm_drops
int
- Internal only.
- Used to simulate se - se hb failure.
- Field introduced in 20.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 0.
se_dp_if_state_poll_interval
int
- Number of jiffies between polling interface state.
- Field introduced in 21.1.3.
- 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 10.
se_dp_isolation
bool
- Toggle support to run se datapath instances in isolation on exclusive cpus.
- This improves latency and performance.
- However, this could reduce the total number of se_dp instances created on that se instance.
- Supported for >= 8 cpus.
- Requires se reboot.
- Field introduced in 20.1.4.
- 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_dp_isolation_num_non_dp_cpus
int
- Number of cpus for non se-dp tasks in se datapath isolation mode.
- Translates total cpus minus 'num_non_dp_cpus' for datapath use.
- It is recommended to reserve an even number of cpus for hyper-threaded processors.
- Requires se reboot.
- Allowed values are 1-8.
- Special values are 0- auto.
- Field introduced in 20.1.4.
- 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 0.
se_dp_log_nf_enqueue_percent
int
- Internal buffer full indicator on the service engine beyond which the unfiltered logs are abandoned.
- Field introduced in 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 70.
se_dp_log_udf_enqueue_percent
int
- Internal buffer full indicator on the service engine beyond which the user filtered logs are abandoned.
- Field introduced in 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 90.
se_dpdk_pmd
int
- Determines if dpdk pool mode driver should be used or not 0 automatically determine based on hypervisor/nic type 1 unconditionally use dpdk
- poll mode driver 2 don't use dpdk poll mode driver.requires se reboot.
- Allowed values are 0-2.
- Field introduced in 18.1.3.
- 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 0.
se_emulated_cores
int
- Use this to emulate more/less cpus than is actually available.
- One datapath process is started for each core.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, essentials edition(allowed values- 0), basic edition(allowed values- 0), enterprise with cloud
- services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
se_hyperthreaded_mode
str
- Controls the distribution of se data path processes on cpus which support hyper-threading.
- Requires hyper-threading to be enabled at host level.
- Requires se reboot.
- For more details please refer to se placement kb.
- Enum options - SE_CPU_HT_AUTO, SE_CPU_HT_SPARSE_DISPATCHER_PRIORITY, SE_CPU_HT_SPARSE_PROXY_PRIORITY, SE_CPU_HT_PACKED_CORES.
- Field introduced in 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 SE_CPU_HT_AUTO.
se_lro
bool
- Enable or disable large receive optimization for vnics.supported on vmxnet3.requires se reboot.
- Field introduced in 18.2.5.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
se_mtu
int
- Mtu for the vnics of ses in the se group.
- Allowed values are 512-9000.
- Field introduced in 18.2.8, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
se_name_prefix
str
- Prefix to use for virtual machine name of service engines.
- 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 Avi.
se_use_dpdk
int
- Determines if dpdk library should be used or not 0 automatically determine based on hypervisor type 1 use dpdk if pcap is not enabled 2
- don't use dpdk.
- Allowed values are 0-2.
- Field introduced in 18.1.3.
- 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 0.
self_se_election
bool
- Enable ses to elect a primary amongst themselves in the absence of a connectivity to controller.
- Field introduced in 18.1.2.
- 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.
significant_log_throttle
int
- This setting limits the number of significant logs generated per second per core on this se.
- Default is 100 logs per second.
- Set it to zero (0) to deactivate throttling.
- Field introduced in 17.1.3.
- Unit is per_second.
- 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 100.
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.
udf_log_throttle
int
- This setting limits the number of udf logs generated per second per core on this se.
- Udf logs are generated due to the configured client log filters or the rules with logging enabled.
- Default is 100 logs per second.
- Set it to zero (0) to deactivate throttling.
- Field introduced in 17.1.3.
- Unit is per_second.
- 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 100.
use_dp_util_for_scaleout
bool
- If enabled, the datapath cpu utilization is consulted by the auto scale-out logic.
- Field introduced in 22.1.3.
- 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 False.
use_hyperthreaded_cores
bool
- Enables the use of hyper-threaded cores on se.
- Requires se reboot.
- Field introduced in 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 True.
use_objsync
bool
- Enable interse objsyc distribution framework.
- Field introduced in 20.1.3.
- 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 True.
use_standard_alb
bool
- Use standard sku azure load balancer.
- By default cloud level flag is set.
- If not set, it inherits/uses the use_standard_alb flag from the cloud.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
user_agent_cache_config
dict
- Configuration for user-agent cache used in bot management.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
uuid
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
vcenter_clusters
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
vcenter_datastore_mode
str
- Enum options - VCENTER_DATASTORE_ANY, VCENTER_DATASTORE_LOCAL, VCENTER_DATASTORE_SHARED.
- 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 VCENTER_DATASTORE_ANY.
vcenter_datastores
list
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
vcenter_datastores_include
bool
- 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.
vcenter_folder
str
- Folder to place all the service engine virtual machines in vcenter.
- 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 AviSeFolder.
vcenter_hosts
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
vcenter_parking_vnic_pg
str
- Parking port group to be used by 9 vnics at the time of se creation.
- Field introduced in 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
vcenters
list
- Vcenter information for scoping at host/cluster level.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
vcpus_per_se
int
- Number of vcpus for each of the service engine virtual machines.
- Changes to this setting do not affect existing ses.
- 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 1.
vs_host_redundancy
bool
- Ensure primary and secondary service engines are deployed on different physical hosts.
- Allowed in enterprise edition with any value, essentials edition(allowed values- true), basic edition(allowed values- true), enterprise with
- cloud services edition.
- Special default for essentials edition is true, basic edition is true, enterprise is true.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
vs_scalein_timeout
int
- Time to wait for the scaled in se to drain existing flows before marking the scalein done.
- Unit is sec.
- 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 30.
vs_scalein_timeout_for_upgrade
int
- During se upgrade, time to wait for the scaled-in se to drain existing flows before marking the scalein done.
- Unit is sec.
- 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 30.
vs_scaleout_timeout
int
- Time to wait for the scaled out se to become ready before marking the scaleout done.
- Unit is sec.
- 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 600.
vs_se_scaleout_additional_wait_time
int
- Wait time for sending scaleout ready notification after virtual service is marked up.
- In certain deployments, there may be an additional delay to accept traffic.
- For example, for bgp, some time is needed for route advertisement.
- Allowed values are 0-300.
- Field introduced in 18.1.5,18.2.1.
- Unit is sec.
- 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 0.
vs_se_scaleout_ready_timeout
int
- Timeout in seconds for service engine to sendscaleout ready notification of a virtual service.
- Allowed values are 0-90.
- Field introduced in 18.1.5,18.2.1.
- Unit is sec.
- 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 60.
vs_switchover_timeout
int
- During se upgrade in a legacy active/standby segroup, time to wait for the new primary se to accept flows before marking the switchover done.
- Field introduced in 17.2.13,18.1.4,18.2.1.
- Unit is sec.
- 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 300.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create Serviceenginegroup object
      avi_serviceenginegroup:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_serviceenginegroup

Authors