Cminstance
Cminstance provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-marketplace-cminstance-create | Create Central Manager Insatnce. |
f5xc-api-marketplace-cminstance-get | Get Central Manager Instance. |
f5xc-api-marketplace-cminstance-list | List Central Manager Instance. |
f5xc-api-marketplace-cminstance-update | Update Central Manager Instance. |
f5xc-api-marketplace-cminstance-delete | Delete Central Manager Instance. |
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 |
label_filter | A LabelSelectorType expression that every item in list response will satisfy. | - |
report_fields | The report_fields parameter… | - |
report_status_fields | The report_status_fields parameter… | - |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Cminstance resources:
Create Cminstance
Section titled “Create Cminstance”“Create a cminstance named ‘example’ in the ‘production’ namespace”
List Cminstances
Section titled “List Cminstances”“List all cminstances in the ‘production’ namespace”
Get Cminstance Details
Section titled “Get Cminstance Details”“Get details of the cminstance named ‘example’ in namespace ‘production‘“
CURL Examples
Section titled “CURL Examples”# List resourcescurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/cminstances" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/cminstances/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/cminstances" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @cminstance.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/cminstances/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"