datacenter_cluster_filer_vsans

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

Overview

Name	datacenter_cluster_filer_vsans
Type	Resource
Id	ovh.dedicated_cloud.datacenter_cluster_filer_vsans

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
cluster_id	integer	Id of Cluster. (wire: clusterId)
datacenter_id	integer	Id of the datacenter. (wire: datacenterId)
datastore_id	integer	Id of the vsan datastore. (wire: datastoreId)
datastore_name	string	Name of the datastore. (wire: datastoreName)
connection_state	string	Datastore connection state. (offline, online) (wire: connectionState)
space_free	number	Available space of this datastore, in GB (wire: spaceFree)
space_provisioned	number	Provisioned space of this datastore, in GB (wire: spaceProvisioned)
space_used	number	Used Space of this datastore, in GB (wire: spaceUsed)
vm_total	integer	Number of virtual machine on the datastore (wire: vmTotal)

list

vSAN datastore

Name	Datatype	Description
cluster_id	integer	Id of Cluster. (wire: clusterId)
datacenter_id	integer	Id of the datacenter. (wire: datacenterId)
datastore_id	integer	Id of the vsan datastore. (wire: datastoreId)
datastore_name	string	Name of the datastore. (wire: datastoreName)
connection_state	string	Datastore connection state. (offline, online) (wire: connectionState)
space_free	number	Available space of this datastore, in GB (wire: spaceFree)
space_provisioned	number	Provisioned space of this datastore, in GB (wire: spaceProvisioned)
space_used	number	Used Space of this datastore, in GB (wire: spaceUsed)
vm_total	integer	Number of virtual machine on the datastore (wire: vmTotal)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, datacenter_id, datastore_id, service_name		Get a vSAN datastore. Returns the vSAN datastore: used, free and provisioned space, connection state and number of virtual machines.
list	select	cluster_id, datacenter_id, service_name	x_pagination_mode	List vSAN datastores

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"}})
cluster_id	integer	Id of the cluster (wire: clusterId)
datacenter_id	integer	Id of the Datacenter (wire: datacenterId)
datastore_id	integer	Id of the vsan datastore. (wire: datastoreId)
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 vSAN datastore. Returns the vSAN datastore: used, free and provisioned space, connection state and number of virtual machines.

SELECT
cluster_id,
datacenter_id,
datastore_id,
datastore_name,
connection_state,
space_free,
space_provisioned,
space_used,
vm_total
FROM ovh.dedicated_cloud.datacenter_cluster_filer_vsans
WHERE cluster_id = '{{ cluster_id }}' -- required
AND datacenter_id = '{{ datacenter_id }}' -- required
AND datastore_id = '{{ datastore_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List vSAN datastores

SELECT
cluster_id,
datacenter_id,
datastore_id,
datastore_name,
connection_state,
space_free,
space_provisioned,
space_used,
vm_total
FROM ovh.dedicated_cloud.datacenter_cluster_filer_vsans
WHERE cluster_id = '{{ cluster_id }}' -- required
AND datacenter_id = '{{ datacenter_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;