zones

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

Overview

Name	zones
Type	Resource
Id	ovh.ip_loadbalancing.zones

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of your zone
state	string	State of your zone

list

IP Load Balancing Zone

Name	Datatype	Description
name	string	Name of your zone
state	string	State of your zone

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, service_name		Get a zone
list	select	service_name	x_pagination_mode	List zones
cancel_termination	exec	name, serviceName		Cancel a zone option termination
terminate	exec	name, serviceName		Terminate a zone option

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"}})
name	string	Name of your zone
serviceName	string	The internal name of your IP load balancing
service_name	string	The internal name of your IP load balancing (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a zone

SELECT
name,
state
FROM ovh.ip_loadbalancing.zones
WHERE name = '{{ name }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List zones

SELECT
name,
state
FROM ovh.ip_loadbalancing.zones
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

cancel_termination

Cancel a zone option termination

EXEC ovh.ip_loadbalancing.zones.cancel_termination 
@name='{{ name }}' --required, 
@serviceName='{{ serviceName }}' --required
;

terminate

Terminate a zone option

EXEC ovh.ip_loadbalancing.zones.terminate 
@name='{{ name }}' --required, 
@serviceName='{{ serviceName }}' --required
;