Avi Tenant Object API

##CLI## ``` - configure tenant - show tenant ```
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 /tenant
  2. post /tenant
  3. delete /tenant/{uuid}
  4. get /tenant/{uuid}
  5. patch /tenant/{uuid}
  6. put /tenant/{uuid}
Up
get /tenant
( tenantGet)

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

TenantApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "config_settings" : {
      "tenant_access_to_provider_se" : true,
      "se_in_provider_context" : true,
      "tenant_vrf" : true
    },
    "created_by" : "aeiou",
    "uuid" : "aeiou",
    "local" : true,
    "url" : "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 TenantApiResponse

401

log in failed

Up
post /tenant
( tenantPost)

Consumes

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

Request body

body (required)
Body Parameter — Tenant object creation

Return type

Tenant

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "description" : "aeiou",
  "config_settings" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "local" : true,
  "url" : "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 Tenant

401

log in failed

Up
delete /tenant/{uuid}
( tenantUuidDelete)

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 /tenant/{uuid}
( tenantUuidGet)

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

Tenant

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "description" : "aeiou",
  "config_settings" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "local" : true,
  "url" : "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 Tenant

401

log in failed

Up
patch /tenant/{uuid}
( tenantUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

Tenant

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "description" : "aeiou",
  "config_settings" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "local" : true,
  "url" : "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 Tenant

401

log in failed

Up
put /tenant/{uuid}
( tenantUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

Tenant

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "description" : "aeiou",
  "config_settings" : {
    "tenant_access_to_provider_se" : true,
    "se_in_provider_context" : true,
    "tenant_vrf" : true
  },
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "local" : true,
  "url" : "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 Tenant

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. Tenant
  2. TenantApiResponse
  3. TenantConfiguration

Tenant Up

config_settings (optional)
TenantConfiguration Placeholder for description of property config_settings of obj type Tenant field type str type object
created_by (optional)
String Creator of this tenant.
description (optional)
String User defined description for the object.
local (optional)
Boolean Placeholder for description of property local of obj type Tenant field type str type boolean
name
String Name of the object.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

TenantApiResponse Up

count
Integer format: int32
results

TenantConfiguration Up

se_in_provider_context (optional)
Boolean Controls the ownership of ServiceEngines. Service Engines can either be exclusively owned by each tenant or owned by the administrator and shared by all tenants. When ServiceEngines are owned by the administrator, each tenant can have either read access or no access to their Service Engines.
tenant_access_to_provider_se (optional)
Boolean Placeholder for description of property tenant_access_to_provider_se of obj type TenantConfiguration field type str type boolean
tenant_vrf (optional)
Boolean When 'Per Tenant IP Domain' is selected, each tenant gets its own routing domain that is not shared with any other tenant. When 'Share IP Domain across all tenants' is selected, all tenants share the same routing domain.