You are now viewing Migrate to Virtual Machines (formerly Migrate for Compute Engine). For Migrate for Compute Engine versions 4.x, see the 4.x documentation.

REST Resource: projects.locations.sources.migratingVms.cutoverJobs

Stay organized with collections Save and categorize content based on your preferences.

Resource: CutoverJob

CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.

JSON representation
{
  "createTime": string,
  "endTime": string,
  "name": string,
  "targetDetails": {
    object (TargetVMDetails)
  },
  "state": enum (State),
  "stateTime": string,
  "progress": integer,
  "progressPercent": integer,
  "error": {
    object (Status)
  },
  "stateMessage": string,
  "steps": [
    {
      object (CutoverStep)
    }
  ],
  "computeEngineVmDetails": {
    object (TargetVMDetails)
  },
  "computeEngineTargetDetails": {
    object (ComputeEngineTargetDetails)
  }
}
Fields
createTime

string (Timestamp format)

Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Output only. The time the cutover job had finished.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

name

string

Output only. The name of the cutover job.

targetDetails
(deprecated)

object (TargetVMDetails)

Output only. Details of the VM to create as the target of this cutover job. Deprecated: Use computeEngineTargetDetails instead.

state

enum (State)

Output only. State of the cutover job.

stateTime

string (Timestamp format)

Output only. The time the state was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

progress
(deprecated)

integer

Output only. The current progress in percentage of the cutover job.

progressPercent

integer

Output only. The current progress in percentage of the cutover job.

error

object (Status)

Output only. Provides details for the errors that led to the Cutover Job's state.

stateMessage

string

Output only. A message providing possible extra details about the current state.

steps[]

object (CutoverStep)

Output only. The cutover steps list representing its progress.

computeEngineVmDetails
(deprecated)

object (TargetVMDetails)

Output only. Details of the VM in Compute Engine. Deprecated: Use computeEngineTargetDetails instead.

computeEngineTargetDetails

object (ComputeEngineTargetDetails)

Output only. Details of the target VM in Compute Engine.

State

Possible states of the cutover job.

Enums
STATE_UNSPECIFIED The state is unknown. This is used for API compatibility only and is not used by the system.
PENDING The cutover job has not yet started.
FAILED The cutover job finished with errors.
SUCCEEDED The cutover job finished successfully.
CANCELLED The cutover job was cancelled.
CANCELLING The cutover job is being cancelled.
ACTIVE The cutover job is active and running.
ADAPTING_OS OS adaptation is running as part of the cutover job to generate license.

CutoverStep

CutoverStep holds information about the cutover step progress.

JSON representation
{
  "startTime": string,
  "endTime": string,

  // Union field step can be only one of the following:
  "previousReplicationCycle": {
    object (ReplicationCycle)
  },
  "shuttingDownSourceVm": {
    object (ShuttingDownSourceVMStep)
  },
  "finalSync": {
    object (ReplicationCycle)
  },
  "preparingVmDisks": {
    object (PreparingVMDisksStep)
  },
  "instantiatingMigratedVm": {
    object (InstantiatingMigratedVMStep)
  }
  // End of list of possible types for union field step.
}
Fields
startTime

string (Timestamp format)

The time the step has started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The time the step has ended.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Union field step.

step can be only one of the following:

previousReplicationCycle

object (ReplicationCycle)

A replication cycle prior cutover step.

shuttingDownSourceVm

object (ShuttingDownSourceVMStep)

Shutting down VM step.

finalSync

object (ReplicationCycle)

Final sync step.

preparingVmDisks

object (PreparingVMDisksStep)

Preparing VM disks step.

instantiatingMigratedVm

object (InstantiatingMigratedVMStep)

Instantiating migrated VM step.

ShuttingDownSourceVMStep

ShuttingDownSourceVMStep contains specific step details.

Methods

cancel

Initiates the cancellation of a running cutover job.

create

Initiates a Cutover of a specific migrating VM.

get

Gets details of a single CutoverJob.

list

Lists CutoverJobs of a given migrating VM.