security_options_compatibility_matrices

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

Overview

Name	security_options_compatibility_matrices
Type	Resource
Id	ovh.dedicated_cloud.security_options_compatibility_matrices

Fields

The following fields are returned by SELECT queries:

list

Representation of a security option

Name	Datatype	Description
name	string	Security option name (accessNetworkFiltered, advancedSecurity, base, contentLibrary, grsecKernel, hds, hids, hipaa, logForwarder, nids, pcidss, privateCustomerVlan, privateGw, sendLogToCustomer, sessionTimeout, sftp, snc, spla, sslV3, tls1.2, tokenValidation, twoFa, twoFaFail2ban, vrliForwarder, waf)
compatible	boolean	Indicates if option is compatible and can be enabled on your Dedicated Cloud
description	string	Security option description
enabled	boolean	Indicates if option is enabled on your Dedicated Cloud
reason	object	If your Dedicated Cloud is not compatible with this option, indicates the reason
state	string	Detailed security option state (creating, deleted, deleting, delivered, disabled, pending, toCreate, updating)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	service_name	show_incompatible, show_internal	List security options. Returns each security option with its state, whether it is enabled and compatible, and the reason when it is not compatible.

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"}})
service_name	string	Domain of the service (wire: serviceName)
show_incompatible	boolean	Show incompatible security options (enabled by default) (wire: showIncompatible)
show_internal	boolean	Show internal security options (wire: showInternal)

SELECT examples

list

List security options. Returns each security option with its state, whether it is enabled and compatible, and the reason when it is not compatible.

SELECT
name,
compatible,
description,
enabled,
reason,
state
FROM ovh.dedicated_cloud.security_options_compatibility_matrices
WHERE service_name = '{{ service_name }}' -- required
AND show_incompatible = '{{ show_incompatible }}'
AND show_internal = '{{ show_internal }}'
;