- 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-folders|--include-folders=INCLUDE_FOLDERS] [--clear-locations|--include-locations=INCLUDE_LOCATIONS] [--clear-projects|--include-projects=INCLUDE_PROJECTS] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(BETA)Update a policy orchestrator. - EXAMPLES
-
To update an policy orchestrator
my-orchestratorin folder123456with 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.yamlTo update an policy orchestrator
my-orchestratorin folder123456with 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
projectattribute:-
provide the argument
policy_orchestratoron the command line with a fully specified name; -
provide the argument
--projecton 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_orchestratorattribute:-
provide the argument
policy_orchestratoron the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--folder=FOLDER-
Folder of the policy_orchestrator.
To set the
folderattribute:-
provide the argument
policy_orchestratoron the command line with a fully specified name; -
provide the argument
--folderon the command line. Must be specified for resource of type [policy_orchestrator_folder].
-
provide the argument
--organization=ORGANIZATION-
Organization of the policy_orchestrator.
To set the
organizationattribute:-
provide the argument
policy_orchestratoron the command line with a fully specified name; -
provide the argument
--organizationon the command line. Must be specified for resource of type [policy_orchestrator_organization].
-
provide the argument
-
provide the argument
-
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.
- FLAGS
-
--action=ACTION-
Action to be taken on policy.
ACTIONmust be one of:delete-
Delete a policy with a given name.
policy-idmust be specified. upsert-
Create or update a policy.
policy-filemust 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
DELETEaction. --state=STATE-
State of the policy orchestrator.
STATEmust be one of:active-
Updates the policy orchestrator to
ACTIVEstate. stopped-
Updates the policy orchestrator to
STOPPEDstate.
-
Folders to include in the policy orchestrator. Comma-separated list of folder
numbers. If
--include-foldersis set,--clear-foldersmust not be set. At most one of these can be specified:--clear-folders- Clears included folders from policy orchestrator selectors.
--include-folders=INCLUDE_FOLDERS- Applies policy to selected folders only.
-
Locations to include in the policy orchestrator, e.g.
us-central1-a. Ifinclude-locationsis set,clear-locationsmust not be set. At most one of these can be specified:--clear-locations- Clears included locations from policy orchestrator selectors.
--include-locations=INCLUDE_LOCATIONS- Applies policy to selected locations only.
-
Projects to include in the policy orchestrator. Comma separated list of project
numbers. If
include-projectsis set,clear-projectsmust 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 helpfor details. - API REFERENCE
-
This command uses the
osconfig/v2betaAPI. 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. These
variants are also available:
gcloud compute os-config policy-orchestrators updategcloud alpha compute os-config policy-orchestrators update
gcloud beta compute os-config policy-orchestrators update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.