Tunnel
Tunnel provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-network-tunnel-create | Create Tunnel. |
f5xc-api-network-tunnel-get | Get Tunnel. |
f5xc-api-network-tunnel-list | List Tunnel. |
f5xc-api-network-tunnel-update | Update Tunnel. |
f5xc-api-network-tunnel-delete | Delete Tunnel. |
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 Tunnel resources:
Create Tunnel
Section titled “Create Tunnel”“Create a tunnel named ‘example’ in the ‘production’ namespace”
List Tunnels
Section titled “List Tunnels”“List all tunnels in the ‘production’ namespace”
Get Tunnel Details
Section titled “Get Tunnel Details”“Get details of the tunnel 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}/tunnels" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/tunnels/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/tunnels" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @tunnel.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/tunnels/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"