Runbook reference

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
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.
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.
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.

SourceCloudDetails For RunInCloud, FullMigration, OfflineMigration String The name of the Cloud Details that contains Cloud authentication information.
OSType No String VM operating system. Populated from vSphere.
OSLicense Only if changing software license source String A Premium License. The field is left empty when generating a runbook by the Velostrata Manager. The OSLicense field is used as follows:
  1. When migrating from vCenter.
    • If empty, Velostrata will determine the applicable GCP OS license string to apply based on the OS type configured in vCenter for the migrated VM.
    • By default, Windows Pay-as-you-go (PAYG) licenses are applied for Windows OS types.
    • For Windows Bring Your Own License (BYOL) licenses, sole-tenant nodes are recommended to host your migrated VMs.
    • For Linux, this feature allows you to indicate which VMs have a premium license to convert to a PAYG license billed via GCP. This is available for Red Hat Enterprise Linux (RHEL) or Suse Linux Enterprise Server (SLES). For more information, see Using premium OS licenses.
    • You can edit this field to apply a specific license and override the default behavior.
  2. When migrating from AWS
    • When generating a runbook from the Velostrata Manager, the field is auto-populated with a Windows 2012 R2 (PAYG) license string for any source VM identified in AWS as Windows.
    • The user may manually edit this field to apply a specific license and override the default behavior.
NumCPU No Integer Current number of CPUs of the source VM.
MemoryGB No Integer, GB Current memory size of the source VM.
NumDisks No Integer Current number of disks of the source VM.
ProvisionedSpaceGB No Integer Total allocated storage space for the VM.
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.
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, TRUE is the only valid option; write-back synchronization is currently not supported in cloud-to-cloud migrations.

TargetInstanceType For RunInCloud, FullMigration, OfflineMigration String Instance type of the VM to be created on GCP (for example, `n1-standard-1`). For a complete list of instance types, see the Compute Engine documentation.
TargetInstanceName For RunInCloud, FullMigration, OfflineMigration String If the source instance has a Name tag, its value is reformatted according to GCP naming limitations and used. Otherwise, the AWS or vSphere instance ID is used.
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>
TargetPublicIP For RunInCloud, FullMigration, OfflineMigration IPv4 address An internal static IP address to assign to the instance in the cloud. IPs need to be created from the Google Cloud Platform Console.
GcpEphemeralPublicIp No TRUE or FALSE Assign an ephemeral public-facing IP address.
GcpProject Yes String The GCP project to launch the migrated VM in.
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.
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.
GcpDiskType for FullMigration, OfflineMigration standard or SSD Used to create a disk in the PrepareToDetach operation only.
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.

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.
tag:* columns No String Metadata to be applied to migrated VMs.
AffinityIN No String For use with sole-tenant nodes. The list of node affinity labels defining where to place the VM.
AffinityNOT No String For use with sole-tenant nodes. The list of node affinity labels defining where not to place the VM.
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.
HostMaintPolicy 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.

傳送您對下列選項的寶貴意見...

這個網頁
Velostrata - Cloud Migration Software for GCP