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 {u'min_scaleout_per_vs': 2, u'ha_mode': u'HA_MODE_SHARED_PAIR', u'name': u'production-group'} ``` - **serviceenginegroup_example_2**: To create a SE group that is of best effort category suitable for test deployments ```json {u'buffer_se': 0, u'ha_mode': u'HA_MODE_SHARED', u'max_se': 8, u'name': u'test-group'} ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
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.
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
{
  "count" : 123,
  "results" : [ {
    "connection_memory_percentage" : 123,
    "se_ipc_udp_port" : 123,
    "extra_config_multiplier" : 1.3579000000000001069366817318950779736042022705078125,
    "extra_shared_config_memory" : 123,
    "host_gateway_monitor" : true,
    "se_dos_profile" : {
      "thresh_period" : 123,
      "thresh_info" : [ {
        "min_value" : 123,
        "attack" : "aeiou",
        "max_value" : 123
      } ]
    },
    "se_name_prefix" : "aeiou",
    "vs_scalein_timeout" : 123,
    "cloud_ref" : "aeiou",
    "se_sb_threads" : 123,
    "buffer_se" : 123,
    "mem_reserve" : true,
    "openstack_mgmt_network_name" : "aeiou",
    "active_standby" : true,
    "max_scaleout_per_vs" : 123,
    "min_scaleout_per_vs" : 123,
    "os_reserved_memory" : 123,
    "vcenter_clusters" : {
      "include" : true,
      "cluster_refs" : [ "aeiou" ]
    },
    "vcenter_datastores_include" : true,
    "disk_per_se" : 123,
    "host_attribute_key" : "aeiou",
    "host_attribute_value" : "aeiou",
    "instance_flavor" : "aeiou",
    "se_probe_port" : 123,
    "vcpus_per_se" : 123,
    "non_significant_log_throttle" : 123,
    "log_disksz" : 123,
    "se_tunnel_udp_port" : 123,
    "ingress_access_data" : "aeiou",
    "auto_rebalance" : true,
    "ha_mode" : "aeiou",
    "se_sb_dedicated_core" : true,
    "se_vs_hb_max_pkts_in_batch" : 123,
    "distribute_load_active_standby" : true,
    "auto_rebalance_interval" : 123,
    "vcenter_datastore_mode" : "aeiou",
    "auto_rebalance_criteria" : [ "aeiou" ],
    "url" : "aeiou",
    "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",
    "per_app" : true,
    "vcenter_folder" : "aeiou",
    "algo" : "aeiou",
    "ingress_access_mgmt" : "aeiou",
    "ignore_rtt_threshold" : 123,
    "max_se" : 123,
    "waf_mempool" : true,
    "enable_vmac" : true,
    "openstack_availability_zones" : [ "aeiou" ],
    "se_tunnel_mode" : 123,
    "se_vs_hb_max_vs_in_pkt" : 123,
    "least_load_core_selection" : true,
    "hardwaresecuritymodulegroup_ref" : "aeiou",
    "uuid" : "aeiou",
    "se_udp_encap_ipc" : 123,
    "udf_log_throttle" : 123,
    "enable_vip_on_all_interfaces" : true,
    "vcenter_hosts" : {
      "include" : true,
      "host_refs" : [ "aeiou" ]
    },
    "custom_securitygroups_mgmt" : [ "aeiou" ],
    "openstack_availability_zone" : "aeiou",
    "se_thread_multiplier" : 123,
    "waf_mempool_size" : 123,
    "se_remote_punt_udp_port" : 123,
    "max_cpu_usage" : 123,
    "dedicated_dispatcher_core" : true,
    "hm_on_standby" : true,
    "auto_redistribute_active_standby_load" : true,
    "name" : "aeiou",
    "custom_securitygroups_data" : [ "aeiou" ],
    "min_cpu_usage" : 123,
    "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,
    "cpu_socket_affinity" : true,
    "aggressive_failure_detection" : true,
    "floating_intf_ip_se_2" : [ "" ],
    "max_vs_per_se" : 123,
    "description" : "aeiou",
    "significant_log_throttle" : 123,
    "async_ssl_threads" : 123,
    "realtime_se_metrics" : {
      "duration" : 123,
      "enabled" : true
    },
    "archive_shm_limit" : 123,
    "hypervisor" : "aeiou",
    "service_ip_subnets" : [ "" ],
    "memory_per_se" : 123,
    "auto_rebalance_capacity_per_se" : [ "" ],
    "cpu_reserve" : true,
    "vs_host_redundancy" : true,
    "placement_mode" : "aeiou",
    "se_deprovision_delay" : 123,
    "mgmt_network_ref" : "aeiou",
    "async_ssl" : true,
    "vcenter_datastores" : [ {
      "datastore_name" : "aeiou"
    } ],
    "vs_scaleout_timeout" : 123,
    "tenant_ref" : "aeiou",
    "floating_intf_ip" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "mgmt_subnet" : ""
  } ]
}

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
{
  "connection_memory_percentage" : 123,
  "se_ipc_udp_port" : 123,
  "extra_config_multiplier" : 1.3579000000000001069366817318950779736042022705078125,
  "extra_shared_config_memory" : 123,
  "host_gateway_monitor" : true,
  "se_dos_profile" : {
    "thresh_period" : 123,
    "thresh_info" : [ {
      "min_value" : 123,
      "attack" : "aeiou",
      "max_value" : 123
    } ]
  },
  "se_name_prefix" : "aeiou",
  "vs_scalein_timeout" : 123,
  "cloud_ref" : "aeiou",
  "se_sb_threads" : 123,
  "buffer_se" : 123,
  "mem_reserve" : true,
  "openstack_mgmt_network_name" : "aeiou",
  "active_standby" : true,
  "max_scaleout_per_vs" : 123,
  "min_scaleout_per_vs" : 123,
  "os_reserved_memory" : 123,
  "vcenter_clusters" : {
    "include" : true,
    "cluster_refs" : [ "aeiou" ]
  },
  "vcenter_datastores_include" : true,
  "disk_per_se" : 123,
  "host_attribute_key" : "aeiou",
  "host_attribute_value" : "aeiou",
  "instance_flavor" : "aeiou",
  "se_probe_port" : 123,
  "vcpus_per_se" : 123,
  "non_significant_log_throttle" : 123,
  "log_disksz" : 123,
  "se_tunnel_udp_port" : 123,
  "ingress_access_data" : "aeiou",
  "auto_rebalance" : true,
  "ha_mode" : "aeiou",
  "se_sb_dedicated_core" : true,
  "se_vs_hb_max_pkts_in_batch" : 123,
  "distribute_load_active_standby" : true,
  "auto_rebalance_interval" : 123,
  "vcenter_datastore_mode" : "aeiou",
  "auto_rebalance_criteria" : [ "aeiou" ],
  "url" : "aeiou",
  "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",
  "per_app" : true,
  "vcenter_folder" : "aeiou",
  "algo" : "aeiou",
  "ingress_access_mgmt" : "aeiou",
  "ignore_rtt_threshold" : 123,
  "max_se" : 123,
  "waf_mempool" : true,
  "enable_vmac" : true,
  "openstack_availability_zones" : [ "aeiou" ],
  "se_tunnel_mode" : 123,
  "se_vs_hb_max_vs_in_pkt" : 123,
  "least_load_core_selection" : true,
  "hardwaresecuritymodulegroup_ref" : "aeiou",
  "uuid" : "aeiou",
  "se_udp_encap_ipc" : 123,
  "udf_log_throttle" : 123,
  "enable_vip_on_all_interfaces" : true,
  "vcenter_hosts" : {
    "include" : true,
    "host_refs" : [ "aeiou" ]
  },
  "custom_securitygroups_mgmt" : [ "aeiou" ],
  "openstack_availability_zone" : "aeiou",
  "se_thread_multiplier" : 123,
  "waf_mempool_size" : 123,
  "se_remote_punt_udp_port" : 123,
  "max_cpu_usage" : 123,
  "dedicated_dispatcher_core" : true,
  "hm_on_standby" : true,
  "auto_redistribute_active_standby_load" : true,
  "name" : "aeiou",
  "custom_securitygroups_data" : [ "aeiou" ],
  "min_cpu_usage" : 123,
  "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,
  "cpu_socket_affinity" : true,
  "aggressive_failure_detection" : true,
  "floating_intf_ip_se_2" : [ "" ],
  "max_vs_per_se" : 123,
  "description" : "aeiou",
  "significant_log_throttle" : 123,
  "async_ssl_threads" : 123,
  "realtime_se_metrics" : {
    "duration" : 123,
    "enabled" : true
  },
  "archive_shm_limit" : 123,
  "hypervisor" : "aeiou",
  "service_ip_subnets" : [ "" ],
  "memory_per_se" : 123,
  "auto_rebalance_capacity_per_se" : [ "" ],
  "cpu_reserve" : true,
  "vs_host_redundancy" : true,
  "placement_mode" : "aeiou",
  "se_deprovision_delay" : 123,
  "mgmt_network_ref" : "aeiou",
  "async_ssl" : true,
  "vcenter_datastores" : [ {
    "datastore_name" : "aeiou"
  } ],
  "vs_scaleout_timeout" : 123,
  "tenant_ref" : "aeiou",
  "floating_intf_ip" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "mgmt_subnet" : ""
}

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.
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
{
  "connection_memory_percentage" : 123,
  "se_ipc_udp_port" : 123,
  "extra_config_multiplier" : 1.3579000000000001069366817318950779736042022705078125,
  "extra_shared_config_memory" : 123,
  "host_gateway_monitor" : true,
  "se_dos_profile" : {
    "thresh_period" : 123,
    "thresh_info" : [ {
      "min_value" : 123,
      "attack" : "aeiou",
      "max_value" : 123
    } ]
  },
  "se_name_prefix" : "aeiou",
  "vs_scalein_timeout" : 123,
  "cloud_ref" : "aeiou",
  "se_sb_threads" : 123,
  "buffer_se" : 123,
  "mem_reserve" : true,
  "openstack_mgmt_network_name" : "aeiou",
  "active_standby" : true,
  "max_scaleout_per_vs" : 123,
  "min_scaleout_per_vs" : 123,
  "os_reserved_memory" : 123,
  "vcenter_clusters" : {
    "include" : true,
    "cluster_refs" : [ "aeiou" ]
  },
  "vcenter_datastores_include" : true,
  "disk_per_se" : 123,
  "host_attribute_key" : "aeiou",
  "host_attribute_value" : "aeiou",
  "instance_flavor" : "aeiou",
  "se_probe_port" : 123,
  "vcpus_per_se" : 123,
  "non_significant_log_throttle" : 123,
  "log_disksz" : 123,
  "se_tunnel_udp_port" : 123,
  "ingress_access_data" : "aeiou",
  "auto_rebalance" : true,
  "ha_mode" : "aeiou",
  "se_sb_dedicated_core" : true,
  "se_vs_hb_max_pkts_in_batch" : 123,
  "distribute_load_active_standby" : true,
  "auto_rebalance_interval" : 123,
  "vcenter_datastore_mode" : "aeiou",
  "auto_rebalance_criteria" : [ "aeiou" ],
  "url" : "aeiou",
  "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",
  "per_app" : true,
  "vcenter_folder" : "aeiou",
  "algo" : "aeiou",
  "ingress_access_mgmt" : "aeiou",
  "ignore_rtt_threshold" : 123,
  "max_se" : 123,
  "waf_mempool" : true,
  "enable_vmac" : true,
  "openstack_availability_zones" : [ "aeiou" ],
  "se_tunnel_mode" : 123,
  "se_vs_hb_max_vs_in_pkt" : 123,
  "least_load_core_selection" : true,
  "hardwaresecuritymodulegroup_ref" : "aeiou",
  "uuid" : "aeiou",
  "se_udp_encap_ipc" : 123,
  "udf_log_throttle" : 123,
  "enable_vip_on_all_interfaces" : true,
  "vcenter_hosts" : {
    "include" : true,
    "host_refs" : [ "aeiou" ]
  },
  "custom_securitygroups_mgmt" : [ "aeiou" ],
  "openstack_availability_zone" : "aeiou",
  "se_thread_multiplier" : 123,
  "waf_mempool_size" : 123,
  "se_remote_punt_udp_port" : 123,
  "max_cpu_usage" : 123,
  "dedicated_dispatcher_core" : true,
  "hm_on_standby" : true,
  "auto_redistribute_active_standby_load" : true,
  "name" : "aeiou",
  "custom_securitygroups_data" : [ "aeiou" ],
  "min_cpu_usage" : 123,
  "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,
  "cpu_socket_affinity" : true,
  "aggressive_failure_detection" : true,
  "floating_intf_ip_se_2" : [ "" ],
  "max_vs_per_se" : 123,
  "description" : "aeiou",
  "significant_log_throttle" : 123,
  "async_ssl_threads" : 123,
  "realtime_se_metrics" : {
    "duration" : 123,
    "enabled" : true
  },
  "archive_shm_limit" : 123,
  "hypervisor" : "aeiou",
  "service_ip_subnets" : [ "" ],
  "memory_per_se" : 123,
  "auto_rebalance_capacity_per_se" : [ "" ],
  "cpu_reserve" : true,
  "vs_host_redundancy" : true,
  "placement_mode" : "aeiou",
  "se_deprovision_delay" : 123,
  "mgmt_network_ref" : "aeiou",
  "async_ssl" : true,
  "vcenter_datastores" : [ {
    "datastore_name" : "aeiou"
  } ],
  "vs_scaleout_timeout" : 123,
  "tenant_ref" : "aeiou",
  "floating_intf_ip" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "mgmt_subnet" : ""
}

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
{
  "connection_memory_percentage" : 123,
  "se_ipc_udp_port" : 123,
  "extra_config_multiplier" : 1.3579000000000001069366817318950779736042022705078125,
  "extra_shared_config_memory" : 123,
  "host_gateway_monitor" : true,
  "se_dos_profile" : {
    "thresh_period" : 123,
    "thresh_info" : [ {
      "min_value" : 123,
      "attack" : "aeiou",
      "max_value" : 123
    } ]
  },
  "se_name_prefix" : "aeiou",
  "vs_scalein_timeout" : 123,
  "cloud_ref" : "aeiou",
  "se_sb_threads" : 123,
  "buffer_se" : 123,
  "mem_reserve" : true,
  "openstack_mgmt_network_name" : "aeiou",
  "active_standby" : true,
  "max_scaleout_per_vs" : 123,
  "min_scaleout_per_vs" : 123,
  "os_reserved_memory" : 123,
  "vcenter_clusters" : {
    "include" : true,
    "cluster_refs" : [ "aeiou" ]
  },
  "vcenter_datastores_include" : true,
  "disk_per_se" : 123,
  "host_attribute_key" : "aeiou",
  "host_attribute_value" : "aeiou",
  "instance_flavor" : "aeiou",
  "se_probe_port" : 123,
  "vcpus_per_se" : 123,
  "non_significant_log_throttle" : 123,
  "log_disksz" : 123,
  "se_tunnel_udp_port" : 123,
  "ingress_access_data" : "aeiou",
  "auto_rebalance" : true,
  "ha_mode" : "aeiou",
  "se_sb_dedicated_core" : true,
  "se_vs_hb_max_pkts_in_batch" : 123,
  "distribute_load_active_standby" : true,
  "auto_rebalance_interval" : 123,
  "vcenter_datastore_mode" : "aeiou",
  "auto_rebalance_criteria" : [ "aeiou" ],
  "url" : "aeiou",
  "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",
  "per_app" : true,
  "vcenter_folder" : "aeiou",
  "algo" : "aeiou",
  "ingress_access_mgmt" : "aeiou",
  "ignore_rtt_threshold" : 123,
  "max_se" : 123,
  "waf_mempool" : true,
  "enable_vmac" : true,
  "openstack_availability_zones" : [ "aeiou" ],
  "se_tunnel_mode" : 123,
  "se_vs_hb_max_vs_in_pkt" : 123,
  "least_load_core_selection" : true,
  "hardwaresecuritymodulegroup_ref" : "aeiou",
  "uuid" : "aeiou",
  "se_udp_encap_ipc" : 123,
  "udf_log_throttle" : 123,
  "enable_vip_on_all_interfaces" : true,
  "vcenter_hosts" : {
    "include" : true,
    "host_refs" : [ "aeiou" ]
  },
  "custom_securitygroups_mgmt" : [ "aeiou" ],
  "openstack_availability_zone" : "aeiou",
  "se_thread_multiplier" : 123,
  "waf_mempool_size" : 123,
  "se_remote_punt_udp_port" : 123,
  "max_cpu_usage" : 123,
  "dedicated_dispatcher_core" : true,
  "hm_on_standby" : true,
  "auto_redistribute_active_standby_load" : true,
  "name" : "aeiou",
  "custom_securitygroups_data" : [ "aeiou" ],
  "min_cpu_usage" : 123,
  "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,
  "cpu_socket_affinity" : true,
  "aggressive_failure_detection" : true,
  "floating_intf_ip_se_2" : [ "" ],
  "max_vs_per_se" : 123,
  "description" : "aeiou",
  "significant_log_throttle" : 123,
  "async_ssl_threads" : 123,
  "realtime_se_metrics" : {
    "duration" : 123,
    "enabled" : true
  },
  "archive_shm_limit" : 123,
  "hypervisor" : "aeiou",
  "service_ip_subnets" : [ "" ],
  "memory_per_se" : 123,
  "auto_rebalance_capacity_per_se" : [ "" ],
  "cpu_reserve" : true,
  "vs_host_redundancy" : true,
  "placement_mode" : "aeiou",
  "se_deprovision_delay" : 123,
  "mgmt_network_ref" : "aeiou",
  "async_ssl" : true,
  "vcenter_datastores" : [ {
    "datastore_name" : "aeiou"
  } ],
  "vs_scaleout_timeout" : 123,
  "tenant_ref" : "aeiou",
  "floating_intf_ip" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "mgmt_subnet" : ""
}

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
{
  "connection_memory_percentage" : 123,
  "se_ipc_udp_port" : 123,
  "extra_config_multiplier" : 1.3579000000000001069366817318950779736042022705078125,
  "extra_shared_config_memory" : 123,
  "host_gateway_monitor" : true,
  "se_dos_profile" : {
    "thresh_period" : 123,
    "thresh_info" : [ {
      "min_value" : 123,
      "attack" : "aeiou",
      "max_value" : 123
    } ]
  },
  "se_name_prefix" : "aeiou",
  "vs_scalein_timeout" : 123,
  "cloud_ref" : "aeiou",
  "se_sb_threads" : 123,
  "buffer_se" : 123,
  "mem_reserve" : true,
  "openstack_mgmt_network_name" : "aeiou",
  "active_standby" : true,
  "max_scaleout_per_vs" : 123,
  "min_scaleout_per_vs" : 123,
  "os_reserved_memory" : 123,
  "vcenter_clusters" : {
    "include" : true,
    "cluster_refs" : [ "aeiou" ]
  },
  "vcenter_datastores_include" : true,
  "disk_per_se" : 123,
  "host_attribute_key" : "aeiou",
  "host_attribute_value" : "aeiou",
  "instance_flavor" : "aeiou",
  "se_probe_port" : 123,
  "vcpus_per_se" : 123,
  "non_significant_log_throttle" : 123,
  "log_disksz" : 123,
  "se_tunnel_udp_port" : 123,
  "ingress_access_data" : "aeiou",
  "auto_rebalance" : true,
  "ha_mode" : "aeiou",
  "se_sb_dedicated_core" : true,
  "se_vs_hb_max_pkts_in_batch" : 123,
  "distribute_load_active_standby" : true,
  "auto_rebalance_interval" : 123,
  "vcenter_datastore_mode" : "aeiou",
  "auto_rebalance_criteria" : [ "aeiou" ],
  "url" : "aeiou",
  "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",
  "per_app" : true,
  "vcenter_folder" : "aeiou",
  "algo" : "aeiou",
  "ingress_access_mgmt" : "aeiou",
  "ignore_rtt_threshold" : 123,
  "max_se" : 123,
  "waf_mempool" : true,
  "enable_vmac" : true,
  "openstack_availability_zones" : [ "aeiou" ],
  "se_tunnel_mode" : 123,
  "se_vs_hb_max_vs_in_pkt" : 123,
  "least_load_core_selection" : true,
  "hardwaresecuritymodulegroup_ref" : "aeiou",
  "uuid" : "aeiou",
  "se_udp_encap_ipc" : 123,
  "udf_log_throttle" : 123,
  "enable_vip_on_all_interfaces" : true,
  "vcenter_hosts" : {
    "include" : true,
    "host_refs" : [ "aeiou" ]
  },
  "custom_securitygroups_mgmt" : [ "aeiou" ],
  "openstack_availability_zone" : "aeiou",
  "se_thread_multiplier" : 123,
  "waf_mempool_size" : 123,
  "se_remote_punt_udp_port" : 123,
  "max_cpu_usage" : 123,
  "dedicated_dispatcher_core" : true,
  "hm_on_standby" : true,
  "auto_redistribute_active_standby_load" : true,
  "name" : "aeiou",
  "custom_securitygroups_data" : [ "aeiou" ],
  "min_cpu_usage" : 123,
  "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,
  "cpu_socket_affinity" : true,
  "aggressive_failure_detection" : true,
  "floating_intf_ip_se_2" : [ "" ],
  "max_vs_per_se" : 123,
  "description" : "aeiou",
  "significant_log_throttle" : 123,
  "async_ssl_threads" : 123,
  "realtime_se_metrics" : {
    "duration" : 123,
    "enabled" : true
  },
  "archive_shm_limit" : 123,
  "hypervisor" : "aeiou",
  "service_ip_subnets" : [ "" ],
  "memory_per_se" : 123,
  "auto_rebalance_capacity_per_se" : [ "" ],
  "cpu_reserve" : true,
  "vs_host_redundancy" : true,
  "placement_mode" : "aeiou",
  "se_deprovision_delay" : 123,
  "mgmt_network_ref" : "aeiou",
  "async_ssl" : true,
  "vcenter_datastores" : [ {
    "datastore_name" : "aeiou"
  } ],
  "vs_scaleout_timeout" : 123,
  "tenant_ref" : "aeiou",
  "floating_intf_ip" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "mgmt_subnet" : ""
}

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. CustomTag
  2. DosThreshold
  3. DosThresholdProfile
  4. IpAddr
  5. IpAddrPrefix
  6. IptableRule
  7. IptableRuleSet
  8. MetricsRealTimeUpdate
  9. PortRange
  10. ServiceEngineGroup
  11. ServiceEngineGroupApiResponse
  12. VcenterClusters
  13. VcenterDatastore
  14. VcenterHosts

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

IpAddr Up

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

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.

MetricsRealTimeUpdate Up

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

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

ServiceEngineGroup Up

active_standby (optional)
Boolean Service Engines in active/standby mode for HA failover.
advertise_backend_networks (optional)
Boolean Advertise reach-ability of backend server networks via ADC through BGP for default gateway feature.
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.
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. format: int32
async_ssl (optional)
Boolean SSL handshakes will be handled by dedicated SSL Threads.
async_ssl_threads (optional)
Integer Number of Async SSL threads per se_dp. Allowed values are 1-4. 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. Field introduced in 17.2.3.
auto_rebalance_interval (optional)
Integer Frequency of rebalance, if 'Auto rebalance' is enabled. 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.
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.
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. format: int32
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.
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.
disk_per_se (optional)
Integer Amount of disk space for each of the Service Engine virtual machines. 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.
enable_routing (optional)
Boolean Enable routing for this ServiceEngineGroup .
enable_vip_on_all_interfaces (optional)
Boolean Enable VIP on all interfaces of SE. Field introduced in 17.1.1.
enable_vmac (optional)
Boolean Use Virtual MAC address for interfaces on which floating interface IPs are placed.
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. 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.
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.
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.
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. 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 type for SE instance.
iptables (optional)
array[IptableRuleSet] Iptable Rules.
least_load_core_selection (optional)
Boolean Select core with least load for new flow.
log_disksz (optional)
Integer Maximum disk capacity (in MB) to be allocated to an SE. This is exclusively used for debug and log data. 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. 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_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. 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
name
String Name of the object.
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. 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. format: int32
per_app (optional)
Boolean Per-app SE mode is designed for deploying dedicated load balancers per app (VS). In this mode, each SE is limited to a max of 2 VSs. vCPUs in per-app SEs count towards licensing usage at 25% rate.
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.
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. 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_ipc_udp_port (optional)
Integer UDP Port for SE_DP IPC in Docker bridge mode. Field introduced in 17.1.2. format: int32
se_name_prefix (optional)
String Prefix to use for virtual machine name of Service Engines.
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 introduced in 17.1.2. format: int32
se_sb_dedicated_core (optional)
Boolean Sideband traffic will be handled by a dedicated core. Field introduced in 16.5.2, 17.1.9, 17.2.3.
se_sb_threads (optional)
Integer Number of Sideband threads per SE. 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_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 ~[0,1] Enable DSR unconditionally. 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. Field introduced in 17.1.3. format: int32
se_udp_encap_ipc (optional)
Integer Determines if SE-SE IPC messages are encapsulated in an UDP header 0 Automatically determine based on hypervisor type 1 Use UDP encap unconditionally ~[0,1] Don't use UDP encap. Field introduced in 17.1.2. 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
service_ip_subnets (optional)
array[IpAddrPrefix] Subnets assigned to the SE group. Required for VS group placement. Field introduced in 17.1.1.
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. format: int32
tenant_ref (optional)
String It is a reference to an object of type Tenant.
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. format: int32
url (optional)
String url
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
vcpus_per_se (optional)
Integer Number of vcpus for each of the Service Engine virtual machines. format: int32
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. 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. format: int32
vs_scaleout_timeout (optional)
Integer Time to wait for the scaled out SE to become ready before marking the scaleout done. format: int32
waf_mempool (optional)
Boolean Enable memory pool for WAF. Field introduced in 17.2.3.
waf_mempool_size (optional)
Integer Memory pool size used for WAF. Field introduced in 17.2.3. format: int32

ServiceEngineGroupApiResponse Up

count
Integer format: int32
results

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