Skip to main content

lab_agreements

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

Overview​

Namelab_agreements
TypeResource
Idovh.cloud.lab_agreements

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
acceptedarrayList of agreements already accepted to activate the lab
to_acceptarrayList of agreements to accept before activate the lab (wire: toAccept)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectlab_id, service_nameList required agreements to active this lab (Beta version)

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.

NameDatatypeDescription
api_hoststringThe 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"}})
lab_idstringLab ID (wire: labId)
service_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples​

List required agreements to active this lab (Beta version)

SELECT
accepted,
to_accept
FROM ovh.cloud.lab_agreements
WHERE lab_id = '{{ lab_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;