Runbook Reference

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 that will be migrated. VMs in the same group will be migrated in parallel. VMs in different groups will be migrated sequentially in ascending order.
VmID Yes String If migrating from on-premises vSphere, this is the inventory path or VM ID of the source VM.

If migrating from AWS, this is the AWS instance ID.

BlockOnFailure yes TRUE or FALSE If set to TRUE and an action fails, the wave stops and subsequent RunGroups are not executed. The default value is FALSE.
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.

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 Linux, this feature allows you to indicate which VMs should have a premium license converted 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.
    • This field may be manually edited by the user 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.
    • This field may be manually edited by the user to apply a specific license and override the default behavior.

.

SourceCloudDetails For RunInCloud, FullMigration, OfflineMigration String The name of the Cloud Details that contains Cloud authentication information.
TargetCloudExtension For RunInCloud, FullMigration, OfflineMigration String The name of the Cloud Extension that will migrate the VMs.
TargetEdgeNode For RunInCloud, FullMigration, OfflineMigration NodeA or NodeB Primary edge node of the Cloud Extension that will handle this VM's migration.
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 Google Compute Engine documentation.
TargetInstanceName For RunInCloud, FullMigration, OfflineMigration String If the source instance has a Name tag, its value is re-formatted 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>
TargetStaticIP 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 GCP console.
GcpEphemeralPublicIp No TRUE or FALSE Assign an ephemeral public-facing IP address.
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 selected when the runbook is created, then that Cloud Extension's default network is populated.
tag:* columns No String Metadata
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.

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.
NumCPU No Integer Current number of CPUs of the source VM.
MemoryMB No Integer, MB 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.
TargetCloudExtensionName No String Velostrata Cloud Extension name to be used for cloud migration.