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

gcloud: Tue Mar 1 04:29:52 UTC 2022

This commit is contained in:
Automated 2022-03-01 04:29:52 +00:00
parent aab53307a8
commit 1456dab6c7
9791 changed files with 814712 additions and 0 deletions

View file

@ -0,0 +1,43 @@
NAME
gcloud beta recommender - manage Cloud recommendations and recommendation
rules
SYNOPSIS
gcloud beta recommender GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Recommender allows you to retrieve recommendations for Cloud
resources, helping you to improve security, save costs, and more. Each
recommendation includes a suggested action, its justification, and its
impact. Recommendations are grouped into a per-resource collection. To
apply a recommendation, you must use the desired service's API, not the
Recommender. Interact with and manage resources in Cloud Recommender.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
insight-type-config
(BETA) Manage Cloud resource insight type configuration.
insights
(BETA) Manage Cloud resource insights.
recommendations
(BETA) Manage Cloud resource recommendations.
recommender-config
(BETA) Manage Cloud resource recommender configuration.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud recommender
$ gcloud alpha recommender

View file

@ -0,0 +1,50 @@
NAME
gcloud beta recommender insight-type-config describe - describe an insight
type configuration
SYNOPSIS
gcloud beta recommender insight-type-config describe INSIGHT_TYPE
--location=LOCATION
(--organization=ORGANIZATION_ID | --project=PROJECT_ID)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe an insight type configuration based on a given entity
(project, organization), location, and insight type.
EXAMPLES
To describe an insight type configuration, run:
$ gcloud beta recommender insight-type-config describe \
${INSIGHT_TYPE} --project=${PROJECT} --location=${LOCATION}
POSITIONAL ARGUMENTS
INSIGHT_TYPE
Insight type to use for this invocation.
REQUIRED FLAGS
--location=LOCATION
Location to use for this invocation.
Resource that is associated with cloud entity type.
Exactly one of these must be specified:
--organization=ORGANIZATION_ID
The Google Cloud Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Project ID. Overrides the default core/project
property value for this command invocation.
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 beta and might change without notice.

View file

@ -0,0 +1,27 @@
NAME
gcloud beta recommender insight-type-config - manage Cloud resource insight
type configuration
SYNOPSIS
gcloud beta recommender insight-type-config COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Cloud resource insight type configuration.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(BETA) Describe an insight type configuration.
update
(BETA) Update an insight type configuration.
NOTES
This command is currently in beta and might change without notice.

View file

@ -0,0 +1,70 @@
NAME
gcloud beta recommender insight-type-config update - update an insight type
configuration
SYNOPSIS
gcloud beta recommender insight-type-config update INSIGHT_TYPE --etag=ETAG
--location=LOCATION
(--organization=ORGANIZATION_ID | --project=PROJECT_ID)
[--annotations=KEY=VALUE,[KEY=VALUE,...]] [--config-file=CONFIG_FILE]
[--display-name=DISPLAY_NAME] [--validate-only] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update an insight type configuration based on a given entity
(project, organization), location, and insight type.
EXAMPLES
To update an insight type configuration, run:
$ gcloud beta recommender insight-type-config update \
${INSIGHT_TYPE} --project=${PROJECT} --location=${LOCATION}
--etag=\"123\" --config-file=config.yaml
POSITIONAL ARGUMENTS
INSIGHT_TYPE
Insight type to use for this invocation.
REQUIRED FLAGS
--etag=ETAG
Etag of the insight type configuration.
--location=LOCATION
Location to use for this invocation.
Resource that is associated with cloud entity type.
Exactly one of these must be specified:
--organization=ORGANIZATION_ID
The Google Cloud Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Project ID. Overrides the default core/project
property value for this command invocation.
OPTIONAL FLAGS
--annotations=KEY=VALUE,[KEY=VALUE,...]
Store small amounts of arbitrary data on the insight type
configuration.
--config-file=CONFIG_FILE
Generation configuration file for the insight type configuration.
--display-name=DISPLAY_NAME
Display name of the insight type configuration.
--validate-only
If true, validate the request and preview the change, but do not
actually update it.
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 beta and might change without notice.

View file

@ -0,0 +1,67 @@
NAME
gcloud beta recommender insights describe - describe an insight
SYNOPSIS
gcloud beta recommender insights describe INSIGHT
--insight-type=INSIGHT_TYPE --location=LOCATION
(--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe an insight. This currently supports the following parent
entities: project, billing account, folder, and organization.
EXAMPLES
To describe an insight:
$ gcloud beta recommender insights describe INSIGHT_ID \
--project=${PROJECT} --location=${LOCATION}
POSITIONAL ARGUMENTS
INSIGHT
insight to describe
REQUIRED FLAGS
--insight-type=INSIGHT_TYPE
Insight type to describe insights
--location=LOCATION
Location
Resource that is associated with cloud entity type. Currently four
mutually exclusive flags are supported, --project, --billing-account,
--folder, --organization.
Exactly one of these must be specified:
--billing-account=BILLING_ACCOUNT
The Google Cloud Platform Billing Account ID to use for this
invocation.
--folder=FOLDER_ID
Folder ID to use for this invocation.
--organization=ORGANIZATION_ID
The Google Cloud Platform Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Platform project ID. Overrides the default
core/project property value for this command invocation.
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 beta and might change without notice. These
variants are also available:
$ gcloud recommender insights describe
$ gcloud alpha recommender insights describe

View file

@ -0,0 +1,34 @@
NAME
gcloud beta recommender insights - manage Cloud resource insights
SYNOPSIS
gcloud beta recommender insights COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Cloud resource insights.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(BETA) Describe an insight.
list
(BETA) List insights for a cloud entity.
mark-accepted
(BETA) Mark an insight's state as ACCEPTED.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud recommender insights
$ gcloud alpha recommender insights

View file

@ -0,0 +1,100 @@
NAME
gcloud beta recommender insights list - list insights for a cloud entity
SYNOPSIS
gcloud beta recommender insights list --insight-type=INSIGHT_TYPE
--location=LOCATION
(--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command will list all insights for a give cloud entity,
location and insight type. Supported insight-types can be found here:
https://cloud.google.com/recommender/docs/insights/insight-types. Currently
the following cloud_entity_types are supported: project, billing_account,
folder and organization.
EXAMPLES
To list all insights for a billing account:
$ gcloud beta recommender insights list --project=project-name \
--location=global --insight-type=google.compute.firewall.Insight
REQUIRED FLAGS
--insight-type=INSIGHT_TYPE
Insight type to list insights for. Supported insight-types can be found
here: https://cloud.google.com/recommender/docs/insights/insight-types
--location=LOCATION
Location
Resource that is associated with cloud entity type. Currently four
mutually exclusive flags are supported, --project, --billing-account,
--folder, --organization.
Exactly one of these must be specified:
--billing-account=BILLING_ACCOUNT
The Google Cloud Platform Billing Account ID to use for this
invocation.
--folder=FOLDER_ID
Folder ID to use for this invocation.
--organization=ORGANIZATION_ID
The Google Cloud Platform Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Platform project ID. Overrides the default
core/project property value for this command invocation.
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.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud recommender insights list
$ gcloud alpha recommender insights list

View file

@ -0,0 +1,78 @@
NAME
gcloud beta recommender insights mark-accepted - mark an insight's state as
ACCEPTED
SYNOPSIS
gcloud beta recommender insights mark-accepted INSIGHT --etag=etag
--insight-type=INSIGHT_TYPE --location=LOCATION
(--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID)
[--state-metadata=KEY=VALUE,[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Mark an insight's state as ACCEPTED. Can be applied to insights in
ACTIVE or ACCEPTED state. The following are currently supported: project,
billing_account, folder, and organization.
EXAMPLES
To mark an insight as ACCEPTED:
$ gcloud beta recommender insights mark-accepted abcd-1234 \
--project=project-name --location=global \
--insight-type=google.compute.firewall.Insight --etag=abc123
POSITIONAL ARGUMENTS
INSIGHT
Insight id which will be marked as accepted
REQUIRED FLAGS
--etag=etag
Etag of a insight
--insight-type=INSIGHT_TYPE
Insight Type of the insights
--location=LOCATION
Location
Resource that is associated with cloud entity type. Currently four
mutually exclusive flags are supported, --project, --billing-account,
--folder, --organization.
Exactly one of these must be specified:
--billing-account=BILLING_ACCOUNT
The Google Cloud Platform Billing Account ID to use for this
invocation.
--folder=FOLDER_ID
Folder ID to use for this invocation.
--organization=ORGANIZATION_ID
The Google Cloud Platform Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Platform project ID. Overrides the default
core/project property value for this command invocation.
OPTIONAL FLAGS
--state-metadata=KEY=VALUE,[KEY=VALUE,...]
State metadata for recommendation, in format of
--state-metadata=key1=value1,key2=value2
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 beta and might change without notice. These
variants are also available:
$ gcloud recommender insights mark-accepted
$ gcloud alpha recommender insights mark-accepted

View file

@ -0,0 +1,69 @@
NAME
gcloud beta recommender recommendations describe - describe a
recommendation for a Cloud project
SYNOPSIS
gcloud beta recommender recommendations describe RECOMMENDATION
--location=LOCATION --recommender=RECOMMENDER
(--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe a recommendation. This currently supports the following
parent entities: project, billing account, folder, and organization.
EXAMPLES
To describe a recommendation:
$ gcloud beta recommender recommendations describe \
RECOMMENDATION_ID --project=${PROJECT} --location=${LOCATION}
--recommender=${RECOMMENDER}
POSITIONAL ARGUMENTS
RECOMMENDATION
Recommendation to describe
REQUIRED FLAGS
--location=LOCATION
Location
--recommender=RECOMMENDER
Recommender of the recommendations
Resource that is associated with cloud entity type. Currently four
mutually exclusive flags are supported, --project, --billing-account,
--folder, --organization.
Exactly one of these must be specified:
--billing-account=BILLING_ACCOUNT
The Google Cloud Platform Billing Account ID to use for this
invocation.
--folder=FOLDER_ID
Folder ID to use for this invocation.
--organization=ORGANIZATION_ID
The Google Cloud Platform Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Platform project ID. Overrides the default
core/project property value for this command invocation.
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 beta and might change without notice. These
variants are also available:
$ gcloud recommender recommendations describe
$ gcloud alpha recommender recommendations describe

View file

@ -0,0 +1,41 @@
NAME
gcloud beta recommender recommendations - manage Cloud resource
recommendations
SYNOPSIS
gcloud beta recommender recommendations COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Cloud resource recommendations.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(BETA) Describe a recommendation for a Cloud project.
list
(BETA) List operations for a recommendation.
mark-claimed
(BETA) Mark a recommendation's state as CLAIMED.
mark-failed
(BETA) Mark a recommendation's state as FAILED.
mark-succeeded
(BETA) Mark a recommendation's state as SUCCEEDED.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud recommender recommendations
$ gcloud alpha recommender recommendations

View file

@ -0,0 +1,100 @@
NAME
gcloud beta recommender recommendations list - list operations for a
recommendation
SYNOPSIS
gcloud beta recommender recommendations list --location=LOCATION
--recommender=RECOMMENDER
(--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command will list all recommendations for a give
cloud_entity_id, location and recommender. Supported recommenders can be
found here: https://cloud.google.com/recommender/docs/recommenders.
Currently the following cloud_entity_types are supported: project,
billing_account, folder and organization.
EXAMPLES
Lists recommendations for a Cloud project. $ gcloud beta recommender recommendations list \
--project=project-name --location=global \
--recommender=google.compute.instance.MachineTypeRecommender
REQUIRED FLAGS
--location=LOCATION
Location
--recommender=RECOMMENDER
Recommender to list recommendations for. Supported recommenders can be
found here: https://cloud.google.com/recommender/docs/recommenders
Resource that is associated with cloud entity type. Currently four
mutually exclusive flags are supported, --project, --billing-account,
--folder, --organization.
Exactly one of these must be specified:
--billing-account=BILLING_ACCOUNT
The Google Cloud Platform Billing Account ID to use for this
invocation.
--folder=FOLDER_ID
Folder ID to use for this invocation.
--organization=ORGANIZATION_ID
The Google Cloud Platform Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Platform project ID. Overrides the default
core/project property value for this command invocation.
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.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud recommender recommendations list
$ gcloud alpha recommender recommendations list

View file

@ -0,0 +1,81 @@
NAME
gcloud beta recommender recommendations mark-claimed - mark a
recommendation's state as CLAIMED
SYNOPSIS
gcloud beta recommender recommendations mark-claimed RECOMMENDATION
--etag=ETAG --location=LOCATION --recommender=RECOMMENDER
(--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID)
[--state-metadata=KEY=VALUE,[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Mark a recommendation's state as CLAIMED. Can be applied to
recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Users can
use this method to indicate to the Recommender API that they are starting
to apply the recommendation themselves. This stops the recommendation
content from being updated.
EXAMPLES
To mark a recommendation as CLAIMED:
$ gcloud beta recommender recommendations mark-claimed \
RECOMMENDATION --project=project-name --location=global
--recommender=google.compute.instance.MachineTypeRecommender --etag=abc123
--state-metadata=key1=value1,key2=value2
POSITIONAL ARGUMENTS
RECOMMENDATION
Recommendation id which will be marked as claimed
REQUIRED FLAGS
--etag=ETAG
Etag of a recommendation
--location=LOCATION
Location
--recommender=RECOMMENDER
Recommender of recommendation
Resource that is associated with cloud entity type. Currently four
mutually exclusive flags are supported, --project, --billing-account,
--folder, --organization.
Exactly one of these must be specified:
--billing-account=BILLING_ACCOUNT
The Google Cloud Platform Billing Account ID to use for this
invocation.
--folder=FOLDER_ID
Folder ID to use for this invocation.
--organization=ORGANIZATION_ID
The Google Cloud Platform Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Platform project ID. Overrides the default
core/project property value for this command invocation.
OPTIONAL FLAGS
--state-metadata=KEY=VALUE,[KEY=VALUE,...]
State metadata for recommendation, in format of
--state-metadata=key1=value1,key2=value2
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 beta and might change without notice. These
variants are also available:
$ gcloud recommender recommendations mark-claimed
$ gcloud alpha recommender recommendations mark-claimed

View file

@ -0,0 +1,78 @@
NAME
gcloud beta recommender recommendations mark-failed - mark a
recommendation's state as FAILED
SYNOPSIS
gcloud beta recommender recommendations mark-failed RECOMMENDATION
--etag=ETAG --location=LOCATION --recommender=RECOMMENDER
(--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID)
[--state-metadata=KEY=VALUE,[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Mark a recommendation's state as FAILED. Can be applied to
recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.
EXAMPLES
To mark a recommendation as FAILED:
$ gcloud beta recommender recommendations mark-failed abcd-1234 \
--project=project-name --location=global \
--recommender=google.compute.instance.MachineTypeRecommender \
--etag=abc123 --state-metadata=key1=value1,key2=value2
POSITIONAL ARGUMENTS
RECOMMENDATION
Recommendation id which will be marked as FAILED.
REQUIRED FLAGS
--etag=ETAG
Etag of a recommendation.
--location=LOCATION
Location.
--recommender=RECOMMENDER
Recommender of recommendation.
Resource that is associated with cloud entity type. Currently four
mutually exclusive flags are supported, --project, --billing-account,
--folder, --organization.
Exactly one of these must be specified:
--billing-account=BILLING_ACCOUNT
The Google Cloud Platform Billing Account ID to use for this
invocation.
--folder=FOLDER_ID
Folder ID to use for this invocation.
--organization=ORGANIZATION_ID
The Google Cloud Platform Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Platform project ID. Overrides the default
core/project property value for this command invocation.
OPTIONAL FLAGS
--state-metadata=KEY=VALUE,[KEY=VALUE,...]
State metadata for recommendation, in format of
--state-metadata=key1=value1,key2=value2
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 beta and might change without notice. These
variants are also available:
$ gcloud recommender recommendations mark-failed
$ gcloud alpha recommender recommendations mark-failed

View file

@ -0,0 +1,78 @@
NAME
gcloud beta recommender recommendations mark-succeeded - mark a
recommendation's state as SUCCEEDED
SYNOPSIS
gcloud beta recommender recommendations mark-succeeded RECOMMENDATION
--etag=ETAG --location=LOCATION --recommender=RECOMMENDER
(--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID)
[--state-metadata=KEY=VALUE,[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Mark a recommendation's state as SUCCEEDED. Can be applied to
recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.
EXAMPLES
To mark a recommendation as SUCCEEDED:
$ gcloud beta recommender recommendations mark-succeeded abcd-1234 \
--project=project-name --location=global \
--recommender=google.compute.instance.MachineTypeRecommender \
--etag=abc123 --state-metadata=key1=value1,key2=value2
POSITIONAL ARGUMENTS
RECOMMENDATION
Recommendation id which will be marked as succeeded
REQUIRED FLAGS
--etag=ETAG
Etag of a recommendation
--location=LOCATION
Location
--recommender=RECOMMENDER
Recommender of recommendation
Resource that is associated with cloud entity type. Currently four
mutually exclusive flags are supported, --project, --billing-account,
--folder, --organization.
Exactly one of these must be specified:
--billing-account=BILLING_ACCOUNT
The Google Cloud Platform Billing Account ID to use for this
invocation.
--folder=FOLDER_ID
Folder ID to use for this invocation.
--organization=ORGANIZATION_ID
The Google Cloud Platform Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Platform project ID. Overrides the default
core/project property value for this command invocation.
OPTIONAL FLAGS
--state-metadata=KEY=VALUE,[KEY=VALUE,...]
State metadata for recommendation, in format of
--state-metadata=key1=value1,key2=value2
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 beta and might change without notice. These
variants are also available:
$ gcloud recommender recommendations mark-succeeded
$ gcloud alpha recommender recommendations mark-succeeded

View file

@ -0,0 +1,50 @@
NAME
gcloud beta recommender recommender-config describe - describe a
recommender configuration
SYNOPSIS
gcloud beta recommender recommender-config describe RECOMMENDER
--location=LOCATION
(--organization=ORGANIZATION_ID | --project=PROJECT_ID)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe a recommender configuration based on a given entity
(project, organization), location, and recommender.
EXAMPLES
To describe a recommender configuration, run:
$ gcloud beta recommender recommender-config describe \
${RECOMMENDER} --project=${PROJECT} --location=${LOCATION}
POSITIONAL ARGUMENTS
RECOMMENDER
Recommender to use for this invocation.
REQUIRED FLAGS
--location=LOCATION
Location to use for this invocation.
Resource that is associated with cloud entity type.
Exactly one of these must be specified:
--organization=ORGANIZATION_ID
The Google Cloud Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Project ID. Overrides the default core/project
property value for this command invocation.
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 beta and might change without notice.

View file

@ -0,0 +1,27 @@
NAME
gcloud beta recommender recommender-config - manage Cloud resource
recommender configuration
SYNOPSIS
gcloud beta recommender recommender-config COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Cloud resource recommender configuration.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(BETA) Describe a recommender configuration.
update
(BETA) Update a recommender configuration.
NOTES
This command is currently in beta and might change without notice.

View file

@ -0,0 +1,69 @@
NAME
gcloud beta recommender recommender-config update - update a recommender
configuration
SYNOPSIS
gcloud beta recommender recommender-config update RECOMMENDER --etag=ETAG
--location=LOCATION
(--organization=ORGANIZATION_ID | --project=PROJECT_ID)
[--annotations=KEY=VALUE,[KEY=VALUE,...]] [--config-file=CONFIG_FILE]
[--display-name=DISPLAY_NAME] [--validate-only] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update a recommender configuration based on a given entity (project,
organization), location, and recommender.
EXAMPLES
To update a recommender configuration, run:
$ gcloud beta recommender recommender-config update ${RECOMMENDER} \
--project=${PROJECT} --location=${LOCATION}
--etag=\"123\" --config-file=config.yaml
POSITIONAL ARGUMENTS
RECOMMENDER
Recommender to use for this invocation.
REQUIRED FLAGS
--etag=ETAG
Etag of the recommender configuration.
--location=LOCATION
Location to use for this invocation.
Resource that is associated with cloud entity type.
Exactly one of these must be specified:
--organization=ORGANIZATION_ID
The Google Cloud Organization ID to use for this invocation.
--project=PROJECT_ID
The Google Cloud Project ID. Overrides the default core/project
property value for this command invocation.
OPTIONAL FLAGS
--annotations=KEY=VALUE,[KEY=VALUE,...]
Store small amounts of arbitrary data on the recommender configuration.
--config-file=CONFIG_FILE
Generation configuration file for the recommender configuration.
--display-name=DISPLAY_NAME
Display name of the recommender configuration.
--validate-only
If true, validate the request and preview the change, but do not
actually update it.
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 beta and might change without notice.