Inventory APIs

Inventory APIs bring together configuration, runtime, health score, alert, and metrics information about objects under 1 API. While the information provided will not be as complete as making a request to each specific endpoint, these APIs provide a good snapshot of your objects with 1 request.

Inventory Query Options

Option Description Defaults
include Filter for what type of information is returned per object. Eg. include=config,metrics,alert
name Name of the object
page_size Number of objects to return per page 25
page Page to return 1
include_name Append #<name> to references
sort Parameter to sort results in ascending order. Eg. sort=health_score
duration Duration window for alerts
start Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00:00:00 1970-01-01T00:00:00
stop End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12:42:42
limit Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples 60

VirtualServiceInventory

API


    GET /api/virtualservice-inventory
    GET /api/virtualservice-inventory/<key>

Data

VirtualServiceInventory

config

Type
VirtualServiceInventoryConfig
Category
required
Description
Config object of the VirtualService

uuid

Type
string
Category
required
Description

alert

Type
InventoryAlert
Category
optional
Description
Number of alerts for this VirtualService

health_score

Type
InventoryHealthScore
Category
optional
Description
Health score of this VirtualService

runtime

Type
VirtualServiceRuntimeSummary
Category
optional
Description
Runtime information for this Virtual Service

metrics

Type
Metrics
Category
optional
Description
Metrics infromation for this Virtual Service

VirtualServiceInventoryConfig

uuid

Type
string
Category
required
Description
UUID of the VirtualService.

name

Type
string
Category
required
Description
Name for the Virtual Service.

fqdn

Type
string
Category
optional
Description
DNS resolvable, fully qualified domain name of the Virtual Service.

ip_address

Type
IpAddr
Category
optional
Description
IP Address of the Virtual Service.

enabled

Type
bool
Category
optional
Description
Enable or disable the Virtual Service.
Default
True

services

Type
Service
Category
repeated
Description

url

Type
string
Category
required
Description
URL of the VirtualService

floating_ip

Type
IpAddr
Category
optional
Description
Floating IP to associate with this Virtual Service.

pool_ref

Type
Reference to Pool
Category
optional
Description
The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.

type

Type
enum
Category
optional
Description
Specify if this is a normal Virtual Service, or if it is the parent or child of an SNI-enabled virtual hosted Virtual Service.
Default
VS_TYPE_NORMAL
Choices
VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD, VS_TYPE_NORMAL

vh_domain_name

Type
string
Category
repeated
Description
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.

tenant_ref

Type
Reference to Tenant
Category
required
Description

cloud_ref

Type
Reference to Cloud
Category
optional,readonly
Description
Default
/api/cloud?name=Default-Cloud

east_west_placement

Type
bool
Category
optional
Description
Force placement on all SE's in service group (Mesos mode only)
Default
False

se_group_ref

Type
Reference to ServiceEngineGroup
Category
optional
Description
The Service Engine Group to use for this Virtual Service. Moving to a new SE Group is disruptive to existing connection for this VS.

vrf_context_ref

Type
Reference to VrfContext
Category
optional
Description
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.

References

VirtualService VrfContext NetworkProfile Cloud ServiceEngineGroup ServiceEngine Pool Tenant Network

PoolInventory

API


    GET /api/pool-inventory
    GET /api/pool-inventory/<key>

Data

PoolInventory

config

Type
PoolInventoryConfig
Category
required
Description
Config object of the Pool

virtualservice

Type
AssignedVirtualService
Category
optional
Description
Name and UUID of the Virtual Service this Pool is assigned to

backup_pools

Type
Reference to Pool
Category
repeated
Description
Backup Pools assigned to this Pool

ab_pools

Type
Reference to Pool
Category
repeated
Description
AB Pools assigned to this Pool

app_profile_type

Type
enum
Category
optional
Description
Application Profile type of the VirtualService using this Pool
Choices
APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_L4

alert

Type
InventoryAlert
Category
optional
Description
Number of alerts for this Pool

health_score

Type
InventoryHealthScore
Category
optional
Description
Health score of this Pool

runtime

Type
PoolRuntimeSummary
Category
optional
Description
Runtime information for this Pool

metrics

Type
Metrics
Category
optional
Description
Metrics infromation for this Pool

PoolInventoryConfig

uuid

Type
string
Category
required
Description
UUID of the pool

name

Type
string
Category
required
Description
The name of the pool.

url

Type
string
Category
optional
Description
URL of the pool

num_servers

Type
int32
Category
optional
Description

default_server_port

Type
int32
Category
optional
Description
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.
Default
80

tenant_ref

Type
Reference to Tenant
Category
optional
Description

cloud_ref

Type
Reference to Cloud
Category
optional,readonly
Description
Default
/api/cloud?name=Default-Cloud

vrf_ref

Type
Reference to VrfContext
Category
optional,readonly
Description
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.

created_by

Type
string
Category
optional
Description
Creator name

AssignedVirtualService

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

References

Pool Tenant Cloud VrfContext

PoolServerInventory

API


    GET /api/pool-inventory/<key>/server/<key>

Data

PoolServerInventory

config

Type
PoolServerInventoryConfig
Category
required
Description

alert

Type
InventoryAlert
Category
optional
Description
Number of alerts for this Pool

health_score

Type
InventoryHealthScore
Category
optional
Description
Health score of this Pool

runtime

Type
PoolRuntimeSummary
Category
optional
Description
Runtime information for this Pool

metrics

Type
Metrics
Category
optional
Description
Metrics infromation for this Server

PoolServerInventoryConfig

ip

Type
IpAddr
Category
required
Description
IP Address of the server. Required if there is no resolvable host name.

port

Type
int32
Category
optional
Description
Optionally specify the servers port number. This will override the pool's default server port attribute.

hostname

Type
string
Category
optional
Description
DNS resolvable name of the server. May be used in place of the IP address.

enabled

Type
bool
Category
optional
Description
Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed.
Default
True

ratio

Type
int32
Category
optional
Description
Overrides the default ratio of 1. Reduces the percentage the LB algorithm would pick the server in relation to its peers. Range is 1-20.
Default
1

default_server_port

Type
int32
Category
optional
Description
Default server port of the Pool using this server
Default
80

tenant_ref

Type
Reference to Tenant
Category
optional
Description

References

Tenant

ServiceEngineInventory

API

  
    GET /api/serviceengine-inventory
    GET /api/serviceengine-inventory/<key>

Data

ServiceEngineInventory

config

Type
ServiceEngineInventoryConfig
Category
required
Description

alert

Type
InventoryAlert
Category
optional
Description
Number of alerts for this Pool

health_score

Type
InventoryHealthScore
Category
optional
Description
Health score of this Pool

runtime

Type
ServiceEngineRuntimeSummary
Category
optional
Description
Runtime information for this Pool

metrics

Type
Metrics
Category
optional
Description
Metrics infromation for this Service Engine

ServiceEngineInventoryConfig

uuid

Type
string
Category
required
Description

name

Type
string
Category
optional
Description
Default
VM name unknown

tenant_ref

Type
Reference to Tenant
Category
optional
Description

cloud_ref

Type
Reference to Cloud
Category
optional,readonly
Description
Default
/api/cloud?name=Default-Cloud

url

Type
string
Category
required
Description
URL of the ServiceEngine

se_group_ref

Type
Reference to ServiceEngineGroup
Category
optional
Description

enable_state

Type
enum
Category
optional
Description
inorder to disable SE set this field appropriately
Default
SE_STATE_ENABLED
Choices
SE_STATE_DISABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_ENABLED

mgmt_ip_address

Type
IpAddr
Category
optional
Description
Management IP address for the Service Engine Group

virtualservice_refs

Type
Reference to VirtualService
Category
repeated
Description
Virtual Services using this Service Engine

References

VirtualService Tenant Cloud ServiceEngineGroup

ServiceEngineGroupInventory

API


    GET /api/serviceenginegroup-inventory
    GET /api/serviceenginegroup-inventory/<key>

Data

ServiceEngineGroupInventory

config

Type
ServiceEngineGroup
Category
required
Description

uuid

Type
string
Category
required
Description

virtualservices

Type
string
Category
repeated
Description
References to Virtual Services that are using this Service Engine Group

serviceengines

Type
string
Category
repeated
Description
References to the Service Engines in this Service Engine Group

References

HardwareSecurityModuleGroup Network VIMgrClusterRuntime Tenant Cloud VIMgrHostRuntime

CloudInventory

API


    GET /api/cloud-inventory
    GET /api/cloud-inventory/<key>

Data

CloudInventory

config

Type
Cloud
Category
required
Description

mvrf

Type
VrfContext
Category
optional
Description

status

Type
CloudStatus
Category
optional
Description

ipam_provider_type

Type
enum
Category
optional
Description
Choices
IPAMDNS_TYPE_INFOBLOX, IPAMDNS_TYPE_INTERNAL, IPAMDNS_TYPE_OPENSTACK, IPAMDNS_TYPE_AWS

References

Cloud IpamDnsProviderProfile Tenant SSLKeyAndCertificate

NetworkInventory

API


    GET /api/network-inventory
    GET /api/network-inventory/<key>

Data

NetworkInventory

config

Type
Network
Category
required
Description

runtime

Type
NetworkRuntime
Category
optional
Description
Runtime information for this Network

alert

Type
InventoryAlert
Category
optional
Description
Number of alerts for this Network

health_score

Type
InventoryHealthScore
Category
optional
Description
Health score of this Network

discovery

Type
VIMgrNWRuntime
Category
optional
Description
Discovery information for this Network

References

VrfContext VIMgrNWRuntime Cloud VIMgrVMRuntime Tenant VIMgrHostRuntime

Common Inventory Objects

InventoryAlert

high

Type
int32
Category
required
Description

medium

Type
int32
Category
required
Description

low

Type
int32
Category
required
Description

InventoryHealthScore

resources_penalty

Type
int32
Category
required
Description

health_score

Type
int32
Category
required
Description

anomaly_penalty

Type
int32
Category
required
Description

performance_score

Type
int32
Category
required
Description

security_penalty