Avi ControllerLicense Object API

##CLI## ``` - configure license - show license ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
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 /license
  2. post /license
  3. delete /license/{uuid}
  4. get /license/{uuid}
  5. patch /license/{uuid}
  6. put /license/{uuid}
Up
get /license
( licenseGet)

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.
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
{
  "count" : 123,
  "results" : [ {
    "start_on" : "aeiou",
    "max_apps" : 123,
    "uuid" : "aeiou",
    "backend_servers" : 123,
    "url" : "aeiou",
    "licenses" : [ {
      "start_on" : "aeiou",
      "enforced_params" : [ "aeiou" ],
      "license_type" : "aeiou",
      "max_apps" : 123,
      "license_string" : "aeiou",
      "version" : "aeiou",
      "backend_servers" : 123,
      "license_name" : "aeiou",
      "cores" : 123,
      "max_ses" : 123,
      "valid_until" : "aeiou",
      "created_on" : "aeiou",
      "license_id" : "aeiou",
      "last_update" : "aeiou",
      "customer_name" : "aeiou",
      "sockets" : 123,
      "throughput" : 123,
      "license_tier" : [ "aeiou" ]
    } ],
    "max_vses" : 123,
    "cores" : 123,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "name" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "throughput" : 123,
    "license_tier" : [ "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 ControllerLicenseApiResponse

401

log in failed

Up
post /license
( licensePost)

Consumes

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

Request body

body (required)
Body Parameter — ControllerLicense object creation

Return type

ControllerLicense

Example data

Content-Type: application/json
{
  "start_on" : "aeiou",
  "max_apps" : 123,
  "uuid" : "aeiou",
  "backend_servers" : 123,
  "url" : "aeiou",
  "licenses" : [ {
    "start_on" : "aeiou",
    "enforced_params" : [ "aeiou" ],
    "license_type" : "aeiou",
    "max_apps" : 123,
    "license_string" : "aeiou",
    "version" : "aeiou",
    "backend_servers" : 123,
    "license_name" : "aeiou",
    "cores" : 123,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "created_on" : "aeiou",
    "license_id" : "aeiou",
    "last_update" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "throughput" : 123,
    "license_tier" : [ "aeiou" ]
  } ],
  "max_vses" : 123,
  "cores" : 123,
  "max_ses" : 123,
  "valid_until" : "aeiou",
  "name" : "aeiou",
  "customer_name" : "aeiou",
  "sockets" : 123,
  "throughput" : 123,
  "license_tier" : [ "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 ControllerLicense

401

log in failed

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

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

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.
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",
  "max_apps" : 123,
  "uuid" : "aeiou",
  "backend_servers" : 123,
  "url" : "aeiou",
  "licenses" : [ {
    "start_on" : "aeiou",
    "enforced_params" : [ "aeiou" ],
    "license_type" : "aeiou",
    "max_apps" : 123,
    "license_string" : "aeiou",
    "version" : "aeiou",
    "backend_servers" : 123,
    "license_name" : "aeiou",
    "cores" : 123,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "created_on" : "aeiou",
    "license_id" : "aeiou",
    "last_update" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "throughput" : 123,
    "license_tier" : [ "aeiou" ]
  } ],
  "max_vses" : 123,
  "cores" : 123,
  "max_ses" : 123,
  "valid_until" : "aeiou",
  "name" : "aeiou",
  "customer_name" : "aeiou",
  "sockets" : 123,
  "throughput" : 123,
  "license_tier" : [ "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 ControllerLicense

401

log in failed

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

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",
  "max_apps" : 123,
  "uuid" : "aeiou",
  "backend_servers" : 123,
  "url" : "aeiou",
  "licenses" : [ {
    "start_on" : "aeiou",
    "enforced_params" : [ "aeiou" ],
    "license_type" : "aeiou",
    "max_apps" : 123,
    "license_string" : "aeiou",
    "version" : "aeiou",
    "backend_servers" : 123,
    "license_name" : "aeiou",
    "cores" : 123,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "created_on" : "aeiou",
    "license_id" : "aeiou",
    "last_update" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "throughput" : 123,
    "license_tier" : [ "aeiou" ]
  } ],
  "max_vses" : 123,
  "cores" : 123,
  "max_ses" : 123,
  "valid_until" : "aeiou",
  "name" : "aeiou",
  "customer_name" : "aeiou",
  "sockets" : 123,
  "throughput" : 123,
  "license_tier" : [ "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 ControllerLicense

401

log in failed

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

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",
  "max_apps" : 123,
  "uuid" : "aeiou",
  "backend_servers" : 123,
  "url" : "aeiou",
  "licenses" : [ {
    "start_on" : "aeiou",
    "enforced_params" : [ "aeiou" ],
    "license_type" : "aeiou",
    "max_apps" : 123,
    "license_string" : "aeiou",
    "version" : "aeiou",
    "backend_servers" : 123,
    "license_name" : "aeiou",
    "cores" : 123,
    "max_ses" : 123,
    "valid_until" : "aeiou",
    "created_on" : "aeiou",
    "license_id" : "aeiou",
    "last_update" : "aeiou",
    "customer_name" : "aeiou",
    "sockets" : 123,
    "throughput" : 123,
    "license_tier" : [ "aeiou" ]
  } ],
  "max_vses" : 123,
  "cores" : 123,
  "max_ses" : 123,
  "valid_until" : "aeiou",
  "name" : "aeiou",
  "customer_name" : "aeiou",
  "sockets" : 123,
  "throughput" : 123,
  "license_tier" : [ "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 ControllerLicense

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. ControllerLicense
  2. ControllerLicenseApiResponse
  3. SingleLicense

ControllerLicense Up

backend_servers (optional)
Integer Number of backend_servers. format: int32
cores (optional)
Integer Number of service engine cores in non-container clouds. format: int32
customer_name
String customer_name of ControllerLicense.
license_tier (optional)
array[String] license_tier of ControllerLicense.
licenses (optional)
array[SingleLicense] Placeholder for description of property licenses of obj type ControllerLicense field type str type object
max_apps (optional)
Integer Number of max_apps. format: int32
max_ses (optional)
Integer Number of service engines hosts in container clouds. format: int32
max_vses (optional)
Integer Deprecated. format: int32
name (optional)
String Name of the object.
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.
throughput (optional)
Integer Number of throughput. format: int32
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

SingleLicense Up

backend_servers (optional)
Integer Number of backend_servers. format: int32
cores (optional)
Integer Number of service engine cores in non-container clouds. format: int32
created_on (optional)
String created_on of SingleLicense.
customer_name
String customer_name of SingleLicense.
enforced_params (optional)
array[String] enforced_params of SingleLicense.
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_apps (optional)
Integer Number of max_apps. format: int32
max_ses (optional)
Integer Number of service engines hosts in container clouds. format: int32
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.
throughput (optional)
Integer Number of throughput. format: int32
valid_until
String valid_until of SingleLicense.
version (optional)
String version of SingleLicense.