Skip to main content

@swamp/gcp/vmmigration

v2026.04.23.1

Google Cloud vmmigration infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudvmmigrationcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/vmmigration

@swamp/gcp/vmmigration/groupsv2026.04.23.1groups.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
description?stringUser-provided description of the group.
displayName?stringDisplay name is a user defined name for this group which can be updated.
migrationTargetType?enumImmutable. The target type of this group.
groupId?stringRequired. The group identifier.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a groups
getGet a groups
ArgumentTypeDescription
identifierstringThe name of the groups
updateUpdate groups attributes
deleteDelete the groups
ArgumentTypeDescription
identifierstringThe name of the groups
syncSync groups state from GCP
add_group_migrationadd group migration
ArgumentTypeDescription
migratingVm?any

Resources

state(infinite)— Describes message for 'Group' resource. The Group is a collections of several...
@swamp/gcp/vmmigration/imageimportsv2026.04.23.1imageimports.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
cloudStorageUri?stringImmutable. The path to the Cloud Storage file from which the image should be imported.
diskImageTargetDefaults?objectThe target details of the image resource that will be created by the import job.
encryption?objectEncryption message describes the details of the applied encryption.
machineImageTargetDefaults?objectThe target details of the machine image resource that will be created by the image import job.
imageImportId?stringRequired. The image import identifier. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen.
requestId?stringOptional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a imageImports
getGet a imageImports
ArgumentTypeDescription
identifierstringThe name of the imageImports
deleteDelete the imageImports
ArgumentTypeDescription
identifierstringThe name of the imageImports
syncSync imageImports state from GCP

Resources

state(infinite)— ImageImport describes the configuration of the image import to run.
@swamp/gcp/vmmigration/imageimports-imageimportjobsv2026.04.23.1imageimports_imageimportjobs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a imageImportJobs
ArgumentTypeDescription
identifierstringThe name of the imageImportJobs
syncSync imageImportJobs state from GCP
cancelcancel

Resources

state(infinite)— ImageImportJob describes the progress and result of an image import.
@swamp/gcp/vmmigration/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/vmmigration/sourcesv2026.04.23.1sources.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
aws?objectAwsSourceDetails message describes a specific source details for the AWS source type.
azure?objectAzureSourceDetails message describes a specific source details for the Azure source type.
description?stringUser-provided description of the source.
encryption?objectEncryption message describes the details of the applied encryption.
labels?recordThe labels of the source.
vmware?objectVmwareSourceDetails message describes a specific source details for the vmware source type.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
sourceId?stringRequired. The source identifier.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a sources
getGet a sources
ArgumentTypeDescription
identifierstringThe name of the sources
updateUpdate sources attributes
deleteDelete the sources
ArgumentTypeDescription
identifierstringThe name of the sources
syncSync sources state from GCP
fetch_inventoryfetch inventory
fetch_storage_inventoryfetch storage inventory

Resources

state(infinite)— Source message describes a specific vm migration Source resource. It contains...
@swamp/gcp/vmmigration/sources-datacenterconnectorsv2026.04.23.1sources_datacenterconnectors.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
availableVersions?objectHolds information about the available versions for upgrade.
error?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
registrationId?stringImmutable. A unique key for this connector. This key is internal to the OVA connector and is supplied with its creation during the registration process and can not be modified.
serviceAccount?stringThe service account to use in the connector when communicating with the cloud.
upgradeStatus?objectUpgradeStatus contains information about upgradeAppliance operation.
version?stringThe version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified.
datacenterConnectorId?stringRequired. The datacenterConnector identifier.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a datacenterConnectors
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a datacenterConnectors
ArgumentTypeDescription
identifierstringThe name of the datacenterConnectors
deleteDelete the datacenterConnectors
ArgumentTypeDescription
identifierstringThe name of the datacenterConnectors
syncSync datacenterConnectors state from GCP
upgrade_applianceupgrade appliance
ArgumentTypeDescription
requestId?any

Resources

state(infinite)— DatacenterConnector message describes a connector between the Source and Goog...
@swamp/gcp/vmmigration/sources-diskmigrationjobsv2026.04.23.1sources_diskmigrationjobs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
awsSourceDiskDetails?objectRepresents the source AWS Disk details.
targetDetails?objectDetails of the target disk in Compute Engine.
diskMigrationJobId?stringRequired. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen.
requestId?stringOptional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a diskMigrationJobs
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a diskMigrationJobs
ArgumentTypeDescription
identifierstringThe name of the diskMigrationJobs
updateUpdate diskMigrationJobs attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the diskMigrationJobs
ArgumentTypeDescription
identifierstringThe name of the diskMigrationJobs
syncSync diskMigrationJobs state from GCP
cancelcancel
runrun

Resources

state(infinite)— Describes the disk which will be migrated from the source environment. The so...
@swamp/gcp/vmmigration/sources-migratingvmsv2026.04.23.1sources_migratingvms.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
awsSourceVmDetails?objectRepresent the source AWS VM details.
azureSourceVmDetails?objectRepresent the source Azure VM details.
computeEngineDisksTargetDefaults?objectComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project.
computeEngineTargetDefaults?objectComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.
currentSyncInfo?objectReplicationCycle contains information about the current replication cycle status.
cutoverForecast?objectCutoverForecast holds information about future CutoverJobs of a MigratingVm.
description?stringThe description attached to the migrating VM by the user.
displayName?stringThe display name attached to the MigratingVm by the user.
error?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
expiration?objectExpiration holds information about the expiration of a MigratingVm.
labels?recordThe labels of the migrating VM.
lastReplicationCycle?objectReplicationCycle contains information about the current replication cycle status.
lastSync?objectReplicationSync contain information about the last replica sync to the cloud.
policy?objectA policy for scheduling replications.
sourceVmId?stringThe unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-.
vmwareSourceVmDetails?objectRepresent the source Vmware VM details.
migratingVmId?stringRequired. The migratingVm identifier.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a migratingVms
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a migratingVms
ArgumentTypeDescription
identifierstringThe name of the migratingVms
updateUpdate migratingVms attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the migratingVms
ArgumentTypeDescription
identifierstringThe name of the migratingVms
syncSync migratingVms state from GCP
extend_migrationextend migration
finalize_migrationfinalize migration
pause_migrationpause migration
resume_migrationresume migration
start_migrationstart migration

Resources

state(infinite)— MigratingVm describes the VM that will be migrated from a Source environment ...
@swamp/gcp/vmmigration/sources-migratingvms-clonejobsv2026.04.23.1sources_migratingvms_clonejobs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
computeEngineDisksTargetDetails?objectComputeEngineDisksTargetDetails is a collection of created Persistent Disks details.
computeEngineTargetDetails?objectComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.
error?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
cloneJobId?stringRequired. The clone job identifier.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a cloneJobs
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a cloneJobs
ArgumentTypeDescription
identifierstringThe name of the cloneJobs
syncSync cloneJobs state from GCP
cancelcancel

Resources

state(infinite)— CloneJob describes the process of creating a clone of a MigratingVM to the re...
@swamp/gcp/vmmigration/sources-migratingvms-cutoverjobsv2026.04.23.1sources_migratingvms_cutoverjobs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
computeEngineDisksTargetDetails?objectComputeEngineDisksTargetDetails is a collection of created Persistent Disks details.
computeEngineTargetDetails?objectComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.
error?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
cutoverJobId?stringRequired. The cutover job identifier.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a cutoverJobs
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a cutoverJobs
ArgumentTypeDescription
identifierstringThe name of the cutoverJobs
syncSync cutoverJobs state from GCP
cancelcancel

Resources

state(infinite)— CutoverJob message describes a cutover of a migrating VM. The CutoverJob is t...
@swamp/gcp/vmmigration/sources-migratingvms-replicationcyclesv2026.04.23.1sources_migratingvms_replicationcycles.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a replicationCycles
ArgumentTypeDescription
identifierstringThe name of the replicationCycles
syncSync replicationCycles state from GCP

Resources

state(infinite)— ReplicationCycle contains information about the current replication cycle sta...
@swamp/gcp/vmmigration/sources-utilizationreportsv2026.04.23.1sources_utilizationreports.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
displayName?stringThe report display name, as assigned by the user.
error?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
timeFrame?enumTime frame of the report.
vms?arrayList of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
utilizationReportId?stringRequired. The ID to use for the report, which will become the final component of the reports's resource name. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a utilizationReports
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a utilizationReports
ArgumentTypeDescription
identifierstringThe name of the utilizationReports
deleteDelete the utilizationReports
ArgumentTypeDescription
identifierstringThe name of the utilizationReports
syncSync utilizationReports state from GCP

Resources

state(infinite)— Utilization report details the utilization (CPU, memory, etc.) of selected so...
@swamp/gcp/vmmigration/targetprojectsv2026.04.23.1targetprojects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
description?stringThe target project's description.
project?stringRequired. The target project ID (number) or project name.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
targetProjectId?stringRequired. The target_project identifier.
location?stringThe location for this resource (this resource only supports 'global')
createCreate a targetProjects
getGet a targetProjects
ArgumentTypeDescription
identifierstringThe name of the targetProjects
updateUpdate targetProjects attributes
deleteDelete the targetProjects
ArgumentTypeDescription
identifierstringThe name of the targetProjects
syncSync targetProjects state from GCP

Resources

state(infinite)— TargetProject message represents a target Compute Engine project for a migrat...