Avi LicenseLedgerDetails Object API

CLI ``` - show license ledger details ```

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

Contact Info: support@avinetworks.com

Version: 21.1.6

BasePath:/api

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

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /licensing/ledger/details
post /licensing/ledger/details
delete /licensing/ledger/details/{uuid}
get /licensing/ledger/details/{uuid}
patch /licensing/ledger/details/{uuid}
put /licensing/ledger/details/{uuid}

get /licensing/ledger/details

(licensingLedgerDetailsGet)

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

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

application/json

Responses

200

OK LicenseLedgerDetailsApiResponse

401

post /licensing/ledger/details

(licensingLedgerDetailsPost)

Consumes

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

application/json

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

application/json

Responses

200

OK LicenseLedgerDetails

401

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:

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 /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:

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

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

application/json

Responses

200

OK LicenseLedgerDetails

401

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:

application/json

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

application/json

Responses

200

OK LicenseLedgerDetails

401

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:

application/json

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

application/json

Responses

200

OK LicenseLedgerDetails

401

Models

[ Jump to Methods ]

LicenseInfo
LicenseLedgerDetails
LicenseLedgerDetailsApiResponse
LicenseTierUsage
LicenseUsage

LicenseInfo Up

last_updated

Long Last updated time. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

service_cores

Double Quantity of service cores. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

tenant_uuid (optional)

String Specifies the license tier. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

tier

String Specifies the license tier. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS, ENTERPRISE_WITH_CLOUD_SERVICES. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

uuid (optional)

String Identifier(license_id, se_uuid, cookie). Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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

se_infos (optional)

array[LicenseInfo] Maintain information about consumed licenses against se_uuid. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

tier_usages (optional)

array[LicenseTierUsage] License usage per tier. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

url (optional)

String url

uuid (optional)

String Uuid for reference. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

LicenseLedgerDetailsApiResponse Up

count

Integer format: int32

results

array[LicenseLedgerDetails]

next (optional)

String

LicenseTierUsage Up

tier (optional)

usage (optional)

LicenseUsage Usage stats of license tier. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

LicenseUsage Up

available (optional)

Double Total license cores available for consumption. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

consumed (optional)

Double Total license cores consumed. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

escrow (optional)

Double Total license cores reserved or escrowed. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

remaining (optional)

Double Total license cores remaining for consumption. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

Avi LicenseLedgerDetails Object API

Access

Methods

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

Models

Table of Contents

LicenseInfo Up

LicenseLedgerDetails Up

LicenseLedgerDetailsApiResponse Up

LicenseTierUsage Up

LicenseUsage Up