Avi LicenseLedgerDetails Object API

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

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /licensing/ledger/details
  2. post /licensing/ledger/details
  3. delete /licensing/ledger/details/{uuid}
  4. get /licensing/ledger/details/{uuid}
  5. patch /licensing/ledger/details/{uuid}
  6. put /licensing/ledger/details/{uuid}
Up 
get /licensing/ledger/details
(licensingLedgerDetailsGet)

Consumes

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

Query parameters

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

Return type

LicenseLedgerDetailsApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "tier_usages" : [ {
      "tier" : "aeiou",
      "usage" : {
        "consumed" : 1.3579000000000001069366817318950779736042022705078125,
        "available" : 1.3579000000000001069366817318950779736042022705078125,
        "escrow" : 1.3579000000000001069366817318950779736042022705078125,
        "remaining" : 1.3579000000000001069366817318950779736042022705078125
      }
    } ],
    "escrow_infos" : [ {
      "last_updated" : 123456789,
      "tier" : "aeiou",
      "tenant_uuid" : "aeiou",
      "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
      "uuid" : "aeiou"
    } ],
    "se_infos" : [ "" ],
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou"
  } ]
}

Produces

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

Responses

200

OK LicenseLedgerDetailsApiResponse

401

log in failed
Up 
post /licensing/ledger/details
(licensingLedgerDetailsPost)

Consumes

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

Request body

body (required)
Body Parameter — LicenseLedgerDetails object creation

Return type

LicenseLedgerDetails

Example data

Content-Type: application/json
{
  "tier_usages" : [ {
    "tier" : "aeiou",
    "usage" : {
      "consumed" : 1.3579000000000001069366817318950779736042022705078125,
      "available" : 1.3579000000000001069366817318950779736042022705078125,
      "escrow" : 1.3579000000000001069366817318950779736042022705078125,
      "remaining" : 1.3579000000000001069366817318950779736042022705078125
    }
  } ],
  "escrow_infos" : [ {
    "last_updated" : 123456789,
    "tier" : "aeiou",
    "tenant_uuid" : "aeiou",
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "uuid" : "aeiou"
  } ],
  "se_infos" : [ "" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

Responses

200

OK LicenseLedgerDetails

401

log in failed
Up 
delete /licensing/ledger/details/{uuid}
(licensingLedgerDetailsUuidDelete)

Path parameters

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

Consumes

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

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

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

Responses

204

object deleted String

404

not found
Up 
get /licensing/ledger/details/{uuid}
(licensingLedgerDetailsUuidGet)

Path parameters

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

Consumes

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

Query parameters

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

Return type

LicenseLedgerDetails

Example data

Content-Type: application/json
{
  "tier_usages" : [ {
    "tier" : "aeiou",
    "usage" : {
      "consumed" : 1.3579000000000001069366817318950779736042022705078125,
      "available" : 1.3579000000000001069366817318950779736042022705078125,
      "escrow" : 1.3579000000000001069366817318950779736042022705078125,
      "remaining" : 1.3579000000000001069366817318950779736042022705078125
    }
  } ],
  "escrow_infos" : [ {
    "last_updated" : 123456789,
    "tier" : "aeiou",
    "tenant_uuid" : "aeiou",
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "uuid" : "aeiou"
  } ],
  "se_infos" : [ "" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

Responses

200

OK LicenseLedgerDetails

401

log in failed
Up 
patch /licensing/ledger/details/{uuid}
(licensingLedgerDetailsUuidPatch)

Path parameters

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

Consumes

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

Request body

body (required)
Body Parameter — LicenseLedgerDetails object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

LicenseLedgerDetails

Example data

Content-Type: application/json
{
  "tier_usages" : [ {
    "tier" : "aeiou",
    "usage" : {
      "consumed" : 1.3579000000000001069366817318950779736042022705078125,
      "available" : 1.3579000000000001069366817318950779736042022705078125,
      "escrow" : 1.3579000000000001069366817318950779736042022705078125,
      "remaining" : 1.3579000000000001069366817318950779736042022705078125
    }
  } ],
  "escrow_infos" : [ {
    "last_updated" : 123456789,
    "tier" : "aeiou",
    "tenant_uuid" : "aeiou",
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "uuid" : "aeiou"
  } ],
  "se_infos" : [ "" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

Responses

200

OK LicenseLedgerDetails

401

log in failed
Up 
put /licensing/ledger/details/{uuid}
(licensingLedgerDetailsUuidPut)

Path parameters

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

Consumes

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

Request body

body (required)
Body Parameter — LicenseLedgerDetails object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

LicenseLedgerDetails

Example data

Content-Type: application/json
{
  "tier_usages" : [ {
    "tier" : "aeiou",
    "usage" : {
      "consumed" : 1.3579000000000001069366817318950779736042022705078125,
      "available" : 1.3579000000000001069366817318950779736042022705078125,
      "escrow" : 1.3579000000000001069366817318950779736042022705078125,
      "remaining" : 1.3579000000000001069366817318950779736042022705078125
    }
  } ],
  "escrow_infos" : [ {
    "last_updated" : 123456789,
    "tier" : "aeiou",
    "tenant_uuid" : "aeiou",
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "uuid" : "aeiou"
  } ],
  "se_infos" : [ "" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

Responses

200

OK LicenseLedgerDetails

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. LicenseInfo
  2. LicenseLedgerDetails
  3. LicenseLedgerDetailsApiResponse
  4. LicenseTierUsage
  5. LicenseUsage

LicenseInfo Up

last_updated
Long Last updated time. Field introduced in 20.1.1. format: int64
service_cores
Double Quantity of service cores. Field introduced in 20.1.1. format: double
tenant_uuid (optional)
String Specifies the license tier. Field introduced in 20.1.1.
tier
String Specifies the license tier. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 20.1.1.
uuid (optional)
String Identifier(license_id, se_uuid, cookie). Field introduced in 20.1.1.

LicenseLedgerDetails Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
escrow_infos (optional)
array[LicenseInfo] Maintain information about reservation against cookie. Field introduced in 20.1.1.
se_infos (optional)
array[LicenseInfo] Maintain information about consumed licenses against se_uuid. Field introduced in 20.1.1.
tier_usages (optional)
array[LicenseTierUsage] License usage per tier. Field introduced in 20.1.1.
url (optional)
String url
uuid (optional)
String Uuid for reference. Field introduced in 20.1.1.

LicenseLedgerDetailsApiResponse Up

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

LicenseTierUsage Up

tier (optional)
String Specifies the license tier. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 20.1.1.
usage (optional)
LicenseUsage Usage stats of license tier. Field introduced in 20.1.1.

LicenseUsage Up

available (optional)
Double Total license cores available for consumption. Field introduced in 20.1.1. format: double
consumed (optional)
Double Total license cores consumed. Field introduced in 20.1.1. format: double
escrow (optional)
Double Total license cores reserved or escrowed. Field introduced in 20.1.1. format: double
remaining (optional)
Double Total license cores remaining for consumption. Field introduced in 20.1.1. format: double