Skip to main content

distribution_software

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

Overview​

Namedistribution_software
TypeResource
Idovh.vps.distribution_software

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idinteger
namestring
statusstringAvailable Status for a vps Software (deprecated, stable, testing)
typestringAvailable Type for a vps Software (database, environment, webserver)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_name, software_idReturns the name, type and status of a software available for the distribution of the VPS. (Deprecated, will be removed)
listselectservice_namex_pagination_modeReturns the IDs of the software available for the distribution of the VPS. (Deprecated, will be removed)

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"}})
service_namestringService name (wire: serviceName)
software_idintegerSoftware ID (wire: softwareId)
x_pagination_modestringSent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples​

Returns the name, type and status of a software available for the distribution of the VPS. (Deprecated, will be removed)

SELECT
id,
name,
status,
type
FROM ovh.vps.distribution_software
WHERE service_name = '{{ service_name }}' -- required
AND software_id = '{{ software_id }}' -- required
;