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: 20.1.2
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. get /serviceenginegroup
  2. post /serviceenginegroup
  3. post /serviceenginegroup/{uuid}/clear
  4. delete /serviceenginegroup/{uuid}
  5. get /serviceenginegroup/{uuid}
  6. patch /serviceenginegroup/{uuid}
  7. put /serviceenginegroup/{uuid}
  8. post /serviceenginegroup/{uuid}/redistribute
  9. get /serviceenginegroup/{uuid}/runtime/
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,
    "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
      } ]
    },
    "se_flow_probe_retry_timer" : 123,
    "minimum_required_config_memory" : 123,
    "vs_scalein_timeout" : 123,
    "se_pcap_qdisc_bypass" : true,
    "vs_se_scaleout_additional_wait_time" : 123,
    "active_standby" : true,
    "additional_config_memory" : 123,
    "service_ip6_subnets" : [ "" ],
    "se_kni_burst_factor" : 123,
    "resync_time_interval" : 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,
    "instance_flavor" : "aeiou",
    "disable_se_memory_check" : true,
    "se_probe_port" : 123,
    "app_learning_memory_percent" : 123,
    "se_vnic_tx_sw_queue_flush_frequency" : 123,
    "data_network_id" : "aeiou",
    "log_disksz" : 123,
    "ingress_access_data" : "aeiou",
    "se_sb_dedicated_core" : true,
    "gratarp_permanent_periodicity" : 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,
    "vs_scalein_timeout_for_upgrade" : 123,
    "custom_tag" : [ {
      "tag_key" : "aeiou",
      "tag_val" : "aeiou"
    } ],
    "advertise_backend_networks" : true,
    "num_flow_cores_sum_changes_to_ignore" : 123,
    "openstack_mgmt_network_uuid" : "aeiou",
    "core_shm_app_learning" : true,
    "per_app" : true,
    "vcenter_folder" : "aeiou",
    "algo" : "aeiou",
    "max_se" : 123,
    "enable_vmac" : true,
    "shm_minimum_config_memory" : 123,
    "hardwaresecuritymodulegroup_ref" : "aeiou",
    "compress_ip_rules_for_each_ns_subnet" : true,
    "se_dp_vnic_queue_stall_threshold" : 123,
    "udf_log_throttle" : 123,
    "se_dp_vnic_restart_on_queue_stall_count" : 123,
    "custom_securitygroups_mgmt" : [ "aeiou" ],
    "min_se" : 123,
    "waf_mempool_size" : 123,
    "se_remote_punt_udp_port" : 123,
    "disable_avi_securitygroups" : true,
    "max_cpu_usage" : 123,
    "hm_on_standby" : true,
    "name" : "aeiou",
    "se_rum_sampling_nav_percent" : 123,
    "vs_switchover_timeout" : 123,
    "free_list_size" : 123,
    "se_hyperthreaded_mode" : "aeiou",
    "min_cpu_usage" : 123,
    "cpu_socket_affinity" : true,
    "se_rum_sampling_res_percent" : 123,
    "description" : "aeiou",
    "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,
    "se_pcap_reinit_frequency" : 123,
    "disable_csum_offloads" : true,
    "cpu_reserve" : true,
    "se_deprovision_delay" : 123,
    "distribute_vnics" : true,
    "max_rules_per_lb" : 123,
    "nat_flow_udp_noresponse_timeout" : 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
      }
    },
    "mgmt_network_ref" : "aeiou",
    "vcenter_datastores" : [ {
      "datastore_name" : "aeiou"
    } ],
    "se_dp_vnic_queue_stall_timeout" : 123,
    "vcenters" : [ {
      "nsxt_datastores" : {
        "include" : true,
        "ds_ids" : [ "aeiou" ]
      },
      "vcenter_folder" : "aeiou",
      "nsxt_hosts" : {
        "include" : true,
        "host_ids" : [ "aeiou" ]
      },
      "vcenter_ref" : "aeiou"
    } ],
    "minimum_connection_memory" : 123,
    "se_routing" : true,
    "floating_intf_ip" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "mgmt_subnet" : "",
    "connection_memory_percentage" : 123,
    "se_ipc_udp_port" : 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,
    "buffer_se" : 123,
    "nat_flow_tcp_established_timeout" : 123,
    "max_public_ips_per_lb" : 123,
    "mem_reserve" : true,
    "openstack_mgmt_network_name" : "aeiou",
    "max_scaleout_per_vs" : 123,
    "se_use_dpdk" : 123,
    "enable_multi_lb" : true,
    "os_reserved_memory" : 123,
    "vcenter_clusters" : {
      "include" : true,
      "cluster_refs" : [ "aeiou" ]
    },
    "vss_placement" : {
      "num_subcores" : 123,
      "core_nonaffinity" : 123
    },
    "availability_zone_refs" : [ "aeiou" ],
    "nat_flow_tcp_handshake_timeout" : 123,
    "nat_flow_tcp_half_closed_timeout" : 123,
    "datascript_timeout" : 123456789,
    "app_cache_percent" : 123,
    "license_tier" : "aeiou",
    "bgp_state_update_interval" : 123,
    "host_attribute_value" : "aeiou",
    "vcpus_per_se" : 123,
    "non_significant_log_throttle" : 123,
    "se_flow_probe_timer" : 123,
    "allow_burst" : true,
    "reboot_on_panic" : true,
    "transient_shared_memory_max" : 123,
    "se_tunnel_udp_port" : 123,
    "se_pcap_pkt_sz" : 123,
    "auto_rebalance" : true,
    "ha_mode" : "aeiou",
    "disable_tso" : true,
    "nat_flow_udp_response_timeout" : 123,
    "se_dpdk_pmd" : 123,
    "nat_flow_tcp_closed_timeout" : 123,
    "vss_placement_enabled" : true,
    "se_dp_vnic_stall_se_restart_window" : 123,
    "distribute_load_active_standby" : true,
    "auto_rebalance_interval" : 123,
    "max_queues_per_vnic" : 123,
    "waf_learning_memory" : 123,
    "auto_rebalance_criteria" : [ "aeiou" ],
    "max_memory_per_mempool" : 123,
    "n_log_streaming_threads" : 123,
    "url" : "aeiou",
    "se_bandwidth_type" : "aeiou",
    "num_dispatcher_cores" : 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,
    "se_udp_encap_ipc" : 123,
    "enable_vip_on_all_interfaces" : true,
    "vcenter_hosts" : {
      "include" : true,
      "host_refs" : [ "aeiou" ]
    },
    "use_standard_alb" : true,
    "disable_gro" : true,
    "pcap_tx_mode" : "aeiou",
    "openstack_availability_zone" : "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,
    "se_flow_probe_retries" : 123,
    "se_mp_ring_retry_count" : 123,
    "dedicated_dispatcher_core" : true,
    "auto_redistribute_active_standby_load" : true,
    "enable_pcap_tx_ring" : true,
    "se_mtu" : 123,
    "se_tx_batch_size" : 123,
    "custom_securitygroups_data" : [ "aeiou" ],
    "iptables" : [ {
      "chain" : "aeiou",
      "rules" : [ {
        "src_ip" : "",
        "src_port" : "",
        "input_interface" : "aeiou",
        "proto" : "aeiou",
        "dnat_ip" : "",
        "dst_port" : {
          "start" : 123,
          "end" : 123
        },
        "action" : "aeiou",
        "output_interface" : "aeiou",
        "tag" : "aeiou",
        "dst_ip" : {
          "ip_addr" : "",
          "mask" : 123
        }
      } ],
      "table" : "aeiou"
    } ],
    "enable_routing" : true,
    "se_pcap_reinit_threshold" : 123,
    "aggressive_failure_detection" : true,
    "se_lro" : true,
    "floating_intf_ip_se_2" : [ "" ],
    "max_vs_per_se" : 123,
    "reboot_on_stop" : true,
    "waf_learning_interval" : 123,
    "_last_modified" : "aeiou",
    "significant_log_throttle" : 123,
    "se_rum_sampling_nav_interval" : 123,
    "hypervisor" : "aeiou",
    "use_hyperthreaded_cores" : true,
    "service_ip_subnets" : [ "" ],
    "memory_per_se" : 123,
    "auto_rebalance_capacity_per_se" : [ "" ],
    "ssl_preprocess_sni_hostname" : true,
    "vs_host_redundancy" : true,
    "placement_mode" : "aeiou",
    "distribute_queues" : true,
    "se_txq_threshold" : 123,
    "async_ssl" : true,
    "ephemeral_portrange_end" : 123,
    "vs_scaleout_timeout" : 123,
    "tenant_ref" : "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 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,
  "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
    } ]
  },
  "se_flow_probe_retry_timer" : 123,
  "minimum_required_config_memory" : 123,
  "vs_scalein_timeout" : 123,
  "se_pcap_qdisc_bypass" : true,
  "vs_se_scaleout_additional_wait_time" : 123,
  "active_standby" : true,
  "additional_config_memory" : 123,
  "service_ip6_subnets" : [ "" ],
  "se_kni_burst_factor" : 123,
  "resync_time_interval" : 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,
  "instance_flavor" : "aeiou",
  "disable_se_memory_check" : true,
  "se_probe_port" : 123,
  "app_learning_memory_percent" : 123,
  "se_vnic_tx_sw_queue_flush_frequency" : 123,
  "data_network_id" : "aeiou",
  "log_disksz" : 123,
  "ingress_access_data" : "aeiou",
  "se_sb_dedicated_core" : true,
  "gratarp_permanent_periodicity" : 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,
  "vs_scalein_timeout_for_upgrade" : 123,
  "custom_tag" : [ {
    "tag_key" : "aeiou",
    "tag_val" : "aeiou"
  } ],
  "advertise_backend_networks" : true,
  "num_flow_cores_sum_changes_to_ignore" : 123,
  "openstack_mgmt_network_uuid" : "aeiou",
  "core_shm_app_learning" : true,
  "per_app" : true,
  "vcenter_folder" : "aeiou",
  "algo" : "aeiou",
  "max_se" : 123,
  "enable_vmac" : true,
  "shm_minimum_config_memory" : 123,
  "hardwaresecuritymodulegroup_ref" : "aeiou",
  "compress_ip_rules_for_each_ns_subnet" : true,
  "se_dp_vnic_queue_stall_threshold" : 123,
  "udf_log_throttle" : 123,
  "se_dp_vnic_restart_on_queue_stall_count" : 123,
  "custom_securitygroups_mgmt" : [ "aeiou" ],
  "min_se" : 123,
  "waf_mempool_size" : 123,
  "se_remote_punt_udp_port" : 123,
  "disable_avi_securitygroups" : true,
  "max_cpu_usage" : 123,
  "hm_on_standby" : true,
  "name" : "aeiou",
  "se_rum_sampling_nav_percent" : 123,
  "vs_switchover_timeout" : 123,
  "free_list_size" : 123,
  "se_hyperthreaded_mode" : "aeiou",
  "min_cpu_usage" : 123,
  "cpu_socket_affinity" : true,
  "se_rum_sampling_res_percent" : 123,
  "description" : "aeiou",
  "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,
  "se_pcap_reinit_frequency" : 123,
  "disable_csum_offloads" : true,
  "cpu_reserve" : true,
  "se_deprovision_delay" : 123,
  "distribute_vnics" : true,
  "max_rules_per_lb" : 123,
  "nat_flow_udp_noresponse_timeout" : 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
    }
  },
  "mgmt_network_ref" : "aeiou",
  "vcenter_datastores" : [ {
    "datastore_name" : "aeiou"
  } ],
  "se_dp_vnic_queue_stall_timeout" : 123,
  "vcenters" : [ {
    "nsxt_datastores" : {
      "include" : true,
      "ds_ids" : [ "aeiou" ]
    },
    "vcenter_folder" : "aeiou",
    "nsxt_hosts" : {
      "include" : true,
      "host_ids" : [ "aeiou" ]
    },
    "vcenter_ref" : "aeiou"
  } ],
  "minimum_connection_memory" : 123,
  "se_routing" : true,
  "floating_intf_ip" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "mgmt_subnet" : "",
  "connection_memory_percentage" : 123,
  "se_ipc_udp_port" : 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,
  "buffer_se" : 123,
  "nat_flow_tcp_established_timeout" : 123,
  "max_public_ips_per_lb" : 123,
  "mem_reserve" : true,
  "openstack_mgmt_network_name" : "aeiou",
  "max_scaleout_per_vs" : 123,
  "se_use_dpdk" : 123,
  "enable_multi_lb" : true,
  "os_reserved_memory" : 123,
  "vcenter_clusters" : {
    "include" : true,
    "cluster_refs" : [ "aeiou" ]
  },
  "vss_placement" : {
    "num_subcores" : 123,
    "core_nonaffinity" : 123
  },
  "availability_zone_refs" : [ "aeiou" ],
  "nat_flow_tcp_handshake_timeout" : 123,
  "nat_flow_tcp_half_closed_timeout" : 123,
  "datascript_timeout" : 123456789,
  "app_cache_percent" : 123,
  "license_tier" : "aeiou",
  "bgp_state_update_interval" : 123,
  "host_attribute_value" : "aeiou",
  "vcpus_per_se" : 123,
  "non_significant_log_throttle" : 123,
  "se_flow_probe_timer" : 123,
  "allow_burst" : true,
  "reboot_on_panic" : true,
  "transient_shared_memory_max" : 123,
  "se_tunnel_udp_port" : 123,
  "se_pcap_pkt_sz" : 123,
  "auto_rebalance" : true,
  "ha_mode" : "aeiou",
  "disable_tso" : true,
  "nat_flow_udp_response_timeout" : 123,
  "se_dpdk_pmd" : 123,
  "nat_flow_tcp_closed_timeout" : 123,
  "vss_placement_enabled" : true,
  "se_dp_vnic_stall_se_restart_window" : 123,
  "distribute_load_active_standby" : true,
  "auto_rebalance_interval" : 123,
  "max_queues_per_vnic" : 123,
  "waf_learning_memory" : 123,
  "auto_rebalance_criteria" : [ "aeiou" ],
  "max_memory_per_mempool" : 123,
  "n_log_streaming_threads" : 123,
  "url" : "aeiou",
  "se_bandwidth_type" : "aeiou",
  "num_dispatcher_cores" : 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,
  "se_udp_encap_ipc" : 123,
  "enable_vip_on_all_interfaces" : true,
  "vcenter_hosts" : {
    "include" : true,
    "host_refs" : [ "aeiou" ]
  },
  "use_standard_alb" : true,
  "disable_gro" : true,
  "pcap_tx_mode" : "aeiou",
  "openstack_availability_zone" : "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,
  "se_flow_probe_retries" : 123,
  "se_mp_ring_retry_count" : 123,
  "dedicated_dispatcher_core" : true,
  "auto_redistribute_active_standby_load" : true,
  "enable_pcap_tx_ring" : true,
  "se_mtu" : 123,
  "se_tx_batch_size" : 123,
  "custom_securitygroups_data" : [ "aeiou" ],
  "iptables" : [ {
    "chain" : "aeiou",
    "rules" : [ {
      "src_ip" : "",
      "src_port" : "",
      "input_interface" : "aeiou",
      "proto" : "aeiou",
      "dnat_ip" : "",
      "dst_port" : {
        "start" : 123,
        "end" : 123
      },
      "action" : "aeiou",
      "output_interface" : "aeiou",
      "tag" : "aeiou",
      "dst_ip" : {
        "ip_addr" : "",
        "mask" : 123
      }
    } ],
    "table" : "aeiou"
  } ],
  "enable_routing" : true,
  "se_pcap_reinit_threshold" : 123,
  "aggressive_failure_detection" : true,
  "se_lro" : true,
  "floating_intf_ip_se_2" : [ "" ],
  "max_vs_per_se" : 123,
  "reboot_on_stop" : true,
  "waf_learning_interval" : 123,
  "_last_modified" : "aeiou",
  "significant_log_throttle" : 123,
  "se_rum_sampling_nav_interval" : 123,
  "hypervisor" : "aeiou",
  "use_hyperthreaded_cores" : true,
  "service_ip_subnets" : [ "" ],
  "memory_per_se" : 123,
  "auto_rebalance_capacity_per_se" : [ "" ],
  "ssl_preprocess_sni_hostname" : true,
  "vs_host_redundancy" : true,
  "placement_mode" : "aeiou",
  "distribute_queues" : true,
  "se_txq_threshold" : 123,
  "async_ssl" : true,
  "ephemeral_portrange_end" : 123,
  "vs_scaleout_timeout" : 123,
  "tenant_ref" : "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 ServiceEngineGroup

401

log in failed

Up
post /serviceenginegroup/{uuid}/clear
(serviceenginegroupUuidClearPost)

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
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,
  "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
    } ]
  },
  "se_flow_probe_retry_timer" : 123,
  "minimum_required_config_memory" : 123,
  "vs_scalein_timeout" : 123,
  "se_pcap_qdisc_bypass" : true,
  "vs_se_scaleout_additional_wait_time" : 123,
  "active_standby" : true,
  "additional_config_memory" : 123,
  "service_ip6_subnets" : [ "" ],
  "se_kni_burst_factor" : 123,
  "resync_time_interval" : 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,
  "instance_flavor" : "aeiou",
  "disable_se_memory_check" : true,
  "se_probe_port" : 123,
  "app_learning_memory_percent" : 123,
  "se_vnic_tx_sw_queue_flush_frequency" : 123,
  "data_network_id" : "aeiou",
  "log_disksz" : 123,
  "ingress_access_data" : "aeiou",
  "se_sb_dedicated_core" : true,
  "gratarp_permanent_periodicity" : 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,
  "vs_scalein_timeout_for_upgrade" : 123,
  "custom_tag" : [ {
    "tag_key" : "aeiou",
    "tag_val" : "aeiou"
  } ],
  "advertise_backend_networks" : true,
  "num_flow_cores_sum_changes_to_ignore" : 123,
  "openstack_mgmt_network_uuid" : "aeiou",
  "core_shm_app_learning" : true,
  "per_app" : true,
  "vcenter_folder" : "aeiou",
  "algo" : "aeiou",
  "max_se" : 123,
  "enable_vmac" : true,
  "shm_minimum_config_memory" : 123,
  "hardwaresecuritymodulegroup_ref" : "aeiou",
  "compress_ip_rules_for_each_ns_subnet" : true,
  "se_dp_vnic_queue_stall_threshold" : 123,
  "udf_log_throttle" : 123,
  "se_dp_vnic_restart_on_queue_stall_count" : 123,
  "custom_securitygroups_mgmt" : [ "aeiou" ],
  "min_se" : 123,
  "waf_mempool_size" : 123,
  "se_remote_punt_udp_port" : 123,
  "disable_avi_securitygroups" : true,
  "max_cpu_usage" : 123,
  "hm_on_standby" : true,
  "name" : "aeiou",
  "se_rum_sampling_nav_percent" : 123,
  "vs_switchover_timeout" : 123,
  "free_list_size" : 123,
  "se_hyperthreaded_mode" : "aeiou",
  "min_cpu_usage" : 123,
  "cpu_socket_affinity" : true,
  "se_rum_sampling_res_percent" : 123,
  "description" : "aeiou",
  "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,
  "se_pcap_reinit_frequency" : 123,
  "disable_csum_offloads" : true,
  "cpu_reserve" : true,
  "se_deprovision_delay" : 123,
  "distribute_vnics" : true,
  "max_rules_per_lb" : 123,
  "nat_flow_udp_noresponse_timeout" : 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
    }
  },
  "mgmt_network_ref" : "aeiou",
  "vcenter_datastores" : [ {
    "datastore_name" : "aeiou"
  } ],
  "se_dp_vnic_queue_stall_timeout" : 123,
  "vcenters" : [ {
    "nsxt_datastores" : {
      "include" : true,
      "ds_ids" : [ "aeiou" ]
    },
    "vcenter_folder" : "aeiou",
    "nsxt_hosts" : {
      "include" : true,
      "host_ids" : [ "aeiou" ]
    },
    "vcenter_ref" : "aeiou"
  } ],
  "minimum_connection_memory" : 123,
  "se_routing" : true,
  "floating_intf_ip" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "mgmt_subnet" : "",
  "connection_memory_percentage" : 123,
  "se_ipc_udp_port" : 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,
  "buffer_se" : 123,
  "nat_flow_tcp_established_timeout" : 123,
  "max_public_ips_per_lb" : 123,
  "mem_reserve" : true,
  "openstack_mgmt_network_name" : "aeiou",
  "max_scaleout_per_vs" : 123,
  "se_use_dpdk" : 123,
  "enable_multi_lb" : true,
  "os_reserved_memory" : 123,
  "vcenter_clusters" : {
    "include" : true,
    "cluster_refs" : [ "aeiou" ]
  },
  "vss_placement" : {
    "num_subcores" : 123,
    "core_nonaffinity" : 123
  },
  "availability_zone_refs" : [ "aeiou" ],
  "nat_flow_tcp_handshake_timeout" : 123,
  "nat_flow_tcp_half_closed_timeout" : 123,
  "datascript_timeout" : 123456789,
  "app_cache_percent" : 123,
  "license_tier" : "aeiou",
  "bgp_state_update_interval" : 123,
  "host_attribute_value" : "aeiou",
  "vcpus_per_se" : 123,
  "non_significant_log_throttle" : 123,
  "se_flow_probe_timer" : 123,
  "allow_burst" : true,
  "reboot_on_panic" : true,
  "transient_shared_memory_max" : 123,
  "se_tunnel_udp_port" : 123,
  "se_pcap_pkt_sz" : 123,
  "auto_rebalance" : true,
  "ha_mode" : "aeiou",
  "disable_tso" : true,
  "nat_flow_udp_response_timeout" : 123,
  "se_dpdk_pmd" : 123,
  "nat_flow_tcp_closed_timeout" : 123,
  "vss_placement_enabled" : true,
  "se_dp_vnic_stall_se_restart_window" : 123,
  "distribute_load_active_standby" : true,
  "auto_rebalance_interval" : 123,
  "max_queues_per_vnic" : 123,
  "waf_learning_memory" : 123,
  "auto_rebalance_criteria" : [ "aeiou" ],
  "max_memory_per_mempool" : 123,
  "n_log_streaming_threads" : 123,
  "url" : "aeiou",
  "se_bandwidth_type" : "aeiou",
  "num_dispatcher_cores" : 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,
  "se_udp_encap_ipc" : 123,
  "enable_vip_on_all_interfaces" : true,
  "vcenter_hosts" : {
    "include" : true,
    "host_refs" : [ "aeiou" ]
  },
  "use_standard_alb" : true,
  "disable_gro" : true,
  "pcap_tx_mode" : "aeiou",
  "openstack_availability_zone" : "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,
  "se_flow_probe_retries" : 123,
  "se_mp_ring_retry_count" : 123,
  "dedicated_dispatcher_core" : true,
  "auto_redistribute_active_standby_load" : true,
  "enable_pcap_tx_ring" : true,
  "se_mtu" : 123,
  "se_tx_batch_size" : 123,
  "custom_securitygroups_data" : [ "aeiou" ],
  "iptables" : [ {
    "chain" : "aeiou",
    "rules" : [ {
      "src_ip" : "",
      "src_port" : "",
      "input_interface" : "aeiou",
      "proto" : "aeiou",
      "dnat_ip" : "",
      "dst_port" : {
        "start" : 123,
        "end" : 123
      },
      "action" : "aeiou",
      "output_interface" : "aeiou",
      "tag" : "aeiou",
      "dst_ip" : {
        "ip_addr" : "",
        "mask" : 123
      }
    } ],
    "table" : "aeiou"
  } ],
  "enable_routing" : true,
  "se_pcap_reinit_threshold" : 123,
  "aggressive_failure_detection" : true,
  "se_lro" : true,
  "floating_intf_ip_se_2" : [ "" ],
  "max_vs_per_se" : 123,
  "reboot_on_stop" : true,
  "waf_learning_interval" : 123,
  "_last_modified" : "aeiou",
  "significant_log_throttle" : 123,
  "se_rum_sampling_nav_interval" : 123,
  "hypervisor" : "aeiou",
  "use_hyperthreaded_cores" : true,
  "service_ip_subnets" : [ "" ],
  "memory_per_se" : 123,
  "auto_rebalance_capacity_per_se" : [ "" ],
  "ssl_preprocess_sni_hostname" : true,
  "vs_host_redundancy" : true,
  "placement_mode" : "aeiou",
  "distribute_queues" : true,
  "se_txq_threshold" : 123,
  "async_ssl" : true,
  "ephemeral_portrange_end" : 123,
  "vs_scaleout_timeout" : 123,
  "tenant_ref" : "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 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,
  "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
    } ]
  },
  "se_flow_probe_retry_timer" : 123,
  "minimum_required_config_memory" : 123,
  "vs_scalein_timeout" : 123,
  "se_pcap_qdisc_bypass" : true,
  "vs_se_scaleout_additional_wait_time" : 123,
  "active_standby" : true,
  "additional_config_memory" : 123,
  "service_ip6_subnets" : [ "" ],
  "se_kni_burst_factor" : 123,
  "resync_time_interval" : 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,
  "instance_flavor" : "aeiou",
  "disable_se_memory_check" : true,
  "se_probe_port" : 123,
  "app_learning_memory_percent" : 123,
  "se_vnic_tx_sw_queue_flush_frequency" : 123,
  "data_network_id" : "aeiou",
  "log_disksz" : 123,
  "ingress_access_data" : "aeiou",
  "se_sb_dedicated_core" : true,
  "gratarp_permanent_periodicity" : 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,
  "vs_scalein_timeout_for_upgrade" : 123,
  "custom_tag" : [ {
    "tag_key" : "aeiou",
    "tag_val" : "aeiou"
  } ],
  "advertise_backend_networks" : true,
  "num_flow_cores_sum_changes_to_ignore" : 123,
  "openstack_mgmt_network_uuid" : "aeiou",
  "core_shm_app_learning" : true,
  "per_app" : true,
  "vcenter_folder" : "aeiou",
  "algo" : "aeiou",
  "max_se" : 123,
  "enable_vmac" : true,
  "shm_minimum_config_memory" : 123,
  "hardwaresecuritymodulegroup_ref" : "aeiou",
  "compress_ip_rules_for_each_ns_subnet" : true,
  "se_dp_vnic_queue_stall_threshold" : 123,
  "udf_log_throttle" : 123,
  "se_dp_vnic_restart_on_queue_stall_count" : 123,
  "custom_securitygroups_mgmt" : [ "aeiou" ],
  "min_se" : 123,
  "waf_mempool_size" : 123,
  "se_remote_punt_udp_port" : 123,
  "disable_avi_securitygroups" : true,
  "max_cpu_usage" : 123,
  "hm_on_standby" : true,
  "name" : "aeiou",
  "se_rum_sampling_nav_percent" : 123,
  "vs_switchover_timeout" : 123,
  "free_list_size" : 123,
  "se_hyperthreaded_mode" : "aeiou",
  "min_cpu_usage" : 123,
  "cpu_socket_affinity" : true,
  "se_rum_sampling_res_percent" : 123,
  "description" : "aeiou",
  "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,
  "se_pcap_reinit_frequency" : 123,
  "disable_csum_offloads" : true,
  "cpu_reserve" : true,
  "se_deprovision_delay" : 123,
  "distribute_vnics" : true,
  "max_rules_per_lb" : 123,
  "nat_flow_udp_noresponse_timeout" : 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
    }
  },
  "mgmt_network_ref" : "aeiou",
  "vcenter_datastores" : [ {
    "datastore_name" : "aeiou"
  } ],
  "se_dp_vnic_queue_stall_timeout" : 123,
  "vcenters" : [ {
    "nsxt_datastores" : {
      "include" : true,
      "ds_ids" : [ "aeiou" ]
    },
    "vcenter_folder" : "aeiou",
    "nsxt_hosts" : {
      "include" : true,
      "host_ids" : [ "aeiou" ]
    },
    "vcenter_ref" : "aeiou"
  } ],
  "minimum_connection_memory" : 123,
  "se_routing" : true,
  "floating_intf_ip" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "mgmt_subnet" : "",
  "connection_memory_percentage" : 123,
  "se_ipc_udp_port" : 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,
  "buffer_se" : 123,
  "nat_flow_tcp_established_timeout" : 123,
  "max_public_ips_per_lb" : 123,
  "mem_reserve" : true,
  "openstack_mgmt_network_name" : "aeiou",
  "max_scaleout_per_vs" : 123,
  "se_use_dpdk" : 123,
  "enable_multi_lb" : true,
  "os_reserved_memory" : 123,
  "vcenter_clusters" : {
    "include" : true,
    "cluster_refs" : [ "aeiou" ]
  },
  "vss_placement" : {
    "num_subcores" : 123,
    "core_nonaffinity" : 123
  },
  "availability_zone_refs" : [ "aeiou" ],
  "nat_flow_tcp_handshake_timeout" : 123,
  "nat_flow_tcp_half_closed_timeout" : 123,
  "datascript_timeout" : 123456789,
  "app_cache_percent" : 123,
  "license_tier" : "aeiou",
  "bgp_state_update_interval" : 123,
  "host_attribute_value" : "aeiou",
  "vcpus_per_se" : 123,
  "non_significant_log_throttle" : 123,
  "se_flow_probe_timer" : 123,
  "allow_burst" : true,
  "reboot_on_panic" : true,
  "transient_shared_memory_max" : 123,
  "se_tunnel_udp_port" : 123,
  "se_pcap_pkt_sz" : 123,
  "auto_rebalance" : true,
  "ha_mode" : "aeiou",
  "disable_tso" : true,
  "nat_flow_udp_response_timeout" : 123,
  "se_dpdk_pmd" : 123,
  "nat_flow_tcp_closed_timeout" : 123,
  "vss_placement_enabled" : true,
  "se_dp_vnic_stall_se_restart_window" : 123,
  "distribute_load_active_standby" : true,
  "auto_rebalance_interval" : 123,
  "max_queues_per_vnic" : 123,
  "waf_learning_memory" : 123,
  "auto_rebalance_criteria" : [ "aeiou" ],
  "max_memory_per_mempool" : 123,
  "n_log_streaming_threads" : 123,
  "url" : "aeiou",
  "se_bandwidth_type" : "aeiou",
  "num_dispatcher_cores" : 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,
  "se_udp_encap_ipc" : 123,
  "enable_vip_on_all_interfaces" : true,
  "vcenter_hosts" : {
    "include" : true,
    "host_refs" : [ "aeiou" ]
  },
  "use_standard_alb" : true,
  "disable_gro" : true,
  "pcap_tx_mode" : "aeiou",
  "openstack_availability_zone" : "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,
  "se_flow_probe_retries" : 123,
  "se_mp_ring_retry_count" : 123,
  "dedicated_dispatcher_core" : true,
  "auto_redistribute_active_standby_load" : true,
  "enable_pcap_tx_ring" : true,
  "se_mtu" : 123,
  "se_tx_batch_size" : 123,
  "custom_securitygroups_data" : [ "aeiou" ],
  "iptables" : [ {
    "chain" : "aeiou",
    "rules" : [ {
      "src_ip" : "",
      "src_port" : "",
      "input_interface" : "aeiou",
      "proto" : "aeiou",
      "dnat_ip" : "",
      "dst_port" : {
        "start" : 123,
        "end" : 123
      },
      "action" : "aeiou",
      "output_interface" : "aeiou",
      "tag" : "aeiou",
      "dst_ip" : {
        "ip_addr" : "",
        "mask" : 123
      }
    } ],
    "table" : "aeiou"
  } ],
  "enable_routing" : true,
  "se_pcap_reinit_threshold" : 123,
  "aggressive_failure_detection" : true,
  "se_lro" : true,
  "floating_intf_ip_se_2" : [ "" ],
  "max_vs_per_se" : 123,
  "reboot_on_stop" : true,
  "waf_learning_interval" : 123,
  "_last_modified" : "aeiou",
  "significant_log_throttle" : 123,
  "se_rum_sampling_nav_interval" : 123,
  "hypervisor" : "aeiou",
  "use_hyperthreaded_cores" : true,
  "service_ip_subnets" : [ "" ],
  "memory_per_se" : 123,
  "auto_rebalance_capacity_per_se" : [ "" ],
  "ssl_preprocess_sni_hostname" : true,
  "vs_host_redundancy" : true,
  "placement_mode" : "aeiou",
  "distribute_queues" : true,
  "se_txq_threshold" : 123,
  "async_ssl" : true,
  "ephemeral_portrange_end" : 123,
  "vs_scaleout_timeout" : 123,
  "tenant_ref" : "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 ServiceEngineGroup

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,
  "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
    } ]
  },
  "se_flow_probe_retry_timer" : 123,
  "minimum_required_config_memory" : 123,
  "vs_scalein_timeout" : 123,
  "se_pcap_qdisc_bypass" : true,
  "vs_se_scaleout_additional_wait_time" : 123,
  "active_standby" : true,
  "additional_config_memory" : 123,
  "service_ip6_subnets" : [ "" ],
  "se_kni_burst_factor" : 123,
  "resync_time_interval" : 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,
  "instance_flavor" : "aeiou",
  "disable_se_memory_check" : true,
  "se_probe_port" : 123,
  "app_learning_memory_percent" : 123,
  "se_vnic_tx_sw_queue_flush_frequency" : 123,
  "data_network_id" : "aeiou",
  "log_disksz" : 123,
  "ingress_access_data" : "aeiou",
  "se_sb_dedicated_core" : true,
  "gratarp_permanent_periodicity" : 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,
  "vs_scalein_timeout_for_upgrade" : 123,
  "custom_tag" : [ {
    "tag_key" : "aeiou",
    "tag_val" : "aeiou"
  } ],
  "advertise_backend_networks" : true,
  "num_flow_cores_sum_changes_to_ignore" : 123,
  "openstack_mgmt_network_uuid" : "aeiou",
  "core_shm_app_learning" : true,
  "per_app" : true,
  "vcenter_folder" : "aeiou",
  "algo" : "aeiou",
  "max_se" : 123,
  "enable_vmac" : true,
  "shm_minimum_config_memory" : 123,
  "hardwaresecuritymodulegroup_ref" : "aeiou",
  "compress_ip_rules_for_each_ns_subnet" : true,
  "se_dp_vnic_queue_stall_threshold" : 123,
  "udf_log_throttle" : 123,
  "se_dp_vnic_restart_on_queue_stall_count" : 123,
  "custom_securitygroups_mgmt" : [ "aeiou" ],
  "min_se" : 123,
  "waf_mempool_size" : 123,
  "se_remote_punt_udp_port" : 123,
  "disable_avi_securitygroups" : true,
  "max_cpu_usage" : 123,
  "hm_on_standby" : true,
  "name" : "aeiou",
  "se_rum_sampling_nav_percent" : 123,
  "vs_switchover_timeout" : 123,
  "free_list_size" : 123,
  "se_hyperthreaded_mode" : "aeiou",
  "min_cpu_usage" : 123,
  "cpu_socket_affinity" : true,
  "se_rum_sampling_res_percent" : 123,
  "description" : "aeiou",
  "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,
  "se_pcap_reinit_frequency" : 123,
  "disable_csum_offloads" : true,
  "cpu_reserve" : true,
  "se_deprovision_delay" : 123,
  "distribute_vnics" : true,
  "max_rules_per_lb" : 123,
  "nat_flow_udp_noresponse_timeout" : 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
    }
  },
  "mgmt_network_ref" : "aeiou",
  "vcenter_datastores" : [ {
    "datastore_name" : "aeiou"
  } ],
  "se_dp_vnic_queue_stall_timeout" : 123,
  "vcenters" : [ {
    "nsxt_datastores" : {
      "include" : true,
      "ds_ids" : [ "aeiou" ]
    },
    "vcenter_folder" : "aeiou",
    "nsxt_hosts" : {
      "include" : true,
      "host_ids" : [ "aeiou" ]
    },
    "vcenter_ref" : "aeiou"
  } ],
  "minimum_connection_memory" : 123,
  "se_routing" : true,
  "floating_intf_ip" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "mgmt_subnet" : "",
  "connection_memory_percentage" : 123,
  "se_ipc_udp_port" : 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,
  "buffer_se" : 123,
  "nat_flow_tcp_established_timeout" : 123,
  "max_public_ips_per_lb" : 123,
  "mem_reserve" : true,
  "openstack_mgmt_network_name" : "aeiou",
  "max_scaleout_per_vs" : 123,
  "se_use_dpdk" : 123,
  "enable_multi_lb" : true,
  "os_reserved_memory" : 123,
  "vcenter_clusters" : {
    "include" : true,
    "cluster_refs" : [ "aeiou" ]
  },
  "vss_placement" : {
    "num_subcores" : 123,
    "core_nonaffinity" : 123
  },
  "availability_zone_refs" : [ "aeiou" ],
  "nat_flow_tcp_handshake_timeout" : 123,
  "nat_flow_tcp_half_closed_timeout" : 123,
  "datascript_timeout" : 123456789,
  "app_cache_percent" : 123,
  "license_tier" : "aeiou",
  "bgp_state_update_interval" : 123,
  "host_attribute_value" : "aeiou",
  "vcpus_per_se" : 123,
  "non_significant_log_throttle" : 123,
  "se_flow_probe_timer" : 123,
  "allow_burst" : true,
  "reboot_on_panic" : true,
  "transient_shared_memory_max" : 123,
  "se_tunnel_udp_port" : 123,
  "se_pcap_pkt_sz" : 123,
  "auto_rebalance" : true,
  "ha_mode" : "aeiou",
  "disable_tso" : true,
  "nat_flow_udp_response_timeout" : 123,
  "se_dpdk_pmd" : 123,
  "nat_flow_tcp_closed_timeout" : 123,
  "vss_placement_enabled" : true,
  "se_dp_vnic_stall_se_restart_window" : 123,
  "distribute_load_active_standby" : true,
  "auto_rebalance_interval" : 123,
  "max_queues_per_vnic" : 123,
  "waf_learning_memory" : 123,
  "auto_rebalance_criteria" : [ "aeiou" ],
  "max_memory_per_mempool" : 123,
  "n_log_streaming_threads" : 123,
  "url" : "aeiou",
  "se_bandwidth_type" : "aeiou",
  "num_dispatcher_cores" : 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,
  "se_udp_encap_ipc" : 123,
  "enable_vip_on_all_interfaces" : true,
  "vcenter_hosts" : {
    "include" : true,
    "host_refs" : [ "aeiou" ]
  },
  "use_standard_alb" : true,
  "disable_gro" : true,
  "pcap_tx_mode" : "aeiou",
  "openstack_availability_zone" : "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,
  "se_flow_probe_retries" : 123,
  "se_mp_ring_retry_count" : 123,
  "dedicated_dispatcher_core" : true,
  "auto_redistribute_active_standby_load" : true,
  "enable_pcap_tx_ring" : true,
  "se_mtu" : 123,
  "se_tx_batch_size" : 123,
  "custom_securitygroups_data" : [ "aeiou" ],
  "iptables" : [ {
    "chain" : "aeiou",
    "rules" : [ {
      "src_ip" : "",
      "src_port" : "",
      "input_interface" : "aeiou",
      "proto" : "aeiou",
      "dnat_ip" : "",
      "dst_port" : {
        "start" : 123,
        "end" : 123
      },
      "action" : "aeiou",
      "output_interface" : "aeiou",
      "tag" : "aeiou",
      "dst_ip" : {
        "ip_addr" : "",
        "mask" : 123
      }
    } ],
    "table" : "aeiou"
  } ],
  "enable_routing" : true,
  "se_pcap_reinit_threshold" : 123,
  "aggressive_failure_detection" : true,
  "se_lro" : true,
  "floating_intf_ip_se_2" : [ "" ],
  "max_vs_per_se" : 123,
  "reboot_on_stop" : true,
  "waf_learning_interval" : 123,
  "_last_modified" : "aeiou",
  "significant_log_throttle" : 123,
  "se_rum_sampling_nav_interval" : 123,
  "hypervisor" : "aeiou",
  "use_hyperthreaded_cores" : true,
  "service_ip_subnets" : [ "" ],
  "memory_per_se" : 123,
  "auto_rebalance_capacity_per_se" : [ "" ],
  "ssl_preprocess_sni_hostname" : true,
  "vs_host_redundancy" : true,
  "placement_mode" : "aeiou",
  "distribute_queues" : true,
  "se_txq_threshold" : 123,
  "async_ssl" : true,
  "ephemeral_portrange_end" : 123,
  "vs_scaleout_timeout" : 123,
  "tenant_ref" : "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 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. CustomTag
  4. DosThreshold
  5. DosThresholdProfile
  6. IpAddr
  7. IpAddrPrefix
  8. IptableRule
  9. IptableRuleSet
  10. KeyValue
  11. MetricsRealTimeUpdate
  12. NsxtDatastores
  13. NsxtHosts
  14. PlacementScopeConfig
  15. PortRange
  16. RateLimiterProperties
  17. ServiceEngineGroup
  18. ServiceEngineGroupApiResponse
  19. VcenterClusters
  20. VcenterDatastore
  21. VcenterHosts
  22. VipAutoscaleConfiguration
  23. VipAutoscaleGroup
  24. VipAutoscalePolicy
  25. VipAutoscaleZones
  26. VssPlacement

CloudFlavor Up

cost (optional)
String cost of CloudFlavor.
disk_gb (optional)
Integer Number of disk_gb. format: int32
enhanced_nw (optional)
Boolean Placeholder for description of property enhanced_nw of obj type CloudFlavor field type str type boolean
id
String id of CloudFlavor.
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.
max_ip6s_per_nic (optional)
Integer Maximum number of IPv6 addresses that can be configured per NIC. Field introduced in 18.1.1. format: int32
max_ips_per_nic (optional)
Integer Number of max_ips_per_nic. format: int32
max_nics (optional)
Integer Number of max_nics. format: int32
meta (optional)
array[CloudMeta] Placeholder for description of property meta of obj type CloudFlavor field type str type object
name
String Name of the object.
public (optional)
Boolean Placeholder for description of property public of obj type CloudFlavor field type str type boolean
ram_mb (optional)
Integer Number of ram_mb. format: int32
vcpus (optional)
Integer Number of vcpus. format: int32

CloudMeta Up

key
String key of CloudMeta.
value
String value of CloudMeta.

CustomTag Up

tag_key
String tag_key of CustomTag.
tag_val (optional)
String tag_val of CustomTag.

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.
max_value
Integer Maximum number of packets or connections or requests in a given interval of time to be deemed as attack. format: int32
min_value
Integer Minimum number of packets or connections or requests in a given interval of time to be deemed as attack. format: int32

DosThresholdProfile Up

thresh_info (optional)
array[DosThreshold] Attack type, min and max values for DoS attack detection.
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. format: int32

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS, V6.

IpAddrPrefix Up

ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32

IptableRule Up

action
String Enum options - ACCEPT, DROP, REJECT, DNAT, MASQUERADE.
dnat_ip (optional)
IpAddr Placeholder for description of property dnat_ip of obj type IptableRule field type str type object
dst_ip (optional)
IpAddrPrefix Placeholder for description of property dst_ip of obj type IptableRule field type str type object
dst_port (optional)
PortRange Placeholder for description of property dst_port of obj type IptableRule field type str type object
input_interface (optional)
String input_interface of IptableRule.
output_interface (optional)
String output_interface of IptableRule.
proto (optional)
String Enum options - PROTO_TCP, PROTO_UDP, PROTO_ICMP, PROTO_ALL.
src_ip (optional)
IpAddrPrefix Placeholder for description of property src_ip of obj type IptableRule field type str type object
src_port (optional)
PortRange Placeholder for description of property src_port of obj type IptableRule field type str type object
tag (optional)
String tag of IptableRule.

IptableRuleSet Up

chain
String chain of IptableRuleSet.
rules (optional)
array[IptableRule] Placeholder for description of property rules of obj type IptableRuleSet field type str type object
table
String table of IptableRuleSet.

KeyValue Up

key
String Key.
value (optional)
String Value.

MetricsRealTimeUpdate Up

duration (optional)
Integer Real time metrics collection duration in minutes. 0 for infinite. Special values are 0 - 'infinite'. Unit is MIN. format: int32
enabled
Boolean Enables real time metrics collection. When disabled, 6 hour view is the most granular the system will track.

NsxtDatastores Up

ds_ids (optional)
array[String] List of shared datastores. Field introduced in 20.1.2.
include (optional)
Boolean Include or Exclude. Field introduced in 20.1.2.

NsxtHosts Up

host_ids (optional)
array[String] List of transport nodes. Field introduced in 20.1.1.
include (optional)
Boolean Include or Exclude. Field introduced in 20.1.1.

PlacementScopeConfig Up

nsxt_datastores (optional)
NsxtDatastores List of shared datastores to include or exclude. Field introduced in 20.1.2.
nsxt_hosts (optional)
NsxtHosts List of transport nodes include or exclude. Field introduced in 20.1.1.
vcenter_folder (optional)
String Folder to place all the Service Engine virtual machines in vCenter. Field introduced in 20.1.1.
vcenter_ref
String VCenter server configuration. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1.

PortRange Up

end
Integer TCP/UDP port range end (inclusive). Allowed values are 1-65535. format: int32
start
Integer TCP/UDP port range start (inclusive). Allowed values are 1-65535. 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. format: int32
msf_stage_size (optional)
Long Each stage size in msf rate limiter. Field introduced in 20.1.1. format: int64

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.
active_standby (optional)
Boolean Service Engines in active/standby mode for HA failover.
additional_config_memory (optional)
Integer Indicates the percent of config memory used for config updates. Allowed values are 0-90. Field deprecated in 18.1.2. Field introduced in 18.1.1. Unit is PERCENT. format: int32
advertise_backend_networks (optional)
Boolean Advertise reach-ability of backend server networks via ADC through BGP for default gateway feature. Field deprecated in 18.2.5.
aggressive_failure_detection (optional)
Boolean Enable aggressive failover configuration for ha.
algo (optional)
String In compact placement, Virtual Services are placed on existing SEs until max_vs_per_se limit is reached. Enum options - PLACEMENT_ALGO_PACKED, PLACEMENT_ALGO_DISTRIBUTED.
allow_burst (optional)
Boolean Allow SEs to be created using burst license. Field introduced in 17.2.5.
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. 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. 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. 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. format: int32
async_ssl (optional)
Boolean SSL handshakes will be handled by dedicated SSL Threads.Requires SE Reboot.
async_ssl_threads (optional)
Integer Number of Async SSL threads per se_dp.Requires SE Reboot. Allowed values are 1-16. 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.
auto_rebalance_capacity_per_se (optional)
array[Integer] Capacities of SE for auto rebalance for each criteria. Field introduced in 17.2.4.
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.
auto_rebalance_interval (optional)
Integer Frequency of rebalance, if 'Auto rebalance' is enabled. Unit is SEC. 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.
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.
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. format: int32
buffer_se (optional)
Integer Excess Service Engine capacity provisioned for HA failover. format: int32
cloud_ref (optional)
String It is a reference to an object of type Cloud.
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.
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.
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. 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.
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.
cpu_reserve (optional)
Boolean Placeholder for description of property cpu_reserve of obj type ServiceEngineGroup field type str type boolean
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.
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.
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.
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.
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.
datascript_timeout (optional)
Long Number of instructions before datascript times out. Allowed values are 0-100000000. Field introduced in 18.2.3. format: int64
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.
description (optional)
String User defined description for the object.
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.
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.
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.
disable_se_memory_check (optional)
Boolean If set, disable the config memory check done in service engine. Field introduced in 18.1.2.
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.
disk_per_se (optional)
Integer Amount of disk space for each of the Service Engine virtual machines. Unit is GB. 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.
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.
distribute_vnics (optional)
Boolean Distributes vnic ownership among cores so multiple cores handle dispatcher duties.Requires SE Reboot. Field introduced in 18.2.5.
enable_gratarp_permanent (optional)
Boolean Enable GratArp for VIP_IP. Field introduced in 18.2.3.
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.
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.
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.
enable_routing (optional)
Boolean Enable routing for this ServiceEngineGroup . Field deprecated in 18.2.5.
enable_vip_on_all_interfaces (optional)
Boolean Enable VIP on all interfaces of SE. Field deprecated in 18.2.5. Field introduced in 17.1.1.
enable_vmac (optional)
Boolean Use Virtual MAC address for interfaces on which floating interface IPs are placed. Field deprecated in 18.2.5.
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. 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. format: int32
extra_config_multiplier (optional)
Double Multiplier for extra config to support large VS/Pool config. 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. format: int32
floating_intf_ip (optional)
array[IpAddr] If ServiceEngineGroup is configured for Legacy 1+1 Active Standby HA Mode, Floating IP's will be advertised only by the Active SE in the Pair. Virtual Services in this group must be disabled/enabled for any changes to the Floating IP's to take effect. Only active SE hosting VS tagged with Active Standby SE 1 Tag will advertise this floating IP when manual load distribution is enabled. Field deprecated in 18.2.5.
floating_intf_ip_se_2 (optional)
array[IpAddr] If ServiceEngineGroup is configured for Legacy 1+1 Active Standby HA Mode, Floating IP's will be advertised only by the Active SE in the Pair. Virtual Services in this group must be disabled/enabled for any changes to the Floating IP's to take effect. Only active SE hosting VS tagged with Active Standby SE 2 Tag will advertise this floating IP when manual load distribution is enabled. Field deprecated in 18.2.5.
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. format: int32
free_list_size (optional)
Integer Number of entries in the free list. Field introduced in 17.2.10, 18.1.2. format: int32
gratarp_permanent_periodicity (optional)
Integer GratArp periodicity for VIP-IP. Allowed values are 5-30. Field introduced in 18.2.3. Unit is MIN. 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.
hardwaresecuritymodulegroup_ref (optional)
String It is a reference to an object of type HardwareSecurityModuleGroup.
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. format: int32
hm_on_standby (optional)
Boolean Enable active health monitoring from the standby SE for all placed virtual services.
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.
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.
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.
hypervisor (optional)
String Override default hypervisor. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN.
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. 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.
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.
instance_flavor (optional)
String Instance/Flavor name for SE instance.
instance_flavor_info (optional)
CloudFlavor Additional information associated with instance_flavor. Field introduced in 20.1.1.
iptables (optional)
array[IptableRuleSet] Iptable Rules.
labels (optional)
array[KeyValue] Labels associated with this SE group. Field introduced in 20.1.1.
least_load_core_selection (optional)
Boolean Select core with least load for new flow.
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. Field introduced in 17.2.5.
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.
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. 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.
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. 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. 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. format: int32
max_num_se_dps (optional)
Integer Configures the maximum number of se_dp processes created on the SE, requires SE reboot. If not configured, defaults to the number of CPUs on the SE. This should only be used if user wants to limit the number of se_dps to less than the available CPUs on the SE. Allowed values are 1-128. Field introduced in 20.1.1. 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. 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. 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. format: int32
max_scaleout_per_vs (optional)
Integer Maximum number of active Service Engines for the Virtual Service. Allowed values are 1-64. format: int32
max_se (optional)
Integer Maximum number of Services Engines in this group. Allowed values are 0-1000. format: int32
max_vs_per_se (optional)
Integer Maximum number of Virtual Services that can be placed on a single Service Engine. East West Virtual Services are excluded from this limit. Allowed values are 1-1000. format: int32
mem_reserve (optional)
Boolean Placeholder for description of property mem_reserve of obj type ServiceEngineGroup field type str type boolean
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. format: int32
memory_per_se (optional)
Integer Amount of memory for each of the Service Engine virtual machines. 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.
mgmt_subnet (optional)
IpAddrPrefix Management subnet to use for Avi Service Engines.
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. format: int32
min_scaleout_per_vs (optional)
Integer Minimum number of active Service Engines for the Virtual Service. Allowed values are 1-64. 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. 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. format: int32
minimum_required_config_memory (optional)
Integer Required available config memory to apply any configuration. Allowed values are 0-90. Field deprecated in 18.1.2. Field introduced in 18.1.1. Unit is PERCENT. 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. format: int32
name
String Name of the object.
nat_flow_tcp_closed_timeout (optional)
Integer Idle timeout in seconds for nat tcp flows in closed state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. format: int32
nat_flow_tcp_established_timeout (optional)
Integer Idle timeout in seconds for nat tcp flows in established state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. format: int32
nat_flow_tcp_half_closed_timeout (optional)
Integer Idle timeout in seconds for nat tcp flows in half closed state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. format: int32
nat_flow_tcp_handshake_timeout (optional)
Integer Idle timeout in seconds for nat tcp flows in handshake state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. format: int32
nat_flow_udp_noresponse_timeout (optional)
Integer Idle timeout in seconds for nat udp flows in noresponse state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. format: int32
nat_flow_udp_response_timeout (optional)
Integer Idle timeout in seconds for nat udp flows in response state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. format: int32
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 disable throttling. Field introduced in 17.1.3. Unit is PER_SECOND. 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. format: int32
num_flow_cores_sum_changes_to_ignore (optional)
Integer Number of changes in num flow cores sum to ignore. format: int32
openstack_availability_zone (optional)
String Field deprecated in 17.1.1.
openstack_availability_zones (optional)
array[String] Field introduced in 17.1.1.
openstack_mgmt_network_name (optional)
String Avi Management network name.
openstack_mgmt_network_uuid (optional)
String Management network UUID.
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. 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.
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.
placement_mode (optional)
String If placement mode is 'Auto', Virtual Services are automatically placed on Service Engines. Enum options - PLACEMENT_MODE_AUTO.
realtime_se_metrics (optional)
MetricsRealTimeUpdate Enable or disable real time SE metrics.
reboot_on_panic (optional)
Boolean Reboot the VM or host on kernel panic. Field introduced in 18.2.5.
reboot_on_stop (optional)
Boolean Reboot the system if the SE is stopped. Field deprecated in 18.2.5.
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. 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.
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.
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. format: int32
se_dos_profile (optional)
DosThresholdProfile Placeholder for description of property se_dos_profile of obj type ServiceEngineGroup field type str type object
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-2. Field introduced in 20.1.1. 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. 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. 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. 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. 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. 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. 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. 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. format: int32
se_flow_probe_timer (optional)
Integer Timeout in milliseconds for flow probe entries. Allowed values are 10-200. Field deprecated in 18.2.5. Field introduced in 18.1.4, 18.2.1. Unit is MILLISECONDS. format: int32
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.
se_ipc_udp_port (optional)
Integer UDP Port for SE_DP IPC in Docker bridge mode. Field deprecated in 20.1.1. Field introduced in 17.1.2. format: int32
se_kni_burst_factor (optional)
Integer Knob to control burst size used in polling KNI interfaces for traffic sent from KNI towards DPDK application Also controls burst size used by KNI module to read pkts punted from DPDK application towards KNI Helps minimize drops in non-VIP traffic in either pathFactor of (0-2) multiplies/divides burst size by 2^N. Allowed values are 0-2. Field introduced in 18.2.6. format: int32
se_lro (optional)
Boolean Enable or disable Large Receive Optimization for vnics. Requires SE Reboot. Field introduced in 18.2.5.
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.2. 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. format: int32
se_name_prefix (optional)
String Prefix to use for virtual machine name of Service Engines.
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.
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. 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. 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.
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. 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. format: int32
se_probe_port (optional)
Integer TCP port on SE where echo service will be run. Field introduced in 17.2.2. format: int32
se_remote_punt_udp_port (optional)
Integer UDP Port for punted packets in Docker bridge mode. Field deprecated in 20.1.1. Field introduced in 17.1.2. format: int32
se_rl_prop (optional)
RateLimiterProperties Rate limiter properties. Field introduced in 20.1.1.
se_routing (optional)
Boolean Enable routing via Service Engine Datapath. When disabled, routing is done by the Linux kernel. IP Routing needs to be enabled in Service Engine Group for SE Routing to be effective. Field deprecated in 18.2.5. Field introduced in 18.2.3.
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. 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. 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. 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. 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.
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. format: int32
se_thread_multiplier (optional)
Integer Multiplier for SE threads based on vCPU. Allowed values are 1-10. format: int32
se_tracert_port_range (optional)
PortRange Traceroute port range. Field introduced in 17.2.8.
se_tunnel_mode (optional)
Integer Determines if DSR from secondary SE is active or not 0 Automatically determine based on hypervisor type. 1 Disable DSR unconditionally. 2 Enable DSR unconditionally. Allowed values are 0-2. Field introduced in 17.1.1. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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.
service_ip6_subnets (optional)
array[IpAddrPrefix] IPv6 Subnets assigned to the SE group. Required for VS group placement. Field introduced in 18.1.1.
service_ip_subnets (optional)
array[IpAddrPrefix] Subnets assigned to the SE group. Required for VS group placement. Field introduced in 17.1.1.
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. 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 disable throttling. Field introduced in 17.1.3. Unit is PER_SECOND. 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.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
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. 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 disable throttling. Field introduced in 17.1.3. Unit is PER_SECOND. format: int32
url (optional)
String url
use_hyperthreaded_cores (optional)
Boolean Enables the use of hyper-threaded cores on SE. Requires SE Reboot. Field introduced in 20.1.1.
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.
uuid (optional)
String Unique object identifier of the object.
vcenter_clusters (optional)
VcenterClusters Placeholder for description of property vcenter_clusters of obj type ServiceEngineGroup field type str type object
vcenter_datastore_mode (optional)
String Enum options - VCENTER_DATASTORE_ANY, VCENTER_DATASTORE_LOCAL, VCENTER_DATASTORE_SHARED.
vcenter_datastores (optional)
array[VcenterDatastore] Placeholder for description of property vcenter_datastores of obj type ServiceEngineGroup field type str type object
vcenter_datastores_include (optional)
Boolean Placeholder for description of property vcenter_datastores_include of obj type ServiceEngineGroup field type str type boolean
vcenter_folder (optional)
String Folder to place all the Service Engine virtual machines in vCenter.
vcenter_hosts (optional)
VcenterHosts Placeholder for description of property vcenter_hosts of obj type ServiceEngineGroup field type str type object
vcenters (optional)
array[PlacementScopeConfig] VCenter information for scoping at Host/Cluster level. Field introduced in 20.1.1.
vcpus_per_se (optional)
Integer Number of vcpus for each of the Service Engine virtual machines. 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.
vs_host_redundancy (optional)
Boolean Ensure primary and secondary Service Engines are deployed on different physical hosts.
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. 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. 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. 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. 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. 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. 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.
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.
waf_learning_interval (optional)
Integer Frequency with which SE publishes WAF learning. Allowed values are 1-43200. Field deprecated in 18.2.3. Field introduced in 18.1.2. Unit is MIN. format: int32
waf_learning_memory (optional)
Integer Amount of memory reserved on SE for WAF learning. This can be atmost 5% of SE memory. Field deprecated in 18.2.3. Field introduced in 18.1.2. Unit is MB. format: int32
waf_mempool (optional)
Boolean Enable memory pool for WAF.Requires SE Reboot. Field introduced in 17.2.3.
waf_mempool_size (optional)
Integer Memory pool size used for WAF.Requires SE Reboot. Field introduced in 17.2.3. Unit is KB. format: int32

ServiceEngineGroupApiResponse Up

count
Integer format: int32
results
next (optional)

VcenterClusters Up

cluster_refs (optional)
array[String] It is a reference to an object of type VIMgrClusterRuntime.
include (optional)
Boolean Placeholder for description of property include of obj type VcenterClusters field type str type boolean

VcenterDatastore Up

datastore_name
String datastore_name of VcenterDatastore.

VcenterHosts Up

host_refs (optional)
array[String] It is a reference to an object of type VIMgrHostRuntime.
include (optional)
Boolean Placeholder for description of property include of obj type VcenterHosts field type str type boolean

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.

VipAutoscaleGroup Up

configuration (optional)
VipAutoscaleConfiguration Field introduced in 17.2.12, 18.1.2.
policy (optional)
VipAutoscalePolicy Field introduced in 17.2.12, 18.1.2.

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. format: int32
max_size (optional)
Integer The maximum size of the group. Field introduced in 17.2.12, 18.1.2. format: int32
min_size (optional)
Integer The minimum size of the group. Field introduced in 17.2.12, 18.1.2. format: int32
suspend (optional)
Boolean When set, scaling is suspended. Field introduced in 17.2.12, 18.1.2.

VipAutoscaleZones Up

availability_zone (optional)
String Availability zone associated with the subnet. Field introduced in 17.2.12, 18.1.2.
fip_capable (optional)
Boolean Determines if the subnet is capable of hosting publicly accessible IP. Field introduced in 17.2.12, 18.1.2.
subnet_uuid (optional)
String UUID of the subnet for new IP address allocation. Field introduced in 17.2.12, 18.1.2.

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. 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. format: int32