Skip to content

Commit 820f259

Browse files
authored
Merge pull request #7925 from ovh/ds-spla-licence-fix
Guide update - Monitor Windows Licence and activate SPLA - SK-2048
2 parents 2afeb47 + 1216341 commit 820f259

22 files changed

+1322
-288
lines changed
Lines changed: 89 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,93 @@
11
---
2-
title: How to manage Windows licenses for virtual machines on your Hosted Private Cloud infrastructure
3-
excerpt: Find out how to manage Windows licenses for virtual machines on your OVHcloud Hosted Private Cloud infrastructure
4-
updated: 2024-05-23
2+
title: "How to manage Windows licences for virtual machines on your Hosted Private Cloud infrastructure"
3+
excerpt: "Learn how to track and activate Windows licences for your virtual machines using the OVHcloud Control Panel or API"
4+
updated: 2025-05-28
55
---
66

77
## Objective
88

9-
This guide explains how to manage Windows licenses for your virtual machines hosted on your Hosted Private Cloud infrastructure.
9+
This guide explains how to manage Windows licences for your virtual machines hosted on your Hosted Private Cloud infrastructure.
10+
11+
The [OVHcloud Control Panel](/links/manager) now includes a new feature, which allows you to:
12+
13+
- View the number of Windows virtual machines requiring a licence.
14+
- Instantly activate a licence on eligible VMs from the interface.
15+
16+
This gives you better visibility, reduces the need for API calls and helps ensure compliance with Microsoft licensing requirements.
1017

1118
> [!warning]
1219
>
13-
> OVHcloud allows you to ease the management and billing of your Windows licenses by allowing you to tell us which virtual machines require the use of a license.
20+
> OVHcloud simplifies the management and billing of your Windows licences by allowing you to tell us which virtual machines require the use of a licence.
1421
>
1522
> However, you remain responsible for the accuracy of the data you provide to us, and OVHcloud cannot be held liable for any unauthorized use of a Windows system on your part.
1623
1724
## Requirements
1825

19-
- [Windows licenses activated](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud#licence-windows) in your [OVHcloud Control Panel](/links/manager)
26+
- A Hosted Private Cloud service powered by VMware.
27+
- At least one virtual machine running a Windows operating system.
28+
- You must have activated the **Windows licences** in your [OVHcloud Control Panel](/links/manager). See the "Windows Licence" section of our guide "[Introduction to the Hosted Private Cloud Control Panel](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/)" for more information.
2029

2130
## Instructions
2231

23-
### List virtual machines with a license
32+
### Activate and monitor Windows licences directly from the OVHcloud Control Panel
33+
34+
> [!primary]
35+
>
36+
> This feature only applies if you want OVHcloud to licence your Windows VMs via SPLA.
37+
> If you bring your own licence (BYOL), you do not need to activate anything in the [OVHcloud Control Panel](/links/manager).
38+
39+
#### Check your Windows licence usage in the Control Panel
40+
41+
1. Go to the `Hosted Private Cloud`{.action} section of your [OVHcloud Control Panel](/links/manager) and click `Managed VMware vSphere`{.action}.
42+
43+
2. Select your service, then open the `Datacenter`{.action} tab.
44+
45+
Here, you will find:
46+
47+
- The **total number of VMs** running in your datacenter.
48+
- The **number of Windows VMs** (requiring a licence).
49+
- The **number of declared Windows VMs** (licenced by OVHcloud).
50+
51+
![Licence overview](images/licence-visibility-EN.png).{thumbnail}
52+
53+
> [!primary]
54+
>
55+
> Activating the licence in the [OVHcloud Control Panel](/links/manager) is only required if you want OVHcloud to provide a Windows SPLA licence for the VM.
56+
57+
#### Understand the two Windows licence management modes
58+
59+
There are two scenarios:
60+
61+
- **Case 1: You bring your own Microsoft licence (BYOL):**
62+
→ No action required in the interface.
63+
64+
- **Case 2: You want OVHcloud to licence the VM:**
65+
→ The VM licence must be activated in the [OVHcloud Control Panel](/links/manager) for it to be billed properly.
66+
67+
#### Activate a Windows licence from the OVHcloud Control Panel
68+
69+
1. In your `Datacenter`, go to the `Virtual Machines`{.action} tab.
70+
2. Locate the VM that needs to be licenced.
71+
3. Click `...`{.action} on the right, then click `Activate licence`{.action}.
72+
73+
![Activate licence](images/activate-licence-EN.png){.thumbnail}
74+
75+
4. Choose the appropriate licence from the dropdown menu.
76+
5. Click `Activate`{.action} to confirm the action.
2477

25-
You can quickly check which virtual machines in your infrastructure are licensed via the OVHcloud API:
78+
![Activate licence](images/select-licence-EN.png){.thumbnail}
79+
80+
> [!success]
81+
>
82+
> The VM is now declared and licenced by OVHcloud. It will appear in your billing and compliance tracking.
83+
84+
### Manage licences using the OVHcloud API
85+
86+
If you prefer to automate or integrate Windows licence management into your workflows, you can use the [OVHcloud API](/links/api) to list, assign, update or remove licences on your virtual machines.
87+
88+
#### List virtual machines with a licence
89+
90+
You can quickly check which virtual machines in your infrastructure are licenced via the OVHcloud API:
2691

2792
> [!api]
2893
>
@@ -42,16 +107,16 @@ You can quickly check which virtual machines in your infrastructure are licensed
42107
]
43108
```
44109

45-
### Verify the license of a virtual machine
110+
#### Verify the licence of a virtual machine
46111

47-
You can check the license currently associated with one of your virtual machines via the OVHcloud API:
112+
You can check the licence currently associated with one of your virtual machines via the OVHcloud API:
48113

49114
> [!api]
50115
>
51116
> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId}
52117
>
53118
54-
If no license is attached to it, the `license` field value will be `null`.
119+
If no licence is attached to it, the `license` field value will be `null`.
55120

56121
*Return example:*
57122

@@ -63,9 +128,9 @@ If no license is attached to it, the `license` field value will be `null`.
63128
}
64129
```
65130

66-
### Update the license of a virtual machine
131+
#### Update the licence of a virtual machine
67132

68-
You can update the license associated with one of your virtual machines via the OVHcloud API:
133+
You can update the licence associated with one of your virtual machines via the OVHcloud API:
69134

70135
> [!api]
71136
>
@@ -74,23 +139,27 @@ You can update the license associated with one of your virtual machines via the
74139
75140
> [!primary]
76141
>
77-
> Virtual machines deployed from [VMware content libraries](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_content_library) are automatically attached to a corresponding Windows license.
142+
> Virtual machines deployed from [VMware content libraries](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_content_library) are automatically attached to a corresponding Windows licence.
78143
79144
> [!warning]
80145
>
81-
> In order to avoid the incorrect allocation of a Windows license on a virtual machine, the API call above will return an error in the case where the virtual machine has been configured for a different operating system from your vSphere interface.
146+
> In order to avoid the incorrect allocation of a Windows licence on a virtual machine, the API call above will return an error in the case where the virtual machine has been configured for a different operating system from your vSphere interface.
82147
>
83148
> You can resolve this by changing the VM settings or you can choose to ignore this error by passing the option `bypassGuestOsFamilyCheck`.
84149
85-
### Unlicense a virtual machine
150+
#### Unlicence a virtual machine
86151

87-
You can delete the license associated with one of your virtual machines via the OVHcloud API:
152+
You can delete the licence associated with one of your virtual machines via the OVHcloud API:
88153

89154
> [!api]
90155
>
91156
> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId}/removeLicense
92157
>
93158
94-
## Go further
95-
96-
Join our community of users on <https://community.ovh.com/en/>.
159+
## Go further <a name="go-further"></a>
160+
161+
For specialised services (SEO, development, etc.), contact [OVHcloud partners](/links/partner).
162+
163+
If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support).
164+
165+
Join our [community of users](/links/community).
Lines changed: 89 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,93 @@
11
---
2-
title: How to manage Windows licenses for virtual machines on your Hosted Private Cloud infrastructure
3-
excerpt: Find out how to manage Windows licenses for virtual machines on your OVHcloud Hosted Private Cloud infrastructure
4-
updated: 2024-05-23
2+
title: "How to manage Windows licences for virtual machines on your Hosted Private Cloud infrastructure"
3+
excerpt: "Learn how to track and activate Windows licences for your virtual machines using the OVHcloud Control Panel or API"
4+
updated: 2025-05-28
55
---
66

77
## Objective
88

9-
This guide explains how to manage Windows licenses for your virtual machines hosted on your Hosted Private Cloud infrastructure.
9+
This guide explains how to manage Windows licences for your virtual machines hosted on your Hosted Private Cloud infrastructure.
10+
11+
The [OVHcloud Control Panel](/links/manager) now includes a new feature, which allows you to:
12+
13+
- View the number of Windows virtual machines requiring a licence.
14+
- Instantly activate a licence on eligible VMs from the interface.
15+
16+
This gives you better visibility, reduces the need for API calls and helps ensure compliance with Microsoft licensing requirements.
1017

1118
> [!warning]
1219
>
13-
> OVHcloud allows you to ease the management and billing of your Windows licenses by allowing you to tell us which virtual machines require the use of a license.
20+
> OVHcloud simplifies the management and billing of your Windows licences by allowing you to tell us which virtual machines require the use of a licence.
1421
>
1522
> However, you remain responsible for the accuracy of the data you provide to us, and OVHcloud cannot be held liable for any unauthorized use of a Windows system on your part.
1623
1724
## Requirements
1825

19-
- [Windows licenses activated](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud#licence-windows) in your [OVHcloud Control Panel](/links/manager)
26+
- A Hosted Private Cloud service powered by VMware.
27+
- At least one virtual machine running a Windows operating system.
28+
- You must have activated the **Windows licences** in your [OVHcloud Control Panel](/links/manager). See the "Windows Licence" section of our guide "[Introduction to the Hosted Private Cloud Control Panel](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/)" for more information.
2029

2130
## Instructions
2231

23-
### List virtual machines with a license
32+
### Activate and monitor Windows licences directly from the OVHcloud Control Panel
33+
34+
> [!primary]
35+
>
36+
> This feature only applies if you want OVHcloud to licence your Windows VMs via SPLA.
37+
> If you bring your own licence (BYOL), you do not need to activate anything in the [OVHcloud Control Panel](/links/manager).
38+
39+
#### Check your Windows licence usage in the Control Panel
40+
41+
1. Go to the `Hosted Private Cloud`{.action} section of your [OVHcloud Control Panel](/links/manager) and click `Managed VMware vSphere`{.action}.
42+
43+
2. Select your service, then open the `Datacenter`{.action} tab.
44+
45+
Here, you will find:
46+
47+
- The **total number of VMs** running in your datacenter.
48+
- The **number of Windows VMs** (requiring a licence).
49+
- The **number of declared Windows VMs** (licenced by OVHcloud).
50+
51+
![Licence overview](images/licence-visibility-EN.png).{thumbnail}
52+
53+
> [!primary]
54+
>
55+
> Activating the licence in the [OVHcloud Control Panel](/links/manager) is only required if you want OVHcloud to provide a Windows SPLA licence for the VM.
56+
57+
#### Understand the two Windows licence management modes
58+
59+
There are two scenarios:
60+
61+
- **Case 1: You bring your own Microsoft licence (BYOL):**
62+
→ No action required in the interface.
63+
64+
- **Case 2: You want OVHcloud to licence the VM:**
65+
→ The VM licence must be activated in the [OVHcloud Control Panel](/links/manager) for it to be billed properly.
66+
67+
#### Activate a Windows licence from the OVHcloud Control Panel
68+
69+
1. In your `Datacenter`, go to the `Virtual Machines`{.action} tab.
70+
2. Locate the VM that needs to be licenced.
71+
3. Click `...`{.action} on the right, then click `Activate licence`{.action}.
72+
73+
![Activate licence](images/activate-licence-EN.png){.thumbnail}
74+
75+
4. Choose the appropriate licence from the dropdown menu.
76+
5. Click `Activate`{.action} to confirm the action.
2477

25-
You can quickly check which virtual machines in your infrastructure are licensed via the OVHcloud API:
78+
![Activate licence](images/select-licence-EN.png){.thumbnail}
79+
80+
> [!success]
81+
>
82+
> The VM is now declared and licenced by OVHcloud. It will appear in your billing and compliance tracking.
83+
84+
### Manage licences using the OVHcloud API
85+
86+
If you prefer to automate or integrate Windows licence management into your workflows, you can use the [OVHcloud API](/links/api) to list, assign, update or remove licences on your virtual machines.
87+
88+
#### List virtual machines with a licence
89+
90+
You can quickly check which virtual machines in your infrastructure are licenced via the OVHcloud API:
2691

2792
> [!api]
2893
>
@@ -42,16 +107,16 @@ You can quickly check which virtual machines in your infrastructure are licensed
42107
]
43108
```
44109

45-
### Verify the license of a virtual machine
110+
#### Verify the licence of a virtual machine
46111

47-
You can check the license currently associated with one of your virtual machines via the OVHcloud API:
112+
You can check the licence currently associated with one of your virtual machines via the OVHcloud API:
48113

49114
> [!api]
50115
>
51116
> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId}
52117
>
53118
54-
If no license is attached to it, the `license` field value will be `null`.
119+
If no licence is attached to it, the `license` field value will be `null`.
55120

56121
*Return example:*
57122

@@ -63,9 +128,9 @@ If no license is attached to it, the `license` field value will be `null`.
63128
}
64129
```
65130

66-
### Update the license of a virtual machine
131+
#### Update the licence of a virtual machine
67132

68-
You can update the license associated with one of your virtual machines via the OVHcloud API:
133+
You can update the licence associated with one of your virtual machines via the OVHcloud API:
69134

70135
> [!api]
71136
>
@@ -74,23 +139,27 @@ You can update the license associated with one of your virtual machines via the
74139
75140
> [!primary]
76141
>
77-
> Virtual machines deployed from [VMware content libraries](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_content_library) are automatically attached to a corresponding Windows license.
142+
> Virtual machines deployed from [VMware content libraries](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_content_library) are automatically attached to a corresponding Windows licence.
78143
79144
> [!warning]
80145
>
81-
> In order to avoid the incorrect allocation of a Windows license on a virtual machine, the API call above will return an error in the case where the virtual machine has been configured for a different operating system from your vSphere interface.
146+
> In order to avoid the incorrect allocation of a Windows licence on a virtual machine, the API call above will return an error in the case where the virtual machine has been configured for a different operating system from your vSphere interface.
82147
>
83148
> You can resolve this by changing the VM settings or you can choose to ignore this error by passing the option `bypassGuestOsFamilyCheck`.
84149
85-
### Unlicense a virtual machine
150+
#### Unlicence a virtual machine
86151

87-
You can delete the license associated with one of your virtual machines via the OVHcloud API:
152+
You can delete the licence associated with one of your virtual machines via the OVHcloud API:
88153

89154
> [!api]
90155
>
91156
> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId}/removeLicense
92157
>
93158
94-
## Go further
95-
96-
Join our community of users on <https://community.ovh.com/en/>.
159+
## Go further <a name="go-further"></a>
160+
161+
For specialised services (SEO, development, etc.), contact [OVHcloud partners](/links/partner).
162+
163+
If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support).
164+
165+
Join our [community of users](/links/community).

0 commit comments

Comments
 (0)