imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00
Code Activity

gcloud: Wed Jun 19 09:33:28 UTC 2024

Browse source
This commit is contained in:
Automated 2024-06-19 09:33:28 +00:00
parent 04a1e3ce77
commit fb3e2aa33b
182 changed files with 3829 additions and 2129 deletions
Download patch file Download diff file Expand all files Collapse all files

4
gcloud/alpha/migration/vms/help
View file

@ -24,6 +24,10 @@ GROUPS
(ALPHA) Imports images to Google Compute Engine from Google Cloud
Storage.
machine-image-imports
(ALPHA) Imports machine images to Google Compute Engine from Google
Cloud Storage.
target-projects
(ALPHA) Manage Target Projects.

174
gcloud/alpha/migration/vms/machine-image-imports/create Normal file
View file

@ -0,0 +1,174 @@
NAME
gcloud alpha migration vms machine-image-imports create - import machine
images to Google Compute Engine
SYNOPSIS
gcloud alpha migration vms machine-image-imports create
(IMAGE_IMPORT_NAME : --location=LOCATION) --source-file=SOURCE_FILE
[--additional-licenses=[ADDITIONAL_LICENSES,...]]
[--description=DESCRIPTION] [--labels=[KEY=VALUE,...]]
[--machine-image-name=MACHINE_IMAGE_NAME] [--machine-type=MACHINE_TYPE]
[--single-region-storage] [--tags=[TAGS,...]]
[--target-project=TARGET_PROJECT]
[--enable-integrity-monitoring --enable-vtpm --secure-boot=SECURE_BOOT]
[--scopes=[SCOPES,...] --service-account=SERVICE_ACCOUNT]
[--skip-os-adaptation | --generalize --license-type=LICENSE_TYPE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha migration vms machine-image-imports create Imports
machine images such as OVA and OVF 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 ub-14.04.5.ova from my-images-bucket to my-target-project in
us-central1, create my-image-import resource in my-project in us-central1.
Run: $ gcloud alpha migration vms machine-image-imports create \
my-machine-image-import \
--source-file=gs://my-images-bucket/ub-14.04.5.ova \
--image-name=my-ubuntu-machine-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 machine image name if --machine-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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
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
machine image.
--description=DESCRIPTION
A description of the machine image.
--labels=[KEY=VALUE,...]
A map of labels to associate with the machine image.
--machine-image-name=MACHINE_IMAGE_NAME
The name of the machine image that will be imported to Google Compute
Engine. Default is the Image Import name.
--machine-type=MACHINE_TYPE
The machine type to create the machine image with. If not provided, the
service will choose a relevant machine type series based on the
information from the source image.
--single-region-storage
If true, the location of the imported machine image will be the region
of the import job. Otherwise the closest multi-region is selected.
Default is false.
--tags=[TAGS,...]
The tags to apply to the instance created by the machine image.
--target-project=TARGET_PROJECT
The target project resource path to which the machine image will be
imported. Default is the host project. To get a list of the target
projects run the gcloud alpha migration vms target-projects list
command.
Shielded instance configuration.
--enable-integrity-monitoring
Defines whether the instance created by the machine image has
integrity monitoring enabled. This can be set to true only if the
image boot option is EFI, and vTPM is enabled.
--enable-vtpm
Defines whether the instance created by the machine image has vTPM
enabled. This can be set to true only if the image boot option is
EFI.
--secure-boot=SECURE_BOOT
Defines whether the instance created by the machine image has Secure
Boot enabled. This can be set to true only if the image boot option
is EFI. If not specified we will use the configuration of the source.
SECURE_BOOT must be one of: false, secure-boot-unspecified, true.
The service account to assign to the instance created by the machine
image.
--scopes=[SCOPES,...]
The list of scopes to be made available for the service account.
--service-account=SERVICE_ACCOUNT
The email address of the service account.
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 machine image. Default false. The
generalization process enables co-existence of multiple VMs created
from the same machine image. For Windows, generalizing the machine
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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

72
gcloud/alpha/migration/vms/machine-image-imports/delete Normal file
View file

@ -0,0 +1,72 @@
NAME
gcloud alpha migration vms machine-image-imports delete - delete an Image
Import resource
SYNOPSIS
gcloud alpha migration vms machine-image-imports delete
(IMAGE_IMPORT_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha migration vms machine-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 machine images imported to Google Compute
Engine.
EXAMPLES
To delete my-image-import resource in us-central1 in the default project,
run: $ gcloud alpha migration vms machine-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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

70
gcloud/alpha/migration/vms/machine-image-imports/describe Normal file
View file

@ -0,0 +1,70 @@
NAME
gcloud alpha migration vms machine-image-imports describe - describe an
Image Import
SYNOPSIS
gcloud alpha migration vms machine-image-imports describe
(IMAGE_IMPORT_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha migration vms machine-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 alpha migration vms machine-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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

65
gcloud/alpha/migration/vms/machine-image-imports/help Normal file
View file

@ -0,0 +1,65 @@
NAME
gcloud alpha migration vms machine-image-imports - imports machine images
to Google Compute Engine from Google Cloud Storage
SYNOPSIS
gcloud alpha migration vms machine-image-imports COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha migration vms machine-image-imports provides a more
robust and better supported method for importing machine 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 Migration API which supports importing of a machine
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 machine-image-imports create creates a machine
Image Import resource with a nested Image Import Job resource. The Image
Import Job resource tracks the machine image import progress. After the
Image Import Job completes, successfully or otherwise, there's no further
use for the Image Import resource.
The machine 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 up to a certain number of 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 machine image. For more information about the image import
resource, see
https://cloud.google.com/migrate/virtual-machines/docs/5.0/migrate/image_import.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(ALPHA) import machine images to Google Compute Engine.
delete
(ALPHA) delete an Image Import resource.
describe
(ALPHA) describe an Image Import.
list
(ALPHA) list Image Imports.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

90
gcloud/alpha/migration/vms/machine-image-imports/list Normal file
View file

@ -0,0 +1,90 @@
NAME
gcloud alpha migration vms machine-image-imports list - list Image Imports
SYNOPSIS
gcloud alpha migration vms machine-image-imports list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha migration vms machine-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 alpha migration vms machine-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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
--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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.