Avi ControllerLicense Object API

CLI ``` - configure license - show license - show configuration audit ```

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

Contact Info: support@avinetworks.com

Version: 20.1.2

BasePath:/api

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

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

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

get /license

(licenseGet)

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

ControllerLicenseApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "start_on" : "aeiou",
    "burst_cores" : 123,
    "disable_enforcement" : true,
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ "" ],
    "expired_burst_resources" : [ "" ],
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "license_tiers" : [ {
      "burst_cores" : 123,
      "cores" : 123,
      "max_ses" : 123,
      "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
      "se_bandwidth_limits" : [ {
        "count" : 123,
        "type" : "aeiou"
      } ],
      "sockets" : 123,
      "tier_type" : "aeiou"
    } ],
    "licenses" : [ {
      "start_on" : "aeiou",
      "burst_cores" : 123,
      "serial_key" : "aeiou",
      "enforced_params" : [ "aeiou" ],
      "license_type" : "aeiou",
      "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
      "se_bandwidth_limits" : [ "" ],
      "cpu_cores" : 1.3579000000000001069366817318950779736042022705078125,
      "license_string" : "aeiou",
      "version" : "aeiou",
      "license_name" : "aeiou",
      "cores" : 1.3579000000000001069366817318950779736042022705078125,
      "expired" : true,
      "max_ses" : 123,
      "valid_until" : "aeiou",
      "created_on" : "aeiou",
      "license_id" : "aeiou",
      "last_update" : "aeiou",
      "customer_name" : "aeiou",
      "sockets" : 123,
      "tier_type" : "aeiou",
      "license_tier" : [ "aeiou" ]
    } ],
    "active_burst_resources" : [ {
      "accounted_license_id" : "aeiou",
      "start_time" : "aeiou",
      "se_cookie" : "aeiou",
      "license_tier" : "aeiou",
      "last_alert_time" : "aeiou",
      "se_uuid" : "aeiou"
    } ],
    "cores" : 123,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "license_id" : "aeiou",
    "name" : "aeiou",
    "initialized" : true,
    "customer_name" : "aeiou",
    "sockets" : 123,
    "license_tier" : [ "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 ControllerLicenseApiResponse

401

post /license

(licensePost)

Consumes

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

application/json

Request body

body (required)

Body Parameter — ControllerLicense object creation

Return type

ControllerLicense

Example data

Content-Type: application/json

{
  "start_on" : "aeiou",
  "burst_cores" : 123,
  "disable_enforcement" : true,
  "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
  "se_bandwidth_limits" : [ "" ],
  "expired_burst_resources" : [ "" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "license_tiers" : [ {
    "burst_cores" : 123,
    "cores" : 123,
    "max_ses" : 123,
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ {
      "count" : 123,
      "type" : "aeiou"
    } ],
    "sockets" : 123,
    "tier_type" : "aeiou"
  } ],
  "licenses" : [ {
    "start_on" : "aeiou",
    "burst_cores" : 123,
    "serial_key" : "aeiou",
    "enforced_params" : [ "aeiou" ],
    "license_type" : "aeiou",
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ "" ],
    "cpu_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "license_string" : "aeiou",
    "version" : "aeiou",
    "license_name" : "aeiou",
    "cores" : 1.3579000000000001069366817318950779736042022705078125,
    "expired" : true,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "created_on" : "aeiou",
    "license_id" : "aeiou",
    "last_update" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "tier_type" : "aeiou",
    "license_tier" : [ "aeiou" ]
  } ],
  "active_burst_resources" : [ {
    "accounted_license_id" : "aeiou",
    "start_time" : "aeiou",
    "se_cookie" : "aeiou",
    "license_tier" : "aeiou",
    "last_alert_time" : "aeiou",
    "se_uuid" : "aeiou"
  } ],
  "cores" : 123,
  "max_ses" : 123,
  "valid_until" : "aeiou",
  "license_id" : "aeiou",
  "name" : "aeiou",
  "initialized" : true,
  "customer_name" : "aeiou",
  "sockets" : 123,
  "license_tier" : [ "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 ControllerLicense

401

delete /license/{uuid}

(licenseUuidDelete)

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

(licenseUuidGet)

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

ControllerLicense

Example data

Content-Type: application/json

{
  "start_on" : "aeiou",
  "burst_cores" : 123,
  "disable_enforcement" : true,
  "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
  "se_bandwidth_limits" : [ "" ],
  "expired_burst_resources" : [ "" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "license_tiers" : [ {
    "burst_cores" : 123,
    "cores" : 123,
    "max_ses" : 123,
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ {
      "count" : 123,
      "type" : "aeiou"
    } ],
    "sockets" : 123,
    "tier_type" : "aeiou"
  } ],
  "licenses" : [ {
    "start_on" : "aeiou",
    "burst_cores" : 123,
    "serial_key" : "aeiou",
    "enforced_params" : [ "aeiou" ],
    "license_type" : "aeiou",
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ "" ],
    "cpu_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "license_string" : "aeiou",
    "version" : "aeiou",
    "license_name" : "aeiou",
    "cores" : 1.3579000000000001069366817318950779736042022705078125,
    "expired" : true,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "created_on" : "aeiou",
    "license_id" : "aeiou",
    "last_update" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "tier_type" : "aeiou",
    "license_tier" : [ "aeiou" ]
  } ],
  "active_burst_resources" : [ {
    "accounted_license_id" : "aeiou",
    "start_time" : "aeiou",
    "se_cookie" : "aeiou",
    "license_tier" : "aeiou",
    "last_alert_time" : "aeiou",
    "se_uuid" : "aeiou"
  } ],
  "cores" : 123,
  "max_ses" : 123,
  "valid_until" : "aeiou",
  "license_id" : "aeiou",
  "name" : "aeiou",
  "initialized" : true,
  "customer_name" : "aeiou",
  "sockets" : 123,
  "license_tier" : [ "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 ControllerLicense

401

patch /license/{uuid}

(licenseUuidPatch)

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

Query parameters

name (optional)

Query Parameter — object name

Return type

ControllerLicense

Example data

Content-Type: application/json

{
  "start_on" : "aeiou",
  "burst_cores" : 123,
  "disable_enforcement" : true,
  "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
  "se_bandwidth_limits" : [ "" ],
  "expired_burst_resources" : [ "" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "license_tiers" : [ {
    "burst_cores" : 123,
    "cores" : 123,
    "max_ses" : 123,
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ {
      "count" : 123,
      "type" : "aeiou"
    } ],
    "sockets" : 123,
    "tier_type" : "aeiou"
  } ],
  "licenses" : [ {
    "start_on" : "aeiou",
    "burst_cores" : 123,
    "serial_key" : "aeiou",
    "enforced_params" : [ "aeiou" ],
    "license_type" : "aeiou",
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ "" ],
    "cpu_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "license_string" : "aeiou",
    "version" : "aeiou",
    "license_name" : "aeiou",
    "cores" : 1.3579000000000001069366817318950779736042022705078125,
    "expired" : true,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "created_on" : "aeiou",
    "license_id" : "aeiou",
    "last_update" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "tier_type" : "aeiou",
    "license_tier" : [ "aeiou" ]
  } ],
  "active_burst_resources" : [ {
    "accounted_license_id" : "aeiou",
    "start_time" : "aeiou",
    "se_cookie" : "aeiou",
    "license_tier" : "aeiou",
    "last_alert_time" : "aeiou",
    "se_uuid" : "aeiou"
  } ],
  "cores" : 123,
  "max_ses" : 123,
  "valid_until" : "aeiou",
  "license_id" : "aeiou",
  "name" : "aeiou",
  "initialized" : true,
  "customer_name" : "aeiou",
  "sockets" : 123,
  "license_tier" : [ "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 ControllerLicense

401

put /license/{uuid}

(licenseUuidPut)

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

Query parameters

name (optional)

Query Parameter — object name

Return type

ControllerLicense

Example data

Content-Type: application/json

{
  "start_on" : "aeiou",
  "burst_cores" : 123,
  "disable_enforcement" : true,
  "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
  "se_bandwidth_limits" : [ "" ],
  "expired_burst_resources" : [ "" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "license_tiers" : [ {
    "burst_cores" : 123,
    "cores" : 123,
    "max_ses" : 123,
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ {
      "count" : 123,
      "type" : "aeiou"
    } ],
    "sockets" : 123,
    "tier_type" : "aeiou"
  } ],
  "licenses" : [ {
    "start_on" : "aeiou",
    "burst_cores" : 123,
    "serial_key" : "aeiou",
    "enforced_params" : [ "aeiou" ],
    "license_type" : "aeiou",
    "service_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "se_bandwidth_limits" : [ "" ],
    "cpu_cores" : 1.3579000000000001069366817318950779736042022705078125,
    "license_string" : "aeiou",
    "version" : "aeiou",
    "license_name" : "aeiou",
    "cores" : 1.3579000000000001069366817318950779736042022705078125,
    "expired" : true,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "created_on" : "aeiou",
    "license_id" : "aeiou",
    "last_update" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "tier_type" : "aeiou",
    "license_tier" : [ "aeiou" ]
  } ],
  "active_burst_resources" : [ {
    "accounted_license_id" : "aeiou",
    "start_time" : "aeiou",
    "se_cookie" : "aeiou",
    "license_tier" : "aeiou",
    "last_alert_time" : "aeiou",
    "se_uuid" : "aeiou"
  } ],
  "cores" : 123,
  "max_ses" : 123,
  "valid_until" : "aeiou",
  "license_id" : "aeiou",
  "name" : "aeiou",
  "initialized" : true,
  "customer_name" : "aeiou",
  "sockets" : 123,
  "license_tier" : [ "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 ControllerLicense

401

Models

[ Jump to Methods ]

BurstResource
ControllerLicense
ControllerLicenseApiResponse
CumulativeLicense
SEBandwidthLimit
SingleLicense

BurstResource Up

accounted_license_id (optional)

String License ID against which this burst has been accounted. Field introduced in 17.2.5.

last_alert_time (optional)

String Time UTC of the last alert created for this burst resource. Field introduced in 17.2.5.

license_tier (optional)

String Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 17.2.5.

se_cookie (optional)

String Field introduced in 17.2.5.

se_uuid (optional)

String Service Engine which triggered the burst license usage. Field introduced in 17.2.5.

start_time (optional)

String Time UTC when the burst license was put in use. Field introduced in 17.2.5.

ControllerLicense Up

_last_modified (optional)

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

active_burst_resources (optional)

array[BurstResource] List of active burst core license in use. Field introduced in 17.2.5.

burst_cores (optional)

Integer Total number of Service Engine cores for burst core based licenses. Field introduced in 17.2.5. format: int32

cores (optional)

Integer Number of Service Engine cores in non-container clouds. format: int32

customer_name

String customer_name of ControllerLicense.

disable_enforcement (optional)

Boolean Field introduced in 17.2.5.

expired_burst_resources (optional)

array[BurstResource] List of used or expired burst core licenses. Field introduced in 17.2.5.

initialized (optional)

Boolean Flag used to track initialization. Field introduced in 20.1.2.

license_id (optional)

String Field introduced in 17.2.5.

license_tier (optional)

array[String] license_tier of ControllerLicense.

license_tiers (optional)

array[CumulativeLicense] Field introduced in 17.2.5.

licenses (optional)

array[SingleLicense] Placeholder for description of property licenses of obj type ControllerLicense field type str type object

max_ses (optional)

Integer Number of Service Engines hosts in container clouds. format: int32

name (optional)

String Name of the object.

se_bandwidth_limits (optional)

array[SEBandwidthLimit] Service Engine bandwidth limits for bandwidth based licenses. Field introduced in 17.2.5.

service_cores (optional)

Double Number of vmware service cores after aggregating all other license types. Field introduced in 20.1.1. format: double

sockets (optional)

Integer Number of physical cpu sockets across Service Engines in no access and linux server clouds. format: int32

start_on (optional)

String start_on of ControllerLicense.

url (optional)

String url

uuid (optional)

String Unique object identifier of the object.

valid_until

String valid_until of ControllerLicense.

ControllerLicenseApiResponse Up

count

Integer format: int32

results

array[ControllerLicense]

next (optional)

String

CumulativeLicense Up

burst_cores (optional)

Integer Total number of Service Engine cores for burst core based licenses. Field introduced in 17.2.5. format: int32

cores (optional)

Integer Total number of Service Engine cores for core based licenses. Field introduced in 17.2.5. format: int32

max_ses (optional)

Integer Total number of Service Engines for host based licenses. Field introduced in 17.2.5. format: int32

se_bandwidth_limits (optional)

array[SEBandwidthLimit] Service Engine bandwidth limits for bandwidth based licenses. Field introduced in 17.2.5.

service_cores (optional)

Double Total number of Service Engine cores.. Field introduced in 20.1.1. format: double

sockets (optional)

Integer Total number of Service Engine sockets for socket based licenses. Field introduced in 17.2.5. format: int32

tier_type (optional)

String Specifies the licensed tier. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 17.2.5.

SEBandwidthLimit Up

count (optional)

Integer Total number of Service Engines for bandwidth based licenses. Field introduced in 17.2.5. format: int32

type (optional)

String Maximum bandwidth allowed by each Service Engine. Enum options - SE_BANDWIDTH_UNLIMITED, SE_BANDWIDTH_25M, SE_BANDWIDTH_200M, SE_BANDWIDTH_1000M, SE_BANDWIDTH_10000M. Field introduced in 17.2.5.

SingleLicense Up

burst_cores (optional)

Integer Total number of Service Engine burst cores for core based licenses. Field introduced in 17.2.5. format: int32

cores (optional)

Double Number of Service Engine cores in non-container clouds. format: double

cpu_cores (optional)

Double Total number of cpu cores. Field introduced in 20.1.1. format: double

created_on (optional)

String created_on of SingleLicense.

customer_name

String customer_name of SingleLicense.

enforced_params (optional)

array[String] enforced_params of SingleLicense.

expired (optional)

Boolean Flag to track license expiry. Field introduced in 20.1.1.

last_update (optional)

String last_update of SingleLicense.

license_id (optional)

String license_id of SingleLicense.

license_name

String license_name of SingleLicense.

license_string (optional)

String license_string of SingleLicense.

license_tier (optional)

array[String] license_tier of SingleLicense.

license_type (optional)

String license_type of SingleLicense.

max_ses (optional)

Integer Number of Service Engines hosts in container clouds. format: int32

se_bandwidth_limits (optional)

array[SEBandwidthLimit] Service Engine bandwidth limits for bandwidth based licenses. Field introduced in 17.2.5.

serial_key (optional)

String Serial key (Hyphen separated 25 char wide alphanumeric key Ex AA123-23BAS-383AS-383UD-FHSFG). Field introduced in 20.1.1.

service_cores (optional)

Double Total number of service cores equivalent to all the resoures available in the single license. Field introduced in 20.1.1. format: double

sockets (optional)

Integer Number of physical cpu sockets across Service Engines in no access and linux server clouds. format: int32

start_on (optional)

String start_on of SingleLicense.

tier_type (optional)

String Specifies the licensed tier. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 17.2.5.

valid_until

String valid_until of SingleLicense.

version (optional)

String version of SingleLicense.

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