vac_reference_profiles

Creates, updates, deletes, gets or lists a vac_reference_profiles resource.

Overview

Name	vac_reference_profiles
Type	Resource
Id	ovh.network_defense.vac_reference_profiles

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the profile
name	string	Profile name, for example DNS server
description	string	Human-readable description of the profile's intended use case
sensitivities	array	Sensitivity levels offered for this profile
state	string	Lifecycle state of the profile. Only RETIRED blocks new policy assignments. (ACTIVE, BETA, DEPRECATED, RETIRED)

list

A VAC profile: an expert-curated protection configuration for a workload type, for example DNS server, web server. Read-only catalog entry, filtered by per-customer eligibility.

Name	Datatype	Description
id	string	Unique identifier of the profile
name	string	Profile name, for example DNS server
description	string	Human-readable description of the profile's intended use case
sensitivities	array	Sensitivity levels offered for this profile
state	string	Lifecycle state of the profile. Only RETIRED blocks new policy assignments. (ACTIVE, BETA, DEPRECATED, RETIRED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	profile_id		Returns a VAC DDoS protection network traffic profile with its name, description, sensitivity levels and lifecycle state.
list	select		x_pagination_cursor, x_pagination_size	Returns the list of VAC DDoS protection network traffic profiles available to the account. Every profile is an expert-curated configuration for a workload type, such as a VPN or a Web Server, with the sensitivity levels it offers. A RETIRED profile cannot be assigned to a policy.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
profile_id	string	Profile ID (wire: profileId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns a VAC DDoS protection network traffic profile with its name, description, sensitivity levels and lifecycle state.

SELECT
id,
name,
description,
sensitivities,
state
FROM ovh.network_defense.vac_reference_profiles
WHERE profile_id = '{{ profile_id }}' -- required
;

list

Returns the list of VAC DDoS protection network traffic profiles available to the account. Every profile is an expert-curated configuration for a workload type, such as a VPN or a Web Server, with the sensitivity levels it offers. A RETIRED profile cannot be assigned to a policy.

SELECT
id,
name,
description,
sensitivities,
state
FROM ovh.network_defense.vac_reference_profiles
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;