Avi ServiceEngine Object API

##CLI## ``` - configure serviceengine - show serviceengine - reboot serviceengine - delete serviceengine - forcedelete serviceengine - switchover serviceengine - clear serviceengine ```
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 /serviceengine
  2. post /serviceengine
  3. get /serviceengine/{uuid}/arpstat/
  4. get /serviceengine/{uuid}/arptable/
  5. get /serviceengine/{uuid}/bgp/
  6. post /serviceengine/{uuid}/clear
  7. get /serviceengine/{uuid}/connected/
  8. get /serviceengine/{uuid}/cpu/
  9. delete /serviceengine/{uuid}
  10. get /serviceengine/{uuid}/dosstat/
  11. post /serviceengine/{uuid}/faultinject/exhaust_conn/clear
  12. post /serviceengine/{uuid}/faultinject/exhaust_mbuf/clear
  13. post /serviceengine/{uuid}/faultinject/exhaust_mcl/clear
  14. post /serviceengine/{uuid}/faultinject/exhaust_mcl_small/clear
  15. get /serviceengine/{uuid}/flowtable/
  16. get /serviceengine/{uuid}/flowtable_remote/
  17. get /serviceengine/{uuid}/flowtablestat/
  18. post /serviceengine/{uuid}/forcedelete
  19. get /serviceengine/{uuid}
  20. get /serviceengine/{uuid}/graphdb/
  21. get /serviceengine/{uuid}/httpstats/
  22. get /serviceengine/{uuid}/icmpstat/
  23. get /serviceengine/{uuid}/interface/
  24. get /serviceengine/{uuid}/interface/lacp/
  25. get /serviceengine/{uuid}/interfacesummary/
  26. get /serviceengine/{uuid}/ipstat/
  27. get /serviceengine/{uuid}/lldp/
  28. get /serviceengine/{uuid}/mallocstats/
  29. get /serviceengine/{uuid}/mbufstats/
  30. get /serviceengine/{uuid}/memdist/
  31. get /serviceengine/{uuid}/meminfo/
  32. get /serviceengine/{uuid}/metrics/detail/
  33. get /serviceengine/{uuid}/metrics/
  34. get /serviceengine/{uuid}/microservice/
  35. patch /serviceengine/{uuid}
  36. get /serviceengine/{uuid}/placement/
  37. put /serviceengine/{uuid}
  38. post /serviceengine/{uuid}/reboot
  39. get /serviceengine/{uuid}/reservedvs/
  40. get /serviceengine/{uuid}/route/
  41. get /serviceengine/{uuid}/rteringstat/
  42. get /serviceengine/{uuid}/runtime/detail/
  43. get /serviceengine/{uuid}/runtime/
  44. get /serviceengine/{uuid}/seagent/
  45. get /serviceengine/{uuid}/seauthstats/
  46. get /serviceengine/{uuid}/sehmprobedisable/
  47. get /serviceengine/{uuid}/selogstats/
  48. get /serviceengine/{uuid}/seruminsertionstats/
  49. get /serviceengine/{uuid}/sevshbstats/
  50. get /serviceengine/{uuid}/shmallocstats/
  51. post /serviceengine/{uuid}/switchover
  52. get /serviceengine/{uuid}/tcp-flows/detail/
  53. get /serviceengine/{uuid}/tcp-flows/
  54. get /serviceengine/{uuid}/vnicdb/
  55. get /serviceengine/{uuid}/vshash/
Up
get /serviceengine
(serviceengineGet)

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

ServiceEngineApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "availability_zone" : "aeiou",
    "controller_ip" : "aeiou",
    "host_ref" : "aeiou",
    "enable_state" : "aeiou",
    "resources" : {
      "disk" : 123,
      "memory" : 123,
      "num_vcpus" : 123,
      "sockets" : 123,
      "cores_per_socket" : 123,
      "hyper_threading" : true
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "se_group_ref" : "aeiou",
    "flavor" : "aeiou",
    "cloud_ref" : "aeiou",
    "hypervisor" : "aeiou",
    "mgmt_vnic" : "",
    "tenant_ref" : "aeiou",
    "container_type" : "aeiou",
    "controller_created" : true,
    "name" : "aeiou",
    "container_mode" : true,
    "data_vnics" : [ {
      "vlan_id" : 123,
      "vrf_id" : 123,
      "is_hsm" : true,
      "port_uuid" : "aeiou",
      "if_name" : "aeiou",
      "is_asm" : true,
      "can_se_dp_takeover" : true,
      "vrf_ref" : "aeiou",
      "linux_name" : "aeiou",
      "enabled" : true,
      "vnic_networks" : [ "" ],
      "is_avi_internal_network" : true,
      "mac_address" : "aeiou",
      "members" : [ {
        "mac_address" : "aeiou",
        "if_name" : "aeiou",
        "active" : true
      } ],
      "network_ref" : "aeiou",
      "adapter" : "aeiou",
      "pci_id" : "aeiou",
      "network_name" : "aeiou",
      "del_pending" : true,
      "is_mgmt" : true,
      "mtu" : 123,
      "connected" : true,
      "dhcp_enabled" : true,
      "vlan_interfaces" : [ {
        "dhcp_enabled" : true,
        "vlan_id" : 123,
        "if_name" : "aeiou",
        "vrf_ref" : "aeiou",
        "is_mgmt" : true,
        "vnic_networks" : [ {
          "mode" : "aeiou",
          "ip" : {
            "ip_addr" : {
              "addr" : "aeiou",
              "type" : "aeiou"
            },
            "mask" : 123
          },
          "ctlr_alloc" : true
        } ]
      } ],
      "is_portchannel" : true
    } ]
  } ]
}

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 ServiceEngineApiResponse

401

log in failed

Up
post /serviceengine
(serviceenginePost)

Consumes

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

Request body

body (required)
Body Parameter — ServiceEngine object creation

Return type

ServiceEngine

Example data

Content-Type: application/json
{
  "availability_zone" : "aeiou",
  "controller_ip" : "aeiou",
  "host_ref" : "aeiou",
  "enable_state" : "aeiou",
  "resources" : {
    "disk" : 123,
    "memory" : 123,
    "num_vcpus" : 123,
    "sockets" : 123,
    "cores_per_socket" : 123,
    "hyper_threading" : true
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "se_group_ref" : "aeiou",
  "flavor" : "aeiou",
  "cloud_ref" : "aeiou",
  "hypervisor" : "aeiou",
  "mgmt_vnic" : "",
  "tenant_ref" : "aeiou",
  "container_type" : "aeiou",
  "controller_created" : true,
  "name" : "aeiou",
  "container_mode" : true,
  "data_vnics" : [ {
    "vlan_id" : 123,
    "vrf_id" : 123,
    "is_hsm" : true,
    "port_uuid" : "aeiou",
    "if_name" : "aeiou",
    "is_asm" : true,
    "can_se_dp_takeover" : true,
    "vrf_ref" : "aeiou",
    "linux_name" : "aeiou",
    "enabled" : true,
    "vnic_networks" : [ "" ],
    "is_avi_internal_network" : true,
    "mac_address" : "aeiou",
    "members" : [ {
      "mac_address" : "aeiou",
      "if_name" : "aeiou",
      "active" : true
    } ],
    "network_ref" : "aeiou",
    "adapter" : "aeiou",
    "pci_id" : "aeiou",
    "network_name" : "aeiou",
    "del_pending" : true,
    "is_mgmt" : true,
    "mtu" : 123,
    "connected" : true,
    "dhcp_enabled" : true,
    "vlan_interfaces" : [ {
      "dhcp_enabled" : true,
      "vlan_id" : 123,
      "if_name" : "aeiou",
      "vrf_ref" : "aeiou",
      "is_mgmt" : true,
      "vnic_networks" : [ {
        "mode" : "aeiou",
        "ip" : {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        },
        "ctlr_alloc" : true
      } ]
    } ],
    "is_portchannel" : true
  } ]
}

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 ServiceEngine

401

log in failed

Up
get /serviceengine/{uuid}/arpstat/
(serviceengineUuidArpstatGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/arptable/
(serviceengineUuidArptableGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/bgp/
(serviceengineUuidBgpGet)

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
post /serviceengine/{uuid}/clear
(serviceengineUuidClearPost)

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 /serviceengine/{uuid}/connected/
(serviceengineUuidConnectedGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/cpu/
(serviceengineUuidCpuGet)

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
delete /serviceengine/{uuid}
(serviceengineUuidDelete)

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 /serviceengine/{uuid}/dosstat/
(serviceengineUuidDosstatGet)

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
post /serviceengine/{uuid}/faultinject/exhaust_conn/clear
(serviceengineUuidFaultinjectExhaustConnClearPost)

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 — SEFaultInjectExhaustParam

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
post /serviceengine/{uuid}/faultinject/exhaust_mbuf/clear
(serviceengineUuidFaultinjectExhaustMbufClearPost)

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 — SEFaultInjectExhaustParam

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
post /serviceengine/{uuid}/faultinject/exhaust_mcl/clear
(serviceengineUuidFaultinjectExhaustMclClearPost)

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 — SEFaultInjectExhaustParam

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
post /serviceengine/{uuid}/faultinject/exhaust_mcl_small/clear
(serviceengineUuidFaultinjectExhaustMclSmallClearPost)

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 — SEFaultInjectExhaustParam

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 /serviceengine/{uuid}/flowtable/
(serviceengineUuidFlowtableGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/flowtable_remote/
(serviceengineUuidFlowtableRemoteGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/flowtablestat/
(serviceengineUuidFlowtablestatGet)

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
post /serviceengine/{uuid}/forcedelete
(serviceengineUuidForcedeletePost)

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 /serviceengine/{uuid}
(serviceengineUuidGet)

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

ServiceEngine

Example data

Content-Type: application/json
{
  "availability_zone" : "aeiou",
  "controller_ip" : "aeiou",
  "host_ref" : "aeiou",
  "enable_state" : "aeiou",
  "resources" : {
    "disk" : 123,
    "memory" : 123,
    "num_vcpus" : 123,
    "sockets" : 123,
    "cores_per_socket" : 123,
    "hyper_threading" : true
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "se_group_ref" : "aeiou",
  "flavor" : "aeiou",
  "cloud_ref" : "aeiou",
  "hypervisor" : "aeiou",
  "mgmt_vnic" : "",
  "tenant_ref" : "aeiou",
  "container_type" : "aeiou",
  "controller_created" : true,
  "name" : "aeiou",
  "container_mode" : true,
  "data_vnics" : [ {
    "vlan_id" : 123,
    "vrf_id" : 123,
    "is_hsm" : true,
    "port_uuid" : "aeiou",
    "if_name" : "aeiou",
    "is_asm" : true,
    "can_se_dp_takeover" : true,
    "vrf_ref" : "aeiou",
    "linux_name" : "aeiou",
    "enabled" : true,
    "vnic_networks" : [ "" ],
    "is_avi_internal_network" : true,
    "mac_address" : "aeiou",
    "members" : [ {
      "mac_address" : "aeiou",
      "if_name" : "aeiou",
      "active" : true
    } ],
    "network_ref" : "aeiou",
    "adapter" : "aeiou",
    "pci_id" : "aeiou",
    "network_name" : "aeiou",
    "del_pending" : true,
    "is_mgmt" : true,
    "mtu" : 123,
    "connected" : true,
    "dhcp_enabled" : true,
    "vlan_interfaces" : [ {
      "dhcp_enabled" : true,
      "vlan_id" : 123,
      "if_name" : "aeiou",
      "vrf_ref" : "aeiou",
      "is_mgmt" : true,
      "vnic_networks" : [ {
        "mode" : "aeiou",
        "ip" : {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        },
        "ctlr_alloc" : true
      } ]
    } ],
    "is_portchannel" : true
  } ]
}

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 ServiceEngine

401

log in failed

Up
get /serviceengine/{uuid}/graphdb/
(serviceengineUuidGraphdbGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/httpstats/
(serviceengineUuidHttpstatsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/icmpstat/
(serviceengineUuidIcmpstatGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/interface/
(serviceengineUuidInterfaceGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/interface/lacp/
(serviceengineUuidInterfaceLacpGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/interfacesummary/
(serviceengineUuidInterfacesummaryGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/ipstat/
(serviceengineUuidIpstatGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/lldp/
(serviceengineUuidLldpGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/mallocstats/
(serviceengineUuidMallocstatsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/mbufstats/
(serviceengineUuidMbufstatsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/memdist/
(serviceengineUuidMemdistGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/meminfo/
(serviceengineUuidMeminfoGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/metrics/detail/
(serviceengineUuidMetricsDetailGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/metrics/
(serviceengineUuidMetricsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/microservice/
(serviceengineUuidMicroserviceGet)

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
patch /serviceengine/{uuid}
(serviceengineUuidPatch)

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 — ServiceEngine object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ServiceEngine

Example data

Content-Type: application/json
{
  "availability_zone" : "aeiou",
  "controller_ip" : "aeiou",
  "host_ref" : "aeiou",
  "enable_state" : "aeiou",
  "resources" : {
    "disk" : 123,
    "memory" : 123,
    "num_vcpus" : 123,
    "sockets" : 123,
    "cores_per_socket" : 123,
    "hyper_threading" : true
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "se_group_ref" : "aeiou",
  "flavor" : "aeiou",
  "cloud_ref" : "aeiou",
  "hypervisor" : "aeiou",
  "mgmt_vnic" : "",
  "tenant_ref" : "aeiou",
  "container_type" : "aeiou",
  "controller_created" : true,
  "name" : "aeiou",
  "container_mode" : true,
  "data_vnics" : [ {
    "vlan_id" : 123,
    "vrf_id" : 123,
    "is_hsm" : true,
    "port_uuid" : "aeiou",
    "if_name" : "aeiou",
    "is_asm" : true,
    "can_se_dp_takeover" : true,
    "vrf_ref" : "aeiou",
    "linux_name" : "aeiou",
    "enabled" : true,
    "vnic_networks" : [ "" ],
    "is_avi_internal_network" : true,
    "mac_address" : "aeiou",
    "members" : [ {
      "mac_address" : "aeiou",
      "if_name" : "aeiou",
      "active" : true
    } ],
    "network_ref" : "aeiou",
    "adapter" : "aeiou",
    "pci_id" : "aeiou",
    "network_name" : "aeiou",
    "del_pending" : true,
    "is_mgmt" : true,
    "mtu" : 123,
    "connected" : true,
    "dhcp_enabled" : true,
    "vlan_interfaces" : [ {
      "dhcp_enabled" : true,
      "vlan_id" : 123,
      "if_name" : "aeiou",
      "vrf_ref" : "aeiou",
      "is_mgmt" : true,
      "vnic_networks" : [ {
        "mode" : "aeiou",
        "ip" : {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        },
        "ctlr_alloc" : true
      } ]
    } ],
    "is_portchannel" : true
  } ]
}

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 ServiceEngine

401

log in failed

Up
get /serviceengine/{uuid}/placement/
(serviceengineUuidPlacementGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
put /serviceengine/{uuid}
(serviceengineUuidPut)

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 — ServiceEngine object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ServiceEngine

Example data

Content-Type: application/json
{
  "availability_zone" : "aeiou",
  "controller_ip" : "aeiou",
  "host_ref" : "aeiou",
  "enable_state" : "aeiou",
  "resources" : {
    "disk" : 123,
    "memory" : 123,
    "num_vcpus" : 123,
    "sockets" : 123,
    "cores_per_socket" : 123,
    "hyper_threading" : true
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "se_group_ref" : "aeiou",
  "flavor" : "aeiou",
  "cloud_ref" : "aeiou",
  "hypervisor" : "aeiou",
  "mgmt_vnic" : "",
  "tenant_ref" : "aeiou",
  "container_type" : "aeiou",
  "controller_created" : true,
  "name" : "aeiou",
  "container_mode" : true,
  "data_vnics" : [ {
    "vlan_id" : 123,
    "vrf_id" : 123,
    "is_hsm" : true,
    "port_uuid" : "aeiou",
    "if_name" : "aeiou",
    "is_asm" : true,
    "can_se_dp_takeover" : true,
    "vrf_ref" : "aeiou",
    "linux_name" : "aeiou",
    "enabled" : true,
    "vnic_networks" : [ "" ],
    "is_avi_internal_network" : true,
    "mac_address" : "aeiou",
    "members" : [ {
      "mac_address" : "aeiou",
      "if_name" : "aeiou",
      "active" : true
    } ],
    "network_ref" : "aeiou",
    "adapter" : "aeiou",
    "pci_id" : "aeiou",
    "network_name" : "aeiou",
    "del_pending" : true,
    "is_mgmt" : true,
    "mtu" : 123,
    "connected" : true,
    "dhcp_enabled" : true,
    "vlan_interfaces" : [ {
      "dhcp_enabled" : true,
      "vlan_id" : 123,
      "if_name" : "aeiou",
      "vrf_ref" : "aeiou",
      "is_mgmt" : true,
      "vnic_networks" : [ {
        "mode" : "aeiou",
        "ip" : {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        },
        "ctlr_alloc" : true
      } ]
    } ],
    "is_portchannel" : true
  } ]
}

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 ServiceEngine

401

log in failed

Up
post /serviceengine/{uuid}/reboot
(serviceengineUuidRebootPost)

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 /serviceengine/{uuid}/reservedvs/
(serviceengineUuidReservedvsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/route/
(serviceengineUuidRouteGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/rteringstat/
(serviceengineUuidRteringstatGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/runtime/detail/
(serviceengineUuidRuntimeDetailGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/runtime/
(serviceengineUuidRuntimeGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/seagent/
(serviceengineUuidSeagentGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/seauthstats/
(serviceengineUuidSeauthstatsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/sehmprobedisable/
(serviceengineUuidSehmprobedisableGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/selogstats/
(serviceengineUuidSelogstatsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/seruminsertionstats/
(serviceengineUuidSeruminsertionstatsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/sevshbstats/
(serviceengineUuidSevshbstatsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/shmallocstats/
(serviceengineUuidShmallocstatsGet)

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
post /serviceengine/{uuid}/switchover
(serviceengineUuidSwitchoverPost)

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 /serviceengine/{uuid}/tcp-flows/detail/
(serviceengineUuidTcpFlowsDetailGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/tcp-flows/
(serviceengineUuidTcpFlowsGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/vnicdb/
(serviceengineUuidVnicdbGet)

Path parameters

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

Consumes

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

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

200

OK String

401

log in failed

Up
get /serviceengine/{uuid}/vshash/
(serviceengineUuidVshashGet)

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. ArpTableFilter
  2. DispatcherTableDumpClear
  3. IpAddr
  4. IpAddrPrefix
  5. MemberInterface
  6. SEFaultInjectExhaustParam
  7. SeResources
  8. ServiceEngine
  9. ServiceEngineApiResponse
  10. vNIC
  11. vNICNetwork
  12. VlanInterface

ArpTableFilter Up

ip_address (optional)
IpAddr IP address.

DispatcherTableDumpClear Up

se_uuid (optional)
String Unique object identifier of se.

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

MemberInterface Up

active (optional)
Boolean Placeholder for description of property active of obj type MemberInterface field type str type boolean
if_name
String if_name of MemberInterface.
mac_address (optional)
String Field introduced in 17.1.5.

SEFaultInjectExhaustParam Up

leak (optional)
Boolean Placeholder for description of property leak of obj type SEFaultInjectExhaustParam field type str type boolean
num
Long Number of num. format: int64

SeResources Up

cores_per_socket (optional)
Integer Number of cores_per_socket. format: int32
disk
Integer Number of disk. format: int32
hyper_threading (optional)
Boolean Placeholder for description of property hyper_threading of obj type SeResources field type str type boolean
memory
Integer Number of memory. format: int32
num_vcpus
Integer Number of num_vcpus. format: int32
sockets (optional)
Integer Number of sockets. format: int32

ServiceEngine Up

availability_zone (optional)
String availability_zone of ServiceEngine.
cloud_ref (optional)
String It is a reference to an object of type Cloud.
container_mode (optional)
Boolean Placeholder for description of property container_mode of obj type ServiceEngine field type str type boolean
container_type (optional)
String Enum options - CONTAINER_TYPE_BRIDGE, CONTAINER_TYPE_HOST, CONTAINER_TYPE_HOST_DPDK.
controller_created (optional)
Boolean Placeholder for description of property controller_created of obj type ServiceEngine field type str type boolean
controller_ip (optional)
String controller_ip of ServiceEngine.
data_vnics (optional)
array[vNIC] Placeholder for description of property data_vnics of obj type ServiceEngine field type str type object
enable_state (optional)
String inorder to disable SE set this field appropriately. Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE.
flavor (optional)
String flavor of ServiceEngine.
host_ref (optional)
String It is a reference to an object of type VIMgrHostRuntime.
hypervisor (optional)
String Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN.
mgmt_vnic (optional)
vNIC Placeholder for description of property mgmt_vnic of obj type ServiceEngine field type str type object
name (optional)
String Name of the object.
resources (optional)
SeResources Placeholder for description of property resources of obj type ServiceEngine field type str type object
se_group_ref (optional)
String It is a reference to an object of type ServiceEngineGroup.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

ServiceEngineApiResponse Up

count
Integer format: int32
results

vNIC Up

adapter (optional)
String adapter of vNIC.
can_se_dp_takeover (optional)
Boolean Placeholder for description of property can_se_dp_takeover of obj type vNIC field type str type boolean
connected (optional)
Boolean Placeholder for description of property connected of obj type vNIC field type str type boolean
del_pending (optional)
Boolean Placeholder for description of property del_pending of obj type vNIC field type str type boolean
dhcp_enabled (optional)
Boolean Placeholder for description of property dhcp_enabled of obj type vNIC field type str type boolean
enabled (optional)
Boolean Placeholder for description of property enabled of obj type vNIC field type str type boolean
if_name (optional)
String if_name of vNIC.
is_asm (optional)
Boolean Placeholder for description of property is_asm of obj type vNIC field type str type boolean
is_avi_internal_network (optional)
Boolean Placeholder for description of property is_avi_internal_network of obj type vNIC field type str type boolean
is_hsm (optional)
Boolean Placeholder for description of property is_hsm of obj type vNIC field type str type boolean
is_mgmt (optional)
Boolean Placeholder for description of property is_mgmt of obj type vNIC field type str type boolean
is_portchannel (optional)
Boolean Placeholder for description of property is_portchannel of obj type vNIC field type str type boolean
linux_name (optional)
String linux_name of vNIC.
mac_address
String mac_address of vNIC.
members (optional)
array[MemberInterface] Placeholder for description of property members of obj type vNIC field type str type object
mtu (optional)
Integer Number of mtu. format: int32
network_name (optional)
String network_name of vNIC.
network_ref (optional)
String It is a reference to an object of type Network.
pci_id (optional)
String pci_id of vNIC.
port_uuid (optional)
String Unique object identifier of port.
vlan_id (optional)
Integer Number of vlan_id. format: int32
vlan_interfaces (optional)
array[VlanInterface] Placeholder for description of property vlan_interfaces of obj type vNIC field type str type object
vnic_networks (optional)
array[vNICNetwork] Placeholder for description of property vnic_networks of obj type vNIC field type str type object
vrf_id (optional)
Integer Number of vrf_id. format: int32
vrf_ref (optional)
String It is a reference to an object of type VrfContext.

vNICNetwork Up

ctlr_alloc (optional)
Boolean Placeholder for description of property ctlr_alloc of obj type vNICNetwork field type str type boolean
ip
IpAddrPrefix Placeholder for description of property ip of obj type vNICNetwork field type str type object
mode
String Enum options - DHCP, STATIC, VIP, DOCKER_HOST.

VlanInterface Up

dhcp_enabled (optional)
Boolean Placeholder for description of property dhcp_enabled of obj type VlanInterface field type str type boolean
if_name
String if_name of VlanInterface.
is_mgmt (optional)
Boolean Placeholder for description of property is_mgmt of obj type VlanInterface field type str type boolean
vlan_id (optional)
Integer Number of vlan_id. format: int32
vnic_networks (optional)
array[vNICNetwork] Placeholder for description of property vnic_networks of obj type VlanInterface field type str type object
vrf_ref (optional)
String It is a reference to an object of type VrfContext.