datacenter_vm_licenseds
Creates, updates, deletes, gets or lists a datacenter_vm_licenseds resource.
Overview​
| Name | datacenter_vm_licenseds |
| Type | Resource |
| Id | ovh.dedicated_cloud.datacenter_vm_licenseds |
Fields​
The following fields are returned by SELECT queries:
- list
A structure describing the licensing of a virtual machine
| Name | Datatype | Description |
|---|---|---|
name | string | Virtual machine name |
vm_id | integer | Virtual machine identifier (wire: vmId) |
guest_os_family | string | Guest Operating System reported by VMware tools (wire: guestOsFamily) |
license | string | Attached SPLA licensing (OVHcloud managed, unknown or unsupported license, unlicensed windows guestos, windows 2008 R2 Datacenter, windows 2008 R2 Enterprise, windows 2008 R2 Standard, windows 2008 R2 Web, windows 2012 Datacenter, windows 2012 R2 Datacenter, windows 2012 R2 Standard, windows 2012 R2 Standard SQL2016 Standard, windows 2012 R2 Standard SQL2016 Web, windows 2012 Standard, windows 2016 Datacenter, windows 2016 Standard, windows 2016 Standard SQL2016 Standard, windows 2016 Standard SQL2016 Web, windows 2019 Datacenter, windows 2019 Datacenter Core, windows 2019 Standard, windows 2019 Standard Core, windows 2019 Standard SQL2019 Standard, windows 2019 Standard SQL2019 Web, windows 2019 Standard SQL2022 Standard, windows 2019 Standard SQL2022 Web, windows 2022 Datacenter, windows 2022 Datacenter Core, windows 2022 Datacenter SQL2019 Standard, windows 2022 Datacenter SQL2019 Web, windows 2022 Datacenter SQL2022 Standard, windows 2022 Datacenter SQL2022 Web, windows 2022 Standard, windows 2022 Standard Core, windows 2022 Standard SQL2019 Standard, windows 2022 Standard SQL2019 Web, windows 2022 Standard SQL2022 Standard, windows 2022 Standard SQL2022 Web, windows 2025 Datacenter, windows 2025 Datacenter Core, windows 2025 Datacenter SQL2022 Enterprise, windows 2025 Datacenter SQL2022 Standard, windows 2025 Datacenter SQL2022 Web, windows 2025 Standard, windows 2025 Standard Core, windows 2025 Standard SQL2022 Standard, windows 2025 Standard SQL2022 Web) |
mo_ref | string | VMware Managed object Reference identifier (wire: moRef) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | datacenter_id, service_name | kms_license | List licensed VMs. Returns the virtual machines with a managed license, with their guest OS and license. Filter by license with kmsLicense. |
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"}}) |
datacenter_id | integer | Id of the Datacenter (wire: datacenterId) |
service_name | string | Domain of the service (wire: serviceName) |
kms_license | string | Only display virtual machines with this license (wire: kmsLicense) |
SELECT examples​
- list
List licensed VMs. Returns the virtual machines with a managed license, with their guest OS and license. Filter by license with kmsLicense.
SELECT
name,
vm_id,
guest_os_family,
license,
mo_ref
FROM ovh.dedicated_cloud.datacenter_vm_licenseds
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND kms_license = '{{ kms_license }}'
;