Runbooks define the VMs to be migrated, their order, and additional configuration parameters. This page describes the columns that can be part of a runbook. For more information on runbooks, see the Migration waves overview.
An example runbook is available for your review.
The fields in a runbook are defined in the following table.
Field | Required | Format | Notes |
---|---|---|---|
BlockOnFailure | Yes. | TRUE or FALSE
|
If set to TRUE and an action fails, the wave stops and
subsequent RunGroups are not run. The default value is FALSE .
|
GcpDiskType | for FullMigration, OfflineMigration | standard or SSD
|
Used to create a disk in the PrepareToDetach operation only. |
GcpEphemeralPublicIp | No | TRUE or FALSE
|
Assign an ephemeral public-facing IP address. |
GcpInstanceServiceAccount | No | Service Account to apply to the new instance. If the default Cloud Extension checkbox is selected when the runbook is created, then that Cloud Extension's default network is populated. | |
GcpNetworkTags | No | Network tags to apply to the new instance. If empty, no tag will be added to the instance. If the default Cloud Extension checkbox is selected when the runbook is created, then that Cloud Extension's default network is populated. | |
GcpProject | Yes | String | The Google Cloud project to launch the migrated VM in. |
MemoryGB | No | Integer, GB | Current memory size of the source VM. |
NumCPU | No | Integer | Current number of CPUs of the source VM. |
NumDisks | No | Integer | Current number of disks of the source VM. |
OSLicense | Only if changing software license source | String | A Premium License. The field is left empty when generating a runbook by
the Migrate for Compute Engine Manager.
The OSLicense field is used as follows:
|
OSType | No | String | VM operating system. Populated from vSphere. |
ProbeTCPPort | Yes | Unsigned Integer | TCP port to probe the VM on. We recommend you use 3389 (RDP) for Windows
VMs, or 22 (SSH) for Linux VMs.
Probing is performed during the RunInCloud and Detach phases. |
ProvisionedSpaceGB | No | Integer | Total allocated storage space for the VM. |
ProbeWaitMinutes | Yes | Unsigned Integer | Number of minutes to wait for the port probe to respond, after which the probe check is considered to have failed. The default is 0 minutes (no wait). Used by RunInCloud, Detach phases. |
RunGroup | Yes | Signed Integer | Grouping of VMs to be migrated. VMs in the same group are migrated in parallel. VMs in different groups are migrated sequentially in ascending order. |
SoleTenancy-NodeAffinity:[KEY] | No | String | For use with sole-tenant nodes. The list of node affinity labels defining where to place the VM. |
SoleTenancy-NodeAffinityNot:[KEY] | No | String | For use with sole-tenant nodes. The list of node affinity labels defining where not to place the VM. |
SoleTenancy-RestartOnFailure | No | Yes (default) or No
|
For use with sole-tenant nodes. Attempt to restart the VM on the same physical host. For more information on how to set this field for your licenses, see the sole-tenant documentation. |
SoleTenancy-VmHostMaintenancePolicy | No | migrate (default) or terminate
|
For use with sole-tenant nodes. Useful for when changing hosts incurs an
additional software license cost.
If set to migrate , the VM is migrated to a new host during
maintenance. If set to terminate , Compute Engine won't attempt to
migrate the VM until the host has been down for more than 60 minutes.
For more information
on how to set this field for your licenses,
see the sole-tenant documentation.
The |
SourceCloudDetails | For RunInCloud, FullMigration, OfflineMigration | String | The name of the Cloud Details that contains Cloud authentication information. |
tag:* columns | No | String | Metadata to be applied to migrated VMs. |
TargetCloudExtension | For RunInCloud, FullMigration, OfflineMigration | String | The name of the Cloud Extension that migrates the VMs. |
TargetEdgeNode | For RunInCloud, FullMigration, OfflineMigration | NodeA or NodeB
|
Primary edge node of the Cloud Extension that handles this VM's migration. |
TargetInstanceName | For RunInCloud, FullMigration, OfflineMigration | String | If the source instance has a Name tag, its value is reformatted according to Google Cloud naming limitations and used. Otherwise, the AWS or vSphere instance ID is used. |
TargetInstanceType | For RunInCloud, FullMigration, OfflineMigration | String | Instance type of the VM to be created on Google Cloud (for example,
n1-standard-1 ). For a complete list of instance types, see the Compute Engine documentation.
|
TargetPublicIP | For RunInCloud, FullMigration, OfflineMigration | The name of a reserved static IP address. | The name of an internal static IPv4 IP address to assign to the instance in the cloud. You can create IPs from the Google Cloud console. |
TargetSubnet | For RunInCloud, FullMigration, OfflineMigration | String | Subnet ID to be used by the target instance. When empty, the default subnet (as specified during the Cloud Extension creation) is selected. For example, https://www.googleapis.com/compute/v1/projects/<project ID>/regions/europe-west1/subnetworks/<subnet> name> |
VmID | Yes | String | If migrating from on-premises vSphere, this is the VM ID of
the source VM.
If migrating from AWS, this is the AWS instance ID. |
VmName | No | String | If migrating from on-premises vSphere, this is the name of
the source VM.
If migrating from AWS, this is the AWS instance ID. |
WriteIsolation | For On-Premises to Cloud Migrations | TRUE or FALSE
|
For on-premises to cloud migrations, you can select either TRUE (write
isolation enabled) or FALSE (write-back mode).
For cloud-to-cloud migrations, |