cutover_jobs

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

Overview

Name	cutover_jobs
Type	Resource
Id	google.vmmigration.cutover_jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The name of the cutover job.
computeEngineDisksTargetDetails	object	Output only. Details of the target Persistent Disks in Compute Engine. (id: ComputeEngineDisksTargetDetails)
computeEngineTargetDetails	object	Output only. Details of the target VM in Compute Engine. (id: ComputeEngineTargetDetails)
createTime	string (google-datetime)	Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
endTime	string (google-datetime)	Output only. The time the cutover job had finished.
error	object	Output only. Provides details for the errors that led to the Cutover Job's state. (id: Status)
progressPercent	integer (int32)	Output only. The current progress in percentage of the cutover job.
state	string	Output only. State of the cutover job. (STATE_UNSPECIFIED, PENDING, FAILED, SUCCEEDED, CANCELLED, CANCELLING, ACTIVE, ADAPTING_OS)
stateMessage	string	Output only. A message providing possible extra details about the current state.
stateTime	string (google-datetime)	Output only. The time the state was last updated.
steps	array	Output only. The cutover steps list representing its progress.

list

Name	Datatype	Description
name	string	Output only. The name of the cutover job.
computeEngineDisksTargetDetails	object	Output only. Details of the target Persistent Disks in Compute Engine. (id: ComputeEngineDisksTargetDetails)
computeEngineTargetDetails	object	Output only. Details of the target VM in Compute Engine. (id: ComputeEngineTargetDetails)
createTime	string (google-datetime)	Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
endTime	string (google-datetime)	Output only. The time the cutover job had finished.
error	object	Output only. Provides details for the errors that led to the Cutover Job's state. (id: Status)
progressPercent	integer (int32)	Output only. The current progress in percentage of the cutover job.
state	string	Output only. State of the cutover job. (STATE_UNSPECIFIED, PENDING, FAILED, SUCCEEDED, CANCELLED, CANCELLING, ACTIVE, ADAPTING_OS)
stateMessage	string	Output only. A message providing possible extra details about the current state.
stateTime	string (google-datetime)	Output only. The time the state was last updated.
steps	array	Output only. The cutover steps list representing its progress.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, sourcesId, migratingVmsId, cutoverJobsId		Gets details of a single CutoverJob.
list	select	projectsId, locationsId, sourcesId, migratingVmsId	filter, orderBy, pageSize, pageToken	Lists the CutoverJobs of a migrating VM. Only 25 most recent CutoverJobs are listed.
create	insert	projectsId, locationsId, sourcesId, migratingVmsId	cutoverJobId, requestId	Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.
cancel	exec	projectsId, locationsId, sourcesId, migratingVmsId, cutoverJobsId		Initiates the cancellation of a running cutover job.

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
cutoverJobsId	string
locationsId	string
migratingVmsId	string
projectsId	string
sourcesId	string
cutoverJobId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single CutoverJob.

SELECT
name,
computeEngineDisksTargetDetails,
computeEngineTargetDetails,
createTime,
endTime,
error,
progressPercent,
state,
stateMessage,
stateTime,
steps
FROM google.vmmigration.cutover_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND migratingVmsId = '{{ migratingVmsId }}' -- required
AND cutoverJobsId = '{{ cutoverJobsId }}' -- required
;

list

Lists the CutoverJobs of a migrating VM. Only 25 most recent CutoverJobs are listed.

SELECT
name,
computeEngineDisksTargetDetails,
computeEngineTargetDetails,
createTime,
endTime,
error,
progressPercent,
state,
stateMessage,
stateTime,
steps
FROM google.vmmigration.cutover_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND migratingVmsId = '{{ migratingVmsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.

INSERT INTO google.vmmigration.cutover_jobs (
projectsId,
locationsId,
sourcesId,
migratingVmsId,
cutoverJobId,
requestId
)
SELECT 
'{{ projectsId }}',
'{{ locationsId }}',
'{{ sourcesId }}',
'{{ migratingVmsId }}',
'{{ cutoverJobId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: cutover_jobs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the cutover_jobs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the cutover_jobs resource.
  - name: sourcesId
    value: "{{ sourcesId }}"
    description: Required parameter for the cutover_jobs resource.
  - name: migratingVmsId
    value: "{{ migratingVmsId }}"
    description: Required parameter for the cutover_jobs resource.
  - name: cutoverJobId
    value: "{{ cutoverJobId }}"
  - name: requestId
    value: "{{ requestId }}"

Lifecycle Methods

cancel

Initiates the cancellation of a running cutover job.

EXEC google.vmmigration.cutover_jobs.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@sourcesId='{{ sourcesId }}' --required, 
@migratingVmsId='{{ migratingVmsId }}' --required, 
@cutoverJobsId='{{ cutoverJobsId }}' --required
;