module_lists

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

Overview

Name	module_lists
Type	Resource
Id	ovh.hosting_web.module_lists

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	The ID of the module
name	string	The name of the module
active	boolean	Is the module available?
admin_name_type	string	The type of the admin name (email, string) (wire: adminNameType)
author	string	The packager of this module for OVH
branch	string	The branch of the module (old, stable, testing)
keywords	array	The keywords for this module
language	array	All available languages for this module
language_requirement	object	Minimal language version required to run this module (wire: languageRequirement)
latest	boolean	Is this the latest version available?
size	object	Size of the module
upgrade_from	array	The IDs of the module you can upgrade to (wire: upgradeFrom)
version	string	The version of the module

list

A module specifically packaged by OVH

Name	Datatype	Description
id	integer	The ID of the module
name	string	The name of the module
active	boolean	Is the module available?
admin_name_type	string	The type of the admin name (email, string) (wire: adminNameType)
author	string	The packager of this module for OVH
branch	string	The branch of the module (old, stable, testing)
keywords	array	The keywords for this module
language	array	All available languages for this module
language_requirement	object	Minimal language version required to run this module (wire: languageRequirement)
latest	boolean	Is this the latest version available?
size	object	Size of the module
upgrade_from	array	The IDs of the module you can upgrade to (wire: upgradeFrom)
version	string	The version of the module

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get an available module. Returns the name, version, branch, languages and requirements of the module, and the modules it can be upgraded to.
list	select		active, branch, latest, x_pagination_mode	List available modules. Returns the IDs of the modules that can be installed. Filter them by active, branch or latest.

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"}})
id	integer	The ID of the module
active	boolean	Filter the value of active property (=)
branch	string	Filter the value of branch property (=)
latest	boolean	Filter the value of latest property (=)
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 an available module. Returns the name, version, branch, languages and requirements of the module, and the modules it can be upgraded to.

SELECT
id,
name,
active,
admin_name_type,
author,
branch,
keywords,
language,
language_requirement,
latest,
size,
upgrade_from,
version
FROM ovh.hosting_web.module_lists
WHERE id = '{{ id }}' -- required
;

list

List available modules. Returns the IDs of the modules that can be installed. Filter them by active, branch or latest.

SELECT
id,
name,
active,
admin_name_type,
author,
branch,
keywords,
language,
language_requirement,
latest,
size,
upgrade_from,
version
FROM ovh.hosting_web.module_lists
WHERE active = '{{ active }}'
AND branch = '{{ branch }}'
AND latest = '{{ latest }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;