migration2020s

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

Overview

Name	migration2020s
Type	Resource
Id	ovh.vps.migration2020s

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
available_plans	array	List of available plans to migrate (wire: availablePlans)
current_plan	string	VPS current plan code (wire: currentPlan)
date	string (date-time)	Date of planned migration, null if not scheduled
position	integer	Position on the migration queue, null if not in queue
status	string	All status a migration task can be in (available, done, notAvailable, ongoing, planned, toPlan)
target_plan	string	VPS target plan code after migration (wire: targetPlan)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the state of the migration of the VPS 2020 to VPS 2025, with the current and target plans, the available plans, the position in the queue and the date.
create	insert	service_name, plan		Queues the VPS 2020 for migration to VPS 2025 with the given target plan and returns the migration state.
update	update	service_name		Updates the target plan of the pending migration of the VPS 2020 to VPS 2025 and returns the migration state.
delete	delete	service_name		Cancels the pending migration request of the VPS 2020 to VPS 2025.

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	Service name (wire: serviceName)

SELECT examples

get

Returns the state of the migration of the VPS 2020 to VPS 2025, with the current and target plans, the available plans, the position in the queue and the date.

SELECT
available_plans,
current_plan,
date,
position,
status,
target_plan
FROM ovh.vps.migration2020s
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Queues the VPS 2020 for migration to VPS 2025 with the given target plan and returns the migration state.

INSERT INTO ovh.vps.migration2020s (
plan,
service_name
)
SELECT 
'{{ plan }}' /* required */,
'{{ service_name }}'
RETURNING
available_plans,
current_plan,
date,
position,
status,
target_plan
;

Manifest

# Description fields are for documentation purposes
- name: migration2020s
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the migration2020s resource.
  - name: plan
    value: "{{ plan }}"
    description: |
      VPS target plan code

UPDATE examples

update

Updates the target plan of the pending migration of the VPS 2020 to VPS 2025 and returns the migration state.

UPDATE ovh.vps.migration2020s
SET 
date = '{{ date }}'
WHERE 
service_name = '{{ service_name }}' --required
RETURNING
available_plans,
current_plan,
date,
position,
status,
target_plan;

DELETE examples

delete

Cancels the pending migration request of the VPS 2020 to VPS 2025.

DELETE FROM ovh.vps.migration2020s
WHERE service_name = '{{ service_name }}' --required
;