available_farm_probes

Creates, updates, deletes, gets or lists an available_farm_probes resource.

Overview

Name	available_farm_probes
Type	Resource
Id	ovh.ip_loadbalancing.available_farm_probes

Fields

The following fields are returned by SELECT queries:

list

Available farm probes options

Name	Datatype	Description
matches	array	List of possible probe result checkers for this type of probe
method	array	List of available HTTP method, if available
negatable_matches	array	List of matches operators that accept the negate option for this type of probe (wire: negatableMatches)
port	boolean	True is this probe type supports a custom port
type	string	Probe protocol name. See probe "type" field in the farm probe
url	boolean	True is this probe type supports a URL

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	service_name		List available farm probes

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	The internal name of your IP load balancing (wire: serviceName)

SELECT examples

list

List available farm probes

SELECT
matches,
method,
negatable_matches,
port,
type,
url
FROM ovh.ip_loadbalancing.available_farm_probes
WHERE service_name = '{{ service_name }}' -- required
;