Avi PoolInventory Object API

CLI ``` - show poolinventory ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /poolinventory
  2. post /poolinventory
  3. delete /poolinventory/{uuid}
  4. get /poolinventory/{uuid}
  5. patch /poolinventory/{uuid}
  6. put /poolinventory/{uuid}
Up 
get /poolinventory
(poolinventoryGet)

Consumes

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

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

PoolInventoryApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "app_profile_type" : "aeiou",
    "alert" : {
      "level" : "aeiou"
    },
    "virtualservices" : [ {
      "ref" : "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" : {
      "num_servers_enabled" : 123456789,
      "percent_servers_up_total" : 123,
      "num_servers" : 123456789,
      "num_servers_up" : 123456789,
      "oper_status" : {
        "reason_code" : 123456789,
        "reason" : [ "aeiou" ],
        "last_changed_time" : {
          "usecs" : 123456789,
          "secs" : 123456789
        },
        "state" : "aeiou",
        "reason_code_string" : "aeiou"
      },
      "percent_servers_up_enabled" : 123
    },
    "metrics" : {
      "headers" : {
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      },
      "data" : {
        "value" : 1.3579000000000001069366817318950779736042022705078125
      }
    },
    "config" : {
      "gslb_sp_enabled" : true,
      "ref" : "aeiou",
      "default_server_port" : 123,
      "cloud_ref" : "aeiou",
      "tenant_ref" : "aeiou",
      "name" : "aeiou",
      "vrf_ref" : "aeiou",
      "created_by" : "aeiou",
      "enabled" : true,
      "url" : "aeiou"
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "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 PoolInventoryApiResponse

401

log in failed
Up 
post /poolinventory
(poolinventoryPost)

Consumes

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

Request body

body (required)
Body Parameter — PoolInventory object creation

Return type

PoolInventory

Example data

Content-Type: application/json
{
  "app_profile_type" : "aeiou",
  "alert" : {
    "level" : "aeiou"
  },
  "virtualservices" : [ {
    "ref" : "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" : {
    "num_servers_enabled" : 123456789,
    "percent_servers_up_total" : 123,
    "num_servers" : 123456789,
    "num_servers_up" : 123456789,
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "percent_servers_up_enabled" : 123
  },
  "metrics" : {
    "headers" : {
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    },
    "data" : {
      "value" : 1.3579000000000001069366817318950779736042022705078125
    }
  },
  "config" : {
    "gslb_sp_enabled" : true,
    "ref" : "aeiou",
    "default_server_port" : 123,
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vrf_ref" : "aeiou",
    "created_by" : "aeiou",
    "enabled" : true,
    "url" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 PoolInventory

401

log in failed
Up 
delete /poolinventory/{uuid}
(poolinventoryUuidDelete)

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 /poolinventory/{uuid}
(poolinventoryUuidGet)

Path parameters

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

Consumes

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

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

PoolInventory

Example data

Content-Type: application/json
{
  "app_profile_type" : "aeiou",
  "alert" : {
    "level" : "aeiou"
  },
  "virtualservices" : [ {
    "ref" : "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" : {
    "num_servers_enabled" : 123456789,
    "percent_servers_up_total" : 123,
    "num_servers" : 123456789,
    "num_servers_up" : 123456789,
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "percent_servers_up_enabled" : 123
  },
  "metrics" : {
    "headers" : {
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    },
    "data" : {
      "value" : 1.3579000000000001069366817318950779736042022705078125
    }
  },
  "config" : {
    "gslb_sp_enabled" : true,
    "ref" : "aeiou",
    "default_server_port" : 123,
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vrf_ref" : "aeiou",
    "created_by" : "aeiou",
    "enabled" : true,
    "url" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 PoolInventory

401

log in failed
Up 
patch /poolinventory/{uuid}
(poolinventoryUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

PoolInventory

Example data

Content-Type: application/json
{
  "app_profile_type" : "aeiou",
  "alert" : {
    "level" : "aeiou"
  },
  "virtualservices" : [ {
    "ref" : "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" : {
    "num_servers_enabled" : 123456789,
    "percent_servers_up_total" : 123,
    "num_servers" : 123456789,
    "num_servers_up" : 123456789,
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "percent_servers_up_enabled" : 123
  },
  "metrics" : {
    "headers" : {
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    },
    "data" : {
      "value" : 1.3579000000000001069366817318950779736042022705078125
    }
  },
  "config" : {
    "gslb_sp_enabled" : true,
    "ref" : "aeiou",
    "default_server_port" : 123,
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vrf_ref" : "aeiou",
    "created_by" : "aeiou",
    "enabled" : true,
    "url" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 PoolInventory

401

log in failed
Up 
put /poolinventory/{uuid}
(poolinventoryUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

PoolInventory

Example data

Content-Type: application/json
{
  "app_profile_type" : "aeiou",
  "alert" : {
    "level" : "aeiou"
  },
  "virtualservices" : [ {
    "ref" : "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" : {
    "num_servers_enabled" : 123456789,
    "percent_servers_up_total" : 123,
    "num_servers" : 123456789,
    "num_servers_up" : 123456789,
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "percent_servers_up_enabled" : 123
  },
  "metrics" : {
    "headers" : {
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    },
    "data" : {
      "value" : 1.3579000000000001069366817318950779736042022705078125
    }
  },
  "config" : {
    "gslb_sp_enabled" : true,
    "ref" : "aeiou",
    "default_server_port" : 123,
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vrf_ref" : "aeiou",
    "created_by" : "aeiou",
    "enabled" : true,
    "url" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 PoolInventory

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. AlertSummary
  2. ApplicationPerformanceScoreData
  3. HealthScoreEntity
  4. HealthScorePerformanceData
  5. HealthScoreSummary
  6. InventoryMetricStatistics
  7. InventoryMetrics
  8. InventoryMetricsData
  9. InventoryMetricsHeaders
  10. OperationalStatus
  11. PoolConfig
  12. PoolConfigApiResponse
  13. PoolInventory
  14. PoolInventoryApiResponse
  15. PoolPerformanceScore
  16. PoolPerformanceScoreData
  17. PoolRuntimeSummary
  18. ServerPerformanceScoreData
  19. ServiceEnginePerformanceScoreData
  20. TimeStamp
  21. VirtualServicePerformanceScore
  22. VirtualServicePerformanceScoreData
  23. VsRefs

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

InventoryMetricStatistics Up

max (optional)
Double Maximum value in time series requested. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
mean (optional)
Double Arithmetic mean. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
min (optional)
Double Minimum value in time series requested. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
num_samples (optional)
Integer Number of actual data samples. It excludes fake data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

InventoryMetrics Up

data (optional)
InventoryMetricsData Metric data. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
headers (optional)
InventoryMetricsHeaders Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

InventoryMetricsData Up

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

InventoryMetricsHeaders Up

statistics (optional)
InventoryMetricStatistics 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.

PoolConfig Up

cloud_ref (optional)
String It is a reference to an object of type Cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
created_by (optional)
String Creator name. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
default_server_port (optional)
Integer Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The SSL checkbox enables Avi to server encryption. Allowed values are 1-65535. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
enabled (optional)
Boolean Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
gslb_sp_enabled (optional)
Boolean Indicates if the pool is a site-persistence pool. . Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name (optional)
String Name of the pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ref (optional)
String UUID of the pool. It is a reference to an object of type Pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
String URL of the pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vrf_ref (optional)
String Virtual Routing Context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the Virtual Routing Conext of the Virtual Service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type VrfContext. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

PoolConfigApiResponse Up

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

PoolInventory Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
alert (optional)
AlertSummary Alert summary of the pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
app_profile_type (optional)
String Application type of the VS. Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
config (optional)
PoolConfig Configuration summary of the pool. 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 pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
metrics (optional)
InventoryMetrics Metrics summary of the pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
runtime (optional)
PoolRuntimeSummary Runtime summary of the pool. 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 pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
virtualservices (optional)
array[VsRefs] Virtual services the pool is assigned to. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

PoolInventoryApiResponse Up

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

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)
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.
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

PoolRuntimeSummary Up

num_servers
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
num_servers_enabled
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
num_servers_up
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
oper_status
OperationalStatus Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
percent_servers_up_enabled (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
percent_servers_up_total (optional)
Integer 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)
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.
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

ServiceEnginePerformanceScoreData Up

oper_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.
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.

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
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.
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

VsRefs Up

ref (optional)
String UUID of the Virtual Service. It is a reference to an object of type VirtualService. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.