OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-27 04:10:02 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/google_vmmigration1_cli/projects_locations-sources-migrating-vms-patch/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

924 lines
39 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-vmmigration1-cli/projects_locations-sources-migrating-vms-patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Locations Sources Migrating Vms Patch - VM Migration Service v5.0.4+20240222</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Locations Sources Migrating Vms Patch";
var mkdocs_page_input_path = "projects_locations-sources-migrating-vms-patch.md";
var mkdocs_page_url = "/google-apis-rs/google-vmmigration1-cli/projects_locations-sources-migrating-vms-patch/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> VM Migration Service v5.0.4+20240222
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get/">Locations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-groups-add-group-migration/">Locations Groups Add Group Migration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-groups-create/">Locations Groups Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-groups-delete/">Locations Groups Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-groups-get/">Locations Groups Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-groups-list/">Locations Groups List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-groups-patch/">Locations Groups Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-groups-remove-group-migration/">Locations Groups Remove Group Migration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-image-imports-create/">Locations Image Imports Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-image-imports-delete/">Locations Image Imports Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-image-imports-get/">Locations Image Imports Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-image-imports-image-import-jobs-cancel/">Locations Image Imports Image Import Jobs Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-image-imports-image-import-jobs-get/">Locations Image Imports Image Import Jobs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-image-imports-image-import-jobs-list/">Locations Image Imports Image Import Jobs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-image-imports-list/">Locations Image Imports List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-delete/">Locations Operations Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-list/">Locations Operations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-create/">Locations Sources Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-datacenter-connectors-create/">Locations Sources Datacenter Connectors Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-datacenter-connectors-delete/">Locations Sources Datacenter Connectors Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-datacenter-connectors-get/">Locations Sources Datacenter Connectors Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-datacenter-connectors-list/">Locations Sources Datacenter Connectors List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-datacenter-connectors-upgrade-appliance/">Locations Sources Datacenter Connectors Upgrade Appliance</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-delete/">Locations Sources Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-fetch-inventory/">Locations Sources Fetch Inventory</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-get/">Locations Sources Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-list/">Locations Sources List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-clone-jobs-cancel/">Locations Sources Migrating Vms Clone Jobs Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-clone-jobs-create/">Locations Sources Migrating Vms Clone Jobs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-clone-jobs-get/">Locations Sources Migrating Vms Clone Jobs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-clone-jobs-list/">Locations Sources Migrating Vms Clone Jobs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-create/">Locations Sources Migrating Vms Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-cutover-jobs-cancel/">Locations Sources Migrating Vms Cutover Jobs Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-cutover-jobs-create/">Locations Sources Migrating Vms Cutover Jobs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-cutover-jobs-get/">Locations Sources Migrating Vms Cutover Jobs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-cutover-jobs-list/">Locations Sources Migrating Vms Cutover Jobs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-delete/">Locations Sources Migrating Vms Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-finalize-migration/">Locations Sources Migrating Vms Finalize Migration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-get/">Locations Sources Migrating Vms Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-list/">Locations Sources Migrating Vms List</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Sources Migrating Vms Patch</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-pause-migration/">Locations Sources Migrating Vms Pause Migration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-replication-cycles-get/">Locations Sources Migrating Vms Replication Cycles Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-replication-cycles-list/">Locations Sources Migrating Vms Replication Cycles List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-resume-migration/">Locations Sources Migrating Vms Resume Migration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-migrating-vms-start-migration/">Locations Sources Migrating Vms Start Migration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-patch/">Locations Sources Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-utilization-reports-create/">Locations Sources Utilization Reports Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-utilization-reports-delete/">Locations Sources Utilization Reports Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-utilization-reports-get/">Locations Sources Utilization Reports Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-sources-utilization-reports-list/">Locations Sources Utilization Reports List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-target-projects-create/">Locations Target Projects Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-target-projects-delete/">Locations Target Projects Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-target-projects-get/">Locations Target Projects Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-target-projects-list/">Locations Target Projects List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-target-projects-patch/">Locations Target Projects Patch</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">VM Migration Service v5.0.4+20240222</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Locations Sources Migrating Vms Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/vmmigration1-cli/edit/master/docs/projects_locations-sources-migrating-vms-patch.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Updates the parameters of a single MigratingVm.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>vmmigration1 --scope &lt;scope&gt; projects locations-sources-migrating-vms-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Output only. The identifier of the MigratingVm.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>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.</p>
<p>For example, a structure like this:</p>
<pre><code>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]
</code></pre>
<p>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.</p>
<ul>
<li><code>-r .aws-source-vm-details committed-storage-bytes=at</code><ul>
<li>The total size of the disks being migrated in bytes.</li>
</ul>
</li>
<li><code>firmware=invidunt</code><ul>
<li>The firmware type of the source VM.</li>
</ul>
</li>
<li><code>vm-capabilities-info last-os-capabilities-update-time=clita</code><ul>
<li>Output only. The last time OS capabilities list was updated.</li>
</ul>
</li>
<li>
<p><code>os-capabilities=stet</code></p>
<ul>
<li>Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>...azure-source-vm-details committed-storage-bytes=aliquyam</code></p>
<ul>
<li>The total size of the disks being migrated in bytes.</li>
</ul>
</li>
<li><code>firmware=ut</code><ul>
<li>The firmware type of the source VM.</li>
</ul>
</li>
<li><code>vm-capabilities-info last-os-capabilities-update-time=sit</code><ul>
<li>Output only. The last time OS capabilities list was updated.</li>
</ul>
</li>
<li>
<p><code>os-capabilities=vero</code></p>
<ul>
<li>Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>...compute-engine-disks-target-defaults target-project=rebum.</code></p>
<ul>
<li>The full path of the resource of type TargetProject which represents the Compute Engine project in which to create the Persistent Disks.</li>
</ul>
</li>
<li><code>vm-target-defaults additional-licenses=dolores</code><ul>
<li>Optional. Additional licenses to assign to the VM.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>boot-disk-defaults device-name=consetetur</code><ul>
<li>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.</li>
</ul>
</li>
<li><code>disk-name=dolores</code><ul>
<li>Optional. The name of the disk.</li>
</ul>
</li>
<li><code>disk-type=sed</code><ul>
<li>Optional. The type of disk provisioning to use for the VM.</li>
</ul>
</li>
<li>
<p><code>encryption kms-key=invidunt</code></p>
<ul>
<li>Required. The name of the encryption key that is stored in Google Cloud KMS.</li>
</ul>
</li>
<li>
<p><code>..image source-image=clita</code></p>
<ul>
<li>Required. The Image resource used when creating the disk.</li>
</ul>
</li>
<li>
<p><code>...compute-scheduling min-node-cpus=2</code></p>
<ul>
<li>The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.</li>
</ul>
</li>
<li><code>on-host-maintenance=aliquyam</code><ul>
<li>How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.</li>
</ul>
</li>
<li>
<p><code>restart-type=magna</code></p>
<ul>
<li>Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to <code>automaticRestart</code> 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.</li>
</ul>
</li>
<li>
<p><code>..encryption kms-key=diam</code></p>
<ul>
<li>Required. The name of the encryption key that is stored in Google Cloud KMS.</li>
</ul>
</li>
<li>
<p><code>.. hostname=nonumy</code></p>
<ul>
<li>Optional. The hostname to assign to the VM.</li>
</ul>
</li>
<li><code>labels=key=et</code><ul>
<li>Optional. A map of labels to associate with the VM.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>machine-type=sanctus</code><ul>
<li>Required. The machine type to create the VM with.</li>
</ul>
</li>
<li><code>machine-type-series=accusam</code><ul>
<li>Optional. The machine type series to create the VM with. For presentation only.</li>
</ul>
</li>
<li><code>metadata=key=tempor</code><ul>
<li>Optional. The metadata key/value pairs to assign to the VM.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>network-tags=sed</code><ul>
<li>Optional. A list of network tags to associate with the VM.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>secure-boot=false</code><ul>
<li>Optional. Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI.</li>
</ul>
</li>
<li><code>service-account=diam</code><ul>
<li>Optional. The service account to associate the VM with.</li>
</ul>
</li>
<li>
<p><code>vm-name=at</code></p>
<ul>
<li>Required. The name of the VM to create.</li>
</ul>
</li>
<li>
<p><code>.. zone=erat</code></p>
<ul>
<li>The zone in which to create the Persistent Disks.</li>
</ul>
</li>
<li>
<p><code>..compute-engine-target-defaults additional-licenses=justo</code></p>
<ul>
<li>Additional licenses to assign to the VM.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>applied-license os-license=ipsum</code><ul>
<li>The OS license returned from the adaptation module&#39;s report.</li>
</ul>
</li>
<li>
<p><code>type=accusam</code></p>
<ul>
<li>The license type that was used in OS adaptation.</li>
</ul>
</li>
<li>
<p><code>.. boot-option=dolores</code></p>
<ul>
<li>Output only. The VM Boot Option, as set in the source VM.</li>
</ul>
</li>
<li><code>compute-scheduling min-node-cpus=5</code><ul>
<li>The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.</li>
</ul>
</li>
<li><code>on-host-maintenance=no</code><ul>
<li>How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.</li>
</ul>
</li>
<li>
<p><code>restart-type=justo</code></p>
<ul>
<li>Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to <code>automaticRestart</code> 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.</li>
</ul>
</li>
<li>
<p><code>.. disk-type=sadipscing</code></p>
<ul>
<li>The disk type to use in the VM.</li>
</ul>
</li>
<li>
<p><code>encryption kms-key=diam</code></p>
<ul>
<li>Required. The name of the encryption key that is stored in Google Cloud KMS.</li>
</ul>
</li>
<li>
<p><code>.. hostname=sea</code></p>
<ul>
<li>The hostname to assign to the VM.</li>
</ul>
</li>
<li><code>labels=key=ipsum</code><ul>
<li>A map of labels to associate with the VM.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>license-type=stet</code><ul>
<li>The license type to use in OS adaptation.</li>
</ul>
</li>
<li><code>machine-type=gubergren</code><ul>
<li>The machine type to create the VM with.</li>
</ul>
</li>
<li><code>machine-type-series=ipsum</code><ul>
<li>The machine type series to create the VM with.</li>
</ul>
</li>
<li><code>metadata=key=no</code><ul>
<li>The metadata key/value pairs to assign to the VM.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>network-tags=sit</code><ul>
<li>A list of network tags to associate with the VM.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>secure-boot=true</code><ul>
<li>Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI.</li>
</ul>
</li>
<li><code>service-account=lorem</code><ul>
<li>The service account to associate the VM with.</li>
</ul>
</li>
<li><code>target-project=justo</code><ul>
<li>The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.</li>
</ul>
</li>
<li><code>vm-name=invidunt</code><ul>
<li>The name of the VM to create.</li>
</ul>
</li>
<li>
<p><code>zone=sed</code></p>
<ul>
<li>The zone in which to create the VM.</li>
</ul>
</li>
<li>
<p><code>.. create-time=nonumy</code></p>
<ul>
<li>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).</li>
</ul>
</li>
<li><code>current-sync-info cycle-number=91</code><ul>
<li>The cycle&#39;s ordinal number.</li>
</ul>
</li>
<li><code>end-time=ipsum</code><ul>
<li>The time the replication cycle has ended.</li>
</ul>
</li>
<li><code>error code=38</code><ul>
<li>The status code, which should be an enum value of google.rpc.Code.</li>
</ul>
</li>
<li>
<p><code>message=justo</code></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><code>.. name=ea</code></p>
<ul>
<li>The identifier of the ReplicationCycle.</li>
</ul>
</li>
<li><code>progress-percent=24</code><ul>
<li>The current progress in percentage of this cycle. Was replaced by &#39;steps&#39; field, which breaks down the cycle progression more accurately.</li>
</ul>
</li>
<li><code>start-time=erat</code><ul>
<li>The time the replication cycle has started.</li>
</ul>
</li>
<li><code>state=clita</code><ul>
<li>State of the ReplicationCycle.</li>
</ul>
</li>
<li>
<p><code>total-pause-duration=vero</code></p>
<ul>
<li>The accumulated duration the replication cycle was paused.</li>
</ul>
</li>
<li>
<p><code>..cutover-forecast estimated-cutover-job-duration=invidunt</code></p>
<ul>
<li>Output only. Estimation of the CutoverJob duration.</li>
</ul>
</li>
<li>
<p><code>.. description=nonumy</code></p>
<ul>
<li>The description attached to the migrating VM by the user.</li>
</ul>
</li>
<li><code>display-name=erat</code><ul>
<li>The display name attached to the MigratingVm by the user.</li>
</ul>
</li>
<li><code>error code=70</code><ul>
<li>The status code, which should be an enum value of google.rpc.Code.</li>
</ul>
</li>
<li>
<p><code>message=dolores</code></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><code>.. group=ipsum</code></p>
<ul>
<li>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.</li>
</ul>
</li>
<li><code>labels=key=voluptua.</code><ul>
<li>The labels of the migrating VM.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>last-replication-cycle cycle-number=76</code><ul>
<li>The cycle&#39;s ordinal number.</li>
</ul>
</li>
<li><code>end-time=duo</code><ul>
<li>The time the replication cycle has ended.</li>
</ul>
</li>
<li><code>error code=7</code><ul>
<li>The status code, which should be an enum value of google.rpc.Code.</li>
</ul>
</li>
<li>
<p><code>message=consetetur</code></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><code>.. name=et</code></p>
<ul>
<li>The identifier of the ReplicationCycle.</li>
</ul>
</li>
<li><code>progress-percent=87</code><ul>
<li>The current progress in percentage of this cycle. Was replaced by &#39;steps&#39; field, which breaks down the cycle progression more accurately.</li>
</ul>
</li>
<li><code>start-time=sit</code><ul>
<li>The time the replication cycle has started.</li>
</ul>
</li>
<li><code>state=takimata</code><ul>
<li>State of the ReplicationCycle.</li>
</ul>
</li>
<li>
<p><code>total-pause-duration=erat</code></p>
<ul>
<li>The accumulated duration the replication cycle was paused.</li>
</ul>
</li>
<li>
<p><code>..last-sync last-sync-time=diam</code></p>
<ul>
<li>The most updated snapshot created time in the source that finished replication.</li>
</ul>
</li>
<li>
<p><code>.. name=nonumy</code></p>
<ul>
<li>Output only. The identifier of the MigratingVm.</li>
</ul>
</li>
<li><code>policy idle-duration=lorem</code><ul>
<li>The idle duration between replication stages.</li>
</ul>
</li>
<li>
<p><code>skip-os-adaptation=false</code></p>
<ul>
<li>A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM&#39;s operating system undergoes changes and adaptations to fully function on Compute Engine.</li>
</ul>
</li>
<li>
<p><code>.. source-vm-id=diam</code></p>
<ul>
<li>The unique ID of the VM in the source. The VM&#39;s name in vSphere can be changed, so this is not the VM&#39;s name but rather its moRef id. This id is of the form vm-.</li>
</ul>
</li>
<li><code>state=diam</code><ul>
<li>Output only. State of the MigratingVm.</li>
</ul>
</li>
<li><code>state-time=sed</code><ul>
<li>Output only. The last time the migrating VM state was updated.</li>
</ul>
</li>
<li><code>update-time=et</code><ul>
<li>Output only. The last time the migrating VM resource was updated.</li>
</ul>
</li>
<li><code>vmware-source-vm-details committed-storage-bytes=ea</code><ul>
<li>The total size of the disks being migrated in bytes.</li>
</ul>
</li>
<li><code>firmware=dolore</code><ul>
<li>The firmware type of the source VM.</li>
</ul>
</li>
<li><code>vm-capabilities-info last-os-capabilities-update-time=ipsum</code><ul>
<li>Output only. The last time OS capabilities list was updated.</li>
</ul>
</li>
<li><code>os-capabilities=ea</code><ul>
<li>Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>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 <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li>
<p><strong>-p request-id=string</strong></p>
<ul>
<li>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).</li>
</ul>
</li>
<li>
<p><strong>-p update-mask=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_locations-sources-migrating-vms-list/" class="btn btn-neutral float-left" title="Locations Sources Migrating Vms List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_locations-sources-migrating-vms-pause-migration/" class="btn btn-neutral float-right" title="Locations Sources Migrating Vms Pause Migration">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/vmmigration1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_locations-sources-migrating-vms-list/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_locations-sources-migrating-vms-pause-migration/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink