Skip to main content

capabilities

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

Overview​

Namecapabilities
TypeResource
Idovh.dedicated_cloud.capabilities

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
add_ressource_right_statusstringcanAddRessource right order status in this VMware on OVHcloud (active, comingSoon, no) (wire: addRessourceRightStatus)
backup_statusstringBackup feature order status for this VMware on OVHcloud (active, comingSoon, no) (wire: backupStatus)
can_add_userbooleanif true user can be added in this VMware on OVHcloud (with POST /dedicatedCloud/{serviceName}/user (wire: canAddUser)
full_admin_ro_user_statusstringfullAdminRO user right order status in this VMware on OVHcloud (active, comingSoon, no) (wire: fullAdminRoUserStatus)
nexus_1000v_statusstringNexus 1000v feature order status in this VMware on OVHcloud ? (active, comingSoon, no) (wire: nexus1000vStatus)
upgradablebooleanHypervisor upgrade order status in this VMware on OVHcloud (upgrade with POST /dedicatedCloud/{serviceName}/upgradeHypervisor)
user_access_policy_statusstringuserAccessPolicy property edition status in PUT /dedicatedCloud/{serviceName} (active, comingSoon, no) (wire: userAccessPolicyStatus)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameGet the service capabilities. Returns which features can be ordered or used on the service, such as backup, user creation and hypervisor upgrade.

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_namestringDomain of the service (wire: serviceName)

SELECT examples​

Get the service capabilities. Returns which features can be ordered or used on the service, such as backup, user creation and hypervisor upgrade.

SELECT
add_ressource_right_status,
backup_status,
can_add_user,
full_admin_ro_user_status,
nexus_1000v_status,
upgradable,
user_access_policy_status
FROM ovh.dedicated_cloud.capabilities
WHERE service_name = '{{ service_name }}' -- required
;