imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 02:25:19 +00:00
Code Activity

gcloud: Wed Sep 18 09:49:45 UTC 2024

Browse source
This commit is contained in:
Automated 2024-09-18 09:49:45 +00:00
parent a3842bba95
commit 8ebed5b0f1
182 changed files with 2067 additions and 1436 deletions
Download patch file Download diff file Expand all files Collapse all files

26
gcloud/migration/help Normal file
View file

@ -0,0 +1,26 @@
NAME
gcloud migration - the root group for various Cloud Migration teams
SYNOPSIS
gcloud migration GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Each team must have its own sub-group.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
vms
Provides Migrate to Virtual Machines (VM migration) service
functionality.
NOTES
This variant is also available:
$ gcloud alpha migration

30
gcloud/migration/vms/help Normal file
View file

@ -0,0 +1,30 @@
NAME
gcloud migration vms - provides Migrate to Virtual Machines (VM migration)
service functionality
SYNOPSIS
gcloud migration vms GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
The gcloud alpha migration vms command group provides the CLI for the
Migrate to Virtual Machines API. Google Cloud Migrate to Virtual Machines
migrates VMs from on-premises data center and other cloud providers to
Google Compute Engine virtual machine (VM) instances. VM Migration API must
be enabled in your project.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
image-imports
Imports images to Google Compute Engine from Google Cloud Storage.
NOTES
This variant is also available:
$ gcloud alpha migration vms

140
gcloud/migration/vms/image-imports/create Normal file
View file

@ -0,0 +1,140 @@
NAME
gcloud migration vms image-imports create - import Virtual Disk images to
Google Compute Engine
SYNOPSIS
gcloud migration vms image-imports create
(IMAGE_IMPORT_NAME : --location=LOCATION) --source-file=SOURCE_FILE
[--additional-licenses=[ADDITIONAL_LICENSES,...]]
[--description=DESCRIPTION] [--family-name=FAMILY_NAME]
[--image-name=IMAGE_NAME] [--kms-key=KMS_KEY]
[--labels=[KEY=VALUE,...]] [--single-region-storage]
[--target-project=TARGET_PROJECT]
[--skip-os-adaptation | --generalize --license-type=LICENSE_TYPE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud migration vms image-imports create imports images such as VMWare
VMDK files and VHD files, from a Google Cloud Storage file (gs://...) to
Google Compute Engine, using the Migrate to Virtual Machines service API.
This command creates an Image Import resource with a nested Image Import
Job resource. The Image Import Job resource tracks the image import
progress. To use this command, you must enable VM Migration API in your
project.
EXAMPLES
To import my-ubuntu22.04.vmdk from my-images-bucket to my-target-project in
us-central1, create my-image-import resource in my-project in us-central1.
Run: $ gcloud migration vms image-imports create my-image-import \
--source-file=gs://my-images-bucket/my-ubuntu22.04.vmdk \
--image-name=my-ubuntu-image --location=us-central1 \
--target-project=projects/my-project/locations/global/\
targetProjects/my-target-project --project=my-project
POSITIONAL ARGUMENTS
Image import resource - The Image Import resource you want to create. This
would be the image name if --image-name is not given. The arguments in
this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in
other ways.
To set the project attribute:
◆ provide the argument image_import_name on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
IMAGE_IMPORT_NAME
ID of the image_import or fully qualified identifier for the
image_import.
To set the image_import_name attribute:
▸ provide the argument image_import_name on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Resource location.
To set the location attribute:
▸ provide the argument image_import_name on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property compute/region.
REQUIRED FLAGS
--source-file=SOURCE_FILE
The path to the Google Cloud Storage file from which the image should
be imported.
OPTIONAL FLAGS
--additional-licenses=[ADDITIONAL_LICENSES,...]
Comma-separated list of the additional licenses to assign to the image.
--description=DESCRIPTION
A description of the image.
--family-name=FAMILY_NAME
The name of the image family to which the new image belongs.
--image-name=IMAGE_NAME
The name of the image that will be imported to Google Compute Engine.
Default is the Image Import name.
--kms-key=KMS_KEY
Fully qualified identifier for the Cloud KMS (Key Management Service)
cryptokey that will be used to protect the image.
--labels=[KEY=VALUE,...]
A map of labels to associate with the image.
--single-region-storage
If true, the location of the imported image will be the region of the
import job. Otherwise the closest multi-region is selected. Default is
false.
--target-project=TARGET_PROJECT
The target project resource path to which the image will be imported.
Default is the customer project. To get a list of the target projects
run the gcloud alpha migration vms target-projects list command.
OS adaptation parameters
At most one of these can be specified:
--skip-os-adaptation
If true, skip OS adaptation. Default false.
--generalize
If true, generalize the imported image. Default false. The
generalization process enables co-existence of multiple VMs created
from the same image. For Windows, generalizing the image removes
computer-specific information such as installed drivers and the
computer security identifier (SID).
--license-type=LICENSE_TYPE
The license to use post migration. LICENSE_TYPE must be one of:
compute-engine-license-type-byol,
compute-engine-license-type-default,
compute-engine-license-type-payg.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the vmmigration/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/migrate/virtual-machines
NOTES
This variant is also available:
$ gcloud alpha migration vms image-imports create

68
gcloud/migration/vms/image-imports/delete Normal file
View file

@ -0,0 +1,68 @@
NAME
gcloud migration vms image-imports delete - delete an Image Import resource
SYNOPSIS
gcloud migration vms image-imports delete
(IMAGE_IMPORT_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud migration vms image-imports delete deletes an Image Import resource.
To use this command, you must enable VM Migration API in your project.
This command does not delete any images imported to Google Compute Engine.
EXAMPLES
To delete my-image-import resource in us-central1 in the default project,
run: $ gcloud migration vms image-imports delete my-image-import \
--location=us-central1
POSITIONAL ARGUMENTS
Image import resource - The Image Import resource you want to delete. The
arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument image_import_name on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
IMAGE_IMPORT_NAME
ID of the image_import or fully qualified identifier for the
image_import.
To set the image_import_name attribute:
▸ provide the argument image_import_name on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Resource location.
To set the location attribute:
▸ provide the argument image_import_name on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property compute/region.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the vmmigration/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/migrate/virtual-machines
NOTES
This variant is also available:
$ gcloud alpha migration vms image-imports delete

68
gcloud/migration/vms/image-imports/describe Normal file
View file

@ -0,0 +1,68 @@
NAME
gcloud migration vms image-imports describe - describe an Image Import
SYNOPSIS
gcloud migration vms image-imports describe
(IMAGE_IMPORT_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud migration vms image-imports describe describes an Image Import
resource with a nested Image Import Job. The Image Import Job resource
tracks the image import progress. To use this command, you must enable VM
Migration API in your project.
EXAMPLES
To describe my-image-import resource in us-central1 in the default project,
run: $ gcloud migration vms image-imports describe my-image-import \
--location=us-central1
POSITIONAL ARGUMENTS
Image import resource - The Image Import you want to describe. The
arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument image_import_name on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
IMAGE_IMPORT_NAME
ID of the image_import or fully qualified identifier for the
image_import.
To set the image_import_name attribute:
▸ provide the argument image_import_name on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Resource location.
To set the location attribute:
▸ provide the argument image_import_name on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property compute/region.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the vmmigration/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/migrate/virtual-machines
NOTES
This variant is also available:
$ gcloud alpha migration vms image-imports describe

60
gcloud/migration/vms/image-imports/help Normal file
View file

@ -0,0 +1,60 @@
NAME
gcloud migration vms image-imports - imports images to Google Compute
Engine from Google Cloud Storage
SYNOPSIS
gcloud migration vms image-imports COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud alpha migration vms image-imports provides a more robust and better
supported method for importing images to Google Compute Engine. Other
image-related operations (for example, list) can be done using gcloud
compute images, as usual.
The commands use VM Migartion API which supports importing of an image from
a Google Cloud Storage file (gs://...) to a target project. VM Migration
API must be enabled in your project.
gcloud alpha migration vms image-imports create creates an Image Import
resource with a nested Image Import Job resource. The Image Import Job
resource tracks the image import progress. After the Image Import Job
completes, successfully or otherwise, there's no further use for the Image
Import resource.
The image is imported to a Google Cloud Project, desginated by the Target
Project resource. To get a list of Target Projects, run the gcloud alpha
migration vms target-projects list command. Use the Google Cloud console to
add target project resources. For information on adding target projects,
see
https://cloud.google.com/migrate/virtual-machines/docs/5.0/how-to/target-project.
A project can support a maximum of 1000 Image Import resources per project.
Hence it's recommended to delete an Image Import resource after the Image
Import Job is complete to avoid reaching the Image Import resources limit.
Deletion of Image Import resource does not affect the imported image.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
import Virtual Disk images to Google Compute Engine.
delete
delete an Image Import resource.
describe
describe an Image Import.
list
list Image Imports.
NOTES
This variant is also available:
$ gcloud alpha migration vms image-imports

88
gcloud/migration/vms/image-imports/list Normal file
View file

@ -0,0 +1,88 @@
NAME
gcloud migration vms image-imports list - list Image Imports
SYNOPSIS
gcloud migration vms image-imports list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud migration vms image-imports list prints a detailed list of Image
Import resources. To use this command, you must enable VM Migration API in
your project.
EXAMPLES
To list the Image Import resources in us-central1 in the default project,
run: $ gcloud migration vms image-imports list --location=us-central1
FLAGS
Location resource - The compute/region of the Image Import. To get a list
of the available regions, run gcloud compute regions list command. If not
specified, the value of the [compute/zone] property in the current gcloud
configuration is used. This represents a Cloud resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other
ways.
To set the project attribute:
◆ provide the argument --location on the command line with a fully
specified name;
◆ set the property compute/region with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line;
▸ set the property compute/region.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the vmmigration/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/migrate/virtual-machines
NOTES
This variant is also available:
$ gcloud alpha migration vms image-imports list