Skip to main content

migration_offers

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

Overview​

Namemigration_offers
TypeResource
Idovh.over_the_box.migration_offers

Fields​

The following fields are returned by SELECT queries:

Migration offer

NameDatatypeDescription
hardware_namestringName of the hardware (wire: hardwareName)
current_offer_priceobjectMonthly price of the current offer (wire: currentOfferPrice)
descriptionstringDescription of the offer
engagement_monthsintegerNumber of months of engagement (wire: engagementMonths)
hardware_availablebooleanSpecify if a hardware is available (wire: hardwareAvailable)
hardware_priceobjectHardware purchase price (wire: hardwarePrice)
hardwaresarrayDetails of available hardwares
offerstringName of the offer
priceobjectMonthly price of the new offer

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectservice_nameList 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.

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_namestringThe internal name of your overTheBox offer (wire: serviceName)

SELECT examples​

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
;