Advertise Policy¶

High Risk Operation

This resource includes operations that may cause significant changes. Review carefully before executing.

Confirmation Required

Some operations on this resource require explicit confirmation before execution.

Advertise_policy object controls how and where a service represented by a given virtual_host object is advertised to consumers.

Tools¶

Tool	Description
`f5xc-api-network-advertise-policy-create`	Create Advertise Policy.
`f5xc-api-network-advertise-policy-get`	GET Advertise Policy.
`f5xc-api-network-advertise-policy-list`	List Advertise Policy.
`f5xc-api-network-advertise-policy-update`	Replace Advertise Policy.
`f5xc-api-network-advertise-policy-delete`	DELETE Advertise Policy.

Parameters¶

Path Parameters¶

Parameter	Description	Example
`metadata.namespace`	Namespace	`-`
`name`	Name	`-`
`namespace`	Namespace	`-`
`metadata.name`	Name	`-`

Query Parameters¶

Parameter	Description	Example
`response_format`	The format in which the configuration object is to be fetched. This could be for example	`-`
`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	`-`

Side Effects¶

Operations on this resource may have the following effects:

Creates:

advertise-policy

Modifies:

advertise-policy

Deletes:

advertise-policy
contained_resources

Example Usage¶

Ask Claude to help you work with Advertise Policy resources:

Create Advertise Policy¶

"Create a advertise-policy named 'example' in the 'production' namespace"

List Advertise Policys¶

"List all advertise-policys in the 'production' namespace"

Get Advertise Policy Details¶

"Get details of the advertise-policy named 'example' in namespace 'production'"

CURL Examples¶

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/advertise_policys" \
  -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}/advertise_policys/<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}/advertise_policys" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @advertise_policy.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/advertise_policys/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"