You are now viewing Migrate to Virtual Machines (formerly Migrate for Compute Engine). For Migrate for Compute Engine versions 4.x, see the 4.x documentation.

REST Resource: projects.locations.sources

Stay organized with collections Save and categorize content based on your preferences.

Resource: Source

Source message describes a specific vm migration Source resource. It contains the source environment information.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "error": {
    object (Status)
  },

  // Union field source_details can be only one of the following:
  "vmware": {
    object (VmwareSourceDetails)
  },
  "aws": {
    object (AwsSourceDetails)
  }
  // End of list of possible types for union field source_details.
}
Fields
name

string

Output only. The Source name.

createTime

string (Timestamp format)

Output only. The create time timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The update time timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

The labels of the source.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

description

string

User-provided description of the source.

error
(deprecated)

object (Status)

Output only. Provides details on the state of the Source in case of an error.

Union field source_details.

source_details can be only one of the following:

vmware

object (VmwareSourceDetails)

Vmware type source details.

aws

object (AwsSourceDetails)

AWS type source details.

VmwareSourceDetails

VmwareSourceDetails message describes a specific source details for the vmware source type.

JSON representation
{
  "username": string,
  "password": string,
  "vcenterIp": string,
  "thumbprint": string
}
Fields
username

string

The credentials username.

password

string

Input only. The credentials password. This is write only and can not be read in a GET operation.

vcenterIp

string

The ip address of the vcenter this Source represents.

thumbprint

string

The thumbprint representing the certificate for the vcenter.

AwsSourceDetails

AwsSourceDetails message describes a specific source details for the AWS source type.

JSON representation
{
  "accessKeyId": string,
  "secretAccessKey": string,
  "awsRegion": string,
  "state": enum (State),
  "error": {
    object (Status)
  },
  "inventoryTags": {
    string: string,
    ...
  },
  "inventorySecurityGroupNames": [
    string
  ],
  "migrationResourcesUserTags": {
    string: string,
    ...
  },
  "publicIp": string
}
Fields
accessKeyId

string

AWS access key ID.

secretAccessKey

string

Input only. AWS secret access key.

awsRegion

string

Immutable. The AWS region that the source VMs will be migrated from.

state

enum (State)

Output only. State of the source as determined by the health check.

error

object (Status)

Output only. Provides details on the state of the Source in case of an error.

inventoryTags

map (key: string, value: string)

AWS resource tags to limit the scope of the source inventory.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

inventorySecurityGroupNames[]

string

AWS security group names to limit the scope of the source inventory.

migrationResourcesUserTags

map (key: string, value: string)

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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

publicIp

string

Output only. The source's public IP. All communication initiated by this source will originate from this IP.

State

The possible values of the state.

Enums
STATE_UNSPECIFIED The state is unknown. This is used for API compatibility only and is not used by the system.
PENDING The state was not sampled by the health checks yet.
FAILED The source is available but might not be usable yet due to invalid credentials or another reason. The error message will contain further details.
ACTIVE The source exists and its credentials were verified.

Methods

create

Creates a new Source in a given project and location.

delete

Deletes a single Source.

fetchInventory

List remote source's inventory of VMs.

get

Gets details of a single Source.

list

Lists Sources in a given project and location.

patch

Updates the parameters of a single Source.