reference_rancher_plans

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

Overview

Name	reference_rancher_plans
Type	Resource
Id	ovh.public_cloud.reference_rancher_plans

Fields

The following fields are returned by SELECT queries:

list

A managed Rancher service plan reference, applicable to service creations

Name	Datatype	Description
name	string	Name of the plan (OVHCLOUD_EDITION, STANDARD)
cause	string	Cause for an unavailability (CANNOT_DOWNGRADE_USING_HIGHER_FEATURES, CANNOT_SWITCH_PLAN_FOR_ALPHA, NOT_IMPLEMENTED)
message	string	Human-readable description of the unavailability cause
status	string	Status of the plan (AVAILABLE, UNAVAILABLE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	project_id	x_pagination_cursor, x_pagination_size	Returns the plans available for creating a managed Rancher service, with their status and the cause when a plan is unavailable.

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"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

list

Returns the plans available for creating a managed Rancher service, with their status and the cause when a plan is unavailable.

SELECT
name,
cause,
message,
status
FROM ovh.public_cloud.reference_rancher_plans
WHERE project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;