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

gcloud: Thu Nov 7 09:57:40 UTC 2024

Browse source
This commit is contained in:
Automated 2024-11-07 09:57:40 +00:00
parent d7d92f8000
commit 7da5872e5c
106 changed files with 3468 additions and 293 deletions
Download patch file Download diff file Expand all files Collapse all files

3
gcloud/beta/compute/os-config/help
View file

@ -26,6 +26,9 @@ GROUPS
patch-jobs
(BETA) Manage OS patches for Compute Engine VMs.
policy-orchestrators
(BETA) Manage VM Manager policy orchestrators.
COMMANDS
COMMAND is one of the following:

137
gcloud/beta/compute/os-config/policy-orchestrators/create Normal file
View file

@ -0,0 +1,137 @@
NAME
gcloud beta compute os-config policy-orchestrators create - create a policy
orchestrator
SYNOPSIS
gcloud beta compute os-config policy-orchestrators create
(POLICY_ORCHESTRATOR : --folder=FOLDER --organization=ORGANIZATION)
--policy-type=POLICY_TYPE [--action=ACTION; default="upsert"] [--async]
[--include-projects=INCLUDE_PROJECTS] [--policy-file=POLICY_FILE]
[--policy-id=POLICY_ID] [--state=STATE; default="ACTIVE"]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create a policy orchestrator.
EXAMPLES
To create a policy orchestrator my-orchestrator in folder 123456 for OS
policy assignment with config file /path/to/file/config.yaml, run:
$ gcloud beta compute os-config policy-orchestrators create \
my-orchestrator --folder=123456 \
--policy-type os_policy_assignment_v1 \
--policy-file=/path/to/file/config.yaml
To create a policy orchestrator my-orchestrator in folder 123456 that
deletes OS Policy assignments with id my-policy, run:
$ gcloud beta compute os-config policy-orchestrators create \
my-orchestrator --folder=123456 \
--policy-type os_policy_assignment_v1 --action delete \
--policy-id my-policy
POSITIONAL ARGUMENTS
Policy orchestrator resource - Policy orchestrator to create. 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 policy_orchestrator on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [policy_orchestrator_project,
policy_orchestrator_folder, policy_orchestrator_organization].
This must be specified.
POLICY_ORCHESTRATOR
ID of the policy_orchestrator or fully qualified identifier for the
policy_orchestrator.
To set the policy_orchestrator attribute:
▸ provide the argument policy_orchestrator on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--folder=FOLDER
Folder of the policy_orchestrator.
To set the folder attribute:
▸ provide the argument policy_orchestrator on the command line with
a fully specified name;
▸ provide the argument --folder on the command line. Must be
specified for resource of type [policy_orchestrator_folder].
--organization=ORGANIZATION
Organization of the policy_orchestrator.
To set the organization attribute:
▸ provide the argument policy_orchestrator on the command line with
a fully specified name;
▸ provide the argument --organization on the command line. Must be
specified for resource of type [policy_orchestrator_organization].
REQUIRED FLAGS
--policy-type=POLICY_TYPE
Policy type to use. POLICY_TYPE must be (only one value is supported):
os_policy_assignment_v1
OS policy assignment v1.
OPTIONAL FLAGS
--action=ACTION; default="upsert"
Action to be taken on policy. ACTION must be one of:
delete
Delete a policy with a given name. policy-id must be specified.
upsert
Create or update a policy. policy-file must be specified.
--async
Return immediately, without waiting for the operation in progress to
complete.
--include-projects=INCLUDE_PROJECTS
Applies policy to selected projects only.
--policy-file=POLICY_FILE
Absolute path to the OS policy assignment file on your local client.
File must be in either JSON or YAML format. This file defines the OS
policies that you want to apply to your VMs, the target VMs that you
want to apply the policies to, and the rollout rate at which to apply
the OS policies on a zonal level. For more information about this
resource and sample OS policy assignment files, see
https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies#os-policy-assignment.
--policy-id=POLICY_ID
Policy id. Must be specified for DELETE action.
--state=STATE; default="ACTIVE"
State of the policy orchestrator. STATE must be one of:
active
Creates a policy orchestrator in ACTIVE state.
stopped
Creates a policy orchestrator in STOPPED state.
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 osconfig/v2beta API. The full documentation for this
API can be found at: https://cloud.google.com/compute/docs/osconfig/rest
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha compute os-config policy-orchestrators create

86
gcloud/beta/compute/os-config/policy-orchestrators/delete Normal file
View file

@ -0,0 +1,86 @@
NAME
gcloud beta compute os-config policy-orchestrators delete - delete a policy
orchestrator
SYNOPSIS
gcloud beta compute os-config policy-orchestrators delete
(POLICY_ORCHESTRATOR : --folder=FOLDER --organization=ORGANIZATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Delete a policy orchestrator and cancel ongoing rollouts
(best-effort).
EXAMPLES
To delete a policy orchestrator my-orchestrator in the folder 123456:
$ gcloud beta compute os-config policy-orchestrators delete \
my-orchestrator --folder=123456
POSITIONAL ARGUMENTS
Policy orchestrator resource - policy orchestrator 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 policy_orchestrator on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [policy_orchestrator_project,
policy_orchestrator_folder, policy_orchestrator_organization].
This must be specified.
POLICY_ORCHESTRATOR
ID of the policy_orchestrator or fully qualified identifier for the
policy_orchestrator.
To set the policy_orchestrator attribute:
▸ provide the argument policy_orchestrator on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--folder=FOLDER
Folder of the policy_orchestrator.
To set the folder attribute:
▸ provide the argument policy_orchestrator on the command line with
a fully specified name;
▸ provide the argument --folder on the command line. Must be
specified for resource of type [policy_orchestrator_folder].
--organization=ORGANIZATION
Organization of the policy_orchestrator.
To set the organization attribute:
▸ provide the argument policy_orchestrator on the command line with
a fully specified name;
▸ provide the argument --organization on the command line. Must be
specified for resource of type [policy_orchestrator_organization].
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 osconfig/v2beta API. The full documentation for this
API can be found at: https://cloud.google.com/compute/docs/osconfig/rest
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha compute os-config policy-orchestrators delete

80
gcloud/beta/compute/os-config/policy-orchestrators/describe Normal file
View file

@ -0,0 +1,80 @@
NAME
gcloud beta compute os-config policy-orchestrators describe - describe a
policy orchestrator
SYNOPSIS
gcloud beta compute os-config policy-orchestrators describe
(POLICY_ORCHESTRATOR : --folder=FOLDER --organization=ORGANIZATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Get the details of a policy orchestrator.
EXAMPLES
To describe a policy orchestrator my-orchestrator:
$ gcloud beta compute os-config policy-orchestrators describe \
my-orchestrator
POSITIONAL ARGUMENTS
Policy orchestrator resource - The policy orchestrator 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 policy_orchestrator on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [policy_orchestrator_project,
policy_orchestrator_folder, policy_orchestrator_organization].
This must be specified.
POLICY_ORCHESTRATOR
ID of the policy_orchestrator or fully qualified identifier for the
policy_orchestrator.
To set the policy_orchestrator attribute:
▸ provide the argument policy_orchestrator on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--folder=FOLDER
Folder of the policy_orchestrator.
To set the folder attribute:
▸ provide the argument policy_orchestrator on the command line with
a fully specified name;
▸ provide the argument --folder on the command line. Must be
specified for resource of type [policy_orchestrator_folder].
--organization=ORGANIZATION
Organization of the policy_orchestrator.
To set the organization attribute:
▸ provide the argument policy_orchestrator on the command line with
a fully specified name;
▸ provide the argument --organization on the command line. Must be
specified for resource of type [policy_orchestrator_organization].
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 osconfig/v2beta API. The full documentation for this
API can be found at: https://cloud.google.com/compute/docs/osconfig/rest
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha compute os-config policy-orchestrators describe

40
gcloud/beta/compute/os-config/policy-orchestrators/help Normal file
View file

@ -0,0 +1,40 @@
NAME
gcloud beta compute os-config policy-orchestrators - manage VM Manager
policy orchestrators
SYNOPSIS
gcloud beta compute os-config policy-orchestrators COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage VM Manager policy orchestrators.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(BETA) Create a policy orchestrator.
delete
(BETA) Delete a policy orchestrator.
describe
(BETA) Describe a policy orchestrator.
list
(BETA) List policy orchestrators for a specified folder.
update
(BETA) Update a policy orchestrator.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha compute os-config policy-orchestrators

96
gcloud/beta/compute/os-config/policy-orchestrators/list Normal file
View file

@ -0,0 +1,96 @@
NAME
gcloud beta compute os-config policy-orchestrators list - list policy
orchestrators for a specified folder
SYNOPSIS
gcloud beta compute os-config policy-orchestrators list
[--folder=FOLDER --organization=ORGANIZATION] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List policy orchestrators for a specified folder.
EXAMPLES
To list the policy orchestrators in folder 123456, run:
$ gcloud beta compute os-config policy-orchestrators list \
--folder 123456
FLAGS
Project folder organization resource - Folder to list policy orchestrators
from. 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 --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [project_a, folder_a, organization_a].
--folder=FOLDER
ID of the project_folder_organization or fully qualified identifier
for the project_folder_organization.
To set the folder attribute:
▸ provide the argument --folder on the command line. Must be
specified for resource of type [folder_a].
--organization=ORGANIZATION
ID of the project_folder_organization or fully qualified identifier
for the project_folder_organization.
To set the organization attribute:
▸ provide the argument --organization on the command line. Must be
specified for resource of type [organization_a].
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 osconfig/v2beta API. The full documentation for this
API can be found at: https://cloud.google.com/compute/docs/osconfig/rest
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha compute os-config policy-orchestrators list

135
gcloud/beta/compute/os-config/policy-orchestrators/update Normal file
View file

@ -0,0 +1,135 @@
NAME
gcloud beta compute os-config policy-orchestrators update - update a policy
orchestrator
SYNOPSIS
gcloud beta compute os-config policy-orchestrators update
(POLICY_ORCHESTRATOR : --folder=FOLDER --organization=ORGANIZATION)
[--action=ACTION] [--async] [--policy-file=POLICY_FILE]
[--policy-id=POLICY_ID] [--state=STATE]
[--clear-projects | --include-projects=INCLUDE_PROJECTS]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update a policy orchestrator.
EXAMPLES
To update an policy orchestrator my-orchestrator in folder 123456 with
config file /path/to/file/config.yaml, run:
$ gcloud beta compute os-config policy-orchestrators update \
my-orchestrator --folder=123456 \
--policy-file=/path/to/file/config.yaml
To update an policy orchestrator my-orchestrator in folder 123456 with
state STOPPED, run:
$ gcloud beta compute os-config policy-orchestrators update \
my-orchestrator --folder=123456 --state=stopped
POSITIONAL ARGUMENTS
Policy orchestrator resource - Policy orchestrator to update. 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 policy_orchestrator on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [policy_orchestrator_project,
policy_orchestrator_folder, policy_orchestrator_organization].
This must be specified.
POLICY_ORCHESTRATOR
ID of the policy_orchestrator or fully qualified identifier for the
policy_orchestrator.
To set the policy_orchestrator attribute:
▸ provide the argument policy_orchestrator on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--folder=FOLDER
Folder of the policy_orchestrator.
To set the folder attribute:
▸ provide the argument policy_orchestrator on the command line with
a fully specified name;
▸ provide the argument --folder on the command line. Must be
specified for resource of type [policy_orchestrator_folder].
--organization=ORGANIZATION
Organization of the policy_orchestrator.
To set the organization attribute:
▸ provide the argument policy_orchestrator on the command line with
a fully specified name;
▸ provide the argument --organization on the command line. Must be
specified for resource of type [policy_orchestrator_organization].
FLAGS
--action=ACTION
Action to be taken on policy. ACTION must be one of:
delete
Delete a policy with a given name. policy-id must be specified.
upsert
Create or update a policy. policy-file must be specified.
--async
Return immediately, without waiting for the operation in progress to
complete.
--policy-file=POLICY_FILE
Absolute path to the OS policy assignment file on your local client.
File must be in either JSON or YAML format. This file defines the OS
policies that you want to apply to your VMs, the target VMs that you
want to apply the policies to, and the rollout rate at which to apply
the OS policies on a zonal level. For more information about this
resource and sample OS policy assignment files, see
https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies#os-policy-assignment.
--policy-id=POLICY_ID
Policy id. Must be specified for DELETE action.
--state=STATE
State of the policy orchestrator. STATE must be one of:
active
Updates the policy orchestrator to ACTIVE state.
stopped
Updates the policy orchestrator to STOPPED state.
Projects to include in the policy orchestrator. If include-projects is
set, clear-projects must not be set.
At most one of these can be specified:
--clear-projects
Clears included projects from policy orchestrator selectors.
--include-projects=INCLUDE_PROJECTS
Applies policy to selected projects only.
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 osconfig/v2beta API. The full documentation for this
API can be found at: https://cloud.google.com/compute/docs/osconfig/rest
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha compute os-config policy-orchestrators update