Bigip Virtual Server

Bigip Virtual Server provides tools for listing, retrieving, and updating resources in F5 Distributed Cloud.

Tools

Tool	Description
`f5xc-api-bigip-bigip-virtual-server-get`	Get BIG-IP virtual server.
`f5xc-api-bigip-bigip-virtual-server-list`	List BIG-IP virtual server.
`f5xc-api-bigip-bigip-virtual-server-update`	Update BIG-IP virtual server.

Parameters

Path Parameters

Parameter	Description	Example
`name`	Name The name of the configuration object to be fetched.	`example-resource`
`namespace`	Namespace The namespace in which the configuration object is present.	`system`

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…	`-`

Configuration Choices

This resource includes mutually exclusive configuration options:

api_definition_choice

Option	Description	Recommended
`spec.api_specification`	Api specification
`spec.disable_api_definition`	Disable api definition

api_discovery_choice

Option	Description	Recommended
`spec.disable_api_discovery`	Disable api discovery
`spec.enable_api_discovery`	Enable api discovery

sensitive_data_policy_choice

Option	Description	Recommended
`spec.default_sensitive_data_policy`	Default sensitive data policy
`spec.sensitive_data_policy`	Sensitive data policy

Example Usage

Ask Claude to help you work with Bigip Virtual Server resources:

List Bigip Virtual Servers

“List all bigip-virtual-servers in the ‘production’ namespace”

Get Bigip Virtual Server Details

“Get details of the bigip-virtual-server named ‘example’ in namespace ‘production‘“

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/bigip_virtual_servers" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/bigip_virtual_servers/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"