Child Tenant
Child Tenant provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-tenantandidentity-child-tenant-create | Child Tenant. |
f5xc-api-tenantandidentity-child-tenant-get | List child tenants for a given child tenant manager. |
f5xc-api-tenantandidentity-child-tenant-list | List of Child Tenants. |
f5xc-api-tenantandidentity-child-tenant-update | Update Child Tenant. |
f5xc-api-tenantandidentity-child-tenant-delete | Delete Child 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… | example-resource |
Query Parameters
Section titled “Query Parameters”| Parameter | Description | Example |
|---|---|---|
ctm | Name of the Child Tenant Manager. If this field set, child tenant list will be filtered by given CTM. | - |
name | Filter child tenant list using name of child tenant. | example-resource |
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. | - |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Child Tenant resources:
Create Child Tenant
Section titled “Create Child Tenant”“Create a child-tenant named ‘example’ in the ‘production’ namespace”
List Child Tenants
Section titled “List Child Tenants”“List all child-tenants in the ‘production’ namespace”
Get Child Tenant Details
Section titled “Get Child Tenant Details”“Get details of the child-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/partner-management/child_tenants" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/web/namespaces/system/partner-management/child_tenant_managers/$${PARAM}/child_tenants" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/web/namespaces/$${PARAM}/child_tenants" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @child_tenant.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/web/namespaces/$${PARAM}/child_tenants/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"