Avi Tenant Object API
CLI ``` - configure tenant - show tenant ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /tenantpost /tenantdelete /tenant/{uuid}get /tenant/{uuid}patch /tenant/{uuid}put /tenant/{uuid}
(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.
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
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"enforce_label_group" : true,
"suggested_object_labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"config_settings" : {
"tenant_access_to_provider_se" : true,
"se_in_provider_context" : true,
"tenant_vrf" : true
},
"created_by" : "aeiou",
"label_group_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"local" : true,
"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.
Responses
200
OK
TenantApiResponse
401
log in failed
(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
Example data
Content-Type: application/json
{
"enforce_label_group" : true,
"suggested_object_labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"config_settings" : {
"tenant_access_to_provider_se" : true,
"se_in_provider_context" : true,
"tenant_vrf" : true
},
"created_by" : "aeiou",
"label_group_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"local" : true,
"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.
Responses
200
OK
Tenant
401
log in failed
(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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
(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.
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
Example data
Content-Type: application/json
{
"enforce_label_group" : true,
"suggested_object_labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"config_settings" : {
"tenant_access_to_provider_se" : true,
"se_in_provider_context" : true,
"tenant_vrf" : true
},
"created_by" : "aeiou",
"label_group_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"local" : true,
"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.
Responses
200
OK
Tenant
401
log in failed
(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
Example data
Content-Type: application/json
{
"enforce_label_group" : true,
"suggested_object_labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"config_settings" : {
"tenant_access_to_provider_se" : true,
"se_in_provider_context" : true,
"tenant_vrf" : true
},
"created_by" : "aeiou",
"label_group_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"local" : true,
"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.
Responses
200
OK
Tenant
401
log in failed
(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
Example data
Content-Type: application/json
{
"enforce_label_group" : true,
"suggested_object_labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"config_settings" : {
"tenant_access_to_provider_se" : true,
"se_in_provider_context" : true,
"tenant_vrf" : true
},
"created_by" : "aeiou",
"label_group_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"local" : true,
"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.
Responses
200
OK
Tenant
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesTenantTenantApiResponseTenantConfigurationTenantLabel
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
config_settings (optional)
TenantConfiguration Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
created_by (optional)
String Creator of this tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enforce_label_group (optional)
Boolean The referred label groups are enforced on the tenant if this is set to true.If this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
label_group_refs (optional)
array[String] The label_groups to be enforced on the tenant. This is strictly enforced only if enforce_label_group is set to True. It is a reference to an object of type LabelGroup. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
local (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
suggested_object_labels (optional)
array[TenantLabel] Suggestive pool of key value pairs for recommending assignment of labels to objects in the User Interface. Every entry is unique in both key and value. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 256 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_access_to_provider_se (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Label key string. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
value (optional)
String Label value string. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.