migration_offers
Creates, updates, deletes, gets or lists a migration_offers resource.
Overview​
| Name | migration_offers |
| Type | Resource |
| Id | ovh.over_the_box.migration_offers |
Fields​
The following fields are returned by SELECT queries:
- list
Migration offer
| Name | Datatype | Description |
|---|---|---|
hardware_name | string | Name of the hardware (wire: hardwareName) |
current_offer_price | object | Monthly price of the current offer (wire: currentOfferPrice) |
description | string | Description of the offer |
engagement_months | integer | Number of months of engagement (wire: engagementMonths) |
hardware_available | boolean | Specify if a hardware is available (wire: hardwareAvailable) |
hardware_price | object | Hardware purchase price (wire: hardwarePrice) |
hardwares | array | Details of available hardwares |
offer | string | Name of the offer |
price | object | Monthly price of the new offer |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | service_name | List the migration offers of an OverTheBox service. Returns the offers the service can migrate to, with their price, engagement and available hardware. |
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"}}) |
service_name | string | The internal name of your overTheBox offer (wire: serviceName) |
SELECT examples​
- list
List the migration offers of an OverTheBox service. Returns the offers the service can migrate to, with their price, engagement and available hardware.
SELECT
hardware_name,
current_offer_price,
description,
engagement_months,
hardware_available,
hardware_price,
hardwares,
offer,
price
FROM ovh.over_the_box.migration_offers
WHERE service_name = '{{ service_name }}' -- required
;