Get desktop application:
View/edit binary Protocol Buffers messages
AdaptingOSStep contains specific step details.
Used in:
(message has no fields)
Describes an appliance version.
Used in:
The appliance version.
A link for downloading the version.
Determine whether it's critical to upgrade the appliance to this version.
Link to a page that contains the version release notes.
AppliedLicense holds the license data returned by adaptation module report.
Used in:
,The license type that was used in OS adaptation.
The OS license returned from the adaptation module's report.
License types used in OS adaptation.
Used in:
Unspecified license for the OS.
No license available for the OS.
The license type is Pay As You Go license type.
The license type is Bring Your Own License type.
Holds informatiom about the available versions for upgrade.
Used in:
The newest deployable version of the appliance. The current appliance can't be updated into this version, and the owner must manually deploy this OVA to a new appliance.
The latest version for in place update. The current appliance can be updated to this version using the API or m4c CLI.
AwsSourceDetails message describes a specific source details for the AWS source type.
Used in:
AWS Credentials using access key id and secret.
Immutable. The AWS region that the source VMs will be migrated from.
Output only. State of the source as determined by the health check.
Output only. Provides details on the state of the Source in case of an error.
AWS resource tags to limit the scope of the source inventory.
AWS security group names to limit the scope of the source inventory.
User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`.
Output only. The source's public IP. All communication initiated by this source will originate from this IP.
Message describing AWS Credentials using access key id and secret.
Used in:
AWS access key ID.
The possible values of the state.
Used in:
The state is unknown. This is used for API compatibility only and is not used by the system.
The state was not sampled by the health checks yet.
The source is available but might not be usable yet due to invalid credentials or another reason. The error message will contain further details.
The source exists and its credentials were verified.
Tag is an AWS tag representation.
Used in:
Key of tag.
Value of tag.
Represent the source AWS VM details.
Used in:
The firmware type of the source VM.
The total size of the disks being migrated in bytes.
The disks attached to the source VM.
The details of an AWS instance disk.
Used in:
The ordinal number of the disk.
AWS volume ID.
Size in GB.
Possible values for AWS VM firmware.
Used in:
The firmware is unknown.
The firmware is EFI.
The firmware is BIOS.
CloneJob describes the process of creating a clone of a [MigratingVM][google.cloud.vmmigration.v1.MigratingVm] to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.
Used in:
,Details of the VM to create as the target of this clone job.
Output only. Details of the target VM in Compute Engine.
Output only. The time the clone job was created (as an API call, not when it was actually created in the target).
Output only. The time the clone job was ended.
Output only. The name of the clone.
Output only. State of the clone job.
Output only. The time the state was last updated.
Output only. Provides details for the errors that led to the Clone Job's state.
Output only. The clone steps list representing its progress.
Possible states of the clone job.
Used in:
The state is unknown. This is used for API compatibility only and is not used by the system.
The clone job has not yet started.
The clone job is active and running.
The clone job finished with errors.
The clone job finished successfully.
The clone job was cancelled.
The clone job is being cancelled.
OS adaptation is running as part of the clone job to generate license.
The CloudEvent raised when a CloneJob is created.
The data associated with the event.
The data within all CloneJob events.
Used in:
The CloneJob event payload.
CloneStep holds information about the clone step progress.
Used in:
Adapting OS step.
Preparing VM disks step.
Instantiating migrated VM step.
The time the step has started.
The time the step has ended.
Possible values for vm boot option.
Used in:
,The boot option is unknown.
The boot option is EFI.
The boot option is BIOS.
Types of disks supported for Compute Engine VM.
Used in:
,An unspecified disk type. Will be used as STANDARD.
A Standard disk type.
SSD hard disk type.
An alternative to SSD persistent disks that balance performance and cost.
Types of licenses used in OS adaptation.
Used in:
,The license type is the default for the OS.
The license type is Pay As You Go license type.
The license type is Bring Your Own License type.
ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.
Used in:
The name of the VM to create.
The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
The zone in which to create the VM.
The machine type series to create the VM with.
The machine type to create the VM with.
A map of network tags to associate with the VM.
List of NICs connected to this VM.
The service account to associate the VM with.
The disk type to use in the VM.
A map of labels to associate with the VM.
The license type to use in OS adaptation.
Output only. The OS license returned from the adaptation module report.
Compute instance scheduling information (if empty default is used).
Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
Output only. The VM Boot Option, as set in the source vm.
The metadata key/value pairs to assign to the VM.
Additional licenses to assign to the VM.
The hostname to assign to the VM.
ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.
Used in:
,The name of the VM to create.
The Google Cloud target project ID or project name.
The zone in which to create the VM.
The machine type series to create the VM with.
The machine type to create the VM with.
A map of network tags to associate with the VM.
List of NICs connected to this VM.
The service account to associate the VM with.
The disk type to use in the VM.
A map of labels to associate with the VM.
The license type to use in OS adaptation.
The OS license returned from the adaptation module report.
Compute instance scheduling information (if empty default is used).
Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
The VM Boot Option, as set in the source vm.
The metadata key/value pairs to assign to the VM.
Additional licenses to assign to the VM.
The hostname to assign to the VM.
Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes.
Used in:
,How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
A set of node affinity and anti-affinity configurations for sole tenant nodes.
The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
Used in:
An unknown, unexpected behavior.
Terminate the instance when the host machine undergoes maintenance.
Migrate the instance when the host machine undergoes maintenance.
Defines whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
Used in:
Unspecified behavior. This will use the default.
The Instance should be automatically restarted whenever it is terminated by Compute Engine.
The Instance isn't automatically restarted whenever it is terminated by Compute Engine.
CutoverForecast holds information about future CutoverJobs of a MigratingVm.
Used in:
Output only. Estimation of the CutoverJob duration.
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.
Used in:
,Details of the VM to create as the target of this cutover job.
Output only. Details of the target VM in Compute Engine.
Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
Output only. The time the cutover job had finished.
Output only. The name of the cutover job.
Output only. State of the cutover job.
Output only. The time the state was last updated.
Output only. The current progress in percentage of the cutover job.
Output only. Provides details for the errors that led to the Cutover Job's state.
Output only. A message providing possible extra details about the current state.
Output only. The cutover steps list representing its progress.
Possible states of the cutover job.
Used in:
The state is unknown. This is used for API compatibility only and is not used by the system.
The cutover job has not yet started.
The cutover job finished with errors.
The cutover job finished successfully.
The cutover job was cancelled.
The cutover job is being cancelled.
The cutover job is active and running.
OS adaptation is running as part of the cutover job to generate license.
The CloudEvent raised when a CutoverJob is created.
The data associated with the event.
The data within all CutoverJob events.
Used in:
The CutoverJob event payload.
CutoverStep holds information about the cutover step progress.
Used in:
A replication cycle prior cutover step.
Shutting down VM step.
Final sync step.
Preparing VM disks step.
Instantiating migrated VM step.
The time the step has started.
The time the step has ended.
CycleStep holds information about a step progress.
Used in:
Initializing replication step.
Replicating step.
Post processing step.
The time the cycle step has started.
The time the cycle step has ended.
DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer.
Used in:
Output only. The time the connector was created (as an API call, not when it was actually installed).
Output only. The last time the connector was updated with an API call.
Output only. The connector's name.
Immutable. 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.
The service account to use in the connector when communicating with the cloud.
The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified.
Output only. The communication channel between the datacenter connector and Google Cloud.
Output only. State of the DatacenterConnector, as determined by the health checks.
Output only. The time the state was last set.
Output only. Provides details on the state of the Datacenter Connector in case of an error.
Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance.
Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance.
Output only. The available versions for updating this appliance.
Output only. The status of the current / last upgradeAppliance operation.
The possible values of the state.
Used in:
The state is unknown. This is used for API compatibility only and is not used by the system.
The state was not sampled by the health checks yet.
The source was sampled by health checks and is not available.
The source is available but might not be usable yet due to unvalidated credentials or another reason. The credentials referred to are the ones to the Source. The error message will contain further details.
The source exists and its credentials were verified.
The CloudEvent raised when a DatacenterConnector is created.
The data associated with the event.
The CloudEvent raised when a DatacenterConnector is deleted.
The data associated with the event.
The data within all DatacenterConnector events.
Used in:
,Optional. The DatacenterConnector event payload. Unset for deletion events.
Describes message for 'Group' resource. The Group is a collections of several MigratingVms.
Used in:
Output only. The Group name.
Output only. The create time timestamp.
Output only. The update time timestamp.
User-provided description of the group.
Display name is a user defined name for this group which can be updated.
The CloudEvent raised when a Group is created.
The data associated with the event.
The CloudEvent raised when a Group is deleted.
The data associated with the event.
The data within all Group events.
Used in:
, ,Optional. The Group event payload. Unset for deletion events.
The CloudEvent raised when a Group is updated.
The data associated with the event.
InitializingReplicationStep contains specific step details.
Used in:
(message has no fields)
InstantiatingMigratedVMStep contains specific step details.
Used in:
,(message has no fields)
MigratingVm describes the VM that will be migrated from a Source environment and its replication state.
Used in:
The default configuration of the target VM that will be created in Google Cloud as a result of the migration.
Details of the target VM in Compute Engine.
Details about the source VM.
Output only. Details of the VM from an AWS source.
Output only. The identifier of the MigratingVm.
The 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-<num>.
The display name attached to the MigratingVm by the user.
The description attached to the migrating VM by the user.
The replication schedule policy.
Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source).
Output only. The last time the migrating VM resource was updated.
Output only. The most updated snapshot created time in the source that finished replication.
Output only. State of the MigratingVm.
Output only. The last time the migrating VM state was updated.
Output only. Details of the current running replication cycle.
Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles.
Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate [Group][google.cloud.vmmigration.v1.Group] resource.
The labels of the migrating VM.
Output only. The recent [clone jobs][google.cloud.vmmigration.v1.CloneJob] performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request.
Output only. Provides details on the state of the Migrating VM in case of an error in replication.
Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request.
Output only. Provides details of future CutoverJobs of a MigratingVm. Set to empty when cutover forecast is unavailable.
The possible values of the state/health of source VM.
Used in:
The state was not sampled by the health checks yet.
The VM in the source is being verified.
The source VM was verified, and it's ready to start replication.
Migration is going through the first sync cycle.
The replication is active, and it's running or scheduled to run.
The source VM is being turned off, and a final replication is currently running.
The source VM was stopped and replicated. The replication is currently paused.
A cutover job is active and replication cycle is running the final sync.
The replication was paused by the user and no cycles are scheduled to run.
The migrating VM is being finalized and migration resources are being removed.
The replication process is done. The migrating VM is finalized and no longer consumes billable resources.
The replication process encountered an unrecoverable error and was aborted.
The CloudEvent raised when a MigratingVm is created.
The data associated with the event.
The CloudEvent raised when a MigratingVm is deleted.
The data associated with the event.
The data within all MigratingVm events.
Used in:
, ,Optional. The MigratingVm event payload. Unset for deletion events.
The CloudEvent raised when a MigratingVm is updated.
The data associated with the event.
Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations.
Used in:
The warning code.
The localized warning message.
Suggested action for solving the warning.
URL(s) pointing to additional information on handling the current warning.
The time the warning occurred.
Represents possible warning codes.
Used in:
Default value. This value is not used.
A warning originated from OS Adaptation.
NetworkInterface represents a NIC of a VM.
Used in:
,The network to connect the NIC to.
The subnetwork to connect the NIC to.
The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
The external IP to define in the NIC.
PostProcessingStep contains specific step details.
Used in:
(message has no fields)
PreparingVMDisksStep contains specific step details.
Used in:
,(message has no fields)
ReplicatingStep contains specific step details.
Used in:
Total bytes to be handled in the step.
Replicated bytes in the step.
The source disks replication rate for the last 2 minutes in bytes per second.
The source disks replication rate for the last 30 minutes in bytes per second.
ReplicationCycle contains information about the current replication cycle status.
Used in:
,The identifier of the ReplicationCycle.
The cycle's ordinal number.
The time the replication cycle has started.
The time the replication cycle has ended.
The accumulated duration the replication cycle was paused.
The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.
The cycle's steps list representing its progress.
State of the ReplicationCycle.
Provides details on the state of the cycle in case of an error.
Output only. Warnings that occurred during the cycle.
Possible states of a replication cycle.
Used in:
The state is unknown. This is used for API compatibility only and is not used by the system.
The replication cycle is running.
The replication cycle is paused.
The replication cycle finished with errors.
The replication cycle finished successfully.
ReplicationSync contain information about the last replica sync to the cloud.
Used in:
The most updated snapshot created time in the source that finished replication.
A policy for scheduling replications.
Used in:
The idle duration between replication stages.
A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM's operating system undergoes changes and adaptations to fully function on Compute Engine.
Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
Used in:
The label key of Node resource to reference.
The operator to use for the node resources specified in the `values` parameter.
Corresponds to the label values of Node resource.
Possible types of node selection operators. Valid operators are IN for affinity and NOT_IN for anti-affinity.
Used in:
An unknown, unexpected behavior.
The node resource group should be in these resources affinity.
The node resource group should not be in these resources affinity.
ShuttingDownSourceVMStep contains specific step details.
Used in:
(message has no fields)
Source message describes a specific vm migration Source resource. It contains the source environment information.
Used in:
Vmware type source details.
AWS type source details.
Output only. The Source name.
Output only. The create time timestamp.
Output only. The update time timestamp.
The labels of the source.
User-provided description of the source.
The CloudEvent raised when a Source is created.
The data associated with the event.
The CloudEvent raised when a Source is deleted.
The data associated with the event.
The data within all Source events.
Used in:
, ,Optional. The Source event payload. Unset for deletion events.
The CloudEvent raised when a Source is updated.
The data associated with the event.
TargetProject message represents a target Compute Engine project for a migration or a clone.
Used in:
Output only. The name of the target project.
The target project ID (number) or project name.
The target project's description.
Output only. The time this target project resource was created (not related to when the Compute Engine project it points to was created).
Output only. The last time the target project resource was updated.
The CloudEvent raised when a TargetProject is created.
The data associated with the event.
The CloudEvent raised when a TargetProject is deleted.
The data associated with the event.
The data within all TargetProject events.
Used in:
, ,Optional. The TargetProject event payload. Unset for deletion events.
The CloudEvent raised when a TargetProject is updated.
The data associated with the event.
UpgradeStatus contains information about upgradeAppliance operation.
Used in:
The version to upgrade to.
The state of the upgradeAppliance operation.
Provides details on the state of the upgrade operation in case of an error.
The time the operation was started.
The version from which we upgraded.
The possible values of the state.
Used in:
The state was not sampled by the health checks yet.
The upgrade has started.
The upgrade failed.
The upgrade finished successfully.
Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.
Used in:
Output only. The report unique name.
The report display name, as assigned by the user.
Output only. Current state of the report.
Output only. The time the state was last set.
Output only. Provides details on the state of the report in case of an error.
Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).
Time frame of the report.
Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.
Output only. Total number of VMs included in the report.
List 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.
Utilization report state.
Used in:
The state is unknown. This value is not in use.
The report is in the making.
Report creation completed successfully.
Report creation failed.
Report time frame options.
Used in:
The time frame was not specified and will default to WEEK.
One week.
One month.
One year.
The CloudEvent raised when an UtilizationReport is created.
The data associated with the event.
The CloudEvent raised when an UtilizationReport is deleted.
The data associated with the event.
The data within all UtilizationReport events.
Used in:
,Optional. The UtilizationReport event payload. Unset for deletion events.
Utilization information of a single VM.
Used in:
The description of the VM in a Source of type Vmware.
The VM's ID in the source.
Utilization metrics for this VM.
Utilization metrics values for a single VM.
Used in:
Max CPU usage, percent.
Average CPU usage, percent.
Max memory usage, percent.
Average memory usage, percent.
Max disk IO rate, in kilobytes per second.
Average disk IO rate, in kilobytes per second.
Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
VmwareSourceDetails message describes a specific source details for the vmware source type.
Used in:
The credentials username.
The ip address of the vcenter this Source represents.
The thumbprint representing the certificate for the vcenter.
The hostname of the vcenter.
VmwareVmDetails describes a VM in vCenter.
Used in:
The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.
The id of the vCenter's datacenter this VM is contained in.
The descriptive name of the vCenter's datacenter this VM is contained in.
The unique identifier of the VM in vCenter.
The display name of the VM. Note that this is not necessarily unique.
The power state of the VM at the moment list was taken.
The number of cpus in the VM.
The size of the memory of the VM in MB.
The number of disks the VM has.
The total size of the storage allocated to the VM in MB.
The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
Output only. The VM Boot Option.
Possible values for vm boot option.
Used in:
The boot option is unknown.
The boot option is EFI.
The boot option is BIOS.
Possible values for the power state of the VM.
Used in:
Power state is not specified.
The VM is turned ON.
The VM is turned OFF.
The VM is suspended. This is similar to hibernation or sleep mode.