1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-15 17:35:31 +00:00

gcloud: Wed Sep 28 10:27:48 UTC 2022

This commit is contained in:
Automated 2022-09-28 10:27:48 +00:00
parent 29683b8af4
commit ffb9e43995
Failed to extract signature
198 changed files with 4783 additions and 367 deletions

View file

@ -24,6 +24,10 @@ GROUPS
nfs-shares
(ALPHA) Manage NFS shares in Bare Metal Solution.
serial-console-ssh-keys
(ALPHA) Manage SSH keys for accessing the interactive serial console in
Bare Metal Solution.
volumes
(ALPHA) Manage bare metal volumes in Bare Metal Solution.

View file

@ -0,0 +1,68 @@
NAME
gcloud alpha bms instances disable-serial-console - disable interactive
serial console for a Bare Metal Solution instance
SYNOPSIS
gcloud alpha bms instances disable-serial-console
(INSTANCE : --region=REGION) [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Disables interactive serial console for a Bare Metal Solution
instance.
EXAMPLES
To disable interactive serial console for an instance named test-instance,
run:
$ gcloud alpha bms instances disable-serial-console test-instance
POSITIONAL ARGUMENTS
Instance resource - Arguments and flags that specify the Bare Metal
Solution instance you want to disable interactive serial console for. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance. To
set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Region of the resource. To set the region attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --region on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 baremetalsolution/v2 API. The full documentation for
this API can be found at: https://cloud.google.com/bare-metal
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.

View file

@ -0,0 +1,68 @@
NAME
gcloud alpha bms instances enable-serial-console - enable interactive
serial console for a Bare Metal Solution instance
SYNOPSIS
gcloud alpha bms instances enable-serial-console
(INSTANCE : --region=REGION) [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Enables interactive serial console for a Bare Metal Solution
instance.
EXAMPLES
To enable interactive serial console for an instance named test-instance,
run:
$ gcloud alpha bms instances enable-serial-console test-instance
POSITIONAL ARGUMENTS
Instance resource - Arguments and flags that specify the Bare Metal
Solution instance you want to enable interactive serial console for. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance. To
set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Region of the resource. To set the region attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --region on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 baremetalsolution/v2 API. The full documentation for
this API can be found at: https://cloud.google.com/bare-metal
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.

View file

@ -19,6 +19,14 @@ COMMANDS
describe
(ALPHA) Describe a Bare Metal solution instance.
disable-serial-console
(ALPHA) Disable interactive serial console for a Bare Metal Solution
instance.
enable-serial-console
(ALPHA) Enable interactive serial console for a Bare Metal Solution
instance.
list
(ALPHA) List Bare Metal Solution instances in a project.

View file

@ -0,0 +1,71 @@
NAME
gcloud alpha bms serial-console-ssh-keys add - add a public SSH key to the
project for accessing the interactive serial console in Bare Metal
Solution
SYNOPSIS
gcloud alpha bms serial-console-ssh-keys add SERIAL_CONSOLE_SSH_KEY
(--key=KEY | --key-file=KEY_FILE) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Add a public SSH key to the project for accessing the interactive
serial console in Bare Metal Solution."
EXAMPLES
To add an SSH key called my-ssh-key in project my-project with a public key
ABC6695
$ gcloud alpha bms serial-console-ssh-keys add my-ssh-key \
--project=my-project --key=ABC6695
To add an SSH key called my-ssh-key in project my-project with a public key
stored in /home/user/.ssh/id_rsa.pub
$ gcloud alpha bms serial-console-ssh-keys add my-ssh-key \
--project=my-project --key-file=/home/user/.ssh/id_rsa.pub
POSITIONAL ARGUMENTS
Serial console ssh key resource - serial_console_ssh_key. 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 serial_console_ssh_key on the command line with
a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line. To set the region
attribute:
◆ provide the argument serial_console_ssh_key on the command line with
a fully specified name;
◆ global is the only supported location.
This must be specified.
SERIAL_CONSOLE_SSH_KEY
ID of the serial_console_ssh_key or fully qualified identifier for
the serial_console_ssh_key. To set the serial_console_ssh_key
attribute:
▸ provide the argument serial_console_ssh_key on the command line.
REQUIRED FLAGS
Exactly one of these must be specified:
--key=KEY
The SSH public key to add for the interactive serial console
--key-file=KEY_FILE
The path to a file containing an SSH public key to add for the
interactive serial console
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.
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.

View file

@ -0,0 +1,37 @@
NAME
gcloud alpha bms serial-console-ssh-keys - manage SSH keys for accessing
the interactive serial console in Bare Metal Solution
SYNOPSIS
gcloud alpha bms serial-console-ssh-keys COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage SSH keys for accessing the interactive serial console in
Bare Metal Solution.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
add
(ALPHA) Add a public SSH key to the project for accessing the
interactive serial console in Bare Metal Solution.
list
(ALPHA) List the SSH keys added to the project for accessing the
interactive serial console in Bare Metal Solution.
remove
(ALPHA) Remove an SSH key that is used to access the interactive serial
console in Bare Metal Solution given its name.
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.

View file

@ -0,0 +1,45 @@
NAME
gcloud alpha bms serial-console-ssh-keys list - list the SSH keys added to
the project for accessing the interactive serial console in Bare Metal
Solution
SYNOPSIS
gcloud alpha bms serial-console-ssh-keys list [--filter=EXPRESSION]
[--limit=LIMIT] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List the SSH keys added to the project for accessing the
interactive serial console in Bare Metal Solution.
EXAMPLES
To list all interactive serial console SSH keys within the project, run:
$ gcloud alpha bms serial-console-ssh-keys list
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, --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, --filter, --limit.
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.
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.

View file

@ -0,0 +1,53 @@
NAME
gcloud alpha bms serial-console-ssh-keys remove - remove an SSH key that is
used to access the interactive serial console in Bare Metal Solution
given its name
SYNOPSIS
gcloud alpha bms serial-console-ssh-keys remove SERIAL_CONSOLE_SSH_KEY
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Remove an SSH key that is used to access the interactive serial
console in Bare Metal Solution given its name.
EXAMPLES
To remove an SSH key called my-ssh-key run:
$ gcloud alpha bms serial-console-ssh-keys remove my-ssh-key
POSITIONAL ARGUMENTS
Serial console ssh key resource - serial_console_ssh_key. 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 serial_console_ssh_key on the command line with
a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line. To set the region
attribute:
◆ provide the argument serial_console_ssh_key on the command line with
a fully specified name;
◆ global is the only supported location.
This must be specified.
SERIAL_CONSOLE_SSH_KEY
ID of the serial_console_ssh_key or fully qualified identifier for
the serial_console_ssh_key. To set the serial_console_ssh_key
attribute:
▸ provide the argument serial_console_ssh_key on the command line.
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.
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.