filers

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

Overview

Name	filers
Type	Resource
Id	ovh.dedicated_cloud.filers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Filer name
filer_id	integer	Filer Id (wire: filerId)
resource_name	string	Resource name (wire: resourceName)
active_node	string	Filer active node. (master, slave) (wire: activeNode)
billing_type	string	Billing type of this filer (freeSpare, hourly, monthly, undefined) (wire: billingType)
connection_state	string	Filer connexion state. (offline, online) (wire: connectionState)
full_profile	string	Human-Readable profile name (wire: fullProfile)
is_managed_by_ovh	boolean	Filer accessibility (if true, customer cannot access it) (wire: isManagedByOvh)
master	string	Filer master node hostname.
profile	string	Commercial profile name
size	object	Filer capacity
slave	string	Filer slave node hostname.
space_free	number	Available space of this datastore, in GB (wire: spaceFree)
space_provisionned	number	Provisionned space of this datastore, in GB (wire: spaceProvisionned)
space_used	number	Used Space of this filer, in GB (wire: spaceUsed)
state	string	State of the filer (adding, delivered, error, removing, unknown)
vm_total	integer	Number of virtual machine on the filer (wire: vmTotal)

list

Datastore

Name	Datatype	Description
name	string	Filer name
filer_id	integer	Filer Id (wire: filerId)
resource_name	string	Resource name (wire: resourceName)
active_node	string	Filer active node. (master, slave) (wire: activeNode)
billing_type	string	Billing type of this filer (freeSpare, hourly, monthly, undefined) (wire: billingType)
connection_state	string	Filer connexion state. (offline, online) (wire: connectionState)
full_profile	string	Human-Readable profile name (wire: fullProfile)
is_managed_by_ovh	boolean	Filer accessibility (if true, customer cannot access it) (wire: isManagedByOvh)
master	string	Filer master node hostname.
profile	string	Commercial profile name
size	object	Filer capacity
slave	string	Filer slave node hostname.
space_free	number	Available space of this datastore, in GB (wire: spaceFree)
space_provisionned	number	Provisionned space of this datastore, in GB (wire: spaceProvisionned)
space_used	number	Used Space of this filer, in GB (wire: spaceUsed)
state	string	State of the filer (adding, delivered, error, removing, unknown)
vm_total	integer	Number of virtual machine on the filer (wire: vmTotal)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	filer_id, service_name		Get a datastore. Returns the datastore: profile, size, used, free and provisioned space, state and number of virtual machines.
list	select	service_name	x_pagination_mode	List global datastores
convert_to_global	exec	filerId, serviceName		Convert a datastore to global. Converts the datastore to a global datastore, mounted on all datacenters of the service. Returns a task to track progress.
remove	exec	filerId, serviceName		Remove a datastore

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"}})
filerId	integer	Filer Id
filer_id	integer	Filer Id (wire: filerId)
serviceName	string	Domain of the service
service_name	string	Domain of the service (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 datastore. Returns the datastore: profile, size, used, free and provisioned space, state and number of virtual machines.

SELECT
name,
filer_id,
resource_name,
active_node,
billing_type,
connection_state,
full_profile,
is_managed_by_ovh,
master,
profile,
size,
slave,
space_free,
space_provisionned,
space_used,
state,
vm_total
FROM ovh.dedicated_cloud.filers
WHERE filer_id = '{{ filer_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List global datastores

SELECT
name,
filer_id,
resource_name,
active_node,
billing_type,
connection_state,
full_profile,
is_managed_by_ovh,
master,
profile,
size,
slave,
space_free,
space_provisionned,
space_used,
state,
vm_total
FROM ovh.dedicated_cloud.filers
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

convert_to_global

Convert a datastore to global. Converts the datastore to a global datastore, mounted on all datacenters of the service. Returns a task to track progress.

EXEC ovh.dedicated_cloud.filers.convert_to_global 
@filerId='{{ filerId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

remove

Remove a datastore

EXEC ovh.dedicated_cloud.filers.remove 
@filerId='{{ filerId }}' --required, 
@serviceName='{{ serviceName }}' --required
;