Advertise Policy
Advertise Policy provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| 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 | Update Advertise Policy. |
f5xc-api-network-advertise-policy-delete | Delete Advertise Policy. |
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… | - |
Configuration Choices
Section titled “Configuration Choices”This resource includes mutually exclusive configuration options:
port_choice
Section titled “port_choice”| Option | Description | Recommended |
|---|---|---|
spec.port | Port | |
spec.port_ranges | Port ranges |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Advertise Policy resources:
Create Advertise Policy
Section titled “Create Advertise Policy”“Create a advertise-policy named ‘example’ in the ‘production’ namespace”
List Advertise Policys
Section titled “List Advertise Policys”“List all advertise-policys in the ‘production’ namespace”
Get Advertise Policy Details
Section titled “Get Advertise Policy Details”“Get details of the advertise-policy 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}/advertise_policys" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/advertise_policys/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/advertise_policys" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @advertise_policy.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/advertise_policys/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"