GET /serviceenginegroup/{uuid}

GET /serviceenginegroup/{uuid}

/serviceenginegroup/{uuid}

Request
URI
GET
https://api_host/api/serviceenginegroup/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Responses
200

OK

Returns ServiceEngineGroup of type(s) application/json
{
    "_last_modified": "string",
    "accelerated_networking": false,
    "active_standby": false,
    "aggressive_failure_detection": false,
    "algo": "string",
    "allow_burst": false,
    "app_cache_percent": 0,
    "app_cache_threshold": 0,
    "app_learning_memory_percent": 0,
    "archive_shm_limit": 0,
    "async_ssl": false,
    "async_ssl_threads": 0,
    "auto_rebalance": false,
    "auto_rebalance_capacity_per_se": [
        0
    ],
    "auto_rebalance_criteria": [
        "string"
    ],
    "auto_rebalance_interval": 0,
    "auto_redistribute_active_standby_load": false,
    "availability_zone_refs": [
        "string"
    ],
    "baremetal_dispatcher_handles_flows": false,
    "bgp_peer_monitor_failover_enabled": false,
    "bgp_state_update_interval": 0,
    "buffer_se": 0,
    "cloud_ref": "string",
    "compress_ip_rules_for_each_ns_subnet": false,
    "config_debugs_on_all_cores": false,
    "configpb_attributes": {
        "version": 0
    },
    "connection_memory_percentage": 0,
    "core_shm_app_cache": false,
    "core_shm_app_learning": false,
    "cpu_reserve": false,
    "cpu_socket_affinity": false,
    "custom_securitygroups_data": [
        "string"
    ],
    "custom_securitygroups_mgmt": [
        "string"
    ],
    "custom_tag": [
        {
            "tag_key": "string",
            "tag_val": "string"
        }
    ],
    "data_network_id": "string",
    "datascript_timeout": 0,
    "deactivate_ipv6_discovery": false,
    "deactivate_kni_filtering_at_dispatcher": false,
    "dedicated_dispatcher_core": false,
    "description": "string",
    "disable_avi_securitygroups": false,
    "disable_csum_offloads": false,
    "disable_flow_probes": false,
    "disable_gro": false,
    "disable_se_memory_check": false,
    "disable_tso": false,
    "disk_per_se": 0,
    "distribute_load_active_standby": false,
    "distribute_queues": false,
    "distribute_vnics": false,
    "downstream_send_timeout": 0,
    "dp_aggressive_deq_interval_msec": 0,
    "dp_aggressive_enq_interval_msec": 0,
    "dp_aggressive_hb_frequency": 0,
    "dp_aggressive_hb_timeout_count": 0,
    "dp_deq_interval_msec": 0,
    "dp_enq_interval_msec": 0,
    "dp_hb_frequency": 0,
    "dp_hb_timeout_count": 0,
    "dpdk_gro_timeout_interval": 0,
    "enable_gratarp_permanent": false,
    "enable_hsm_log": false,
    "enable_hsm_priming": false,
    "enable_multi_lb": false,
    "enable_pcap_tx_ring": false,
    "ephemeral_portrange_end": 0,
    "ephemeral_portrange_start": 0,
    "extra_config_multiplier": "number",
    "extra_shared_config_memory": 0,
    "flow_table_new_syn_max_entries": 0,
    "free_list_size": 0,
    "gcp_config": {
        "backend_data_vpc_network_name": "string",
        "backend_data_vpc_project_id": "string",
        "backend_data_vpc_subnet_name": "string"
    },
    "gratarp_permanent_periodicity": 0,
    "grpc_channel_connect_timeout": 0,
    "ha_mode": "string",
    "handle_per_pkt_attack": false,
    "hardwaresecuritymodulegroup_ref": "string",
    "heap_minimum_config_memory": 0,
    "hm_on_standby": false,
    "host_attribute_key": "string",
    "host_attribute_value": "string",
    "host_gateway_monitor": false,
    "http_rum_console_log": false,
    "http_rum_min_content_length": 0,
    "hybrid_rss_mode": false,
    "hypervisor": "string",
    "ignore_docker_mac_change": false,
    "ignore_rtt_threshold": 0,
    "ingress_access_data": "string",
    "ingress_access_mgmt": "string",
    "instance_flavor": "string",
    "instance_flavor_info": {
        "cost": "string",
        "disk_gb": 0,
        "enhanced_nw": false,
        "id": "string",
        "is_recommended": false,
        "max_ip6s_per_nic": 0,
        "max_ips_per_nic": 0,
        "max_nics": 0,
        "meta": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "name": "string",
        "public": false,
        "ram_mb": 0,
        "vcpus": 0
    },
    "iptables": [
        {
            "chain": "string",
            "rules": [
                {
                    "action": "string",
                    "dnat_ip": {
                        "addr": "string",
                        "type": "string"
                    },
                    "dst_ip": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "dst_port": {
                        "end": 0,
                        "start": 0
                    },
                    "input_interface": "string",
                    "output_interface": "string",
                    "proto": "string",
                    "src_ip": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "src_port": {
                        "end": 0,
                        "start": 0
                    },
                    "tag": "string"
                }
            ],
            "table": "string"
        }
    ],
    "kni_allowed_server_ports": [
        {
            "protocol": "string",
            "range": {
                "end": 0,
                "start": 0
            }
        }
    ],
    "l7_conns_per_core": 0,
    "l7_resvd_listen_conns_per_core": 0,
    "labels": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "lbaction_num_requests_to_dispatch": 0,
    "lbaction_rq_per_request_max_retries": 0,
    "least_load_core_selection": false,
    "license_tier": "string",
    "license_type": "string",
    "log_agent_compress_logs": false,
    "log_agent_debug_enabled": false,
    "log_agent_file_sz_appl": 0,
    "log_agent_file_sz_conn": 0,
    "log_agent_file_sz_debug": 0,
    "log_agent_file_sz_event": 0,
    "log_agent_log_storage_min_sz": 0,
    "log_agent_max_concurrent_rsync": 0,
    "log_agent_max_storage_excess_percent": 0,
    "log_agent_max_storage_ignore_percent": "number",
    "log_agent_min_storage_per_vs": 0,
    "log_agent_sleep_interval": 0,
    "log_agent_trace_enabled": false,
    "log_agent_unknown_vs_timer": 0,
    "log_disksz": 0,
    "log_malloc_failure": false,
    "log_message_max_file_list_size": 0,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "max_concurrent_external_hm": 0,
    "max_cpu_usage": 0,
    "max_memory_per_mempool": 0,
    "max_num_http_sessions_to_store": 0,
    "max_num_se_dps": 0,
    "max_public_ips_per_lb": 0,
    "max_queues_per_vnic": 0,
    "max_rules_per_lb": 0,
    "max_scaleout_per_vs": 0,
    "max_se": 0,
    "max_skb_frags": 0,
    "max_vs_per_se": 0,
    "mem_reserve": false,
    "memory_for_config_update": 0,
    "memory_per_se": 0,
    "metrics_collection_mode": 0,
    "mgmt_network_ref": "string",
    "mgmt_subnet": {
        "ip_addr": {
            "addr": "string",
            "type": "string"
        },
        "mask": 0
    },
    "min_cpu_usage": 0,
    "min_scaleout_per_vs": 0,
    "min_se": 0,
    "minimum_connection_memory": 0,
    "multicast_enable": false,
    "n_log_streaming_threads": 0,
    "name": "string",
    "netlink_poller_threads": 0,
    "netlink_sock_buf_size": 0,
    "ngx_free_connection_stack": false,
    "non_significant_log_throttle": 0,
    "ns_helper_deq_interval_msec": 0,
    "ntp_sync_fail_event": false,
    "ntp_sync_status_interval": 0,
    "num_dispatcher_cores": 0,
    "num_dispatcher_queues": 0,
    "num_flow_cores_sum_changes_to_ignore": 0,
    "objsync_config": {
        "objsync_cpu_limit": 0,
        "objsync_hub_elect_interval": 0,
        "objsync_reconcile_interval": 0
    },
    "objsync_port": 0,
    "openstack_availability_zones": [
        "string"
    ],
    "openstack_mgmt_network_name": "string",
    "openstack_mgmt_network_uuid": "string",
    "os_reserved_memory": 0,
    "path_mtu_discovery_v4": false,
    "path_mtu_discovery_v6": false,
    "pcap_tx_mode": "string",
    "pcap_tx_ring_rd_balancing_factor": 0,
    "per_app": false,
    "per_vs_admission_control": false,
    "placement_mode": "string",
    "realtime_se_metrics": {
        "duration": 0,
        "enabled": false
    },
    "reboot_on_panic": false,
    "replay_vrf_routes_interval": 0,
    "resync_time_interval": 0,
    "sdb_flush_interval": 0,
    "sdb_pipeline_size": 0,
    "sdb_scan_count": 0,
    "se_bandwidth_type": "string",
    "se_debug_trace_sz": 0,
    "se_delayed_flow_delete": false,
    "se_deprovision_delay": 0,
    "se_dos_profile": {
        "thresh_info": [
            {
                "attack": "string",
                "max_value": 0,
                "min_value": 0
            }
        ],
        "thresh_period": 0
    },
    "se_dp_hm_drops": 0,
    "se_dp_if_state_poll_interval": 0,
    "se_dp_isolation": false,
    "se_dp_isolation_num_non_dp_cpus": 0,
    "se_dp_log_nf_enqueue_percent": 0,
    "se_dp_log_udf_enqueue_percent": 0,
    "se_dp_max_hb_version": 0,
    "se_dp_vnic_queue_stall_event_sleep": 0,
    "se_dp_vnic_queue_stall_threshold": 0,
    "se_dp_vnic_queue_stall_timeout": 0,
    "se_dp_vnic_restart_on_queue_stall_count": 0,
    "se_dp_vnic_stall_se_restart_window": 0,
    "se_dpdk_pmd": 0,
    "se_dump_core_on_assert": false,
    "se_emulated_cores": 0,
    "se_flow_probe_retries": 0,
    "se_flow_probe_retry_timer": 0,
    "se_group_analytics_policy": {
        "metrics_event_thresholds": [
            {
                "metrics_event_threshold_type": "string",
                "reset_threshold": "number",
                "watermark_thresholds": [
                    0
                ]
            }
        ]
    },
    "se_hyperthreaded_mode": "string",
    "se_ip_encap_ipc": 0,
    "se_kni_burst_factor": 0,
    "se_l3_encap_ipc": 0,
    "se_log_buffer_app_blocking_dequeue": false,
    "se_log_buffer_conn_blocking_dequeue": false,
    "se_log_buffer_events_blocking_dequeue": false,
    "se_lro": false,
    "se_mp_ring_retry_count": 0,
    "se_mtu": 0,
    "se_name_prefix": "string",
    "se_packet_buffer_max": 0,
    "se_pcap_lookahead": false,
    "se_pcap_pkt_count": 0,
    "se_pcap_pkt_sz": 0,
    "se_pcap_qdisc_bypass": false,
    "se_pcap_reinit_frequency": 0,
    "se_pcap_reinit_threshold": 0,
    "se_probe_port": 0,
    "se_rl_prop": {
        "msf_num_stages": 0,
        "msf_stage_size": 0
    },
    "se_rum_sampling_nav_interval": 0,
    "se_rum_sampling_nav_percent": 0,
    "se_rum_sampling_res_interval": 0,
    "se_rum_sampling_res_percent": 0,
    "se_sb_dedicated_core": false,
    "se_sb_threads": 0,
    "se_thread_multiplier": 0,
    "se_time_tracker_props": {
        "egress_audit_mode": "string",
        "egress_threshold": 0,
        "event_gen_window": 0,
        "ingress_audit_mode": "string",
        "ingress_threshold": 0
    },
    "se_tracert_port_range": {
        "end": 0,
        "start": 0
    },
    "se_tunnel_mode": 0,
    "se_tunnel_udp_port": 0,
    "se_tx_batch_size": 0,
    "se_txq_threshold": 0,
    "se_udp_encap_ipc": 0,
    "se_use_dpdk": 0,
    "se_vnic_tx_sw_queue_flush_frequency": 0,
    "se_vnic_tx_sw_queue_size": 0,
    "se_vs_hb_max_pkts_in_batch": 0,
    "se_vs_hb_max_vs_in_pkt": 0,
    "self_se_election": false,
    "send_se_ready_timeout": 0,
    "service_ip6_subnets": [
        {
            "ip_addr": {
                "addr": "string",
                "type": "string"
            },
            "mask": 0
        }
    ],
    "service_ip_subnets": [
        {
            "ip_addr": {
                "addr": "string",
                "type": "string"
            },
            "mask": 0
        }
    ],
    "shm_minimum_config_memory": 0,
    "significant_log_throttle": 0,
    "ssl_preprocess_sni_hostname": false,
    "ssl_sess_cache_per_vs": 0,
    "tenant_ref": "string",
    "transient_shared_memory_max": 0,
    "udf_log_throttle": 0,
    "upstream_connect_timeout": 0,
    "upstream_connpool_enable": false,
    "upstream_read_timeout": 0,
    "upstream_send_timeout": 0,
    "url": "string",
    "use_dp_util_for_scaleout": false,
    "use_hyperthreaded_cores": false,
    "use_legacy_netlink": false,
    "use_objsync": false,
    "use_standard_alb": false,
    "user_agent_cache_config": {
        "batch_size": 0,
        "controller_cache_size": 0,
        "max_age": 0,
        "max_last_hit_time": 0,
        "max_upstream_queries": 0,
        "max_wait_time": 0,
        "num_entries_upstream_update": 0,
        "percent_reserved_for_bad_bots": 0,
        "percent_reserved_for_browsers": 0,
        "percent_reserved_for_good_bots": 0,
        "percent_reserved_for_outstanding": 0,
        "se_cache_size": 0,
        "upstream_update_interval": 0
    },
    "user_defined_metric_age": 0,
    "uuid": "string",
    "vcenter_clusters": {
        "cluster_refs": [
            "string"
        ],
        "include": false
    },
    "vcenter_datastore_mode": "string",
    "vcenter_datastores": [
        {
            "datastore_name": "string",
            "managed_object_id": "string"
        }
    ],
    "vcenter_datastores_include": false,
    "vcenter_folder": "string",
    "vcenter_hosts": {
        "host_refs": [
            "string"
        ],
        "include": false
    },
    "vcenter_parking_vnic_pg": "string",
    "vcenters": [
        {
            "clusters": [
                {
                    "cluster_id": "string",
                    "override_vsphere_ha": false,
                    "vmg_name": "string"
                }
            ],
            "nsxt_clusters": {
                "cluster_ids": [
                    "string"
                ],
                "include": false
            },
            "nsxt_datastores": {
                "ds_ids": [
                    "string"
                ],
                "include": false
            },
            "nsxt_hosts": {
                "host_ids": [
                    "string"
                ],
                "include": false
            },
            "vcenter_folder": "string",
            "vcenter_ref": "string"
        }
    ],
    "vcpus_per_se": 0,
    "vip_asg": {
        "configuration": {
            "zones": [
                {
                    "availability_zone": "string",
                    "fip_capable": false,
                    "subnet_uuid": "string"
                }
            ]
        },
        "policy": {
            "dns_cooldown": 0,
            "max_size": 0,
            "min_size": 0,
            "suspend": false
        }
    },
    "vnic_dhcp_ip_check_interval": 0,
    "vnic_dhcp_ip_max_retries": 0,
    "vnic_ip_delete_interval": 0,
    "vnic_probe_interval": 0,
    "vnic_rpc_retry_interval": 0,
    "vnicdb_cmd_history_size": 0,
    "vs_host_redundancy": false,
    "vs_scalein_timeout": 0,
    "vs_scalein_timeout_for_upgrade": 0,
    "vs_scaleout_timeout": 0,
    "vs_se_primary_switchover_additional_wait_time": 0,
    "vs_se_scalein_additional_wait_time": 0,
    "vs_se_scaleout_additional_wait_time": 0,
    "vs_se_scaleout_ready_timeout": 0,
    "vs_switchover_timeout": 0,
    "vss_placement": {
        "core_nonaffinity": 0,
        "num_subcores": 0
    },
    "vss_placement_enabled": false,
    "waf_mempool": false,
    "waf_mempool_size": 0
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

boolean
accelerated_networking
Optional

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.

boolean
active_standby
Optional

Service Engines in active/standby mode for HA failover. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
aggressive_failure_detection
Optional

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.

string
algo
Optional

In compact placement, Virtual Services are placed on existing SEs until max_vs_per_se limit is reached. In distributed placement, Virtual Services are placed on new SEs until max_se limit is reached. Once this limit is reached, Virtual Services are placed on SEs with least load. Enum options - PLACEMENT_ALGO_PACKED, PLACEMENT_ALGO_DISTRIBUTED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
allow_burst
Optional

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.

integer As uint32 As uint32
app_cache_percent
Optional

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.

integer As uint32 As uint32
app_cache_threshold
Optional

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.

integer As uint32 As uint32
app_learning_memory_percent
Optional

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.

integer As uint32 As uint32
archive_shm_limit
Optional

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.

boolean
async_ssl
Optional

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.

integer As uint32 As uint32
async_ssl_threads
Optional

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.

boolean
auto_rebalance
Optional

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.

array of integer
auto_rebalance_capacity_per_se
Optional

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.

array of string
auto_rebalance_criteria
Optional

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.

integer As int32 As int32
auto_rebalance_interval
Optional

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.

boolean
auto_redistribute_active_standby_load
Optional

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.

array of string
availability_zone_refs
Optional

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.

boolean
baremetal_dispatcher_handles_flows
Optional

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.

boolean
bgp_peer_monitor_failover_enabled
Optional

Enable BGP peer monitoring based failover. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
bgp_state_update_interval
Optional

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.

integer As int32 As int32
buffer_se
Optional

Excess Service Engine capacity provisioned for HA failover. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
cloud_ref
Optional

It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
compress_ip_rules_for_each_ns_subnet
Optional

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.

boolean
config_debugs_on_all_cores
Optional

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.

configpb_attributes
Optional

configpb_attributes

integer As uint32 As uint32
connection_memory_percentage
Optional

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.

boolean
core_shm_app_cache
Optional

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.

boolean
core_shm_app_learning
Optional

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.

boolean
cpu_reserve
Optional

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

boolean
cpu_socket_affinity
Optional

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.

array of string
custom_securitygroups_data
Optional

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.

array of string
custom_securitygroups_mgmt
Optional

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.

array of CustomTag
custom_tag
Optional

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.

string
data_network_id
Optional

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.

integer As uint64 As uint64
datascript_timeout
Optional

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.

boolean
deactivate_ipv6_discovery
Optional

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.

boolean
deactivate_kni_filtering_at_dispatcher
Optional

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.

boolean
dedicated_dispatcher_core
Optional

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.

string
description
Optional

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

boolean
disable_avi_securitygroups
Optional

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.

boolean
disable_csum_offloads
Optional

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.

boolean
disable_flow_probes
Optional

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.

boolean
disable_gro
Optional

Disable Generic Receive Offload (GRO) in DPDK poll-mode driver packet receive path. GRO can be enabled on NICs that do not support LRO (Large Receive Offload) or do not gain performance boost from LRO. GRO is on by default on NICs in a system with 8 vCPUs or higher. Field introduced in 17.2.5, 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
disable_se_memory_check
Optional

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.

boolean
disable_tso
Optional

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.

integer As int32 As int32
disk_per_se
Optional

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.

boolean
distribute_load_active_standby
Optional

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.

boolean
distribute_queues
Optional

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.

boolean
distribute_vnics
Optional

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.

integer As uint32 As uint32
downstream_send_timeout
Optional

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.

integer As uint32 As uint32
dp_aggressive_deq_interval_msec
Optional

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.

integer As uint32 As uint32
dp_aggressive_enq_interval_msec
Optional

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.

integer As uint32 As uint32
dp_aggressive_hb_frequency
Optional

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.

integer As uint32 As uint32
dp_aggressive_hb_timeout_count
Optional

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.

integer As uint32 As uint32
dp_deq_interval_msec
Optional

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.

integer As uint32 As uint32
dp_enq_interval_msec
Optional

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.

integer As uint32 As uint32
dp_hb_frequency
Optional

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.

integer As uint32 As uint32
dp_hb_timeout_count
Optional

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.

integer As uint32 As uint32
dpdk_gro_timeout_interval
Optional

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.

boolean
enable_gratarp_permanent
Optional

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.

boolean
enable_hsm_log
Optional

Enable HSM luna engine logs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable_hsm_priming
Optional

(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.

boolean
enable_multi_lb
Optional

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.

boolean
enable_pcap_tx_ring
Optional

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.

integer As uint32 As uint32
ephemeral_portrange_end
Optional

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.

integer As uint32 As uint32
ephemeral_portrange_start
Optional

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.

number As double As double
extra_config_multiplier
Optional

Multiplier for extra config to support large VS/Pool config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
extra_shared_config_memory
Optional

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.

integer As uint32 As uint32
flow_table_new_syn_max_entries
Optional

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.

integer As uint32 As uint32
free_list_size
Optional

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.

gcp_config
Optional

gcp_config

integer As uint32 As uint32
gratarp_permanent_periodicity
Optional

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.

integer As uint32 As uint32
grpc_channel_connect_timeout
Optional

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.

string
ha_mode
Optional

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.

boolean
handle_per_pkt_attack
Optional

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.

string
hardwaresecuritymodulegroup_ref
Optional

It is a reference to an object of type HardwareSecurityModuleGroup. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
heap_minimum_config_memory
Optional

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.

boolean
hm_on_standby
Optional

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.

string
host_attribute_key
Optional

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.

string
host_attribute_value
Optional

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.

boolean
host_gateway_monitor
Optional

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.

boolean
http_rum_console_log
Optional

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.

integer As uint32 As uint32
http_rum_min_content_length
Optional

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.

boolean
hybrid_rss_mode
Optional

Toggles SE hybrid only mode of operation in DPDK mode with RSS configured;where-in each SE datapath instance operates as a standalone hybrid 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.

string
hypervisor
Optional

Override default hypervisor. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
ignore_docker_mac_change
Optional

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.

integer As uint32 As uint32
ignore_rtt_threshold
Optional

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.

string
ingress_access_data
Optional

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.

string
ingress_access_mgmt
Optional

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.

string
instance_flavor
Optional

Instance/Flavor name for SE instance. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

instance_flavor_info
Optional

instance_flavor_info

iptables
Optional

Iptable Rules. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

kni_allowed_server_ports
Optional

Port ranges for any servers running in inband LinuxServer clouds. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
l7_conns_per_core
Optional

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.

integer As uint32 As uint32
l7_resvd_listen_conns_per_core
Optional

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.

array of KeyValue
labels
Optional

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.

integer As uint32 As uint32
lbaction_num_requests_to_dispatch
Optional

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.

integer As uint32 As uint32
lbaction_rq_per_request_max_retries
Optional

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.

boolean
least_load_core_selection
Optional

Select core with least load for new flow. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
license_tier
Optional

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.

string
license_type
Optional

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.

boolean
log_agent_compress_logs
Optional

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.

boolean
log_agent_debug_enabled
Optional

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.

integer As uint32 As uint32
log_agent_file_sz_appl
Optional

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.

integer As uint32 As uint32
log_agent_file_sz_conn
Optional

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.

integer As uint32 As uint32
log_agent_file_sz_debug
Optional

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.

integer As uint32 As uint32
log_agent_file_sz_event
Optional

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.

integer As uint32 As uint32
log_agent_log_storage_min_sz
Optional

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.

integer As uint32 As uint32
log_agent_max_concurrent_rsync
Optional

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.

integer As uint32 As uint32
log_agent_max_storage_excess_percent
Optional

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.

number As float As float
log_agent_max_storage_ignore_percent
Optional

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.

integer As uint32 As uint32
log_agent_min_storage_per_vs
Optional

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.

integer As uint32 As uint32
log_agent_sleep_interval
Optional

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.

boolean
log_agent_trace_enabled
Optional

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.

integer As uint32 As uint32
log_agent_unknown_vs_timer
Optional

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.

integer As uint32 As uint32
log_disksz
Optional

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.

boolean
log_malloc_failure
Optional

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.

integer As uint32 As uint32
log_message_max_file_list_size
Optional

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.

markers
Optional

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.

integer As uint32 As uint32
max_concurrent_external_hm
Optional

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.

integer As int32 As int32
max_cpu_usage
Optional

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.

integer As uint32 As uint32
max_memory_per_mempool
Optional

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.

integer As uint32 As uint32
max_num_http_sessions_to_store
Optional

Maximum number of HTTP session that will be created. Each session uses about 1kB in the key-value storage in shared memory. Setting this value too high can lead to exhaustion of shared memory and affect services. Allowed values are 1-2000000. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_num_se_dps
Optional

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.

integer As uint32 As uint32
max_public_ips_per_lb
Optional

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.

integer As uint32 As uint32
max_queues_per_vnic
Optional

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.

integer As uint32 As uint32
max_rules_per_lb
Optional

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.

integer As uint32 As uint32
max_scaleout_per_vs
Optional

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.

integer As int32 As int32
max_se
Optional

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.

integer As uint32 As uint32
max_skb_frags
Optional

Maximum of number of 4 KB pages allocated to the Linux kernel GRO subsystem for packet coalescing. This parameter is limited to supported kernels only. Requires SE Reboot. Allowed values are 1-17. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
max_vs_per_se
Optional

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.

boolean
mem_reserve
Optional

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

integer As uint32 As uint32
memory_for_config_update
Optional

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.

integer As int32 As int32
memory_per_se
Optional

Amount of memory for each of the Service Engine virtual machines. Changes to this setting do not affect existing SEs. Allowed values are 2048-262144. Unit is MB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
metrics_collection_mode
Optional

Metrics collection mode, 0 = Pull mode. se_agent pulls metrics from se_dp, 1 = Push mode. se_dp pushes metrics to se_agent. 9 = special value to reset collection state in push mode. . Allowed values are 0-1. Special values are 9- Reset metrics collection state. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
mgmt_network_ref
Optional

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
Optional

mgmt_subnet

integer As int32 As int32
min_cpu_usage
Optional

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.

integer As int32 As int32
min_scaleout_per_vs
Optional

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.

integer As int32 As int32
min_se
Optional

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.

integer As uint32 As uint32
minimum_connection_memory
Optional

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.

boolean
multicast_enable
Optional

This knob enables the Service Engine to process multicast traffic(For VMware Hypervisor). Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
n_log_streaming_threads
Optional

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.

string
name
Required

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

integer As uint32 As uint32
netlink_poller_threads
Optional

Number of threads to poll for netlink messages excluding the thread for default namespace. Requires SE Reboot. Allowed values are 1-32. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
netlink_sock_buf_size
Optional

Socket buffer size for the netlink sockets. Requires SE Reboot. Allowed values are 1-128. Field introduced in 21.1.1. Unit is MEGA_BYTES. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
ngx_free_connection_stack
Optional

Free the connection stack. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
non_significant_log_throttle
Optional

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.

integer As uint32 As uint32
ns_helper_deq_interval_msec
Optional

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.

boolean
ntp_sync_fail_event
Optional

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.

integer As uint32 As uint32
ntp_sync_status_interval
Optional

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.

integer As uint32 As uint32
num_dispatcher_cores
Optional

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.

integer As uint32 As uint32
num_dispatcher_queues
Optional

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.

integer As uint32 As uint32
num_flow_cores_sum_changes_to_ignore
Optional

Number of changes in num flow cores sum to ignore. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

objsync_config
Optional

objsync_config

integer As uint32 As uint32
objsync_port
Optional

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. Allowed values are 1024-65535. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of string
openstack_availability_zones
Optional

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.

string
openstack_mgmt_network_name
Optional

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

string
openstack_mgmt_network_uuid
Optional

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

integer As uint32 As uint32
os_reserved_memory
Optional

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.

boolean
path_mtu_discovery_v4
Optional

Enable Path MTU Discovery feature for IPv4. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
path_mtu_discovery_v6
Optional

Enable Path MTU Discovery feature for IPv6. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
pcap_tx_mode
Optional

Determines the PCAP transmit mode of operation. Requires SE Reboot. Enum options - PCAP_TX_AUTO, PCAP_TX_SOCKET, PCAP_TX_RING. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
pcap_tx_ring_rd_balancing_factor
Optional

In PCAP mode, reserve a configured portion of TX ring resources for itself and the remaining portion for the RX ring to achieve better balance in terms of queue depth. Requires SE Reboot. Allowed values are 10-100. Field introduced in 20.1.3. Unit is PERCENT. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
per_app
Optional

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.

boolean
per_vs_admission_control
Optional

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.

string
placement_mode
Optional

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.

realtime_se_metrics
Optional

realtime_se_metrics

boolean
reboot_on_panic
Optional

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.

integer As uint32 As uint32
replay_vrf_routes_interval
Optional

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.

integer As uint32 As uint32
resync_time_interval
Optional

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.

integer As uint32 As uint32
sdb_flush_interval
Optional

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.

integer As uint32 As uint32
sdb_pipeline_size
Optional

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.

integer As uint32 As uint32
sdb_scan_count
Optional

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.

string
se_bandwidth_type
Optional

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.

integer As uint32 As uint32
se_debug_trace_sz
Optional

Use to cap the size of debug ring min(se_debug_trace_sz, num_dispatcher_cores). Only applicable to > 8G systems. Requires SE Reboot. Allowed values are 1,2,4,8,255. Field introduced in 22.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
se_delayed_flow_delete
Optional

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.

integer As int32 As int32
se_deprovision_delay
Optional

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.

se_dos_profile
Optional

se_dos_profile

integer As int32 As int32
se_dp_hm_drops
Optional

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.

integer As uint32 As uint32
se_dp_if_state_poll_interval
Optional

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.

boolean
se_dp_isolation
Optional

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.

integer As uint32 As uint32
se_dp_isolation_num_non_dp_cpus
Optional

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.

integer As uint32 As uint32
se_dp_log_nf_enqueue_percent
Optional

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.

integer As uint32 As uint32
se_dp_log_udf_enqueue_percent
Optional

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.

integer As uint32 As uint32
se_dp_max_hb_version
Optional

The highest supported SE-SE Heartbeat protocol version. This version is reported by Secondary SE to Primary SE in Heartbeat response messages. Allowed values are 1-3. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_dp_vnic_queue_stall_event_sleep
Optional

Time (in seconds) service engine waits for after generating a Vnic transmit queue stall event before resetting theNIC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_dp_vnic_queue_stall_threshold
Optional

Number of consecutive transmit failures to look for before generating a Vnic transmit queue stall event. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_dp_vnic_queue_stall_timeout
Optional

Time (in milliseconds) to wait for network/NIC recovery on detecting a transmit queue stall after which service engine resets the NIC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_dp_vnic_restart_on_queue_stall_count
Optional

Number of consecutive transmit queue stall events in se_dp_vnic_stall_se_restart_window to look for before restarting SE. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_dp_vnic_stall_se_restart_window
Optional

Window of time (in seconds) during which se_dp_vnic_restart_on_queue_stall_count number of consecutive stalls results in a SE restart. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_dpdk_pmd
Optional

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.

boolean
se_dump_core_on_assert
Optional

Enable core dump on assert. 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.

integer As uint32 As uint32
se_emulated_cores
Optional

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.

integer As uint32 As uint32
se_flow_probe_retries
Optional

Flow probe retry count if no replies are received.Requires SE Reboot. Allowed values are 0-5. Field introduced in 18.1.4, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_flow_probe_retry_timer
Optional

Timeout in milliseconds for flow probe retries.Requires SE Reboot. Allowed values are 20-50. Field introduced in 18.2.5. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

se_group_analytics_policy
Optional

se_group_analytics_policy

string
se_hyperthreaded_mode
Optional

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.

integer As uint32 As uint32
se_ip_encap_ipc
Optional

Determines if SE-SE IPC messages are encapsulated in an IP header 0 Automatically determine based on hypervisor type 1 Use IP encap unconditionally ~[0,1] Don't use IP encapRequires SE Reboot. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_kni_burst_factor
Optional

This knob controls the resource availability and burst size used between SE datapath and KNI. This helps in minimising packet drops when there is higher KNI traffic (non-VIP traffic from and to Linux). The factor takes the following values 0-default. 1-doubles the burst size and KNI resources. 2-quadruples the burst size and KNI resources. Allowed values are 0-2. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_l3_encap_ipc
Optional

Determines if SE-SE IPC messages use SE interface IP instead of VIP 0 Automatically determine based on hypervisor type 1 Use SE interface IP unconditionally ~[0,1] Don't use SE interface IPRequires SE Reboot. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
se_log_buffer_app_blocking_dequeue
Optional

Internal flag that blocks dataplane until all application logs are flushed to log-agent process. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
se_log_buffer_conn_blocking_dequeue
Optional

Internal flag that blocks dataplane until all connection logs are flushed to log-agent process. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
se_log_buffer_events_blocking_dequeue
Optional

Internal flag that blocks dataplane until all outstanding events are flushed to log-agent process. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
se_lro
Optional

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.

integer As uint32 As uint32
se_mp_ring_retry_count
Optional

The retry count for the multi-producer enqueue before yielding the CPU. To be used under surveillance of Avi Support. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 500), Basic edition(Allowed values- 500), Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_mtu
Optional

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.

string
se_name_prefix
Optional

Prefix to use for virtual machine name of Service Engines. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_packet_buffer_max
Optional

Internal use only. Used to artificially reduce the available number of packet buffers. 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.

boolean
se_pcap_lookahead
Optional

Enables lookahead mode of packet receive in PCAP mode. Introduced to overcome an issue with hv_netvsc driver. Lookahead mode attempts to ensure that application and kernel's view of the receive rings are consistent. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_pcap_pkt_count
Optional

Max number of packets the pcap interface can hold and if the value is 0 the optimum value will be chosen. The optimum value will be chosen based on SE-memory, Cloud Type and Number of Interfaces.Requires SE Reboot. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_pcap_pkt_sz
Optional

Max size of each packet in the pcap interface. Requires SE Reboot. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
se_pcap_qdisc_bypass
Optional

Bypass the kernel's traffic control layer, to deliver packets directly to the driver. Enabling this feature results in egress packets not being captured in host tcpdump. Note brief packet reordering or loss may occur upon toggle. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_pcap_reinit_frequency
Optional

Frequency in seconds at which periodically a PCAP reinit check is triggered. May be used in conjunction with the configuration pcap_reinit_threshold. (Valid range 15 mins - 12 hours, 0 - disables). Allowed values are 900-43200. Special values are 0- disable. Field introduced in 17.2.13, 18.1.3, 18.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_pcap_reinit_threshold
Optional

Threshold for input packet receive errors in PCAP mode exceeding which a PCAP reinit is triggered. If not set, an unconditional reinit is performed. This value is checked every pcap_reinit_frequency interval. Field introduced in 17.2.13, 18.1.3, 18.2.1. Unit is METRIC_COUNT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_probe_port
Optional

TCP port on SE where echo service will be run. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

se_rl_prop
Optional

se_rl_prop

integer As uint32 As uint32
se_rum_sampling_nav_interval
Optional

Minimum time to wait on server between taking sampleswhen sampling the navigation timing data from the end user client. Field introduced in 18.2.6. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_rum_sampling_nav_percent
Optional

Percentage of navigation timing data from the end user client, used for sampling to get client insights. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_rum_sampling_res_interval
Optional

Minimum time to wait on server between taking sampleswhen sampling the resource timing data from the end user client. Field introduced in 18.2.6. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_rum_sampling_res_percent
Optional

Percentage of resource timing data from the end user client used for sampling to get client insight. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
se_sb_dedicated_core
Optional

Sideband traffic will be handled by a dedicated core.Requires SE Reboot. Field introduced in 16.5.2, 17.1.9, 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_sb_threads
Optional

Number of Sideband threads per SE.Requires SE Reboot. Allowed values are 1-128. Field introduced in 16.5.2, 17.1.9, 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_thread_multiplier
Optional

Multiplier for SE threads based on vCPU. Allowed values are 1-10. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1), Basic edition(Allowed values- 1), Enterprise with Cloud Services edition.

se_time_tracker_props
Optional

se_time_tracker_props

se_tracert_port_range
Optional

se_tracert_port_range

integer As uint32 As uint32
se_tunnel_mode
Optional

Determines if Direct Secondary Return (DSR) from secondary SE is active or not 0 Automatically determine based on hypervisor type. 1 Enable tunnel mode - DSR is unconditionally disabled. 2 Disable tunnel mode - DSR is unconditionally enabled. Tunnel mode can be enabled or disabled at run-time. Allowed values are 0-2. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_tunnel_udp_port
Optional

UDP Port for tunneled packets from secondary to primary SE in Docker bridge mode.Requires SE Reboot. Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_tx_batch_size
Optional

Number of packets to batch for transmit to the nic. Requires SE Reboot. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_txq_threshold
Optional

Once the TX queue of the dispatcher reaches this threshold, hardware queues are not polled for further packets. To be used under surveillance of Avi Support. Allowed values are 512-32768. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2048), Basic edition(Allowed values- 2048), Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_udp_encap_ipc
Optional

Determines if SE-SE IPC messages are encapsulated in a UDP header 0 Automatically determine based on hypervisor type. 1 Use UDP encap unconditionally.Requires SE Reboot. Allowed values are 0-1. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_use_dpdk
Optional

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.

integer As uint32 As uint32
se_vnic_tx_sw_queue_flush_frequency
Optional

Configure the frequency in milliseconds of software transmit spillover queue flush when enabled. This is necessary to flush any packets in the spillover queue in the absence of a packet transmit in the normal course of operation. Allowed values are 50-500. Special values are 0- disable. Field introduced in 20.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_vnic_tx_sw_queue_size
Optional

Configure the size of software transmit spillover queue when enabled. Requires SE Reboot. Allowed values are 128-2048. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_vs_hb_max_pkts_in_batch
Optional

Maximum number of aggregated vs heartbeat packets to send in a batch. Allowed values are 1-256. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_vs_hb_max_vs_in_pkt
Optional

Maximum number of virtualservices for which heartbeat messages are aggregated in one packet. Allowed values are 1-1024. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
self_se_election
Optional

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.

integer As uint32 As uint32
send_se_ready_timeout
Optional

Timeout for sending SE_READY without NS HELPER registration completion. Allowed values are 10-600. Field introduced in 21.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.

service_ip6_subnets
Optional

IPv6 Subnets assigned to the SE group. Required for VS group placement. Field introduced in 18.1.1. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

service_ip_subnets
Optional

Subnets assigned to the SE group. Required for VS group placement. Field introduced in 17.1.1. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
shm_minimum_config_memory
Optional

Minimum required shared 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.

integer As uint32 As uint32
significant_log_throttle
Optional

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.

boolean
ssl_preprocess_sni_hostname
Optional

(Beta) Preprocess SSL Client Hello for SNI hostname extension.If set to True, this will apply SNI child's SSL protocol(s), if they are different from SNI Parent's allowed SSL protocol(s). Field introduced in 17.2.12, 18.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
ssl_sess_cache_per_vs
Optional

Number of SSL sessions that can be cached per VS. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
transient_shared_memory_max
Optional

The threshold for the transient shared config memory in the SE. Allowed values are 0-100. Field introduced in 20.1.1. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
udf_log_throttle
Optional

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.

integer As uint32 As uint32
upstream_connect_timeout
Optional

Timeout for backend connection. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
upstream_connpool_enable
Optional

Enable upstream connection pool,. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
upstream_read_timeout
Optional

Timeout for data to be received from backend. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
upstream_send_timeout
Optional

Timeout for upstream to become writable. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 3600000), Basic edition(Allowed values- 3600000), Enterprise with Cloud Services edition.

string
url
Optional

url

boolean
use_dp_util_for_scaleout
Optional

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.

boolean
use_hyperthreaded_cores
Optional

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.

boolean
use_legacy_netlink
Optional

Enable legacy model of netlink notifications. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
use_objsync
Optional

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.

boolean
use_standard_alb
Optional

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
Optional

user_agent_cache_config

integer As uint32 As uint32
user_defined_metric_age
Optional

Defines in seconds how long before an unused user-defined-metric is garbage collected. Field introduced in 21.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
uuid
Optional

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

vcenter_clusters
Optional

vcenter_clusters

string
vcenter_datastore_mode
Optional

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.

vcenter_datastores
Optional

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

boolean
vcenter_datastores_include
Optional

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

string
vcenter_folder
Optional

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.

vcenter_hosts
Optional

vcenter_hosts

string
vcenter_parking_vnic_pg
Optional

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
Optional

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.

integer As int32 As int32
vcpus_per_se
Optional

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.

vip_asg
Optional

vip_asg

integer As uint32 As uint32
vnic_dhcp_ip_check_interval
Optional

DHCP ip check interval. Allowed values are 1-1000. Field introduced in 21.1.1. 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.

integer As uint32 As uint32
vnic_dhcp_ip_max_retries
Optional

DHCP ip max retries. 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.

integer As uint32 As uint32
vnic_ip_delete_interval
Optional

wait interval before deleting IP. . Field introduced in 21.1.1. 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.

integer As uint32 As uint32
vnic_probe_interval
Optional

Probe vnic interval. Field introduced in 21.1.1. 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.

integer As uint32 As uint32
vnic_rpc_retry_interval
Optional

Time interval for retrying the failed VNIC RPC requests. Field introduced in 21.1.1. 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.

integer As uint32 As uint32
vnicdb_cmd_history_size
Optional

Size of vnicdb command history. Allowed values are 0-65535. 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.

boolean
vs_host_redundancy
Optional

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.

integer As uint32 As uint32
vs_scalein_timeout
Optional

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.

integer As uint32 As uint32
vs_scalein_timeout_for_upgrade
Optional

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.

integer As uint32 As uint32
vs_scaleout_timeout
Optional

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.

integer As uint32 As uint32
vs_se_primary_switchover_additional_wait_time
Optional

Wait time for primary switchover ready notification after flows are completed. 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 30.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_se_scalein_additional_wait_time
Optional

Wait time for sending scalein ready notification after flows are completed. 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 30.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_se_scaleout_additional_wait_time
Optional

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.

integer As uint32 As uint32
vs_se_scaleout_ready_timeout
Optional

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.

integer As uint32 As uint32
vs_switchover_timeout
Optional

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.

vss_placement
Optional

vss_placement

boolean
vss_placement_enabled
Optional

If set, Virtual Services will be placed on only a subset of the cores of an SE. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
waf_mempool
Optional

Enable memory pool for WAF.Requires SE Reboot. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
waf_mempool_size
Optional

Memory pool size used for WAF.Requires SE Reboot. Field introduced in 17.2.3. Unit is KB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure