GET /serviceenginegroup
/serviceenginegroup
Request
URI
GET
https://{api_host}/api/serviceenginegroup
COPY
Query Parameters
string
name
Optional
object name
string
refers_to
Optional
Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=
string
referred_by
Optional
Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=
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 ServiceEngineGroupApiResponse of type(s) application/json
{
"count": 0,
"results": [
{
"_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
}
],
"next": "string"
}integer As int32 As int32
count
Required
count
array of object
results
Required
results
string
next
Optional
next
401
log in failed
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/serviceenginegroup
On This Page
Service Engine Group Operations
GET
GET /serviceenginegroup
POST
POST /serviceenginegroup
GET
GET /serviceenginegroup/{uuid}
PUT
PUT /serviceenginegroup/{uuid}
PATCH
PATCH /serviceenginegroup/{uuid}
DELETE
DELETE /serviceenginegroup/{uuid}
POST
POST /serviceenginegroup/{uuid}/redistribute
POST
POST /serviceenginegroup/clear
GET
GET /serviceenginegroup/{uuid}/runtime/
GET
GET /serviceenginegroup/{uuid}/placement/summary/
GET
GET /serviceenginegroup/{uuid}/placement/detail/
GET
GET /serviceenginegroup/{uuid}/placement/ineligible/