Avi ServiceEngineGroup Object API

CLI ``` - configure serviceenginegroup - show serviceenginegroup - redistribute serviceenginegroup - clear serviceenginegroup ``` Examples - **serviceenginegroup_example_1**: To create a SE group that is suitable for a production application with a HA policy of shared active/active with a minimum scale out of 2 SE ```json {'name': 'production-group', 'min_scaleout_per_vs': 2, 'ha_mode': 'HA_MODE_SHARED_PAIR'} ``` - **serviceenginegroup_example_2**: To create a SE group that is of best effort category suitable for test deployments ```json {'name': 'test-group', 'max_se': 8, 'ha_mode': 'HA_MODE_SHARED', 'buffer_se': 0} ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. post /serviceenginegroup/clear
  2. get /serviceenginegroup
  3. post /serviceenginegroup
  4. delete /serviceenginegroup/{uuid}
  5. get /serviceenginegroup/{uuid}
  6. patch /serviceenginegroup/{uuid}
  7. get /serviceenginegroup/{uuid}/placement/detail/
  8. get /serviceenginegroup/{uuid}/placement/ineligible/
  9. get /serviceenginegroup/{uuid}/placement/summary/
  10. put /serviceenginegroup/{uuid}
  11. post /serviceenginegroup/{uuid}/redistribute
  12. get /serviceenginegroup/{uuid}/runtime/
Up 
post /serviceenginegroup/clear
(serviceenginegroupClearPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — empty

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up 
get /serviceenginegroup
(serviceenginegroupGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.

Return type

ServiceEngineGroupApiResponse

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ServiceEngineGroupApiResponse

401

log in failed
Up 
post /serviceenginegroup
(serviceenginegroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ServiceEngineGroup object creation

Return type

ServiceEngineGroup

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ServiceEngineGroup

401

log in failed
Up 
delete /serviceenginegroup/{uuid}
(serviceenginegroupUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found
Up 
get /serviceenginegroup/{uuid}
(serviceenginegroupUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ServiceEngineGroup

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ServiceEngineGroup

401

log in failed
Up 
patch /serviceenginegroup/{uuid}
(serviceenginegroupUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ServiceEngineGroup object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ServiceEngineGroup

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ServiceEngineGroup

401

log in failed
Up 
get /serviceenginegroup/{uuid}/placement/detail/
(serviceenginegroupUuidPlacementDetailGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up 
get /serviceenginegroup/{uuid}/placement/ineligible/
(serviceenginegroupUuidPlacementIneligibleGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up 
get /serviceenginegroup/{uuid}/placement/summary/
(serviceenginegroupUuidPlacementSummaryGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up 
put /serviceenginegroup/{uuid}
(serviceenginegroupUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ServiceEngineGroup object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ServiceEngineGroup

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ServiceEngineGroup

401

log in failed
Up 
post /serviceenginegroup/{uuid}/redistribute
(serviceenginegroupUuidRedistributePost)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — empty

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up 
get /serviceenginegroup/{uuid}/runtime/
(serviceenginegroupUuidRuntimeGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. CloudFlavor
  2. CloudMeta
  3. ClusterHAConfig
  4. ConfigPbAttributes
  5. CustomTag
  6. DosThreshold
  7. DosThresholdProfile
  8. GCPSeGroupConfig
  9. IpAddr
  10. IpAddrPrefix
  11. IptableRule
  12. IptableRuleSet
  13. KeyValue
  14. KniPortRange
  15. MetricsEventThreshold
  16. MetricsRealTimeUpdate
  17. NsxtClusters
  18. NsxtDatastores
  19. NsxtHosts
  20. ObjSyncConfig
  21. PlacementScopeConfig
  22. PortRange
  23. RateLimiterProperties
  24. RoleFilterMatchLabel
  25. SETimeTrackerProperties
  26. SeGroupAnalyticsPolicy
  27. ServiceEngineGroup
  28. ServiceEngineGroupApiResponse
  29. UserAgentCacheConfig
  30. VcenterClusters
  31. VcenterDatastore
  32. VcenterHosts
  33. VipAutoscaleConfiguration
  34. VipAutoscaleGroup
  35. VipAutoscalePolicy
  36. VipAutoscaleZones
  37. VssPlacement

CloudFlavor Up

cost (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disk_gb (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
enhanced_nw (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_recommended (optional)
Boolean If a vm flavor is recommended for requested se_usage_type.Set to True if the chosen VM flavor is recommended for requested se_usage_type.Else set to False. Field introduced in 18.1.4, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
max_ip6s_per_nic (optional)
Integer Maximum number of IPv6 addresses that can be configured per NIC. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_ips_per_nic (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_nics (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
meta (optional)
array[CloudMeta] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
public (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ram_mb (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vcpus (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

CloudMeta Up

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

ClusterHAConfig Up

cluster_id (optional)
String Transport node cluster. Avi derives vSphere HA property from vCenter cluster.If vSphere HA enabled on vCenter cluster, vSphere will handle HA of ServiceEngine VMs in case of underlying ESX failure.Ex MOB domain-c23. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
override_vsphere_ha (optional)
Boolean If this flag set to True, Avi handles ServiceEngine failure irrespective of vSphere HA enabled on vCenter cluster or not. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
vmg_name (optional)
String Cluster VM Group name.VM Group name is unique inside cluster. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. 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. format: int32

CustomTag Up

tag_key
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tag_val (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

DosThreshold Up

attack
String Attack type. Enum options - LAND, SMURF, ICMP_PING_FLOOD, UNKOWN_PROTOCOL, TEARDROP, IP_FRAG_OVERRUN, IP_FRAG_TOOSMALL, IP_FRAG_FULL, IP_FRAG_INCOMPLETE, PORT_SCAN, TCP_NON_SYN_FLOOD_OLD, SYN_FLOOD, BAD_RST_FLOOD, MALFORMED_FLOOD, FAKE_SESSION, ZERO_WINDOW_STRESS, SMALL_WINDOW_STRESS, DOS_HTTP_TIMEOUT, DOS_HTTP_ERROR, DOS_HTTP_ABORT, DOS_SSL_ERROR, DOS_APP_ERROR, DOS_REQ_IP_RL_DROP, DOS_REQ_URI_RL_DROP, DOS_REQ_URI_SCAN_BAD_RL_DROP, DOS_REQ_URI_SCAN_UNKNOWN_RL_DROP, DOS_REQ_IP_URI_RL_DROP, DOS_CONN_IP_RL_DROP, DOS_SLOW_URL, TCP_NON_SYN_FLOOD, DOS_REQ_CIP_SCAN_BAD_RL_DROP, DOS_REQ_CIP_SCAN_UNKNOWN_RL_DROP, DOS_REQ_IP_RL_DROP_BAD, DOS_REQ_URI_RL_DROP_BAD, DOS_REQ_IP_URI_RL_DROP_BAD, POLICY_DROPS, DOS_CONN_RL_DROP, DOS_REQ_RL_DROP, DOS_REQ_HDR_RL_DROP, DOS_REQ_CUSTOM_RL_DROP, DNS_ATTACK_REFLECTION, DNS_ATTACK_AMPLIFICATION_EGRESS, TCP_SLOW_AND_LOW, DNS_ATTACK_NXDOMAIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
max_value
Integer Maximum number of packets or connections or requests in a given interval of time to be deemed as attack. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
min_value
Integer Minimum number of packets or connections or requests in a given interval of time to be deemed as attack. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

DosThresholdProfile Up

thresh_info (optional)
array[DosThreshold] Attack type, min and max values for DoS attack detection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
thresh_period
Integer Timer value in seconds to collect DoS attack metrics based on threshold on the Service Engine for this Virtual Service. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

GCPSeGroupConfig Up

backend_data_vpc_network_name (optional)
String Service Engine Backend Data Network Name, used only for GCP cloud.Overrides the cloud level setting for Backend Data Network in GCP Two Arm Mode. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
backend_data_vpc_project_id (optional)
String Project ID of the Service Engine Backend Data Network. By default, Service Engine Project ID will be used. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
backend_data_vpc_subnet_name (optional)
String Service Engine Backend Data Subnet Name, used only for GCP cloud.Overrides the cloud level setting for Backend Data Subnet in GCP Two Arm Mode. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

IpAddr Up

addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrPrefix Up

ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

IptableRule Up

action
String Enum options - ACCEPT, DROP, REJECT, DNAT, MASQUERADE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dnat_ip (optional)
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dst_ip (optional)
IpAddrPrefix Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dst_port (optional)
PortRange Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
input_interface (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
output_interface (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
proto (optional)
String Enum options - PROTO_TCP, PROTO_UDP, PROTO_ICMP, PROTO_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
src_ip (optional)
IpAddrPrefix Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
src_port (optional)
PortRange Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tag (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IptableRuleSet Up

chain
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
rules (optional)
array[IptableRule] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
table
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

KeyValue Up

key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

KniPortRange Up

protocol
String Protocol associated with port range. Enum options - KNI_PROTO_TCP, KNI_PROTO_UDP. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
range
PortRange Port range to be allowed to KNI. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

MetricsEventThreshold Up

metrics_event_threshold_type
String Type of the metrics event threshold. This value will decide which metric rule (or rules) use configured thresholds. Enum options - THRESHOLD_TYPE_STATIC, SE_CPU_THRESHOLD, SE_MEM_THRESHOLD, SE_DISK_THRESHOLD, CONTROLLER_CPU_THRESHOLD, CONTROLLER_MEM_THRESHOLD, CONTROLLER_DISK_THRESHOLD. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
reset_threshold (optional)
Double This value is used to reset the event state machine. Allowed values are 0-100. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: double
watermark_thresholds (optional)
array[Integer] Threshold value for which event in raised. There can be multiple thresholds defined.Health score degrades when the the target is higher than this threshold. Allowed values are 0-100. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

MetricsRealTimeUpdate Up

duration (optional)
Integer Real time metrics collection duration in minutes. 0 for infinite. Special values are 0 - infinite. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
enabled
Boolean Enables real time metrics collection. When deactivated, 6 hour view is the most granular the system will track. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NsxtClusters Up

cluster_ids (optional)
array[String] List of transport node clusters. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
include (optional)
Boolean Include or Exclude. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

NsxtDatastores Up

ds_ids (optional)
array[String] List of shared datastores. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
include (optional)
Boolean Include or Exclude. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

NsxtHosts Up

host_ids (optional)
array[String] List of transport nodes. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include (optional)
Boolean Include or Exclude. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ObjSyncConfig Up

objsync_cpu_limit (optional)
Integer SE CPU limit for InterSE Object Distribution. Allowed values are 15-80. Field introduced in 20.1.3. Unit is PERCENT. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
objsync_hub_elect_interval (optional)
Integer Hub election interval for InterSE Object Distribution. Allowed values are 30-300. Field introduced in 20.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
objsync_reconcile_interval (optional)
Integer Reconcile interval for InterSE Object Distribution. Allowed values are 1-120. Field introduced in 20.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

PlacementScopeConfig Up

clusters (optional)
array[ClusterHAConfig] Cluster vSphere HA configuration. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
nsxt_clusters (optional)
NsxtClusters List of transport node clusters include or exclude. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
nsxt_datastores (optional)
NsxtDatastores List of shared datastores to include or exclude. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
nsxt_hosts (optional)
NsxtHosts List of transport nodes include or exclude. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_folder (optional)
String Folder to place all the Service Engine virtual machines in vCenter. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_ref
String VCenter server configuration. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PortRange Up

end
Integer TCP/UDP port range end (inclusive). Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
start
Integer TCP/UDP port range start (inclusive). Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

RateLimiterProperties Up

msf_num_stages (optional)
Integer Number of stages in msf rate limiter. Allowed values are 1-2. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
msf_stage_size (optional)
Long Each stage size in msf rate limiter. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

RoleFilterMatchLabel Up

key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

SETimeTrackerProperties Up

egress_audit_mode (optional)
String Audit queueing latency from proxy to dispatcher. Enum options - SE_TT_AUDIT_OFF, SE_TT_AUDIT_ON, SE_TT_AUDIT_ON_WITH_EVENT. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
egress_threshold (optional)
Integer Maximum egress latency threshold between dispatcher and proxy. Field introduced in 22.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
event_gen_window (optional)
Long Window for cumulative event generation. Field introduced in 22.1.1. Unit is SECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int64
ingress_audit_mode (optional)
String Audit queueing latency from dispatcher to proxy. Enum options - SE_TT_AUDIT_OFF, SE_TT_AUDIT_ON, SE_TT_AUDIT_ON_WITH_EVENT. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ingress_threshold (optional)
Integer Maximum ingress latency threshold between dispatcher and proxy. Field introduced in 22.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

SeGroupAnalyticsPolicy Up

metrics_event_thresholds (optional)
array[MetricsEventThreshold] Thresholds for various events generated by metrics system. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ServiceEngineGroup Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
accelerated_networking (optional)
Boolean Enable accelerated networking option for Azure SE. Accelerated networking enables single root I/O virtualization (SR-IOV) to a SE VM. This improves networking performance. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
active_standby (optional)
Boolean Service Engines in active/standby mode for HA failover. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggressive_failure_detection (optional)
Boolean 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.
algo (optional)
String 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.
allow_burst (optional)
Boolean Allow SEs to be created using burst license. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
app_cache_percent (optional)
Integer 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. format: int32
app_cache_threshold (optional)
Integer 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. format: int32
app_learning_memory_percent (optional)
Integer 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. format: int32
archive_shm_limit (optional)
Integer 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. format: int32
async_ssl (optional)
Boolean 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.
async_ssl_threads (optional)
Integer 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. format: int32
auto_rebalance (optional)
Boolean 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.
auto_rebalance_capacity_per_se (optional)
array[Integer] Capacities of SE for auto rebalance for each criteria. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
auto_rebalance_criteria (optional)
array[String] Set of criteria for SE Auto Rebalance. Enum options - SE_AUTO_REBALANCE_CPU, SE_AUTO_REBALANCE_PPS, SE_AUTO_REBALANCE_MBPS, SE_AUTO_REBALANCE_OPEN_CONNS, SE_AUTO_REBALANCE_CPS. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
auto_rebalance_interval (optional)
Integer 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. format: int32
auto_redistribute_active_standby_load (optional)
Boolean 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.
availability_zone_refs (optional)
array[String] 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.
baremetal_dispatcher_handles_flows (optional)
Boolean 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.
bgp_peer_monitor_failover_enabled (optional)
Boolean Enable BGP peer monitoring based failover. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
bgp_state_update_interval (optional)
Integer 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. format: int32
buffer_se (optional)
Integer Excess Service Engine capacity provisioned for HA failover. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
cloud_ref (optional)
String It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
compress_ip_rules_for_each_ns_subnet (optional)
Boolean 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.
config_debugs_on_all_cores (optional)
Boolean 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)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
connection_memory_percentage (optional)
Integer 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. format: int32
core_shm_app_cache (optional)
Boolean 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.
core_shm_app_learning (optional)
Boolean 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.
cpu_reserve (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cpu_socket_affinity (optional)
Boolean 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.
custom_securitygroups_data (optional)
array[String] Custom Security Groups to be associated with data vNics for SE instances in OpenStack and AWS Clouds. Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
custom_securitygroups_mgmt (optional)
array[String] Custom Security Groups to be associated with management vNic for SE instances in OpenStack and AWS Clouds. Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
custom_tag (optional)
array[CustomTag] Custom tag will be used to create the tags for SE instance in AWS. Note this is not the same as the prefix for SE name. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
data_network_id (optional)
String Subnet used to spin up the data nic for Service Engines, used only for Azure cloud. Overrides the cloud level setting for Service Engine subnet. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
datascript_timeout (optional)
Long 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. format: int64
deactivate_ipv6_discovery (optional)
Boolean If activated, IPv6 address and route discovery are deactivated.Requires SE reboot. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
deactivate_kni_filtering_at_dispatcher (optional)
Boolean Deactivate filtering of packets to KNI interface. To be used under surveillance of Avi Support. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
dedicated_dispatcher_core (optional)
Boolean Dedicate the core that handles packet receive/transmit from the network to just the dispatching function. Don't use it for TCP/IP and SSL functions. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_avi_securitygroups (optional)
Boolean 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.
disable_csum_offloads (optional)
Boolean 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.
disable_flow_probes (optional)
Boolean 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.
disable_gro (optional)
Boolean Disable Generic Receive Offload (GRO) in DPDK poll-mode driver packet receive path. GRO is on by default on NICs that do not support LRO (Large Receive Offload) or do not gain performance boost from LRO. Field introduced in 17.2.5, 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_se_memory_check (optional)
Boolean 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.
disable_tso (optional)
Boolean 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.
disk_per_se (optional)
Integer 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. format: int32
distribute_load_active_standby (optional)
Boolean 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.
distribute_queues (optional)
Boolean 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.
distribute_vnics (optional)
Boolean 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.
downstream_send_timeout (optional)
Integer 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. format: int32
dp_aggressive_deq_interval_msec (optional)
Integer 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. format: int32
dp_aggressive_enq_interval_msec (optional)
Integer 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. format: int32
dp_aggressive_hb_frequency (optional)
Integer 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. format: int32
dp_aggressive_hb_timeout_count (optional)
Integer 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. format: int32
dp_deq_interval_msec (optional)
Integer 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. format: int32
dp_enq_interval_msec (optional)
Integer 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. format: int32
dp_hb_frequency (optional)
Integer 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. format: int32
dp_hb_timeout_count (optional)
Integer 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. format: int32
dpdk_gro_timeout_interval (optional)
Integer 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. format: int32
enable_gratarp_permanent (optional)
Boolean 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.
enable_hsm_log (optional)
Boolean Enable HSM luna engine logs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enable_hsm_priming (optional)
Boolean (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.
enable_multi_lb (optional)
Boolean 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.
enable_pcap_tx_ring (optional)
Boolean Enable TX ring support in pcap mode of operation. TSO feature is not supported with TX Ring enabled. Deprecated from 18.2.8, instead use pcap_tx_mode. Requires SE Reboot. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ephemeral_portrange_end (optional)
Integer 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. format: int32
ephemeral_portrange_start (optional)
Integer 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. format: int32
extra_config_multiplier (optional)
Double Multiplier for extra config to support large VS/Pool config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
extra_shared_config_memory (optional)
Integer 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. format: int32
flow_table_new_syn_max_entries (optional)
Integer 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. format: int32
free_list_size (optional)
Integer 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. format: int32
gcp_config (optional)
GCPSeGroupConfig Google Cloud Platform, Service Engine Group Configuration. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
gratarp_permanent_periodicity (optional)
Integer 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. format: int32
grpc_channel_connect_timeout (optional)
Integer 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. format: int32
ha_mode (optional)
String 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.
handle_per_pkt_attack (optional)
Boolean 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.
hardwaresecuritymodulegroup_ref (optional)
String It is a reference to an object of type HardwareSecurityModuleGroup. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
heap_minimum_config_memory (optional)
Integer 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. format: int32
hm_on_standby (optional)
Boolean 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.
host_attribute_key (optional)
String Key of a (Key, Value) pair identifying a label for a set of Nodes usually in Container Clouds. Needs to be specified together with host_attribute_value. SEs can be configured differently including HA modes across different SE Groups. May also be used for isolation between different classes of VirtualServices. VirtualServices' SE Group may be specified via annotations/labels. A OpenShift/Kubernetes namespace maybe annotated with a matching SE Group label as openshift.io/node-selector apptype=prod. When multiple SE Groups are used in a Cloud with host attributes specified,just a single SE Group can exist as a match-all SE Group without a host_attribute_key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_attribute_value (optional)
String Value of a (Key, Value) pair identifying a label for a set of Nodes usually in Container Clouds. Needs to be specified together with host_attribute_key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_gateway_monitor (optional)
Boolean 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.
http_rum_console_log (optional)
Boolean 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.
http_rum_min_content_length (optional)
Integer 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. format: int32
hybrid_rss_mode (optional)
Boolean Toggles SE hybrid only mode of operation in DPDK mode with RSS configured;where-in each SE datapath instance operates as an independent standalonehybrid instance performing both dispatcher and proxy function. Requires reboot. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
hypervisor (optional)
String Override default hypervisor. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ignore_docker_mac_change (optional)
Boolean 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.
ignore_rtt_threshold (optional)
Integer 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. format: int32
ingress_access_data (optional)
String 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.
ingress_access_mgmt (optional)
String 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.
instance_flavor (optional)
String Instance/Flavor name for SE instance. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
instance_flavor_info (optional)
CloudFlavor Additional information associated with instance_flavor. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
iptables (optional)
array[IptableRuleSet] 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)
array[KniPortRange] 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.
l7_conns_per_core (optional)
Integer 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. format: int32
l7_resvd_listen_conns_per_core (optional)
Integer 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. format: int32
labels (optional)
array[KeyValue] Labels associated with this SE group. Field introduced in 20.1.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lbaction_num_requests_to_dispatch (optional)
Integer 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. format: int32
lbaction_rq_per_request_max_retries (optional)
Integer 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. format: int32
least_load_core_selection (optional)
Boolean Select core with least load for new flow. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
license_tier (optional)
String Specifies the license tier which would be used. This field by default inherits the value from cloud. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS, ENTERPRISE_WITH_CLOUD_SERVICES. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
license_type (optional)
String If no license type is specified then default license enforcement for the cloud type is chosen. Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log_agent_compress_logs (optional)
Boolean 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.
log_agent_debug_enabled (optional)
Boolean 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.
log_agent_file_sz_appl (optional)
Integer 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. format: int32
log_agent_file_sz_conn (optional)
Integer 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. format: int32
log_agent_file_sz_debug (optional)
Integer 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. format: int32
log_agent_file_sz_event (optional)
Integer 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. format: int32
log_agent_log_storage_min_sz (optional)
Integer 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. format: int32
log_agent_max_concurrent_rsync (optional)
Integer 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. format: int32
log_agent_max_storage_excess_percent (optional)
Integer 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. format: int32
log_agent_max_storage_ignore_percent (optional)
Float Maximum storage on the disk not allocated for logs on the Service Engine. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: float
log_agent_min_storage_per_vs (optional)
Integer 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. format: int32
log_agent_sleep_interval (optional)
Integer 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. format: int32
log_agent_trace_enabled (optional)
Boolean 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.
log_agent_unknown_vs_timer (optional)
Integer 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. format: int32
log_disksz (optional)
Integer 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. format: int32
log_malloc_failure (optional)
Boolean 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.
log_message_max_file_list_size (optional)
Integer 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. format: int32
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.7. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
max_concurrent_external_hm (optional)
Integer 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. format: int32
max_cpu_usage (optional)
Integer 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. format: int32
max_memory_per_mempool (optional)
Integer 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. format: int32
max_num_se_dps (optional)
Integer 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. format: int32
max_public_ips_per_lb (optional)
Integer 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. format: int32
max_queues_per_vnic (optional)
Integer 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. format: int32
max_rules_per_lb (optional)
Integer 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. format: int32
max_scaleout_per_vs (optional)
Integer 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. format: int32
max_se (optional)
Integer 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. format: int32
max_skb_frags (optional)
Integer 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. format: int32
max_vs_per_se (optional)
Integer 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. format: int32
mem_reserve (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
memory_for_config_update (optional)
Integer 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. format: int32
memory_per_se (optional)
Integer Amount of memory for each of the Service Engine virtual machines. Changes to this setting do not affect existing SEs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
mgmt_network_ref (optional)
String 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)
IpAddrPrefix Management subnet to use for Avi Service Engines. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
min_cpu_usage (optional)
Integer 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. format: int32
min_scaleout_per_vs (optional)
Integer 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. format: int32
min_se (optional)
Integer 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. format: int32
minimum_connection_memory (optional)
Integer 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. format: int32
n_log_streaming_threads (optional)
Integer 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. format: int32
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
netlink_poller_threads (optional)
Integer 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. format: int32
netlink_sock_buf_size (optional)
Integer 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. format: int32
ngx_free_connection_stack (optional)
Boolean Free the connection stack. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
non_significant_log_throttle (optional)
Integer 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. format: int32
ns_helper_deq_interval_msec (optional)
Integer 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. format: int32
ntp_sync_fail_event (optional)
Boolean 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.
ntp_sync_status_interval (optional)
Integer 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. format: int32
num_dispatcher_cores (optional)
Integer 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. format: int32
num_dispatcher_queues (optional)
Integer 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. format: int32
num_flow_cores_sum_changes_to_ignore (optional)
Integer Number of changes in num flow cores sum to ignore. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
objsync_config (optional)
ObjSyncConfig Configuration knobs for InterSE Object Distribution. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
objsync_port (optional)
Integer TCP port on SE management interface for InterSE Object Distribution. Supported only for externally managed security groups. Not supported on full access deployments. Requires SE reboot. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
openstack_availability_zones (optional)
array[String] Field introduced in 17.1.1. Maximum of 5 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
openstack_mgmt_network_name (optional)
String Avi Management network name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
openstack_mgmt_network_uuid (optional)
String Management network UUID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os_reserved_memory (optional)
Integer 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. format: int32
pcap_tx_mode (optional)
String 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.
pcap_tx_ring_rd_balancing_factor (optional)
Integer 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. format: int32
per_app (optional)
Boolean 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.
per_vs_admission_control (optional)
Boolean 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.
placement_mode (optional)
String 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)
MetricsRealTimeUpdate Enable or deactivate real time SE metrics. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reboot_on_panic (optional)
Boolean 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.
replay_vrf_routes_interval (optional)
Integer 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. format: int32
resync_time_interval (optional)
Integer 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. format: int32
sdb_flush_interval (optional)
Integer 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. format: int32
sdb_pipeline_size (optional)
Integer 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. format: int32
sdb_scan_count (optional)
Integer 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. format: int32
se_bandwidth_type (optional)
String Select the SE bandwidth for the bandwidth license. Enum options - SE_BANDWIDTH_UNLIMITED, SE_BANDWIDTH_25M, SE_BANDWIDTH_200M, SE_BANDWIDTH_1000M, SE_BANDWIDTH_10000M. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- SE_BANDWIDTH_UNLIMITED), Basic edition(Allowed values- SE_BANDWIDTH_UNLIMITED), Enterprise with Cloud Services edition.
se_delayed_flow_delete (optional)
Boolean 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.
se_deprovision_delay (optional)
Integer 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. format: int32
se_dos_profile (optional)
DosThresholdProfile Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_dp_hm_drops (optional)
Integer 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. format: int32
se_dp_if_state_poll_interval (optional)
Integer 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. format: int32
se_dp_isolation (optional)
Boolean 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.
se_dp_isolation_num_non_dp_cpus (optional)
Integer 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. format: int32
se_dp_log_nf_enqueue_percent (optional)
Integer 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. format: int32
se_dp_log_udf_enqueue_percent (optional)
Integer 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. format: int32
se_dp_max_hb_version (optional)
Integer 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. format: int32
se_dp_vnic_queue_stall_event_sleep (optional)
Integer 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. format: int32
se_dp_vnic_queue_stall_threshold (optional)
Integer 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. format: int32
se_dp_vnic_queue_stall_timeout (optional)
Integer 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. format: int32
se_dp_vnic_restart_on_queue_stall_count (optional)
Integer 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. format: int32
se_dp_vnic_stall_se_restart_window (optional)
Integer 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. format: int32
se_dpdk_pmd (optional)
Integer 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. format: int32
se_dump_core_on_assert (optional)
Boolean 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.
se_emulated_cores (optional)
Integer 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. format: int32
se_flow_probe_retries (optional)
Integer 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. format: int32
se_flow_probe_retry_timer (optional)
Integer 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. format: int32
se_group_analytics_policy (optional)
SeGroupAnalyticsPolicy Analytics Policy for ServiceEngineGroup. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_hyperthreaded_mode (optional)
String 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.
se_ip_encap_ipc (optional)
Integer 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. format: int32
se_kni_burst_factor (optional)
Integer 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. format: int32
se_l3_encap_ipc (optional)
Integer 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. format: int32
se_log_buffer_app_blocking_dequeue (optional)
Boolean 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.
se_log_buffer_conn_blocking_dequeue (optional)
Boolean 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.
se_log_buffer_events_blocking_dequeue (optional)
Boolean 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.
se_lro (optional)
Boolean Enable or disable Large Receive Optimization for vnics.Supported on VMXnet3.Requires SE Reboot. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_mp_ring_retry_count (optional)
Integer 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. format: int32
se_mtu (optional)
Integer 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. format: int32
se_name_prefix (optional)
String Prefix to use for virtual machine name of Service Engines. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_packet_buffer_max (optional)
Integer 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. format: int32
se_pcap_lookahead (optional)
Boolean 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.
se_pcap_pkt_count (optional)
Integer 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. format: int32
se_pcap_pkt_sz (optional)
Integer 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. format: int32
se_pcap_qdisc_bypass (optional)
Boolean 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.
se_pcap_reinit_frequency (optional)
Integer 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. format: int32
se_pcap_reinit_threshold (optional)
Integer 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. format: int32
se_probe_port (optional)
Integer 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. format: int32
se_rl_prop (optional)
RateLimiterProperties Rate limiter properties. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_rum_sampling_nav_interval (optional)
Integer 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. format: int32
se_rum_sampling_nav_percent (optional)
Integer 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. format: int32
se_rum_sampling_res_interval (optional)
Integer 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. format: int32
se_rum_sampling_res_percent (optional)
Integer 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. format: int32
se_sb_dedicated_core (optional)
Boolean 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.
se_sb_threads (optional)
Integer 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. format: int32
se_thread_multiplier (optional)
Integer 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. format: int32
se_time_tracker_props (optional)
SETimeTrackerProperties SE per-packet latency tracking configuration. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
se_tracert_port_range (optional)
PortRange Traceroute port range. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_tunnel_mode (optional)
Integer 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. format: int32
se_tunnel_udp_port (optional)
Integer 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. format: int32
se_tx_batch_size (optional)
Integer 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. format: int32
se_txq_threshold (optional)
Integer 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. format: int32
se_udp_encap_ipc (optional)
Integer 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. format: int32
se_use_dpdk (optional)
Integer 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. format: int32
se_vnic_tx_sw_queue_flush_frequency (optional)
Integer 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. format: int32
se_vnic_tx_sw_queue_size (optional)
Integer 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. format: int32
se_vs_hb_max_pkts_in_batch (optional)
Integer 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. format: int32
se_vs_hb_max_vs_in_pkt (optional)
Integer 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. format: int32
self_se_election (optional)
Boolean 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.
send_se_ready_timeout (optional)
Integer 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. format: int32
service_ip6_subnets (optional)
array[IpAddrPrefix] 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)
array[IpAddrPrefix] 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.
shm_minimum_config_memory (optional)
Integer 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. format: int32
significant_log_throttle (optional)
Integer 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. format: int32
ssl_preprocess_sni_hostname (optional)
Boolean (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.
ssl_sess_cache_per_vs (optional)
Integer 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. format: int32
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
transient_shared_memory_max (optional)
Integer 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. format: int32
udf_log_throttle (optional)
Integer 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. format: int32
upstream_connect_timeout (optional)
Integer 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. format: int32
upstream_connpool_enable (optional)
Boolean Enable upstream connection pool,. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
upstream_read_timeout (optional)
Integer 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. format: int32
upstream_send_timeout (optional)
Integer 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. format: int32
url (optional)
String url
use_dp_util_for_scaleout (optional)
Boolean 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.
use_hyperthreaded_cores (optional)
Boolean 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.
use_legacy_netlink (optional)
Boolean Enable legacy model of netlink notifications. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
use_objsync (optional)
Boolean 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.
use_standard_alb (optional)
Boolean 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)
UserAgentCacheConfig Configuration for User-Agent Cache used in Bot Management. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
user_defined_metric_age (optional)
Integer 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. format: int32
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_clusters (optional)
VcenterClusters Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_datastore_mode (optional)
String 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)
array[VcenterDatastore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_datastores_include (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_folder (optional)
String 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)
VcenterHosts Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_parking_vnic_pg (optional)
String 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)
array[PlacementScopeConfig] VCenter information for scoping at Host/Cluster level. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcpus_per_se (optional)
Integer 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. format: int32
vip_asg (optional)
VipAutoscaleGroup When vip_asg is set, Vip configuration will be managed by Avi.User will be able to configure vip_asg or Vips individually at the time of create. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vnic_dhcp_ip_check_interval (optional)
Integer 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. format: int32
vnic_dhcp_ip_max_retries (optional)
Integer 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. format: int32
vnic_ip_delete_interval (optional)
Integer 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. format: int32
vnic_probe_interval (optional)
Integer 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. format: int32
vnic_rpc_retry_interval (optional)
Integer 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. format: int32
vnicdb_cmd_history_size (optional)
Integer 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. format: int32
vs_host_redundancy (optional)
Boolean 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.
vs_scalein_timeout (optional)
Integer 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. format: int32
vs_scalein_timeout_for_upgrade (optional)
Integer 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. format: int32
vs_scaleout_timeout (optional)
Integer 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. format: int32
vs_se_scaleout_additional_wait_time (optional)
Integer 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-20. 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. format: int32
vs_se_scaleout_ready_timeout (optional)
Integer 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. format: int32
vs_switchover_timeout (optional)
Integer 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. format: int32
vss_placement (optional)
VssPlacement Parameters to place Virtual Services on only a subset of the cores of an SE. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vss_placement_enabled (optional)
Boolean 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.
waf_mempool (optional)
Boolean 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.
waf_mempool_size (optional)
Integer 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. format: int32

ServiceEngineGroupApiResponse Up

count
Integer format: int32
results
array[ServiceEngineGroup]
next (optional)
String

UserAgentCacheConfig Up

batch_size (optional)
Integer How many unknown User-Agents to batch up before querying Controller - unless max_wait_time is reached first. Allowed values are 1-500. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
controller_cache_size (optional)
Integer The number of User-Agent entries to cache on the Controller. Allowed values are 500-10000000. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_age (optional)
Integer Time interval in seconds after which an existing entry is refreshed from upstream if it has been accessed during max_last_hit_time. Allowed values are 60-604800. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_last_hit_time (optional)
Integer Time interval in seconds backwards from now during which an existing entry must have been hit for refresh from upstream. Entries that have last been accessed further in the past than max_last_hit time are not included in upstream refresh requests even if they are older than 'max_age'. Allowed values are 60-604800. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_upstream_queries (optional)
Integer How often at most to query controller for a given User-Agent. Allowed values are 2-100. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_wait_time (optional)
Integer The time interval in seconds after which to make a request to the Controller, even if the 'batch_size' hasn't been reached yet. Allowed values are 20-100000. Field introduced in 21.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
num_entries_upstream_update (optional)
Integer How many BotUACacheResult elements to include in an upstream update message. Allowed values are 1-10000. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
percent_reserved_for_bad_bots (optional)
Integer How much space to reserve in percent for known bad bots. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
percent_reserved_for_browsers (optional)
Integer How much space to reserve in percent for browsers. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
percent_reserved_for_good_bots (optional)
Integer How much space to reserve in percent for known good bots. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
percent_reserved_for_outstanding (optional)
Integer How much space to reserve in percent for outstanding upstream requests. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
se_cache_size (optional)
Integer The number of User-Agent entries to cache on each Service Engine. Allowed values are 500-10000000. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
upstream_update_interval (optional)
Integer How often in seconds to send updates about User-Agent cache entries to the next upstream cache. Field introduced in 21.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

VcenterClusters Up

cluster_refs (optional)
array[String] It is a reference to an object of type VIMgrClusterRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VcenterDatastore Up

datastore_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
managed_object_id (optional)
String Will be used by default, if not set fallback to datastore_name. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

VcenterHosts Up

host_refs (optional)
array[String] It is a reference to an object of type VIMgrHostRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VipAutoscaleConfiguration Up

zones (optional)
array[VipAutoscaleZones] This is the list of AZ+Subnet in which Vips will be spawned. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VipAutoscaleGroup Up

configuration (optional)
VipAutoscaleConfiguration Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
policy (optional)
VipAutoscalePolicy Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VipAutoscalePolicy Up

dns_cooldown (optional)
Integer The amount of time, in seconds, when a Vip is withdrawn before a scaling activity starts. Field introduced in 17.2.12, 18.1.2. Unit is SECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_size (optional)
Integer The maximum size of the group. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
min_size (optional)
Integer The minimum size of the group. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
suspend (optional)
Boolean When set, scaling is suspended. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VipAutoscaleZones Up

availability_zone (optional)
String Availability zone associated with the subnet. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
fip_capable (optional)
Boolean Determines if the subnet is capable of hosting publicly accessible IP. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
subnet_uuid (optional)
String UUID of the subnet for new IP address allocation. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VssPlacement Up

core_nonaffinity (optional)
Integer Degree of core non-affinity for VS placement. Allowed values are 1-256. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_subcores (optional)
Integer Number of sub-cores that comprise a CPU core. Allowed values are 1-128. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32