Avi VsInventory Object API

CLI ``` - show vsinventory ```

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

Contact Info: support@avinetworks.com

Version: 22.1.5

BasePath:/api

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

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /vsinventory
post /vsinventory
delete /vsinventory/{uuid}
get /vsinventory/{uuid}
patch /vsinventory/{uuid}
put /vsinventory/{uuid}

get /vsinventory

(vsinventoryGet)

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

VsInventoryApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "app_profile_type" : "aeiou",
    "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
    },
    "has_pool_with_realtime_metrics" : true,
    "pools" : [ {
      "ref" : "aeiou"
    } ],
    "runtime" : {
      "percent_ses_up" : 123,
      "vip_summary" : {
        "service_engine" : [ {
          "mgmt_ip6" : "",
          "standby" : true,
          "mgmt_ip" : "",
          "scalein_in_progress" : true,
          "se_ready_in_progress" : true,
          "admin_down_requested" : true,
          "oper_status" : "",
          "connected" : true,
          "active_on_cloud" : true,
          "ref" : "aeiou",
          "snat_ip" : "",
          "attach_ip_in_progress" : true,
          "name" : "aeiou",
          "scaleout_in_progress" : true,
          "detach_ip_in_progress" : true,
          "active_on_se" : true,
          "primary" : true
        } ],
        "num_se_assigned" : 123,
        "placement_networks" : [ "" ],
        "avi_allocated_vip" : true,
        "vip_id" : "aeiou",
        "ip_address" : "",
        "auto_allocate_floating_ip" : true,
        "oper_status" : "",
        "enabled" : true,
        "auto_allocate_ip_type" : "aeiou",
        "percent_ses_up" : 123,
        "num_se_requested" : 123,
        "auto_allocate_ip" : true,
        "avi_allocated_fip" : true,
        "prefix_length" : 123,
        "discovered_networks" : [ "" ]
      },
      "oper_status" : {
        "reason_code" : 123456789,
        "reason" : [ "aeiou" ],
        "last_changed_time" : {
          "usecs" : 123456789,
          "secs" : 123456789
        },
        "state" : "aeiou",
        "reason_code_string" : "aeiou"
      }
    },
    "metrics" : {
      "headers" : {
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      },
      "data" : {
        "value" : 1.3579000000000001069366817318950779736042022705078125
      }
    },
    "config" : {
      "vsvip_ref" : "aeiou",
      "fqdn" : "aeiou",
      "vrf_context_ref" : "aeiou",
      "dns_info" : [ {
        "metadata" : "aeiou",
        "fqdn" : "aeiou",
        "num_records_in_response" : 123,
        "cname" : {
          "cname" : "aeiou"
        },
        "type" : "aeiou",
        "ttl" : 123,
        "algorithm" : "aeiou"
      } ],
      "services" : [ {
        "override_network_profile_ref" : "aeiou",
        "port" : 123,
        "port_range_end" : 123,
        "is_active_ftp_data_port" : true,
        "enable_http2" : true,
        "horizon_internal_ports" : true,
        "enable_ssl" : true,
        "override_application_profile_ref" : "aeiou"
      } ],
      "type" : "aeiou",
      "uuid" : "aeiou",
      "enabled" : true,
      "url" : "aeiou",
      "se_group_ref" : "aeiou",
      "vh_domain_name" : [ "aeiou" ],
      "pool_ref" : "aeiou",
      "cloud_ref" : "aeiou",
      "tenant_ref" : "aeiou",
      "name" : "aeiou",
      "vip" : [ {
        "availability_zone" : "aeiou",
        "ip6_address" : "",
        "subnet" : "",
        "port_uuid" : "aeiou",
        "subnet_uuid" : "aeiou",
        "placement_networks" : [ {
          "subnet" : "",
          "subnet6" : "",
          "network_ref" : "aeiou"
        } ],
        "avi_allocated_vip" : true,
        "vip_id" : "aeiou",
        "ip_address" : "",
        "auto_allocate_floating_ip" : true,
        "enabled" : true,
        "auto_allocate_ip_type" : "aeiou",
        "floating_subnet6_uuid" : "aeiou",
        "auto_allocate_ip" : true,
        "subnet6" : "",
        "floating_ip" : "",
        "floating_subnet_uuid" : "aeiou",
        "avi_allocated_fip" : true,
        "subnet6_uuid" : "aeiou",
        "floating_ip6" : "",
        "ipam_network_subnet" : {
          "subnet" : "",
          "subnet_uuid" : "aeiou",
          "subnet6" : "",
          "subnet6_uuid" : "aeiou",
          "network_ref" : "aeiou"
        },
        "network_ref" : "aeiou",
        "prefix_length" : 123,
        "discovered_networks" : [ {
          "subnet" : [ {
            "ip_addr" : {
              "addr" : "aeiou",
              "type" : "aeiou"
            },
            "mask" : 123
          } ],
          "subnet6" : [ "" ],
          "network_ref" : "aeiou"
        } ]
      } ],
      "east_west_placement" : true
    },
    "uuid" : "aeiou",
    "poolgroups" : [ {
      "ref" : "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 VsInventoryApiResponse

401

post /vsinventory

(vsinventoryPost)

Consumes

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

application/json

Request body

body (required)

Body Parameter — VsInventory object creation

Return type

VsInventory

Example data

Content-Type: application/json

{
  "app_profile_type" : "aeiou",
  "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
  },
  "has_pool_with_realtime_metrics" : true,
  "pools" : [ {
    "ref" : "aeiou"
  } ],
  "runtime" : {
    "percent_ses_up" : 123,
    "vip_summary" : {
      "service_engine" : [ {
        "mgmt_ip6" : "",
        "standby" : true,
        "mgmt_ip" : "",
        "scalein_in_progress" : true,
        "se_ready_in_progress" : true,
        "admin_down_requested" : true,
        "oper_status" : "",
        "connected" : true,
        "active_on_cloud" : true,
        "ref" : "aeiou",
        "snat_ip" : "",
        "attach_ip_in_progress" : true,
        "name" : "aeiou",
        "scaleout_in_progress" : true,
        "detach_ip_in_progress" : true,
        "active_on_se" : true,
        "primary" : true
      } ],
      "num_se_assigned" : 123,
      "placement_networks" : [ "" ],
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "oper_status" : "",
      "enabled" : true,
      "auto_allocate_ip_type" : "aeiou",
      "percent_ses_up" : 123,
      "num_se_requested" : 123,
      "auto_allocate_ip" : true,
      "avi_allocated_fip" : true,
      "prefix_length" : 123,
      "discovered_networks" : [ "" ]
    },
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    }
  },
  "metrics" : {
    "headers" : {
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    },
    "data" : {
      "value" : 1.3579000000000001069366817318950779736042022705078125
    }
  },
  "config" : {
    "vsvip_ref" : "aeiou",
    "fqdn" : "aeiou",
    "vrf_context_ref" : "aeiou",
    "dns_info" : [ {
      "metadata" : "aeiou",
      "fqdn" : "aeiou",
      "num_records_in_response" : 123,
      "cname" : {
        "cname" : "aeiou"
      },
      "type" : "aeiou",
      "ttl" : 123,
      "algorithm" : "aeiou"
    } ],
    "services" : [ {
      "override_network_profile_ref" : "aeiou",
      "port" : 123,
      "port_range_end" : 123,
      "is_active_ftp_data_port" : true,
      "enable_http2" : true,
      "horizon_internal_ports" : true,
      "enable_ssl" : true,
      "override_application_profile_ref" : "aeiou"
    } ],
    "type" : "aeiou",
    "uuid" : "aeiou",
    "enabled" : true,
    "url" : "aeiou",
    "se_group_ref" : "aeiou",
    "vh_domain_name" : [ "aeiou" ],
    "pool_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vip" : [ {
      "availability_zone" : "aeiou",
      "ip6_address" : "",
      "subnet" : "",
      "port_uuid" : "aeiou",
      "subnet_uuid" : "aeiou",
      "placement_networks" : [ {
        "subnet" : "",
        "subnet6" : "",
        "network_ref" : "aeiou"
      } ],
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "enabled" : true,
      "auto_allocate_ip_type" : "aeiou",
      "floating_subnet6_uuid" : "aeiou",
      "auto_allocate_ip" : true,
      "subnet6" : "",
      "floating_ip" : "",
      "floating_subnet_uuid" : "aeiou",
      "avi_allocated_fip" : true,
      "subnet6_uuid" : "aeiou",
      "floating_ip6" : "",
      "ipam_network_subnet" : {
        "subnet" : "",
        "subnet_uuid" : "aeiou",
        "subnet6" : "",
        "subnet6_uuid" : "aeiou",
        "network_ref" : "aeiou"
      },
      "network_ref" : "aeiou",
      "prefix_length" : 123,
      "discovered_networks" : [ {
        "subnet" : [ {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        } ],
        "subnet6" : [ "" ],
        "network_ref" : "aeiou"
      } ]
    } ],
    "east_west_placement" : true
  },
  "uuid" : "aeiou",
  "poolgroups" : [ {
    "ref" : "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 VsInventory

401

delete /vsinventory/{uuid}

(vsinventoryUuidDelete)

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 /vsinventory/{uuid}

(vsinventoryUuidGet)

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

VsInventory

Example data

Content-Type: application/json

{
  "app_profile_type" : "aeiou",
  "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
  },
  "has_pool_with_realtime_metrics" : true,
  "pools" : [ {
    "ref" : "aeiou"
  } ],
  "runtime" : {
    "percent_ses_up" : 123,
    "vip_summary" : {
      "service_engine" : [ {
        "mgmt_ip6" : "",
        "standby" : true,
        "mgmt_ip" : "",
        "scalein_in_progress" : true,
        "se_ready_in_progress" : true,
        "admin_down_requested" : true,
        "oper_status" : "",
        "connected" : true,
        "active_on_cloud" : true,
        "ref" : "aeiou",
        "snat_ip" : "",
        "attach_ip_in_progress" : true,
        "name" : "aeiou",
        "scaleout_in_progress" : true,
        "detach_ip_in_progress" : true,
        "active_on_se" : true,
        "primary" : true
      } ],
      "num_se_assigned" : 123,
      "placement_networks" : [ "" ],
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "oper_status" : "",
      "enabled" : true,
      "auto_allocate_ip_type" : "aeiou",
      "percent_ses_up" : 123,
      "num_se_requested" : 123,
      "auto_allocate_ip" : true,
      "avi_allocated_fip" : true,
      "prefix_length" : 123,
      "discovered_networks" : [ "" ]
    },
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    }
  },
  "metrics" : {
    "headers" : {
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    },
    "data" : {
      "value" : 1.3579000000000001069366817318950779736042022705078125
    }
  },
  "config" : {
    "vsvip_ref" : "aeiou",
    "fqdn" : "aeiou",
    "vrf_context_ref" : "aeiou",
    "dns_info" : [ {
      "metadata" : "aeiou",
      "fqdn" : "aeiou",
      "num_records_in_response" : 123,
      "cname" : {
        "cname" : "aeiou"
      },
      "type" : "aeiou",
      "ttl" : 123,
      "algorithm" : "aeiou"
    } ],
    "services" : [ {
      "override_network_profile_ref" : "aeiou",
      "port" : 123,
      "port_range_end" : 123,
      "is_active_ftp_data_port" : true,
      "enable_http2" : true,
      "horizon_internal_ports" : true,
      "enable_ssl" : true,
      "override_application_profile_ref" : "aeiou"
    } ],
    "type" : "aeiou",
    "uuid" : "aeiou",
    "enabled" : true,
    "url" : "aeiou",
    "se_group_ref" : "aeiou",
    "vh_domain_name" : [ "aeiou" ],
    "pool_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vip" : [ {
      "availability_zone" : "aeiou",
      "ip6_address" : "",
      "subnet" : "",
      "port_uuid" : "aeiou",
      "subnet_uuid" : "aeiou",
      "placement_networks" : [ {
        "subnet" : "",
        "subnet6" : "",
        "network_ref" : "aeiou"
      } ],
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "enabled" : true,
      "auto_allocate_ip_type" : "aeiou",
      "floating_subnet6_uuid" : "aeiou",
      "auto_allocate_ip" : true,
      "subnet6" : "",
      "floating_ip" : "",
      "floating_subnet_uuid" : "aeiou",
      "avi_allocated_fip" : true,
      "subnet6_uuid" : "aeiou",
      "floating_ip6" : "",
      "ipam_network_subnet" : {
        "subnet" : "",
        "subnet_uuid" : "aeiou",
        "subnet6" : "",
        "subnet6_uuid" : "aeiou",
        "network_ref" : "aeiou"
      },
      "network_ref" : "aeiou",
      "prefix_length" : 123,
      "discovered_networks" : [ {
        "subnet" : [ {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        } ],
        "subnet6" : [ "" ],
        "network_ref" : "aeiou"
      } ]
    } ],
    "east_west_placement" : true
  },
  "uuid" : "aeiou",
  "poolgroups" : [ {
    "ref" : "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 VsInventory

401

patch /vsinventory/{uuid}

(vsinventoryUuidPatch)

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

Query parameters

name (optional)

Query Parameter — object name

Return type

VsInventory

Example data

Content-Type: application/json

{
  "app_profile_type" : "aeiou",
  "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
  },
  "has_pool_with_realtime_metrics" : true,
  "pools" : [ {
    "ref" : "aeiou"
  } ],
  "runtime" : {
    "percent_ses_up" : 123,
    "vip_summary" : {
      "service_engine" : [ {
        "mgmt_ip6" : "",
        "standby" : true,
        "mgmt_ip" : "",
        "scalein_in_progress" : true,
        "se_ready_in_progress" : true,
        "admin_down_requested" : true,
        "oper_status" : "",
        "connected" : true,
        "active_on_cloud" : true,
        "ref" : "aeiou",
        "snat_ip" : "",
        "attach_ip_in_progress" : true,
        "name" : "aeiou",
        "scaleout_in_progress" : true,
        "detach_ip_in_progress" : true,
        "active_on_se" : true,
        "primary" : true
      } ],
      "num_se_assigned" : 123,
      "placement_networks" : [ "" ],
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "oper_status" : "",
      "enabled" : true,
      "auto_allocate_ip_type" : "aeiou",
      "percent_ses_up" : 123,
      "num_se_requested" : 123,
      "auto_allocate_ip" : true,
      "avi_allocated_fip" : true,
      "prefix_length" : 123,
      "discovered_networks" : [ "" ]
    },
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    }
  },
  "metrics" : {
    "headers" : {
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    },
    "data" : {
      "value" : 1.3579000000000001069366817318950779736042022705078125
    }
  },
  "config" : {
    "vsvip_ref" : "aeiou",
    "fqdn" : "aeiou",
    "vrf_context_ref" : "aeiou",
    "dns_info" : [ {
      "metadata" : "aeiou",
      "fqdn" : "aeiou",
      "num_records_in_response" : 123,
      "cname" : {
        "cname" : "aeiou"
      },
      "type" : "aeiou",
      "ttl" : 123,
      "algorithm" : "aeiou"
    } ],
    "services" : [ {
      "override_network_profile_ref" : "aeiou",
      "port" : 123,
      "port_range_end" : 123,
      "is_active_ftp_data_port" : true,
      "enable_http2" : true,
      "horizon_internal_ports" : true,
      "enable_ssl" : true,
      "override_application_profile_ref" : "aeiou"
    } ],
    "type" : "aeiou",
    "uuid" : "aeiou",
    "enabled" : true,
    "url" : "aeiou",
    "se_group_ref" : "aeiou",
    "vh_domain_name" : [ "aeiou" ],
    "pool_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vip" : [ {
      "availability_zone" : "aeiou",
      "ip6_address" : "",
      "subnet" : "",
      "port_uuid" : "aeiou",
      "subnet_uuid" : "aeiou",
      "placement_networks" : [ {
        "subnet" : "",
        "subnet6" : "",
        "network_ref" : "aeiou"
      } ],
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "enabled" : true,
      "auto_allocate_ip_type" : "aeiou",
      "floating_subnet6_uuid" : "aeiou",
      "auto_allocate_ip" : true,
      "subnet6" : "",
      "floating_ip" : "",
      "floating_subnet_uuid" : "aeiou",
      "avi_allocated_fip" : true,
      "subnet6_uuid" : "aeiou",
      "floating_ip6" : "",
      "ipam_network_subnet" : {
        "subnet" : "",
        "subnet_uuid" : "aeiou",
        "subnet6" : "",
        "subnet6_uuid" : "aeiou",
        "network_ref" : "aeiou"
      },
      "network_ref" : "aeiou",
      "prefix_length" : 123,
      "discovered_networks" : [ {
        "subnet" : [ {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        } ],
        "subnet6" : [ "" ],
        "network_ref" : "aeiou"
      } ]
    } ],
    "east_west_placement" : true
  },
  "uuid" : "aeiou",
  "poolgroups" : [ {
    "ref" : "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 VsInventory

401

put /vsinventory/{uuid}

(vsinventoryUuidPut)

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

Query parameters

name (optional)

Query Parameter — object name

Return type

VsInventory

Example data

Content-Type: application/json

{
  "app_profile_type" : "aeiou",
  "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
  },
  "has_pool_with_realtime_metrics" : true,
  "pools" : [ {
    "ref" : "aeiou"
  } ],
  "runtime" : {
    "percent_ses_up" : 123,
    "vip_summary" : {
      "service_engine" : [ {
        "mgmt_ip6" : "",
        "standby" : true,
        "mgmt_ip" : "",
        "scalein_in_progress" : true,
        "se_ready_in_progress" : true,
        "admin_down_requested" : true,
        "oper_status" : "",
        "connected" : true,
        "active_on_cloud" : true,
        "ref" : "aeiou",
        "snat_ip" : "",
        "attach_ip_in_progress" : true,
        "name" : "aeiou",
        "scaleout_in_progress" : true,
        "detach_ip_in_progress" : true,
        "active_on_se" : true,
        "primary" : true
      } ],
      "num_se_assigned" : 123,
      "placement_networks" : [ "" ],
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "oper_status" : "",
      "enabled" : true,
      "auto_allocate_ip_type" : "aeiou",
      "percent_ses_up" : 123,
      "num_se_requested" : 123,
      "auto_allocate_ip" : true,
      "avi_allocated_fip" : true,
      "prefix_length" : 123,
      "discovered_networks" : [ "" ]
    },
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    }
  },
  "metrics" : {
    "headers" : {
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    },
    "data" : {
      "value" : 1.3579000000000001069366817318950779736042022705078125
    }
  },
  "config" : {
    "vsvip_ref" : "aeiou",
    "fqdn" : "aeiou",
    "vrf_context_ref" : "aeiou",
    "dns_info" : [ {
      "metadata" : "aeiou",
      "fqdn" : "aeiou",
      "num_records_in_response" : 123,
      "cname" : {
        "cname" : "aeiou"
      },
      "type" : "aeiou",
      "ttl" : 123,
      "algorithm" : "aeiou"
    } ],
    "services" : [ {
      "override_network_profile_ref" : "aeiou",
      "port" : 123,
      "port_range_end" : 123,
      "is_active_ftp_data_port" : true,
      "enable_http2" : true,
      "horizon_internal_ports" : true,
      "enable_ssl" : true,
      "override_application_profile_ref" : "aeiou"
    } ],
    "type" : "aeiou",
    "uuid" : "aeiou",
    "enabled" : true,
    "url" : "aeiou",
    "se_group_ref" : "aeiou",
    "vh_domain_name" : [ "aeiou" ],
    "pool_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vip" : [ {
      "availability_zone" : "aeiou",
      "ip6_address" : "",
      "subnet" : "",
      "port_uuid" : "aeiou",
      "subnet_uuid" : "aeiou",
      "placement_networks" : [ {
        "subnet" : "",
        "subnet6" : "",
        "network_ref" : "aeiou"
      } ],
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "enabled" : true,
      "auto_allocate_ip_type" : "aeiou",
      "floating_subnet6_uuid" : "aeiou",
      "auto_allocate_ip" : true,
      "subnet6" : "",
      "floating_ip" : "",
      "floating_subnet_uuid" : "aeiou",
      "avi_allocated_fip" : true,
      "subnet6_uuid" : "aeiou",
      "floating_ip6" : "",
      "ipam_network_subnet" : {
        "subnet" : "",
        "subnet_uuid" : "aeiou",
        "subnet6" : "",
        "subnet6_uuid" : "aeiou",
        "network_ref" : "aeiou"
      },
      "network_ref" : "aeiou",
      "prefix_length" : 123,
      "discovered_networks" : [ {
        "subnet" : [ {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        } ],
        "subnet6" : [ "" ],
        "network_ref" : "aeiou"
      } ]
    } ],
    "east_west_placement" : true
  },
  "uuid" : "aeiou",
  "poolgroups" : [ {
    "ref" : "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 VsInventory

401

Models

[ Jump to Methods ]

AlertSummary
ApplicationPerformanceScoreData
DiscoveredNetwork
DnsCnameRdata
DnsInfo
HealthScoreEntity
HealthScorePerformanceData
HealthScoreSummary
IPNetworkSubnet
InventoryMetricStatistics
InventoryMetrics
InventoryMetricsData
InventoryMetricsHeaders
IpAddr
IpAddrPrefix
OperationalStatus
PoolGroupRefs
PoolPerformanceScore
PoolPerformanceScoreData
PoolRefs
ServerPerformanceScoreData
Service
ServiceEnginePerformanceScoreData
TimeStamp
Vip
VipPlacementNetwork
VipSeAssigned
VipSummary
VirtualServicePerformanceScore
VirtualServicePerformanceScoreData
VsInventory
VsInventoryApiResponse
VsInventoryConfig
VsInventoryConfigApiResponse
VsRuntimeSummary

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.

DiscoveredNetwork Up

network_ref

String Discovered network for this IP. It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

subnet (optional)

array[IpAddrPrefix] Discovered subnet for this IP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

subnet6 (optional)

array[IpAddrPrefix] Discovered IPv6 subnet for this IP. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

DnsCnameRdata Up

cname

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

DnsInfo Up

algorithm (optional)

String Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is consistent hash. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

cname (optional)

DnsCnameRdata Canonical name in CNAME record. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

fqdn (optional)

String Fully qualified domain name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

metadata (optional)

String Any metadata associated with this record. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

num_records_in_response (optional)

Integer Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- Return all records. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

ttl (optional)

Integer Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

type (optional)

String DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. 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

IPNetworkSubnet Up

network_ref (optional)

String Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured. It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

subnet (optional)

IpAddrPrefix Subnet for VirtualService IP allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

subnet6 (optional)

IpAddrPrefix Subnet for VirtualService IPv6 allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

subnet6_uuid (optional)

String Subnet UUID or Name or Prefix for VirtualService IPv6 allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

subnet_uuid (optional)

String Subnet UUID or Name or Prefix for VirtualService IP allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

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.

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.

IpAddrPrefix Up

ip_addr

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

mask

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

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.

PoolGroupRefs Up

ref (optional)

String UUID of the pool group. It is a reference to an object of type PoolGroup. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, 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

PoolRefs Up

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.

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

Service Up

enable_http2 (optional)

Boolean Enable HTTP2 on this port. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

enable_ssl (optional)

Boolean Enable SSL termination and offload for traffic from clients. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

horizon_internal_ports (optional)

Boolean Used for Horizon deployment. If set used for L7 redirect. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

is_active_ftp_data_port (optional)

Boolean Source port used by VS for active FTP data connections. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

override_application_profile_ref (optional)

String Enable application layer specific features for the this specific service. It is a reference to an object of type ApplicationProfile. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

override_network_profile_ref (optional)

String Override the network profile for this specific service port. It is a reference to an object of type NetworkProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

port

Integer The Virtual Service's port number. Allowed values are 0-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

port_range_end (optional)

Integer The end of the Virtual Service's port number range. Allowed values are 1-65535. Special values are 0- single port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

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.

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

Vip Up

auto_allocate_floating_ip (optional)

Boolean Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

auto_allocate_ip (optional)

Boolean Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

auto_allocate_ip_type (optional)

String Specifies whether to auto-allocate only a V4 address, only a V6 address, or one of each type. Enum options - V4_ONLY, V6_ONLY, V4_V6. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- V4_ONLY), Basic edition(Allowed values- V4_ONLY), Enterprise with Cloud Services edition.

availability_zone (optional)

String Availability-zone to place the Virtual Service. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

avi_allocated_fip (optional)

Boolean (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

avi_allocated_vip (optional)

Boolean (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

discovered_networks (optional)

array[DiscoveredNetwork] Discovered networks providing reachability for client facing Vip IP. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

enabled (optional)

Boolean Enable or disable the Vip. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

floating_ip (optional)

IpAddr Floating IPv4 to associate with this Vip. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

floating_ip6 (optional)

IpAddr Floating IPv6 address to associate with this Vip. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

floating_subnet6_uuid (optional)

String If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IPv6 address allocation. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

floating_subnet_uuid (optional)

String If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ip6_address (optional)

IpAddr IPv6 Address of the Vip. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ip_address (optional)

IpAddr IPv4 Address of the VIP. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ipam_network_subnet (optional)

IPNetworkSubnet Subnet and/or Network for allocating VirtualService IP by IPAM Provider module. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

network_ref (optional)

String Manually override the network on which the Vip is placed. It is a reference to an object of type Network. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

placement_networks (optional)

array[VipPlacementNetwork] Placement networks/subnets to use for vip placement. Field introduced in 18.2.5. Maximum of 10 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

port_uuid (optional)

String (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

prefix_length (optional)

Integer Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 32), Basic edition(Allowed values- 32), Enterprise with Cloud Services edition. format: int32

subnet (optional)

IpAddrPrefix Subnet providing reachability for client facing Vip IP. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

subnet6 (optional)

IpAddrPrefix Subnet providing reachability for client facing Vip IPv6. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.

subnet6_uuid (optional)

String If auto_allocate_ip is True, then the subnet for the Vip IPv6 address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.

subnet_uuid (optional)

String If auto_allocate_ip is True, then the subnet for the Vip IP address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

vip_id

String Unique ID associated with the vip. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VipPlacementNetwork Up

network_ref (optional)

String Network to use for vip placement. It is a reference to an object of type Network. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

subnet (optional)

IpAddrPrefix IPv4 Subnet to use for vip placement. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

subnet6 (optional)

IpAddrPrefix IPv6 subnet to use for vip placement. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VipSeAssigned Up

active_on_cloud (optional)

Boolean Vip is Active on Cloud. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

active_on_se (optional)

Boolean Vip is Active on this ServiceEngine. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

admin_down_requested (optional)

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

attach_ip_in_progress (optional)

Boolean Attach IP is in progress. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

connected (optional)

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

detach_ip_in_progress (optional)

Boolean Detach IP is in progress. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

mgmt_ip (optional)

IpAddr Management IPv4 address of SE. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

mgmt_ip6 (optional)

IpAddr Management IPv6 address of SE. Field introduced in 20.1.3. 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.

oper_status (optional)

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

primary (optional)

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

scalein_in_progress (optional)

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

scaleout_in_progress (optional)

Boolean Vip is awaiting scaleout response from this ServiceEngine. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

se_ready_in_progress (optional)

Boolean Vip is awaiting response from this ServiceEngine. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

snat_ip (optional)

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

standby (optional)

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

VipSummary Up

auto_allocate_floating_ip (optional)

Boolean Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

auto_allocate_ip (optional)

Boolean Auto-allocate VIP from the provided subnet. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

auto_allocate_ip_type (optional)

String Specifies whether to auto-allocate only a V4 address, only a V6 address, or one of each type. Enum options - V4_ONLY, V6_ONLY, V4_V6. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

avi_allocated_fip (optional)

Boolean (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

avi_allocated_vip (optional)

Boolean (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

discovered_networks (optional)

array[DiscoveredNetwork] Discovered networks providing reachability for client facing Vip IP. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

enabled (optional)

Boolean Enable or disable the Vip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ip_address (optional)

IpAddr IPv4 Address of the VIP. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

num_se_assigned (optional)

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

num_se_requested (optional)

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

oper_status (optional)

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

percent_ses_up (optional)

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

placement_networks (optional)

array[VipPlacementNetwork] Placement networks/subnets to use for vip placement. Field introduced in 22.1.1. Maximum of 10 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

prefix_length (optional)

Integer Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

service_engine (optional)

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

vip_id (optional)

String Unique ID associated with the vip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

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

VsInventory Up

_last_modified (optional)

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

alert (optional)

AlertSummary Alert summary of the virtual service. 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 virtual service. 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)

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

has_pool_with_realtime_metrics (optional)

Boolean 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 virtual service. 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 virtual service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

poolgroups (optional)

array[PoolGroupRefs] List of pool-groups virtual service is assigned to. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

pools (optional)

array[PoolRefs] List of pools virtual service is assigned to. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

runtime (optional)

VsRuntimeSummary Runtime summary of the virtual service. 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 virtual service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

VsInventoryApiResponse Up

count

Integer format: int32

results

array[VsInventory]

next (optional)

String

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

dns_info (optional)

array[DnsInfo] Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Note that only one of fqdn and dns_info setting is allowed. Maximum of 1000 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

east_west_placement (optional)

Boolean Force placement on all SE's in service group (Mesos mode only). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

enabled (optional)

Boolean Enable or disable the Virtual Service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

fqdn (optional)

String DNS resolvable, fully qualified domain name of the virtualservice. Only one of 'fqdn' and 'dns_info' configuration is allowed. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

name (optional)

String Name for the Virtual Service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

pool_ref (optional)

String The pool is an object that contains destination servers and related attributes such as load-balancing and persistence. 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.

se_group_ref (optional)

String The Service Engine Group to use for this Virtual Service. Moving to a new SE Group is disruptive to existing connections for this VS. It is a reference to an object of type ServiceEngineGroup. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

services (optional)

array[Service] List of Services defined for this Virtual Service. Field introduced in 22.1.1. Maximum of 2048 items allowed. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

type (optional)

String Specify if this is a normal Virtual Service, or if it is the parent or child of an SNI-enabled virtual hosted Virtual Service. Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

url (optional)

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

uuid (optional)

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

vh_domain_name (optional)

array[String] The exact name requested from the client's SNI-enabled TLS hello domain name field. If this is a match, the parent VS will forward the connection to this child VS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

vip (optional)

array[Vip] List of Virtual Service IPs. While creating a 'Shared VS',please use vsvip_ref to point to the shared entities. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

vrf_context_ref (optional)

String Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type VrfContext. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

vsvip_ref (optional)

String Mostly used during the creation of Shared VS, this field refers to entities that can be shared across Virtual Services. It is a reference to an object of type VsVip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

VsInventoryConfigApiResponse Up

count

Integer format: int32

results

array[VsInventoryConfig]

next (optional)

String

VsRuntimeSummary Up

oper_status (optional)

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

percent_ses_up (optional)

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

vip_summary (optional)

VipSummary Vip summary of the virtual service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Avi VsInventory 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