Updates the parameters of a single MigratingVm.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: vmmigration1 --scope <scope> projects locations-sources-migrating-vms-patch ...

Required Scalar Argument

• <name> (string)
  • Output only. The identifier of the MigratingVm.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

MigratingVm:
  aws-source-vm-details:
    committed-storage-bytes: string
    firmware: string
    vm-capabilities-info:
      last-os-capabilities-update-time: string
      os-capabilities: [string]
  azure-source-vm-details:
    committed-storage-bytes: string
    firmware: string
    vm-capabilities-info:
      last-os-capabilities-update-time: string
      os-capabilities: [string]
  compute-engine-disks-target-defaults:
    target-project: string
    vm-target-defaults:
      additional-licenses: [string]
      boot-disk-defaults:
        device-name: string
        disk-name: string
        disk-type: string
        encryption:
          kms-key: string
        image:
          source-image: string
      compute-scheduling:
        min-node-cpus: integer
        on-host-maintenance: string
        restart-type: string
      encryption:
        kms-key: string
      hostname: string
      labels: { string: string }
      machine-type: string
      machine-type-series: string
      metadata: { string: string }
      network-tags: [string]
      secure-boot: boolean
      service-account: string
      vm-name: string
    zone: string
  compute-engine-target-defaults:
    additional-licenses: [string]
    applied-license:
      os-license: string
      type: string
    boot-option: string
    compute-scheduling:
      min-node-cpus: integer
      on-host-maintenance: string
      restart-type: string
    disk-type: string
    encryption:
      kms-key: string
    hostname: string
    labels: { string: string }
    license-type: string
    machine-type: string
    machine-type-series: string
    metadata: { string: string }
    network-tags: [string]
    secure-boot: boolean
    service-account: string
    target-project: string
    vm-name: string
    zone: string
  create-time: string
  current-sync-info:
    cycle-number: integer
    end-time: string
    error:
      code: integer
      message: string
    name: string
    progress-percent: integer
    start-time: string
    state: string
    total-pause-duration: string
  cutover-forecast:
    estimated-cutover-job-duration: string
  description: string
  display-name: string
  error:
    code: integer
    message: string
  group: string
  labels: { string: string }
  last-replication-cycle:
    cycle-number: integer
    end-time: string
    error:
      code: integer
      message: string
    name: string
    progress-percent: integer
    start-time: string
    state: string
    total-pause-duration: string
  last-sync:
    last-sync-time: string
  name: string
  policy:
    idle-duration: string
    skip-os-adaptation: boolean
  source-vm-id: string
  state: string
  state-time: string
  update-time: string
  vmware-source-vm-details:
    committed-storage-bytes: string
    firmware: string
    vm-capabilities-info:
      last-os-capabilities-update-time: string
      os-capabilities: [string]

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r .aws-source-vm-details committed-storage-bytes=at
  • The total size of the disks being migrated in bytes.
• firmware=invidunt
  • The firmware type of the source VM.
• vm-capabilities-info last-os-capabilities-update-time=clita
  • Output only. The last time OS capabilities list was updated.

• os-capabilities=stet

  • Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features.
  • Each invocation of this argument appends the given value to the array.

• ...azure-source-vm-details committed-storage-bytes=aliquyam

  • The total size of the disks being migrated in bytes.
• firmware=ut
  • The firmware type of the source VM.
• vm-capabilities-info last-os-capabilities-update-time=sit
  • Output only. The last time OS capabilities list was updated.

• os-capabilities=vero

  • Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features.
  • Each invocation of this argument appends the given value to the array.

• ...compute-engine-disks-target-defaults target-project=rebum.

  • The full path of the resource of type TargetProject which represents the Compute Engine project in which to create the Persistent Disks.
• vm-target-defaults additional-licenses=dolores
  • Optional. Additional licenses to assign to the VM.
  • Each invocation of this argument appends the given value to the array.
• boot-disk-defaults device-name=consetetur
  • Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
• disk-name=dolores
  • Optional. The name of the disk.
• disk-type=sed
  • Optional. The type of disk provisioning to use for the VM.

• encryption kms-key=invidunt

  • Required. The name of the encryption key that is stored in Google Cloud KMS.

• ..image source-image=clita

  • Required. The Image resource used when creating the disk.

• ...compute-scheduling min-node-cpus=2

  • The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
• on-host-maintenance=aliquyam
  • How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.

• restart-type=magna

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

• ..encryption kms-key=diam

  • Required. The name of the encryption key that is stored in Google Cloud KMS.

• .. hostname=nonumy

  • Optional. The hostname to assign to the VM.
• labels=key=et
  • Optional. A map of labels to associate with the VM.
  • the value will be associated with the given key
• machine-type=sanctus
  • Required. The machine type to create the VM with.
• machine-type-series=accusam
  • Optional. The machine type series to create the VM with. For presentation only.
• metadata=key=tempor
  • Optional. The metadata key/value pairs to assign to the VM.
  • the value will be associated with the given key
• network-tags=sed
  • Optional. A list of network tags to associate with the VM.
  • Each invocation of this argument appends the given value to the array.
• secure-boot=false
  • Optional. Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI.
• service-account=diam
  • Optional. The service account to associate the VM with.

• vm-name=at

  • Required. The name of the VM to create.

• .. zone=erat

  • The zone in which to create the Persistent Disks.

• ..compute-engine-target-defaults additional-licenses=justo

  • Additional licenses to assign to the VM.
  • Each invocation of this argument appends the given value to the array.
• applied-license os-license=ipsum
  • The OS license returned from the adaptation module's report.

• type=accusam

  • The license type that was used in OS adaptation.

• .. boot-option=dolores

  • Output only. The VM Boot Option, as set in the source VM.
• compute-scheduling min-node-cpus=5
  • The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
• on-host-maintenance=no
  • How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.

• restart-type=justo

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

• .. disk-type=sadipscing

  • The disk type to use in the VM.

• encryption kms-key=diam

  • Required. The name of the encryption key that is stored in Google Cloud KMS.

• .. hostname=sea

  • The hostname to assign to the VM.
• labels=key=ipsum
  • A map of labels to associate with the VM.
  • the value will be associated with the given key
• license-type=stet
  • The license type to use in OS adaptation.
• machine-type=gubergren
  • The machine type to create the VM with.
• machine-type-series=ipsum
  • The machine type series to create the VM with.
• metadata=key=no
  • The metadata key/value pairs to assign to the VM.
  • the value will be associated with the given key
• network-tags=sit
  • A list of network tags to associate with the VM.
  • Each invocation of this argument appends the given value to the array.
• secure-boot=true
  • Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI.
• service-account=lorem
  • The service account to associate the VM with.
• target-project=justo
  • The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
• vm-name=invidunt
  • The name of the VM to create.

• zone=sed

  • The zone in which to create the VM.

• .. create-time=nonumy

  • 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).
• current-sync-info cycle-number=91
  • The cycle's ordinal number.
• end-time=ipsum
  • The time the replication cycle has ended.
• error code=38
  • The status code, which should be an enum value of google.rpc.Code.

• message=justo

  • A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

• .. name=ea

  • The identifier of the ReplicationCycle.
• progress-percent=24
  • The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.
• start-time=erat
  • The time the replication cycle has started.
• state=clita
  • State of the ReplicationCycle.

• total-pause-duration=vero

  • The accumulated duration the replication cycle was paused.

• ..cutover-forecast estimated-cutover-job-duration=invidunt

  • Output only. Estimation of the CutoverJob duration.

• .. description=nonumy

  • The description attached to the migrating VM by the user.
• display-name=erat
  • The display name attached to the MigratingVm by the user.
• error code=70
  • The status code, which should be an enum value of google.rpc.Code.

• message=dolores

  • A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

• .. group=ipsum

  • Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate Group resource.
• labels=key=voluptua.
  • The labels of the migrating VM.
  • the value will be associated with the given key
• last-replication-cycle cycle-number=76
  • The cycle's ordinal number.
• end-time=duo
  • The time the replication cycle has ended.
• error code=7
  • The status code, which should be an enum value of google.rpc.Code.

• message=consetetur

  • A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

• .. name=et

  • The identifier of the ReplicationCycle.
• progress-percent=87
  • The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.
• start-time=sit
  • The time the replication cycle has started.
• state=takimata
  • State of the ReplicationCycle.

• total-pause-duration=erat

  • The accumulated duration the replication cycle was paused.

• ..last-sync last-sync-time=diam

  • The most updated snapshot created time in the source that finished replication.

• .. name=nonumy

  • Output only. The identifier of the MigratingVm.
• policy idle-duration=lorem
  • The idle duration between replication stages.

• skip-os-adaptation=false

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

• .. source-vm-id=diam

  • 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-.
• state=diam
  • Output only. State of the MigratingVm.
• state-time=sed
  • Output only. The last time the migrating VM state was updated.
• update-time=et
  • Output only. The last time the migrating VM resource was updated.
• vmware-source-vm-details committed-storage-bytes=ea
  • The total size of the disks being migrated in bytes.
• firmware=dolore
  • The firmware type of the source VM.
• vm-capabilities-info last-os-capabilities-update-time=ipsum
  • Output only. The last time OS capabilities list was updated.
• os-capabilities=ea
  • Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features.
  • Each invocation of this argument appends the given value to the array.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p request-id=string

  • 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 received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

• -p update-mask=string

  • Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").