Managed Tenant
Managed Tenant provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-tenantandidentity-managed-tenant-create | Create Managed Tenant. |
f5xc-api-tenantandidentity-managed-tenant-get | Get Managed Tenant. |
f5xc-api-tenantandidentity-managed-tenant-list | List of Managed Tenant By User For Support Operations. |
f5xc-api-tenantandidentity-managed-tenant-update | Update Managed Tenant. |
f5xc-api-tenantandidentity-managed-tenant-delete | Delete Managed Tenant. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”| Parameter | Description | Example |
|---|---|---|
namespace | Namespace This defines the workspace within which each the configuration object is to be created. | system |
name | Name The name of the configuration object to be fetched. | example-resource |
Query Parameters
Section titled “Query Parameters”| Parameter | Description | Example |
|---|---|---|
response_format | The format in which the configuration object is to be fetched. This could be for example - in GetSpec form for the contents of object… | GET_RSP_FORMAT_DEFAULT |
page_limit | PageLimit will hold the limit of items required per query. Default value is set as 100. | - |
page_start | PageStart will hold the UUID of the first item in the requested page. Response will contain items upto count specified in PageLimit starting from PageStart. | - |
search_keyword | Search Keyword for filtering the Managed Tenant List. | - |
Configuration Choices
Section titled “Configuration Choices”This resource includes mutually exclusive configuration options:
tenant_choice
Section titled “tenant_choice”| Option | Description | Recommended |
|---|---|---|
spec.tenant_id | Tenant id |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Managed Tenant resources:
Create Managed Tenant
Section titled “Create Managed Tenant”“Create a managed-tenant named ‘example’ in the ‘production’ namespace”
List Managed Tenants
Section titled “List Managed Tenants”“List all managed-tenants in the ‘production’ namespace”
Get Managed Tenant Details
Section titled “Get Managed Tenant Details”“Get details of the managed-tenant named ‘example’ in namespace ‘production‘“
CURL Examples
Section titled “CURL Examples”# List resourcescurl -X GET "https://${TENANT}.console.ves.volterra.io/api/web/namespaces/system/support-tenant/managed_tenants" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/web/namespaces/$${PARAM}/managed_tenants/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/web/namespaces/$${PARAM}/managed_tenants" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @managed_tenant.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/web/namespaces/$${PARAM}/managed_tenants/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"