Avi ServiceEngineInventory Object API

CLI ``` - show serviceengineinventory ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 22.1.6

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /serviceengine-inventory
post /serviceengine-inventory
delete /serviceengine-inventory/{uuid}
get /serviceengine-inventory/{uuid}
patch /serviceengine-inventory/{uuid}
put /serviceengine-inventory/{uuid}

get /serviceengine-inventory

(serviceengineInventoryGet)

Consumes

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

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ServiceEngineInventoryApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "alert" : {
      "level" : "aeiou"
    },
    "health_score" : {
      "anomaly_penalty" : 123,
      "performance_score" : {
        "reason" : "aeiou",
        "application_performance" : {
          "virtualservice_performance_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : {
              "pool_ref" : "aeiou",
              "server" : "aeiou",
              "entity_uuid" : "aeiou",
              "metrics_entity" : "aeiou"
            },
            "score_data" : {
              "reason" : "aeiou",
              "ref" : "aeiou",
              "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
              "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
              "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
              "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
              "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
              "pool_performance_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                  "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                  "oper_state" : "aeiou"
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason_attr" : "aeiou",
              "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
              "oper_state" : "aeiou"
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou"
        },
        "serviceengine_performance" : {
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "oper_state" : "aeiou"
        },
        "virtualservice_performance" : "",
        "pool_performance" : "",
        "server_performance" : {
          "reason" : "aeiou",
          "server" : "aeiou",
          "ref" : "aeiou",
          "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
          "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
          "reason_attr" : "aeiou",
          "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
          "oper_state" : "aeiou",
          "pool_uuid" : "aeiou"
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "health_score" : 1.3579000000000001069366817318950779736042022705078125,
      "security_penalty" : 123,
      "resources_penalty" : 123
    },
    "runtime" : {
      "vsphere_ha_inprogress" : true,
      "vsphere_ha_enabled" : true,
      "inband_mgmt" : true,
      "active_tags" : [ "aeiou" ],
      "bgp_peers_up" : true,
      "licensed_service_cores" : 1.3579000000000001069366817318950779736042022705078125,
      "hb_status" : {
        "last_hb_req_sent" : "aeiou",
        "num_hb_misses" : 123,
        "num_outstanding_hb" : 123,
        "last_hb_resp_recv" : "aeiou"
      },
      "license_state" : "aeiou",
      "migrate_state" : "aeiou",
      "oper_status" : {
        "reason_code" : 123456789,
        "reason" : [ "aeiou" ],
        "last_changed_time" : {
          "usecs" : 123456789,
          "secs" : 123456789
        },
        "state" : "aeiou",
        "reason_code_string" : "aeiou"
      },
      "power_state" : "aeiou",
      "version" : "aeiou",
      "gateway_up" : true,
      "vsphere_ha_job_active" : true,
      "vinfra_discovered" : true,
      "sufficient_memory" : true,
      "se_grp_reboot_pending" : true,
      "se_connected" : true,
      "at_curr_ver" : true,
      "online_since" : "aeiou"
    },
    "config" : {
      "vs_per_se_refs" : [ "aeiou" ],
      "mgmt_ip6_address" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "host_ref" : "aeiou",
      "cloud_ref" : "aeiou",
      "tenant_ref" : "aeiou",
      "name" : "aeiou",
      "enable_state" : "aeiou",
      "mgmt_ip_address" : "",
      "uuid" : "aeiou",
      "url" : "aeiou",
      "vs_refs" : [ "aeiou" ],
      "se_group_ref" : "aeiou"
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou"
  } ]
}

Produces

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

application/json

Responses

200

OK ServiceEngineInventoryApiResponse

401

post /serviceengine-inventory

(serviceengineInventoryPost)

Consumes

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

application/json

Request body

body (required)

Body Parameter — ServiceEngineInventory object creation

Return type

ServiceEngineInventory

Example data

Content-Type: application/json

{
  "alert" : {
    "level" : "aeiou"
  },
  "health_score" : {
    "anomaly_penalty" : 123,
    "performance_score" : {
      "reason" : "aeiou",
      "application_performance" : {
        "virtualservice_performance_scores" : [ {
          "reason" : "aeiou",
          "hs_entity" : {
            "pool_ref" : "aeiou",
            "server" : "aeiou",
            "entity_uuid" : "aeiou",
            "metrics_entity" : "aeiou"
          },
          "score_data" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
            "pool_performance_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pool_ref" : "aeiou",
                "reason" : "aeiou",
                "ref" : "aeiou",
                "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                "oper_state" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason_attr" : "aeiou",
            "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
            "oper_state" : "aeiou"
          },
          "value" : 1.3579000000000001069366817318950779736042022705078125
        } ],
        "reason" : "aeiou",
        "ref" : "aeiou",
        "reason_attr" : "aeiou"
      },
      "serviceengine_performance" : {
        "reason" : "aeiou",
        "ref" : "aeiou",
        "reason_attr" : "aeiou",
        "oper_state" : "aeiou"
      },
      "virtualservice_performance" : "",
      "pool_performance" : "",
      "server_performance" : {
        "reason" : "aeiou",
        "server" : "aeiou",
        "ref" : "aeiou",
        "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
        "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
        "reason_attr" : "aeiou",
        "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
        "oper_state" : "aeiou",
        "pool_uuid" : "aeiou"
      },
      "reason_attr" : "aeiou",
      "value" : 1.3579000000000001069366817318950779736042022705078125
    },
    "health_score" : 1.3579000000000001069366817318950779736042022705078125,
    "security_penalty" : 123,
    "resources_penalty" : 123
  },
  "runtime" : {
    "vsphere_ha_inprogress" : true,
    "vsphere_ha_enabled" : true,
    "inband_mgmt" : true,
    "active_tags" : [ "aeiou" ],
    "bgp_peers_up" : true,
    "licensed_service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "hb_status" : {
      "last_hb_req_sent" : "aeiou",
      "num_hb_misses" : 123,
      "num_outstanding_hb" : 123,
      "last_hb_resp_recv" : "aeiou"
    },
    "license_state" : "aeiou",
    "migrate_state" : "aeiou",
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "power_state" : "aeiou",
    "version" : "aeiou",
    "gateway_up" : true,
    "vsphere_ha_job_active" : true,
    "vinfra_discovered" : true,
    "sufficient_memory" : true,
    "se_grp_reboot_pending" : true,
    "se_connected" : true,
    "at_curr_ver" : true,
    "online_since" : "aeiou"
  },
  "config" : {
    "vs_per_se_refs" : [ "aeiou" ],
    "mgmt_ip6_address" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "host_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "enable_state" : "aeiou",
    "mgmt_ip_address" : "",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "vs_refs" : [ "aeiou" ],
    "se_group_ref" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK ServiceEngineInventory

401

delete /serviceengine-inventory/{uuid}

(serviceengineInventoryUuidDelete)

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:

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /serviceengine-inventory/{uuid}

(serviceengineInventoryUuidGet)

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:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ServiceEngineInventory

Example data

Content-Type: application/json

{
  "alert" : {
    "level" : "aeiou"
  },
  "health_score" : {
    "anomaly_penalty" : 123,
    "performance_score" : {
      "reason" : "aeiou",
      "application_performance" : {
        "virtualservice_performance_scores" : [ {
          "reason" : "aeiou",
          "hs_entity" : {
            "pool_ref" : "aeiou",
            "server" : "aeiou",
            "entity_uuid" : "aeiou",
            "metrics_entity" : "aeiou"
          },
          "score_data" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
            "pool_performance_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pool_ref" : "aeiou",
                "reason" : "aeiou",
                "ref" : "aeiou",
                "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                "oper_state" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason_attr" : "aeiou",
            "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
            "oper_state" : "aeiou"
          },
          "value" : 1.3579000000000001069366817318950779736042022705078125
        } ],
        "reason" : "aeiou",
        "ref" : "aeiou",
        "reason_attr" : "aeiou"
      },
      "serviceengine_performance" : {
        "reason" : "aeiou",
        "ref" : "aeiou",
        "reason_attr" : "aeiou",
        "oper_state" : "aeiou"
      },
      "virtualservice_performance" : "",
      "pool_performance" : "",
      "server_performance" : {
        "reason" : "aeiou",
        "server" : "aeiou",
        "ref" : "aeiou",
        "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
        "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
        "reason_attr" : "aeiou",
        "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
        "oper_state" : "aeiou",
        "pool_uuid" : "aeiou"
      },
      "reason_attr" : "aeiou",
      "value" : 1.3579000000000001069366817318950779736042022705078125
    },
    "health_score" : 1.3579000000000001069366817318950779736042022705078125,
    "security_penalty" : 123,
    "resources_penalty" : 123
  },
  "runtime" : {
    "vsphere_ha_inprogress" : true,
    "vsphere_ha_enabled" : true,
    "inband_mgmt" : true,
    "active_tags" : [ "aeiou" ],
    "bgp_peers_up" : true,
    "licensed_service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "hb_status" : {
      "last_hb_req_sent" : "aeiou",
      "num_hb_misses" : 123,
      "num_outstanding_hb" : 123,
      "last_hb_resp_recv" : "aeiou"
    },
    "license_state" : "aeiou",
    "migrate_state" : "aeiou",
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "power_state" : "aeiou",
    "version" : "aeiou",
    "gateway_up" : true,
    "vsphere_ha_job_active" : true,
    "vinfra_discovered" : true,
    "sufficient_memory" : true,
    "se_grp_reboot_pending" : true,
    "se_connected" : true,
    "at_curr_ver" : true,
    "online_since" : "aeiou"
  },
  "config" : {
    "vs_per_se_refs" : [ "aeiou" ],
    "mgmt_ip6_address" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "host_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "enable_state" : "aeiou",
    "mgmt_ip_address" : "",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "vs_refs" : [ "aeiou" ],
    "se_group_ref" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK ServiceEngineInventory

401

patch /serviceengine-inventory/{uuid}

(serviceengineInventoryUuidPatch)

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:

application/json

Request body

body (required)

Body Parameter — ServiceEngineInventory object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

ServiceEngineInventory

Example data

Content-Type: application/json

{
  "alert" : {
    "level" : "aeiou"
  },
  "health_score" : {
    "anomaly_penalty" : 123,
    "performance_score" : {
      "reason" : "aeiou",
      "application_performance" : {
        "virtualservice_performance_scores" : [ {
          "reason" : "aeiou",
          "hs_entity" : {
            "pool_ref" : "aeiou",
            "server" : "aeiou",
            "entity_uuid" : "aeiou",
            "metrics_entity" : "aeiou"
          },
          "score_data" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
            "pool_performance_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pool_ref" : "aeiou",
                "reason" : "aeiou",
                "ref" : "aeiou",
                "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                "oper_state" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason_attr" : "aeiou",
            "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
            "oper_state" : "aeiou"
          },
          "value" : 1.3579000000000001069366817318950779736042022705078125
        } ],
        "reason" : "aeiou",
        "ref" : "aeiou",
        "reason_attr" : "aeiou"
      },
      "serviceengine_performance" : {
        "reason" : "aeiou",
        "ref" : "aeiou",
        "reason_attr" : "aeiou",
        "oper_state" : "aeiou"
      },
      "virtualservice_performance" : "",
      "pool_performance" : "",
      "server_performance" : {
        "reason" : "aeiou",
        "server" : "aeiou",
        "ref" : "aeiou",
        "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
        "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
        "reason_attr" : "aeiou",
        "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
        "oper_state" : "aeiou",
        "pool_uuid" : "aeiou"
      },
      "reason_attr" : "aeiou",
      "value" : 1.3579000000000001069366817318950779736042022705078125
    },
    "health_score" : 1.3579000000000001069366817318950779736042022705078125,
    "security_penalty" : 123,
    "resources_penalty" : 123
  },
  "runtime" : {
    "vsphere_ha_inprogress" : true,
    "vsphere_ha_enabled" : true,
    "inband_mgmt" : true,
    "active_tags" : [ "aeiou" ],
    "bgp_peers_up" : true,
    "licensed_service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "hb_status" : {
      "last_hb_req_sent" : "aeiou",
      "num_hb_misses" : 123,
      "num_outstanding_hb" : 123,
      "last_hb_resp_recv" : "aeiou"
    },
    "license_state" : "aeiou",
    "migrate_state" : "aeiou",
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "power_state" : "aeiou",
    "version" : "aeiou",
    "gateway_up" : true,
    "vsphere_ha_job_active" : true,
    "vinfra_discovered" : true,
    "sufficient_memory" : true,
    "se_grp_reboot_pending" : true,
    "se_connected" : true,
    "at_curr_ver" : true,
    "online_since" : "aeiou"
  },
  "config" : {
    "vs_per_se_refs" : [ "aeiou" ],
    "mgmt_ip6_address" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "host_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "enable_state" : "aeiou",
    "mgmt_ip_address" : "",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "vs_refs" : [ "aeiou" ],
    "se_group_ref" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK ServiceEngineInventory

401

put /serviceengine-inventory/{uuid}

(serviceengineInventoryUuidPut)

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:

application/json

Request body

body (required)

Body Parameter — ServiceEngineInventory object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

ServiceEngineInventory

Example data

Content-Type: application/json

{
  "alert" : {
    "level" : "aeiou"
  },
  "health_score" : {
    "anomaly_penalty" : 123,
    "performance_score" : {
      "reason" : "aeiou",
      "application_performance" : {
        "virtualservice_performance_scores" : [ {
          "reason" : "aeiou",
          "hs_entity" : {
            "pool_ref" : "aeiou",
            "server" : "aeiou",
            "entity_uuid" : "aeiou",
            "metrics_entity" : "aeiou"
          },
          "score_data" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
            "pool_performance_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pool_ref" : "aeiou",
                "reason" : "aeiou",
                "ref" : "aeiou",
                "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                "oper_state" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason_attr" : "aeiou",
            "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
            "oper_state" : "aeiou"
          },
          "value" : 1.3579000000000001069366817318950779736042022705078125
        } ],
        "reason" : "aeiou",
        "ref" : "aeiou",
        "reason_attr" : "aeiou"
      },
      "serviceengine_performance" : {
        "reason" : "aeiou",
        "ref" : "aeiou",
        "reason_attr" : "aeiou",
        "oper_state" : "aeiou"
      },
      "virtualservice_performance" : "",
      "pool_performance" : "",
      "server_performance" : {
        "reason" : "aeiou",
        "server" : "aeiou",
        "ref" : "aeiou",
        "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
        "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
        "reason_attr" : "aeiou",
        "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
        "oper_state" : "aeiou",
        "pool_uuid" : "aeiou"
      },
      "reason_attr" : "aeiou",
      "value" : 1.3579000000000001069366817318950779736042022705078125
    },
    "health_score" : 1.3579000000000001069366817318950779736042022705078125,
    "security_penalty" : 123,
    "resources_penalty" : 123
  },
  "runtime" : {
    "vsphere_ha_inprogress" : true,
    "vsphere_ha_enabled" : true,
    "inband_mgmt" : true,
    "active_tags" : [ "aeiou" ],
    "bgp_peers_up" : true,
    "licensed_service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "hb_status" : {
      "last_hb_req_sent" : "aeiou",
      "num_hb_misses" : 123,
      "num_outstanding_hb" : 123,
      "last_hb_resp_recv" : "aeiou"
    },
    "license_state" : "aeiou",
    "migrate_state" : "aeiou",
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "power_state" : "aeiou",
    "version" : "aeiou",
    "gateway_up" : true,
    "vsphere_ha_job_active" : true,
    "vinfra_discovered" : true,
    "sufficient_memory" : true,
    "se_grp_reboot_pending" : true,
    "se_connected" : true,
    "at_curr_ver" : true,
    "online_since" : "aeiou"
  },
  "config" : {
    "vs_per_se_refs" : [ "aeiou" ],
    "mgmt_ip6_address" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "host_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "enable_state" : "aeiou",
    "mgmt_ip_address" : "",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "vs_refs" : [ "aeiou" ],
    "se_group_ref" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK ServiceEngineInventory

401

Models

[ Jump to Methods ]

AlertSummary
ApplicationPerformanceScoreData
HealthScoreEntity
HealthScorePerformanceData
HealthScoreSummary
IpAddr
OperationalStatus
PoolPerformanceScore
PoolPerformanceScoreData
SeHbStatus
ServerPerformanceScoreData
ServiceEngineConfig
ServiceEngineConfigApiResponse
ServiceEngineInventory
ServiceEngineInventoryApiResponse
ServiceEnginePerformanceScoreData
ServiceEngineRuntimeSummary
TimeStamp
VirtualServicePerformanceScore
VirtualServicePerformanceScoreData

AlertSummary Up

level (optional)

String Resolved Alert Type. Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ApplicationPerformanceScoreData Up

reason

String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason_attr (optional)

String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ref (optional)

String It is a reference to an object of type Application. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

virtualservice_performance_scores (optional)

array[VirtualServicePerformanceScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HealthScoreEntity Up

entity_uuid

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

metrics_entity

String Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

pool_ref (optional)

String It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

server (optional)

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

HealthScorePerformanceData Up

application_performance (optional)

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

pool_performance (optional)

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

reason

String Reason for Performance Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason_attr (optional)

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

server_performance (optional)

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

serviceengine_performance (optional)

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

value

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

virtualservice_performance (optional)

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

HealthScoreSummary Up

anomaly_penalty (optional)

Integer Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

health_score (optional)

Double Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: double

performance_score (optional)

HealthScorePerformanceData Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

resources_penalty (optional)

Integer Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

security_penalty (optional)

Integer Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

IpAddr Up

addr

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

type

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

OperationalStatus Up

last_changed_time (optional)

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

reason (optional)

array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason_code (optional)

Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

reason_code_string (optional)

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

state (optional)

String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL, OPER_AGGREGATE_DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PoolPerformanceScore Up

hs_entity

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

reason

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

score_data (optional)

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

value

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

PoolPerformanceScoreData Up

apdexc (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

apdexr (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

oper_state (optional)

pool_ref

String It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason

String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason_attr (optional)

String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ref (optional)

String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

sum_finished_conns (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

SeHbStatus Up

last_hb_req_sent

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

last_hb_resp_recv

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

num_hb_misses

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

num_outstanding_hb (optional)

Integer Field introduced in 17.2.10,18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

ServerPerformanceScoreData Up

apdexc (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

apdexr (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

oper_state (optional)

pool_uuid

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

reason

String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason_attr (optional)

String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ref (optional)

String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

server

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

sum_finished_conns (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

ServiceEngineConfig Up

cloud_ref (optional)

String It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

host_ref (optional)

String It is a reference to an object of type VIMgrHostRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

mgmt_ip6_address (optional)

IpAddr Management IPv6 Address of the service engine. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

mgmt_ip_address (optional)

IpAddr Management IP Address of the service engine. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

name (optional)

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

se_group_ref (optional)

String It is a reference to an object of type ServiceEngineGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

tenant_ref (optional)

String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

url (optional)

String URL of the Service Engine. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

uuid (optional)

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

vs_per_se_refs (optional)

array[String] Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

vs_refs (optional)

array[String] Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ServiceEngineConfigApiResponse Up

count

Integer format: int32

results

array[ServiceEngineConfig]

next (optional)

String

ServiceEngineInventory Up

_last_modified (optional)

String UNIX time since epoch in microseconds. Units(MICROSECONDS).

alert (optional)

AlertSummary Alert summary of the service engine. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

config (optional)

ServiceEngineConfig Configuration summary of the service engine. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

health_score (optional)

HealthScoreSummary Health score summary of the service engine. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

runtime (optional)

ServiceEngineRuntimeSummary Runtime summary of the service engine. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

url (optional)

String url

uuid (optional)

String UUID of the service engine. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ServiceEngineInventoryApiResponse Up

count

Integer format: int32

results

array[ServiceEngineInventory]

next (optional)

String

ServiceEnginePerformanceScoreData Up

oper_state (optional)

reason

String Reason for the Health Performance Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason_attr (optional)

String Attribute that is dominating the performance score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ref (optional)

String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ServiceEngineRuntimeSummary Up

active_tags (optional)

array[String] Enum options - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

at_curr_ver (optional)

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

bgp_peers_up (optional)

Boolean Indicates if at least 1 BGP peer with advertise_vip is UP and at least 1 BGP peer with advertise_snat_ip is UP if there are such peers configured. Flag will be set to false if the condition above is not true for any of the VRFs configured on the SE. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

gateway_up (optional)

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

hb_status (optional)

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

inband_mgmt (optional)

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

license_state (optional)

String Indicates the License state of the SE. Enum options - LICENSE_STATE_INSUFFICIENT_RESOURCES, LICENSE_STATE_LICENSED, LICENSE_STATE_AWAITING_RESPONSE, LICENSE_STATE_UNDETERMINED. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

licensed_service_cores (optional)

Double Number of Service Cores assigned to the SE by License Manager. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

migrate_state (optional)

String This state is used to indicate the current state of disable SE process. Enum options - SE_MIGRATE_STATE_IDLE, SE_MIGRATE_STATE_STARTED, SE_MIGRATE_STATE_FINISHED_WITH_FAILURE, SE_MIGRATE_STATE_FINISHED. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

online_since (optional)

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

oper_status (optional)

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

power_state (optional)

String Enum options - SE_POWER_OFF, SE_POWER_ON, SE_SUSPENDED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

se_connected (optional)

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

se_grp_reboot_pending (optional)

Boolean Indicates SE reboot following SE group change is pending. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

sufficient_memory (optional)

Boolean Field introduced in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

version (optional)

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

vinfra_discovered (optional)

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

vsphere_ha_enabled (optional)

Boolean vSphere HA on cluster enabled. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

vsphere_ha_inprogress (optional)

Boolean This flag is set to true when Cloud Connector has detected an ESX host failure. This flag is set to false when the SE connects back to the controller, or when vSphere HA recovery timeout has occurred. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

vsphere_ha_job_active (optional)

Boolean vSphere HA monitor job has been created or is running. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

TimeStamp Up

secs

Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

usecs

Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

VirtualServicePerformanceScore Up

hs_entity

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

reason

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

score_data (optional)

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

value

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

VirtualServicePerformanceScoreData Up

apdexc (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

apdexr (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

avg_pool_performance_score (optional)

Double Average of all pool performance scores. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

oper_state

pool_performance_scores (optional)

array[PoolPerformanceScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason

String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason_attr (optional)

String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ref (optional)

String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

rum_apdexr (optional)

Double Rum Apdexr when client insights is active. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

sum_finished_conns (optional)

Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

vs_uptime (optional)

Double Percentage time of last 5mins that the VirtualService has been up. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

Avi ServiceEngineInventory Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents