Skip to content

Tunnel

Create tunnel in a given namespace. If one already exist it will give a error.

ToolDescription
f5xc-api-network-tunnel-createCreate Tunnel.
f5xc-api-network-tunnel-getGET Tunnel.
f5xc-api-network-tunnel-listList Tunnel.
f5xc-api-network-tunnel-updateReplace Tunnel.
f5xc-api-network-tunnel-deleteDELETE Tunnel.
ParameterDescriptionExample
metadata.namespaceNamespace-
nameName-
namespaceNamespace-
metadata.nameName-
ParameterDescriptionExample
response_formatThe format in which the configuration object is to be fetched. This could be for example-
label_filterA LabelSelectorType expression that every item in list response will satisfy.-
report_fieldsThe report_fields parameter-
report_status_fieldsThe report_status_fields parameter-

This resource includes mutually exclusive configuration options:

OptionDescriptionRecommended
spec.local_ip.intf-
spec.local_ip.ip_address-
OptionDescriptionRecommended
spec.local_ip.ip_address.ip_address.ipv4-
spec.local_ip.ip_address.ip_address.ipv6-
OptionDescriptionRecommended
spec.local_ip.ip_address.virtual_network_type.public-
spec.local_ip.ip_address.virtual_network_type.site_local-
spec.local_ip.ip_address.virtual_network_type.site_local_inside-
OptionDescriptionRecommended
spec.params.ipsec.ipsec_psk.blindfold_secret_info-
spec.params.ipsec.ipsec_psk.clear_secret_info-

Ask Claude to help you work with Tunnel resources:

“Create a tunnel named ‘example’ in the ‘production’ namespace”

“List all tunnels in the ‘production’ namespace”

“Get details of the tunnel named ‘example’ in namespace ‘production‘“

Terminal window
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/tunnels" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json"
# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/tunnels/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json"
# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/tunnels" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @tunnel.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/tunnels/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"