| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 75 | <h1><a href="osconfig_v1beta.html">OS Config API</a> . <a href="osconfig_v1beta.projects.html">projects</a> . <a href="osconfig_v1beta.projects.guestPolicies.html">guestPolicies</a></h1> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(parent, body=None, guestPolicyId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Create an OS Config guest policy.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Delete an OS Config guest policy.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Get an OS Config guest policy.</p> |
| 89 | <p class="toc_element"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 91 | <p class="firstline">Get a page of OS Config guest policies.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Update an OS Config guest policy.</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | <code class="details" id="create">create(parent, body=None, guestPolicyId=None, x__xgafv=None)</code> |
| 106 | <pre>Create an OS Config guest policy. |
| 107 | |
| 108 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 109 | parent: string, Required. The resource name of the parent using one of the following forms: `projects/{project_number}`. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 113 | { # An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 114 | "packageRepositories": [ # A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available. |
| 115 | { # A package repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 116 | "yum": { # Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 117 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 118 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 119 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 120 | "gpgKeys": [ # URIs of GPG keys. |
| 121 | "A String", |
| 122 | ], |
| 123 | }, |
| 124 | "apt": { # Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 125 | "uri": "A String", # Required. URI for this repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 126 | "archiveType": "A String", # Type of archive files in this repository. The default behavior is DEB. |
| 127 | "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy. |
| 128 | "distribution": "A String", # Required. Distribution of this repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 129 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 130 | "A String", |
| 131 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 132 | }, |
| 133 | "zypper": { # Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 134 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 135 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 136 | "gpgKeys": [ # URIs of GPG keys. |
| 137 | "A String", |
| 138 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 139 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 140 | }, |
| 141 | "goo": { # Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. # A Goo Repository. |
| 142 | "name": "A String", # Required. The name of the repository. |
| 143 | "url": "A String", # Required. The url of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 144 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 145 | }, |
| 146 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 147 | "updateTime": "A String", # Output only. Last time this guest policy was updated. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 148 | "assignment": { # An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones. # Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 149 | "osTypes": [ # Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included. |
| 150 | { # Defines the criteria for selecting VM Instances by OS type. |
| 151 | "osArchitecture": "A String", # Targets VM instances with OS Inventory enabled and having the following OS architecture. |
| 152 | "osShortName": "A String", # Targets VM instances with OS Inventory enabled and having the following OS short name, for example "debian" or "windows". |
| 153 | "osVersion": "A String", # Targets VM instances with OS Inventory enabled and having the following following OS version. |
| 154 | }, |
| 155 | ], |
| 156 | "zones": [ # Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone. |
| 157 | "A String", |
| 158 | ], |
| 159 | "instanceNamePrefixes": [ # Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-". Only supported for project-level policies. |
| 160 | "A String", |
| 161 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 162 | "groupLabels": [ # Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging". |
| 163 | { # Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web". |
| 164 | "labels": { # Google Compute Engine instance labels that must be present for an instance to be included in this assignment group. |
| 165 | "a_key": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 166 | }, |
| 167 | }, |
| 168 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 169 | "instances": [ # Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project. |
| 170 | "A String", |
| 171 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 172 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 173 | "recipes": [ # A list of Recipes to install on the VM instance. |
| 174 | { # A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. |
| 175 | "installSteps": [ # Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. |
| 176 | { # An action that can be taken as part of installing or updating a recipe. |
| 177 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 178 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 179 | }, |
| 180 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 181 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 182 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 183 | 42, |
| 184 | ], |
| 185 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 186 | "A String", |
| 187 | ], |
| 188 | }, |
| 189 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 190 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 191 | }, |
| 192 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 193 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 194 | "args": [ # Arguments to be passed to the provided executable. |
| 195 | "A String", |
| 196 | ], |
| 197 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 198 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 199 | 42, |
| 200 | ], |
| 201 | }, |
| 202 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 203 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 204 | "script": "A String", # Required. The shell script to be executed. |
| 205 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 206 | 42, |
| 207 | ], |
| 208 | }, |
| 209 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 210 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 211 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 212 | "type": "A String", # Required. The type of the archive to extract. |
| 213 | }, |
| 214 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 215 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 216 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 217 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 218 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 219 | }, |
| 220 | }, |
| 221 | ], |
| 222 | "desiredState": "A String", # Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. |
| 223 | "artifacts": [ # Resources available to be used in the steps in the recipe. |
| 224 | { # Specifies a resource to be used in the recipe. |
| 225 | "remote": { # Specifies an artifact available via some URI. # A generic remote artifact. |
| 226 | "checksum": "A String", # Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps. |
| 227 | "uri": "A String", # URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. |
| 228 | }, |
| 229 | "id": "A String", # Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id. |
| 230 | "allowInsecure": True or False, # Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified. |
| 231 | "gcs": { # Specifies an artifact available as a Google Cloud Storage object. # A Google Cloud Storage artifact. |
| 232 | "bucket": "A String", # Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`. |
| 233 | "object": "A String", # Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`. |
| 234 | "generation": "A String", # Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`. |
| 235 | }, |
| 236 | }, |
| 237 | ], |
| 238 | "updateSteps": [ # Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. |
| 239 | { # An action that can be taken as part of installing or updating a recipe. |
| 240 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 241 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 242 | }, |
| 243 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 244 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 245 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 246 | 42, |
| 247 | ], |
| 248 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 249 | "A String", |
| 250 | ], |
| 251 | }, |
| 252 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 253 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 254 | }, |
| 255 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 256 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 257 | "args": [ # Arguments to be passed to the provided executable. |
| 258 | "A String", |
| 259 | ], |
| 260 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 261 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 262 | 42, |
| 263 | ], |
| 264 | }, |
| 265 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 266 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 267 | "script": "A String", # Required. The shell script to be executed. |
| 268 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 269 | 42, |
| 270 | ], |
| 271 | }, |
| 272 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 273 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 274 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 275 | "type": "A String", # Required. The type of the archive to extract. |
| 276 | }, |
| 277 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 278 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 279 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 280 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 281 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 282 | }, |
| 283 | }, |
| 284 | ], |
| 285 | "name": "A String", # Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments. |
| 286 | "version": "A String", # The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 287 | }, |
| 288 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 289 | "createTime": "A String", # Output only. Time this guest policy was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 290 | "description": "A String", # Description of the guest policy. Length of the description is limited to 1024 characters. |
| 291 | "etag": "A String", # The etag for this guest policy. If this is provided on update, it must match the server's etag. |
| 292 | "packages": [ # The software packages to be managed by this policy. |
| 293 | { # Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3` |
| 294 | "desiredState": "A String", # The desired_state the agent should maintain for this package. The default is to ensure the package is installed. |
| 295 | "manager": "A String", # Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY. |
| 296 | "name": "A String", # Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets. |
| 297 | }, |
| 298 | ], |
| 299 | "name": "A String", # Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 300 | } |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 301 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 302 | guestPolicyId: string, Required. The logical name of the guest policy in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 303 | x__xgafv: string, V1 error format. |
| 304 | Allowed values |
| 305 | 1 - v1 error format |
| 306 | 2 - v2 error format |
| 307 | |
| 308 | Returns: |
| 309 | An object of the form: |
| 310 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 311 | { # An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 312 | "packageRepositories": [ # A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available. |
| 313 | { # A package repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 314 | "yum": { # Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 315 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 316 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 317 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 318 | "gpgKeys": [ # URIs of GPG keys. |
| 319 | "A String", |
| 320 | ], |
| 321 | }, |
| 322 | "apt": { # Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 323 | "uri": "A String", # Required. URI for this repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 324 | "archiveType": "A String", # Type of archive files in this repository. The default behavior is DEB. |
| 325 | "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy. |
| 326 | "distribution": "A String", # Required. Distribution of this repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 327 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 328 | "A String", |
| 329 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 330 | }, |
| 331 | "zypper": { # Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 332 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 333 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 334 | "gpgKeys": [ # URIs of GPG keys. |
| 335 | "A String", |
| 336 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 337 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 338 | }, |
| 339 | "goo": { # Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. # A Goo Repository. |
| 340 | "name": "A String", # Required. The name of the repository. |
| 341 | "url": "A String", # Required. The url of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 342 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 343 | }, |
| 344 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 345 | "updateTime": "A String", # Output only. Last time this guest policy was updated. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 346 | "assignment": { # An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones. # Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 347 | "osTypes": [ # Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included. |
| 348 | { # Defines the criteria for selecting VM Instances by OS type. |
| 349 | "osArchitecture": "A String", # Targets VM instances with OS Inventory enabled and having the following OS architecture. |
| 350 | "osShortName": "A String", # Targets VM instances with OS Inventory enabled and having the following OS short name, for example "debian" or "windows". |
| 351 | "osVersion": "A String", # Targets VM instances with OS Inventory enabled and having the following following OS version. |
| 352 | }, |
| 353 | ], |
| 354 | "zones": [ # Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone. |
| 355 | "A String", |
| 356 | ], |
| 357 | "instanceNamePrefixes": [ # Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-". Only supported for project-level policies. |
| 358 | "A String", |
| 359 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 360 | "groupLabels": [ # Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging". |
| 361 | { # Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web". |
| 362 | "labels": { # Google Compute Engine instance labels that must be present for an instance to be included in this assignment group. |
| 363 | "a_key": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 364 | }, |
| 365 | }, |
| 366 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 367 | "instances": [ # Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project. |
| 368 | "A String", |
| 369 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 370 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 371 | "recipes": [ # A list of Recipes to install on the VM instance. |
| 372 | { # A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. |
| 373 | "installSteps": [ # Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. |
| 374 | { # An action that can be taken as part of installing or updating a recipe. |
| 375 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 376 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 377 | }, |
| 378 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 379 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 380 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 381 | 42, |
| 382 | ], |
| 383 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 384 | "A String", |
| 385 | ], |
| 386 | }, |
| 387 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 388 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 389 | }, |
| 390 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 391 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 392 | "args": [ # Arguments to be passed to the provided executable. |
| 393 | "A String", |
| 394 | ], |
| 395 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 396 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 397 | 42, |
| 398 | ], |
| 399 | }, |
| 400 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 401 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 402 | "script": "A String", # Required. The shell script to be executed. |
| 403 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 404 | 42, |
| 405 | ], |
| 406 | }, |
| 407 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 408 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 409 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 410 | "type": "A String", # Required. The type of the archive to extract. |
| 411 | }, |
| 412 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 413 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 414 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 415 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 416 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 417 | }, |
| 418 | }, |
| 419 | ], |
| 420 | "desiredState": "A String", # Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. |
| 421 | "artifacts": [ # Resources available to be used in the steps in the recipe. |
| 422 | { # Specifies a resource to be used in the recipe. |
| 423 | "remote": { # Specifies an artifact available via some URI. # A generic remote artifact. |
| 424 | "checksum": "A String", # Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps. |
| 425 | "uri": "A String", # URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. |
| 426 | }, |
| 427 | "id": "A String", # Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id. |
| 428 | "allowInsecure": True or False, # Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified. |
| 429 | "gcs": { # Specifies an artifact available as a Google Cloud Storage object. # A Google Cloud Storage artifact. |
| 430 | "bucket": "A String", # Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`. |
| 431 | "object": "A String", # Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`. |
| 432 | "generation": "A String", # Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`. |
| 433 | }, |
| 434 | }, |
| 435 | ], |
| 436 | "updateSteps": [ # Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. |
| 437 | { # An action that can be taken as part of installing or updating a recipe. |
| 438 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 439 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 440 | }, |
| 441 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 442 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 443 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 444 | 42, |
| 445 | ], |
| 446 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 447 | "A String", |
| 448 | ], |
| 449 | }, |
| 450 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 451 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 452 | }, |
| 453 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 454 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 455 | "args": [ # Arguments to be passed to the provided executable. |
| 456 | "A String", |
| 457 | ], |
| 458 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 459 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 460 | 42, |
| 461 | ], |
| 462 | }, |
| 463 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 464 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 465 | "script": "A String", # Required. The shell script to be executed. |
| 466 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 467 | 42, |
| 468 | ], |
| 469 | }, |
| 470 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 471 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 472 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 473 | "type": "A String", # Required. The type of the archive to extract. |
| 474 | }, |
| 475 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 476 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 477 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 478 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 479 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 480 | }, |
| 481 | }, |
| 482 | ], |
| 483 | "name": "A String", # Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments. |
| 484 | "version": "A String", # The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 485 | }, |
| 486 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 487 | "createTime": "A String", # Output only. Time this guest policy was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 488 | "description": "A String", # Description of the guest policy. Length of the description is limited to 1024 characters. |
| 489 | "etag": "A String", # The etag for this guest policy. If this is provided on update, it must match the server's etag. |
| 490 | "packages": [ # The software packages to be managed by this policy. |
| 491 | { # Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3` |
| 492 | "desiredState": "A String", # The desired_state the agent should maintain for this package. The default is to ensure the package is installed. |
| 493 | "manager": "A String", # Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY. |
| 494 | "name": "A String", # Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets. |
| 495 | }, |
| 496 | ], |
| 497 | "name": "A String", # Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 498 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 499 | </div> |
| 500 | |
| 501 | <div class="method"> |
| 502 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 503 | <pre>Delete an OS Config guest policy. |
| 504 | |
| 505 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 506 | name: string, Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 507 | x__xgafv: string, V1 error format. |
| 508 | Allowed values |
| 509 | 1 - v1 error format |
| 510 | 2 - v2 error format |
| 511 | |
| 512 | Returns: |
| 513 | An object of the form: |
| 514 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 515 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 516 | }</pre> |
| 517 | </div> |
| 518 | |
| 519 | <div class="method"> |
| 520 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 521 | <pre>Get an OS Config guest policy. |
| 522 | |
| 523 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 524 | name: string, Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 525 | x__xgafv: string, V1 error format. |
| 526 | Allowed values |
| 527 | 1 - v1 error format |
| 528 | 2 - v2 error format |
| 529 | |
| 530 | Returns: |
| 531 | An object of the form: |
| 532 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 533 | { # An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 534 | "packageRepositories": [ # A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available. |
| 535 | { # A package repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 536 | "yum": { # Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 537 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 538 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 539 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 540 | "gpgKeys": [ # URIs of GPG keys. |
| 541 | "A String", |
| 542 | ], |
| 543 | }, |
| 544 | "apt": { # Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 545 | "uri": "A String", # Required. URI for this repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 546 | "archiveType": "A String", # Type of archive files in this repository. The default behavior is DEB. |
| 547 | "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy. |
| 548 | "distribution": "A String", # Required. Distribution of this repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 549 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 550 | "A String", |
| 551 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 552 | }, |
| 553 | "zypper": { # Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 554 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 555 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 556 | "gpgKeys": [ # URIs of GPG keys. |
| 557 | "A String", |
| 558 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 559 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 560 | }, |
| 561 | "goo": { # Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. # A Goo Repository. |
| 562 | "name": "A String", # Required. The name of the repository. |
| 563 | "url": "A String", # Required. The url of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 564 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 565 | }, |
| 566 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 567 | "updateTime": "A String", # Output only. Last time this guest policy was updated. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 568 | "assignment": { # An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones. # Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 569 | "osTypes": [ # Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included. |
| 570 | { # Defines the criteria for selecting VM Instances by OS type. |
| 571 | "osArchitecture": "A String", # Targets VM instances with OS Inventory enabled and having the following OS architecture. |
| 572 | "osShortName": "A String", # Targets VM instances with OS Inventory enabled and having the following OS short name, for example "debian" or "windows". |
| 573 | "osVersion": "A String", # Targets VM instances with OS Inventory enabled and having the following following OS version. |
| 574 | }, |
| 575 | ], |
| 576 | "zones": [ # Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone. |
| 577 | "A String", |
| 578 | ], |
| 579 | "instanceNamePrefixes": [ # Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-". Only supported for project-level policies. |
| 580 | "A String", |
| 581 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 582 | "groupLabels": [ # Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging". |
| 583 | { # Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web". |
| 584 | "labels": { # Google Compute Engine instance labels that must be present for an instance to be included in this assignment group. |
| 585 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 586 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 587 | }, |
| 588 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 589 | "instances": [ # Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project. |
| 590 | "A String", |
| 591 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 592 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 593 | "recipes": [ # A list of Recipes to install on the VM instance. |
| 594 | { # A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. |
| 595 | "installSteps": [ # Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. |
| 596 | { # An action that can be taken as part of installing or updating a recipe. |
| 597 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 598 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 599 | }, |
| 600 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 601 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 602 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 603 | 42, |
| 604 | ], |
| 605 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 606 | "A String", |
| 607 | ], |
| 608 | }, |
| 609 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 610 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 611 | }, |
| 612 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 613 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 614 | "args": [ # Arguments to be passed to the provided executable. |
| 615 | "A String", |
| 616 | ], |
| 617 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 618 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 619 | 42, |
| 620 | ], |
| 621 | }, |
| 622 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 623 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 624 | "script": "A String", # Required. The shell script to be executed. |
| 625 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 626 | 42, |
| 627 | ], |
| 628 | }, |
| 629 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 630 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 631 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 632 | "type": "A String", # Required. The type of the archive to extract. |
| 633 | }, |
| 634 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 635 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 636 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 637 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 638 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 639 | }, |
| 640 | }, |
| 641 | ], |
| 642 | "desiredState": "A String", # Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. |
| 643 | "artifacts": [ # Resources available to be used in the steps in the recipe. |
| 644 | { # Specifies a resource to be used in the recipe. |
| 645 | "remote": { # Specifies an artifact available via some URI. # A generic remote artifact. |
| 646 | "checksum": "A String", # Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps. |
| 647 | "uri": "A String", # URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. |
| 648 | }, |
| 649 | "id": "A String", # Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id. |
| 650 | "allowInsecure": True or False, # Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified. |
| 651 | "gcs": { # Specifies an artifact available as a Google Cloud Storage object. # A Google Cloud Storage artifact. |
| 652 | "bucket": "A String", # Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`. |
| 653 | "object": "A String", # Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`. |
| 654 | "generation": "A String", # Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`. |
| 655 | }, |
| 656 | }, |
| 657 | ], |
| 658 | "updateSteps": [ # Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. |
| 659 | { # An action that can be taken as part of installing or updating a recipe. |
| 660 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 661 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 662 | }, |
| 663 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 664 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 665 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 666 | 42, |
| 667 | ], |
| 668 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 669 | "A String", |
| 670 | ], |
| 671 | }, |
| 672 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 673 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 674 | }, |
| 675 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 676 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 677 | "args": [ # Arguments to be passed to the provided executable. |
| 678 | "A String", |
| 679 | ], |
| 680 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 681 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 682 | 42, |
| 683 | ], |
| 684 | }, |
| 685 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 686 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 687 | "script": "A String", # Required. The shell script to be executed. |
| 688 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 689 | 42, |
| 690 | ], |
| 691 | }, |
| 692 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 693 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 694 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 695 | "type": "A String", # Required. The type of the archive to extract. |
| 696 | }, |
| 697 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 698 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 699 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 700 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 701 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 702 | }, |
| 703 | }, |
| 704 | ], |
| 705 | "name": "A String", # Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments. |
| 706 | "version": "A String", # The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 707 | }, |
| 708 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 709 | "createTime": "A String", # Output only. Time this guest policy was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 710 | "description": "A String", # Description of the guest policy. Length of the description is limited to 1024 characters. |
| 711 | "etag": "A String", # The etag for this guest policy. If this is provided on update, it must match the server's etag. |
| 712 | "packages": [ # The software packages to be managed by this policy. |
| 713 | { # Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3` |
| 714 | "desiredState": "A String", # The desired_state the agent should maintain for this package. The default is to ensure the package is installed. |
| 715 | "manager": "A String", # Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY. |
| 716 | "name": "A String", # Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets. |
| 717 | }, |
| 718 | ], |
| 719 | "name": "A String", # Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 720 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 721 | </div> |
| 722 | |
| 723 | <div class="method"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 724 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 725 | <pre>Get a page of OS Config guest policies. |
| 726 | |
| 727 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 728 | parent: string, Required. The resource name of the parent using one of the following forms: `projects/{project_number}`. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 729 | pageSize: integer, The maximum number of guest policies to return. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 730 | pageToken: string, A pagination token returned from a previous call to `ListGuestPolicies` that indicates where this listing should continue from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 731 | x__xgafv: string, V1 error format. |
| 732 | Allowed values |
| 733 | 1 - v1 error format |
| 734 | 2 - v2 error format |
| 735 | |
| 736 | Returns: |
| 737 | An object of the form: |
| 738 | |
| 739 | { # A response message for listing guest policies. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 740 | "nextPageToken": "A String", # A pagination token that can be used to get the next page of guest policies. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 741 | "guestPolicies": [ # The list of GuestPolicies. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 742 | { # An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 743 | "packageRepositories": [ # A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available. |
| 744 | { # A package repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 745 | "yum": { # Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 746 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 747 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 748 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 749 | "gpgKeys": [ # URIs of GPG keys. |
| 750 | "A String", |
| 751 | ], |
| 752 | }, |
| 753 | "apt": { # Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 754 | "uri": "A String", # Required. URI for this repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 755 | "archiveType": "A String", # Type of archive files in this repository. The default behavior is DEB. |
| 756 | "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy. |
| 757 | "distribution": "A String", # Required. Distribution of this repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 758 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 759 | "A String", |
| 760 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 761 | }, |
| 762 | "zypper": { # Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 763 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 764 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 765 | "gpgKeys": [ # URIs of GPG keys. |
| 766 | "A String", |
| 767 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 768 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 769 | }, |
| 770 | "goo": { # Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. # A Goo Repository. |
| 771 | "name": "A String", # Required. The name of the repository. |
| 772 | "url": "A String", # Required. The url of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 773 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 774 | }, |
| 775 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 776 | "updateTime": "A String", # Output only. Last time this guest policy was updated. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 777 | "assignment": { # An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones. # Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 778 | "osTypes": [ # Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included. |
| 779 | { # Defines the criteria for selecting VM Instances by OS type. |
| 780 | "osArchitecture": "A String", # Targets VM instances with OS Inventory enabled and having the following OS architecture. |
| 781 | "osShortName": "A String", # Targets VM instances with OS Inventory enabled and having the following OS short name, for example "debian" or "windows". |
| 782 | "osVersion": "A String", # Targets VM instances with OS Inventory enabled and having the following following OS version. |
| 783 | }, |
| 784 | ], |
| 785 | "zones": [ # Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone. |
| 786 | "A String", |
| 787 | ], |
| 788 | "instanceNamePrefixes": [ # Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-". Only supported for project-level policies. |
| 789 | "A String", |
| 790 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 791 | "groupLabels": [ # Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging". |
| 792 | { # Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web". |
| 793 | "labels": { # Google Compute Engine instance labels that must be present for an instance to be included in this assignment group. |
| 794 | "a_key": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 795 | }, |
| 796 | }, |
| 797 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 798 | "instances": [ # Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project. |
| 799 | "A String", |
| 800 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 801 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 802 | "recipes": [ # A list of Recipes to install on the VM instance. |
| 803 | { # A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. |
| 804 | "installSteps": [ # Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. |
| 805 | { # An action that can be taken as part of installing or updating a recipe. |
| 806 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 807 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 808 | }, |
| 809 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 810 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 811 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 812 | 42, |
| 813 | ], |
| 814 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 815 | "A String", |
| 816 | ], |
| 817 | }, |
| 818 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 819 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 820 | }, |
| 821 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 822 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 823 | "args": [ # Arguments to be passed to the provided executable. |
| 824 | "A String", |
| 825 | ], |
| 826 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 827 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 828 | 42, |
| 829 | ], |
| 830 | }, |
| 831 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 832 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 833 | "script": "A String", # Required. The shell script to be executed. |
| 834 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 835 | 42, |
| 836 | ], |
| 837 | }, |
| 838 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 839 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 840 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 841 | "type": "A String", # Required. The type of the archive to extract. |
| 842 | }, |
| 843 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 844 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 845 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 846 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 847 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 848 | }, |
| 849 | }, |
| 850 | ], |
| 851 | "desiredState": "A String", # Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. |
| 852 | "artifacts": [ # Resources available to be used in the steps in the recipe. |
| 853 | { # Specifies a resource to be used in the recipe. |
| 854 | "remote": { # Specifies an artifact available via some URI. # A generic remote artifact. |
| 855 | "checksum": "A String", # Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps. |
| 856 | "uri": "A String", # URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. |
| 857 | }, |
| 858 | "id": "A String", # Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id. |
| 859 | "allowInsecure": True or False, # Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified. |
| 860 | "gcs": { # Specifies an artifact available as a Google Cloud Storage object. # A Google Cloud Storage artifact. |
| 861 | "bucket": "A String", # Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`. |
| 862 | "object": "A String", # Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`. |
| 863 | "generation": "A String", # Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`. |
| 864 | }, |
| 865 | }, |
| 866 | ], |
| 867 | "updateSteps": [ # Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. |
| 868 | { # An action that can be taken as part of installing or updating a recipe. |
| 869 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 870 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 871 | }, |
| 872 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 873 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 874 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 875 | 42, |
| 876 | ], |
| 877 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 878 | "A String", |
| 879 | ], |
| 880 | }, |
| 881 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 882 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 883 | }, |
| 884 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 885 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 886 | "args": [ # Arguments to be passed to the provided executable. |
| 887 | "A String", |
| 888 | ], |
| 889 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 890 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 891 | 42, |
| 892 | ], |
| 893 | }, |
| 894 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 895 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 896 | "script": "A String", # Required. The shell script to be executed. |
| 897 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 898 | 42, |
| 899 | ], |
| 900 | }, |
| 901 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 902 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 903 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 904 | "type": "A String", # Required. The type of the archive to extract. |
| 905 | }, |
| 906 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 907 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 908 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 909 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 910 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 911 | }, |
| 912 | }, |
| 913 | ], |
| 914 | "name": "A String", # Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments. |
| 915 | "version": "A String", # The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 916 | }, |
| 917 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 918 | "createTime": "A String", # Output only. Time this guest policy was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 919 | "description": "A String", # Description of the guest policy. Length of the description is limited to 1024 characters. |
| 920 | "etag": "A String", # The etag for this guest policy. If this is provided on update, it must match the server's etag. |
| 921 | "packages": [ # The software packages to be managed by this policy. |
| 922 | { # Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3` |
| 923 | "desiredState": "A String", # The desired_state the agent should maintain for this package. The default is to ensure the package is installed. |
| 924 | "manager": "A String", # Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY. |
| 925 | "name": "A String", # Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets. |
| 926 | }, |
| 927 | ], |
| 928 | "name": "A String", # Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 929 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 930 | ], |
| 931 | }</pre> |
| 932 | </div> |
| 933 | |
| 934 | <div class="method"> |
| 935 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 936 | <pre>Retrieves the next page of results. |
| 937 | |
| 938 | Args: |
| 939 | previous_request: The request for the previous page. (required) |
| 940 | previous_response: The response from the request for the previous page. (required) |
| 941 | |
| 942 | Returns: |
| 943 | A request object that you can call 'execute()' on to request the next |
| 944 | page. Returns None if there are no more items in the collection. |
| 945 | </pre> |
| 946 | </div> |
| 947 | |
| 948 | <div class="method"> |
| 949 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 950 | <pre>Update an OS Config guest policy. |
| 951 | |
| 952 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 953 | name: string, Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 954 | body: object, The request body. |
| 955 | The object takes the form of: |
| 956 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 957 | { # An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 958 | "packageRepositories": [ # A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available. |
| 959 | { # A package repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 960 | "yum": { # Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 961 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 962 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 963 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 964 | "gpgKeys": [ # URIs of GPG keys. |
| 965 | "A String", |
| 966 | ], |
| 967 | }, |
| 968 | "apt": { # Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 969 | "uri": "A String", # Required. URI for this repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 970 | "archiveType": "A String", # Type of archive files in this repository. The default behavior is DEB. |
| 971 | "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy. |
| 972 | "distribution": "A String", # Required. Distribution of this repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 973 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 974 | "A String", |
| 975 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 976 | }, |
| 977 | "zypper": { # Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 978 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 979 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 980 | "gpgKeys": [ # URIs of GPG keys. |
| 981 | "A String", |
| 982 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 983 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 984 | }, |
| 985 | "goo": { # Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. # A Goo Repository. |
| 986 | "name": "A String", # Required. The name of the repository. |
| 987 | "url": "A String", # Required. The url of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 988 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 989 | }, |
| 990 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 991 | "updateTime": "A String", # Output only. Last time this guest policy was updated. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 992 | "assignment": { # An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones. # Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 993 | "osTypes": [ # Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included. |
| 994 | { # Defines the criteria for selecting VM Instances by OS type. |
| 995 | "osArchitecture": "A String", # Targets VM instances with OS Inventory enabled and having the following OS architecture. |
| 996 | "osShortName": "A String", # Targets VM instances with OS Inventory enabled and having the following OS short name, for example "debian" or "windows". |
| 997 | "osVersion": "A String", # Targets VM instances with OS Inventory enabled and having the following following OS version. |
| 998 | }, |
| 999 | ], |
| 1000 | "zones": [ # Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone. |
| 1001 | "A String", |
| 1002 | ], |
| 1003 | "instanceNamePrefixes": [ # Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-". Only supported for project-level policies. |
| 1004 | "A String", |
| 1005 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1006 | "groupLabels": [ # Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging". |
| 1007 | { # Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web". |
| 1008 | "labels": { # Google Compute Engine instance labels that must be present for an instance to be included in this assignment group. |
| 1009 | "a_key": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1010 | }, |
| 1011 | }, |
| 1012 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1013 | "instances": [ # Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project. |
| 1014 | "A String", |
| 1015 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1016 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1017 | "recipes": [ # A list of Recipes to install on the VM instance. |
| 1018 | { # A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. |
| 1019 | "installSteps": [ # Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. |
| 1020 | { # An action that can be taken as part of installing or updating a recipe. |
| 1021 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 1022 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1023 | }, |
| 1024 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 1025 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1026 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 1027 | 42, |
| 1028 | ], |
| 1029 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 1030 | "A String", |
| 1031 | ], |
| 1032 | }, |
| 1033 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 1034 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1035 | }, |
| 1036 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 1037 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 1038 | "args": [ # Arguments to be passed to the provided executable. |
| 1039 | "A String", |
| 1040 | ], |
| 1041 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 1042 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 1043 | 42, |
| 1044 | ], |
| 1045 | }, |
| 1046 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 1047 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 1048 | "script": "A String", # Required. The shell script to be executed. |
| 1049 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 1050 | 42, |
| 1051 | ], |
| 1052 | }, |
| 1053 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 1054 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 1055 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1056 | "type": "A String", # Required. The type of the archive to extract. |
| 1057 | }, |
| 1058 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 1059 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1060 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 1061 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 1062 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 1063 | }, |
| 1064 | }, |
| 1065 | ], |
| 1066 | "desiredState": "A String", # Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. |
| 1067 | "artifacts": [ # Resources available to be used in the steps in the recipe. |
| 1068 | { # Specifies a resource to be used in the recipe. |
| 1069 | "remote": { # Specifies an artifact available via some URI. # A generic remote artifact. |
| 1070 | "checksum": "A String", # Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps. |
| 1071 | "uri": "A String", # URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. |
| 1072 | }, |
| 1073 | "id": "A String", # Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id. |
| 1074 | "allowInsecure": True or False, # Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified. |
| 1075 | "gcs": { # Specifies an artifact available as a Google Cloud Storage object. # A Google Cloud Storage artifact. |
| 1076 | "bucket": "A String", # Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`. |
| 1077 | "object": "A String", # Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`. |
| 1078 | "generation": "A String", # Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`. |
| 1079 | }, |
| 1080 | }, |
| 1081 | ], |
| 1082 | "updateSteps": [ # Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. |
| 1083 | { # An action that can be taken as part of installing or updating a recipe. |
| 1084 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 1085 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1086 | }, |
| 1087 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 1088 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1089 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 1090 | 42, |
| 1091 | ], |
| 1092 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 1093 | "A String", |
| 1094 | ], |
| 1095 | }, |
| 1096 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 1097 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1098 | }, |
| 1099 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 1100 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 1101 | "args": [ # Arguments to be passed to the provided executable. |
| 1102 | "A String", |
| 1103 | ], |
| 1104 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 1105 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 1106 | 42, |
| 1107 | ], |
| 1108 | }, |
| 1109 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 1110 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 1111 | "script": "A String", # Required. The shell script to be executed. |
| 1112 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 1113 | 42, |
| 1114 | ], |
| 1115 | }, |
| 1116 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 1117 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 1118 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1119 | "type": "A String", # Required. The type of the archive to extract. |
| 1120 | }, |
| 1121 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 1122 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1123 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 1124 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 1125 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 1126 | }, |
| 1127 | }, |
| 1128 | ], |
| 1129 | "name": "A String", # Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments. |
| 1130 | "version": "A String", # The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1131 | }, |
| 1132 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1133 | "createTime": "A String", # Output only. Time this guest policy was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1134 | "description": "A String", # Description of the guest policy. Length of the description is limited to 1024 characters. |
| 1135 | "etag": "A String", # The etag for this guest policy. If this is provided on update, it must match the server's etag. |
| 1136 | "packages": [ # The software packages to be managed by this policy. |
| 1137 | { # Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3` |
| 1138 | "desiredState": "A String", # The desired_state the agent should maintain for this package. The default is to ensure the package is installed. |
| 1139 | "manager": "A String", # Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY. |
| 1140 | "name": "A String", # Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets. |
| 1141 | }, |
| 1142 | ], |
| 1143 | "name": "A String", # Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1144 | } |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1145 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1146 | updateMask: string, Field mask that controls which fields of the guest policy should be updated. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1147 | x__xgafv: string, V1 error format. |
| 1148 | Allowed values |
| 1149 | 1 - v1 error format |
| 1150 | 2 - v2 error format |
| 1151 | |
| 1152 | Returns: |
| 1153 | An object of the form: |
| 1154 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1155 | { # An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1156 | "packageRepositories": [ # A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available. |
| 1157 | { # A package repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1158 | "yum": { # Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1159 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1160 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 1161 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1162 | "gpgKeys": [ # URIs of GPG keys. |
| 1163 | "A String", |
| 1164 | ], |
| 1165 | }, |
| 1166 | "apt": { # Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. # An Apt Repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1167 | "uri": "A String", # Required. URI for this repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1168 | "archiveType": "A String", # Type of archive files in this repository. The default behavior is DEB. |
| 1169 | "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy. |
| 1170 | "distribution": "A String", # Required. Distribution of this repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1171 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 1172 | "A String", |
| 1173 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1174 | }, |
| 1175 | "zypper": { # Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1176 | "id": "A String", # Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. |
| 1177 | "baseUrl": "A String", # Required. The location of the repository directory. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1178 | "gpgKeys": [ # URIs of GPG keys. |
| 1179 | "A String", |
| 1180 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1181 | "displayName": "A String", # The display name of the repository. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1182 | }, |
| 1183 | "goo": { # Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. # A Goo Repository. |
| 1184 | "name": "A String", # Required. The name of the repository. |
| 1185 | "url": "A String", # Required. The url of the repository. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1186 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1187 | }, |
| 1188 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1189 | "updateTime": "A String", # Output only. Last time this guest policy was updated. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1190 | "assignment": { # An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones. # Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1191 | "osTypes": [ # Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included. |
| 1192 | { # Defines the criteria for selecting VM Instances by OS type. |
| 1193 | "osArchitecture": "A String", # Targets VM instances with OS Inventory enabled and having the following OS architecture. |
| 1194 | "osShortName": "A String", # Targets VM instances with OS Inventory enabled and having the following OS short name, for example "debian" or "windows". |
| 1195 | "osVersion": "A String", # Targets VM instances with OS Inventory enabled and having the following following OS version. |
| 1196 | }, |
| 1197 | ], |
| 1198 | "zones": [ # Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone. |
| 1199 | "A String", |
| 1200 | ], |
| 1201 | "instanceNamePrefixes": [ # Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-". Only supported for project-level policies. |
| 1202 | "A String", |
| 1203 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1204 | "groupLabels": [ # Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging". |
| 1205 | { # Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web". |
| 1206 | "labels": { # Google Compute Engine instance labels that must be present for an instance to be included in this assignment group. |
| 1207 | "a_key": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1208 | }, |
| 1209 | }, |
| 1210 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1211 | "instances": [ # Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project. |
| 1212 | "A String", |
| 1213 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1214 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1215 | "recipes": [ # A list of Recipes to install on the VM instance. |
| 1216 | { # A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. |
| 1217 | "installSteps": [ # Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. |
| 1218 | { # An action that can be taken as part of installing or updating a recipe. |
| 1219 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 1220 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1221 | }, |
| 1222 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 1223 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1224 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 1225 | 42, |
| 1226 | ], |
| 1227 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 1228 | "A String", |
| 1229 | ], |
| 1230 | }, |
| 1231 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 1232 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1233 | }, |
| 1234 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 1235 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 1236 | "args": [ # Arguments to be passed to the provided executable. |
| 1237 | "A String", |
| 1238 | ], |
| 1239 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 1240 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 1241 | 42, |
| 1242 | ], |
| 1243 | }, |
| 1244 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 1245 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 1246 | "script": "A String", # Required. The shell script to be executed. |
| 1247 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 1248 | 42, |
| 1249 | ], |
| 1250 | }, |
| 1251 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 1252 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 1253 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1254 | "type": "A String", # Required. The type of the archive to extract. |
| 1255 | }, |
| 1256 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 1257 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1258 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 1259 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 1260 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 1261 | }, |
| 1262 | }, |
| 1263 | ], |
| 1264 | "desiredState": "A String", # Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. |
| 1265 | "artifacts": [ # Resources available to be used in the steps in the recipe. |
| 1266 | { # Specifies a resource to be used in the recipe. |
| 1267 | "remote": { # Specifies an artifact available via some URI. # A generic remote artifact. |
| 1268 | "checksum": "A String", # Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps. |
| 1269 | "uri": "A String", # URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. |
| 1270 | }, |
| 1271 | "id": "A String", # Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id. |
| 1272 | "allowInsecure": True or False, # Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified. |
| 1273 | "gcs": { # Specifies an artifact available as a Google Cloud Storage object. # A Google Cloud Storage artifact. |
| 1274 | "bucket": "A String", # Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`. |
| 1275 | "object": "A String", # Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`. |
| 1276 | "generation": "A String", # Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`. |
| 1277 | }, |
| 1278 | }, |
| 1279 | ], |
| 1280 | "updateSteps": [ # Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. |
| 1281 | { # An action that can be taken as part of installing or updating a recipe. |
| 1282 | "dpkgInstallation": { # Installs a deb via dpkg. # Installs a deb file via dpkg. |
| 1283 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1284 | }, |
| 1285 | "msiInstallation": { # Installs an MSI file. # Installs an MSI file. |
| 1286 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1287 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 1288 | 42, |
| 1289 | ], |
| 1290 | "flags": [ # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). |
| 1291 | "A String", |
| 1292 | ], |
| 1293 | }, |
| 1294 | "rpmInstallation": { # Installs an rpm file via the rpm utility. # Installs an rpm file via the rpm utility. |
| 1295 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1296 | }, |
| 1297 | "fileExec": { # Executes an artifact or local file. # Executes an artifact or local file. |
| 1298 | "localPath": "A String", # The absolute path of the file on the local filesystem. |
| 1299 | "args": [ # Arguments to be passed to the provided executable. |
| 1300 | "A String", |
| 1301 | ], |
| 1302 | "artifactId": "A String", # The id of the relevant artifact in the recipe. |
| 1303 | "allowedExitCodes": [ # Defaults to [0]. A list of possible return values that the program can return to indicate a success. |
| 1304 | 42, |
| 1305 | ], |
| 1306 | }, |
| 1307 | "scriptRun": { # Runs a script through an interpreter. # Runs commands in a shell. |
| 1308 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 1309 | "script": "A String", # Required. The shell script to be executed. |
| 1310 | "allowedExitCodes": [ # Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] |
| 1311 | 42, |
| 1312 | ], |
| 1313 | }, |
| 1314 | "archiveExtraction": { # Extracts an archive of the type specified in the specified directory. # Extracts an archive into the specified directory. |
| 1315 | "destination": "A String", # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. |
| 1316 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1317 | "type": "A String", # Required. The type of the archive to extract. |
| 1318 | }, |
| 1319 | "fileCopy": { # Copies the artifact to the specified path on the instance. # Copies a file onto the instance. |
| 1320 | "artifactId": "A String", # Required. The id of the relevant artifact in the recipe. |
| 1321 | "overwrite": True or False, # Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. |
| 1322 | "permissions": "A String", # Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 |
| 1323 | "destination": "A String", # Required. The absolute path on the instance to put the file. |
| 1324 | }, |
| 1325 | }, |
| 1326 | ], |
| 1327 | "name": "A String", # Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments. |
| 1328 | "version": "A String", # The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1329 | }, |
| 1330 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1331 | "createTime": "A String", # Output only. Time this guest policy was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1332 | "description": "A String", # Description of the guest policy. Length of the description is limited to 1024 characters. |
| 1333 | "etag": "A String", # The etag for this guest policy. If this is provided on update, it must match the server's etag. |
| 1334 | "packages": [ # The software packages to be managed by this policy. |
| 1335 | { # Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3` |
| 1336 | "desiredState": "A String", # The desired_state the agent should maintain for this package. The default is to ensure the package is installed. |
| 1337 | "manager": "A String", # Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY. |
| 1338 | "name": "A String", # Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets. |
| 1339 | }, |
| 1340 | ], |
| 1341 | "name": "A String", # Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1342 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1343 | </div> |
| 1344 | |
| 1345 | </body></html> |