| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -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 | |
| 75 | <h1><a href="osconfig_v1alpha.html">OS Config API</a> . <a href="osconfig_v1alpha.projects.html">projects</a> . <a href="osconfig_v1alpha.projects.locations.html">locations</a> . <a href="osconfig_v1alpha.projects.locations.osPolicyAssignments.html">osPolicyAssignments</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="osconfig_v1alpha.projects.locations.osPolicyAssignments.operations.html">operations()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the operations Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#create">create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 87 | <p class="firstline">Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).</p> |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 88 | <p class="toc_element"> |
| 89 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 90 | <p class="firstline">Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).</p> |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 91 | <p class="toc_element"> |
| 92 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the `name` parameter.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 96 | <p class="firstline">List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#listRevisions">listRevisions(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">List the OS policy assignment revisions for a given OS policy assignment.</p> |
| 100 | <p class="toc_element"> |
| 101 | <code><a href="#listRevisions_next">listRevisions_next(previous_request, previous_response)</a></code></p> |
| 102 | <p class="firstline">Retrieves the next page of results.</p> |
| 103 | <p class="toc_element"> |
| 104 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 105 | <p class="firstline">Retrieves the next page of results.</p> |
| 106 | <p class="toc_element"> |
| 107 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 108 | <p class="firstline">Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).</p> |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 109 | <h3>Method Details</h3> |
| 110 | <div class="method"> |
| 111 | <code class="details" id="close">close()</code> |
| 112 | <pre>Close httplib2 connections.</pre> |
| 113 | </div> |
| 114 | |
| 115 | <div class="method"> |
| 116 | <code class="details" id="create">create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)</code> |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 117 | <pre>Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 118 | |
| 119 | Args: |
| 120 | parent: string, Required. The parent resource name in the form: projects/{project}/locations/{location} (required) |
| 121 | body: object, The request body. |
| 122 | The object takes the form of: |
| 123 | |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 124 | { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 125 | "baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. |
| 126 | "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment. |
| 127 | "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters. |
| 128 | "instanceFilter": { # Message to represent the filters to select VMs for an assignment # Required. Filter to select VMs. |
| 129 | "all": True or False, # Target all VMs in the project. If true, no other criteria is permitted. |
| 130 | "exclusionLabels": [ # List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM. This filter is applied last in the filtering chain and therefore a VM is guaranteed to be excluded if it satisfies one of the below label sets. |
| 131 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 132 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 133 | "a_key": "A String", |
| 134 | }, |
| 135 | }, |
| 136 | ], |
| 137 | "inclusionLabels": [ # List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM. |
| 138 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 139 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 140 | "a_key": "A String", |
| 141 | }, |
| 142 | }, |
| 143 | ], |
| 144 | "osShortNames": [ # A VM is included if it's OS short name matches with any of the values provided in this list. |
| 145 | "A String", |
| 146 | ], |
| 147 | }, |
| 148 | "name": "A String", # Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. |
| 149 | "osPolicies": [ # Required. List of OS policies to be applied to the VMs. |
| 150 | { # An OS policy defines the desired state configuration for a VM. |
| 151 | "allowNoResourceGroupMatch": True or False, # This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce. |
| 152 | "description": "A String", # Policy description. Length of the description is limited to 1024 characters. |
| 153 | "id": "A String", # Required. The id of the OS policy 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 assignment. |
| 154 | "mode": "A String", # Required. Policy mode |
| 155 | "resourceGroups": [ # Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match` |
| 156 | { # Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group. |
| 157 | "osFilter": { # The `OSFilter` is used to specify the OS filtering criteria for the resource group. # Used to specify the OS filter for a resource group |
| 158 | "osShortName": "A String", # This should match OS short name emitted by the OS inventory agent. An empty value matches any OS. |
| 159 | "osVersion": "A String", # This value should match the version emitted by the OS inventory agent. Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` |
| 160 | }, |
| 161 | "resources": [ # Required. List of resources configured for this resource group. The resources are executed in the exact order specified here. |
| 162 | { # An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state. |
| 163 | "exec": { # A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen. # Exec resource |
| 164 | "enforce": { # A file or script to execute. # What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce. |
| 165 | "args": [ # Optional arguments to pass to the source during execution. |
| 166 | "A String", |
| 167 | ], |
| 168 | "file": { # A remote or local file. # A remote or local file. |
| 169 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 170 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 171 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 172 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 173 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 174 | }, |
| 175 | "localPath": "A String", # A local path within the VM to use. |
| 176 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 177 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 178 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 179 | }, |
| 180 | }, |
| 181 | "interpreter": "A String", # Required. The script interpreter to use. |
| 182 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 183 | }, |
| 184 | "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. |
| 185 | "args": [ # Optional arguments to pass to the source during execution. |
| 186 | "A String", |
| 187 | ], |
| 188 | "file": { # A remote or local file. # A remote or local file. |
| 189 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 190 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 191 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 192 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 193 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 194 | }, |
| 195 | "localPath": "A String", # A local path within the VM to use. |
| 196 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 197 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 198 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 199 | }, |
| 200 | }, |
| 201 | "interpreter": "A String", # Required. The script interpreter to use. |
| 202 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 203 | }, |
| 204 | }, |
| 205 | "file": { # A resource that manages the state of a file. # File resource |
| 206 | "content": "A String", # A a file with this content. The size of the content is limited to 1024 characters. |
| 207 | "file": { # A remote or local file. # A remote or local source. |
| 208 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 209 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 210 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 211 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 212 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 213 | }, |
| 214 | "localPath": "A String", # A local path within the VM to use. |
| 215 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 216 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 217 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 218 | }, |
| 219 | }, |
| 220 | "path": "A String", # Required. The absolute path of the file within the VM. |
| 221 | "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 |
| 222 | "state": "A String", # Required. Desired state of the file. |
| 223 | }, |
| 224 | "id": "A String", # Required. The id of the resource 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 OS policy. |
| 225 | "pkg": { # A resource that manages a system package. # Package resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 226 | "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 227 | "name": "A String", # Required. Package name. |
| 228 | }, |
| 229 | "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 230 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 231 | "source": { # A remote or local file. # Required. A deb package. |
| 232 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 233 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 234 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 235 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 236 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 237 | }, |
| 238 | "localPath": "A String", # A local path within the VM to use. |
| 239 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 240 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 241 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 242 | }, |
| 243 | }, |
| 244 | }, |
| 245 | "desiredState": "A String", # Required. The desired state the agent should maintain for this package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 246 | "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 247 | "name": "A String", # Required. Package name. |
| 248 | }, |
| 249 | "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 250 | "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 251 | "A String", |
| 252 | ], |
| 253 | "source": { # A remote or local file. # Required. The MSI package. |
| 254 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 255 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 256 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 257 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 258 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 259 | }, |
| 260 | "localPath": "A String", # A local path within the VM to use. |
| 261 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 262 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 263 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 264 | }, |
| 265 | }, |
| 266 | }, |
| 267 | "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 268 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 269 | "source": { # A remote or local file. # Required. An rpm package. |
| 270 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 271 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 272 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 273 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 274 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 275 | }, |
| 276 | "localPath": "A String", # A local path within the VM to use. |
| 277 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 278 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 279 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 280 | }, |
| 281 | }, |
| 282 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 283 | "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 284 | "name": "A String", # Required. Package name. |
| 285 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 286 | "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 287 | "name": "A String", # Required. Package name. |
| 288 | }, |
| 289 | }, |
| 290 | "repository": { # A resource that manages a package repository. # Package repository resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 291 | "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 292 | "archiveType": "A String", # Required. Type of archive files in this repository. |
| 293 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 294 | "A String", |
| 295 | ], |
| 296 | "distribution": "A String", # Required. Distribution of this repository. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 297 | "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. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 298 | "uri": "A String", # Required. URI for this repository. |
| 299 | }, |
| 300 | "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. |
| 301 | "name": "A String", # Required. The name of the repository. |
| 302 | "url": "A String", # Required. The url of the repository. |
| 303 | }, |
| 304 | "yum": { # Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| 305 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 306 | "displayName": "A String", # The display name of the repository. |
| 307 | "gpgKeys": [ # URIs of GPG keys. |
| 308 | "A String", |
| 309 | ], |
| 310 | "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 resource conflicts. |
| 311 | }, |
| 312 | "zypper": { # Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| 313 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 314 | "displayName": "A String", # The display name of the repository. |
| 315 | "gpgKeys": [ # URIs of GPG keys. |
| 316 | "A String", |
| 317 | ], |
| 318 | "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 GuestPolicy conflicts. |
| 319 | }, |
| 320 | }, |
| 321 | }, |
| 322 | ], |
| 323 | }, |
| 324 | ], |
| 325 | }, |
| 326 | ], |
| 327 | "reconciling": True or False, # Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING |
| 328 | "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. |
| 329 | "revisionId": "A String", # Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment |
| 330 | "rollout": { # Message to configure the rollout at the zonal level for the OS policy assignment. # Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted. |
| 331 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment. |
| 332 | "fixed": 42, # Specifies a fixed value. |
| 333 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 334 | }, |
| 335 | "minWaitDuration": "A String", # Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied. |
| 336 | }, |
| 337 | "rolloutState": "A String", # Output only. OS policy assignment rollout state |
| 338 | "uid": "A String", # Output only. Server generated unique id for the OS policy assignment resource. |
| 339 | } |
| 340 | |
| 341 | osPolicyAssignmentId: string, Required. The logical name of the OS policy assignment 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. |
| 342 | x__xgafv: string, V1 error format. |
| 343 | Allowed values |
| 344 | 1 - v1 error format |
| 345 | 2 - v2 error format |
| 346 | |
| 347 | Returns: |
| 348 | An object of the form: |
| 349 | |
| 350 | { # This resource represents a long-running operation that is the result of a network API call. |
| 351 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 352 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 353 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 354 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 355 | { |
| 356 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 357 | }, |
| 358 | ], |
| 359 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 360 | }, |
| 361 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 362 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 363 | }, |
| 364 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 365 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 366 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 367 | }, |
| 368 | }</pre> |
| 369 | </div> |
| 370 | |
| 371 | <div class="method"> |
| 372 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 373 | <pre>Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 374 | |
| 375 | Args: |
| 376 | name: string, Required. The name of the OS policy assignment to be deleted (required) |
| 377 | x__xgafv: string, V1 error format. |
| 378 | Allowed values |
| 379 | 1 - v1 error format |
| 380 | 2 - v2 error format |
| 381 | |
| 382 | Returns: |
| 383 | An object of the form: |
| 384 | |
| 385 | { # This resource represents a long-running operation that is the result of a network API call. |
| 386 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 387 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 388 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 389 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 390 | { |
| 391 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 392 | }, |
| 393 | ], |
| 394 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 395 | }, |
| 396 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 397 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 398 | }, |
| 399 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 400 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 401 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 402 | }, |
| 403 | }</pre> |
| 404 | </div> |
| 405 | |
| 406 | <div class="method"> |
| 407 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 408 | <pre>Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the `name` parameter. |
| 409 | |
| 410 | Args: |
| 411 | name: string, Required. The resource name of OS policy assignment. Format: `projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}` (required) |
| 412 | x__xgafv: string, V1 error format. |
| 413 | Allowed values |
| 414 | 1 - v1 error format |
| 415 | 2 - v2 error format |
| 416 | |
| 417 | Returns: |
| 418 | An object of the form: |
| 419 | |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 420 | { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 421 | "baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. |
| 422 | "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment. |
| 423 | "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters. |
| 424 | "instanceFilter": { # Message to represent the filters to select VMs for an assignment # Required. Filter to select VMs. |
| 425 | "all": True or False, # Target all VMs in the project. If true, no other criteria is permitted. |
| 426 | "exclusionLabels": [ # List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM. This filter is applied last in the filtering chain and therefore a VM is guaranteed to be excluded if it satisfies one of the below label sets. |
| 427 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 428 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 429 | "a_key": "A String", |
| 430 | }, |
| 431 | }, |
| 432 | ], |
| 433 | "inclusionLabels": [ # List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM. |
| 434 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 435 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 436 | "a_key": "A String", |
| 437 | }, |
| 438 | }, |
| 439 | ], |
| 440 | "osShortNames": [ # A VM is included if it's OS short name matches with any of the values provided in this list. |
| 441 | "A String", |
| 442 | ], |
| 443 | }, |
| 444 | "name": "A String", # Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. |
| 445 | "osPolicies": [ # Required. List of OS policies to be applied to the VMs. |
| 446 | { # An OS policy defines the desired state configuration for a VM. |
| 447 | "allowNoResourceGroupMatch": True or False, # This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce. |
| 448 | "description": "A String", # Policy description. Length of the description is limited to 1024 characters. |
| 449 | "id": "A String", # Required. The id of the OS policy 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 assignment. |
| 450 | "mode": "A String", # Required. Policy mode |
| 451 | "resourceGroups": [ # Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match` |
| 452 | { # Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group. |
| 453 | "osFilter": { # The `OSFilter` is used to specify the OS filtering criteria for the resource group. # Used to specify the OS filter for a resource group |
| 454 | "osShortName": "A String", # This should match OS short name emitted by the OS inventory agent. An empty value matches any OS. |
| 455 | "osVersion": "A String", # This value should match the version emitted by the OS inventory agent. Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` |
| 456 | }, |
| 457 | "resources": [ # Required. List of resources configured for this resource group. The resources are executed in the exact order specified here. |
| 458 | { # An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state. |
| 459 | "exec": { # A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen. # Exec resource |
| 460 | "enforce": { # A file or script to execute. # What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce. |
| 461 | "args": [ # Optional arguments to pass to the source during execution. |
| 462 | "A String", |
| 463 | ], |
| 464 | "file": { # A remote or local file. # A remote or local file. |
| 465 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 466 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 467 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 468 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 469 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 470 | }, |
| 471 | "localPath": "A String", # A local path within the VM to use. |
| 472 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 473 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 474 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 475 | }, |
| 476 | }, |
| 477 | "interpreter": "A String", # Required. The script interpreter to use. |
| 478 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 479 | }, |
| 480 | "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. |
| 481 | "args": [ # Optional arguments to pass to the source during execution. |
| 482 | "A String", |
| 483 | ], |
| 484 | "file": { # A remote or local file. # A remote or local file. |
| 485 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 486 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 487 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 488 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 489 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 490 | }, |
| 491 | "localPath": "A String", # A local path within the VM to use. |
| 492 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 493 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 494 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 495 | }, |
| 496 | }, |
| 497 | "interpreter": "A String", # Required. The script interpreter to use. |
| 498 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 499 | }, |
| 500 | }, |
| 501 | "file": { # A resource that manages the state of a file. # File resource |
| 502 | "content": "A String", # A a file with this content. The size of the content is limited to 1024 characters. |
| 503 | "file": { # A remote or local file. # A remote or local source. |
| 504 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 505 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 506 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 507 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 508 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 509 | }, |
| 510 | "localPath": "A String", # A local path within the VM to use. |
| 511 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 512 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 513 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 514 | }, |
| 515 | }, |
| 516 | "path": "A String", # Required. The absolute path of the file within the VM. |
| 517 | "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 |
| 518 | "state": "A String", # Required. Desired state of the file. |
| 519 | }, |
| 520 | "id": "A String", # Required. The id of the resource 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 OS policy. |
| 521 | "pkg": { # A resource that manages a system package. # Package resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 522 | "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 523 | "name": "A String", # Required. Package name. |
| 524 | }, |
| 525 | "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 526 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 527 | "source": { # A remote or local file. # Required. A deb package. |
| 528 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 529 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 530 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 531 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 532 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 533 | }, |
| 534 | "localPath": "A String", # A local path within the VM to use. |
| 535 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 536 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 537 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 538 | }, |
| 539 | }, |
| 540 | }, |
| 541 | "desiredState": "A String", # Required. The desired state the agent should maintain for this package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 542 | "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 543 | "name": "A String", # Required. Package name. |
| 544 | }, |
| 545 | "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 546 | "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 547 | "A String", |
| 548 | ], |
| 549 | "source": { # A remote or local file. # Required. The MSI package. |
| 550 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 551 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 552 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 553 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 554 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 555 | }, |
| 556 | "localPath": "A String", # A local path within the VM to use. |
| 557 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 558 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 559 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 560 | }, |
| 561 | }, |
| 562 | }, |
| 563 | "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 564 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 565 | "source": { # A remote or local file. # Required. An rpm package. |
| 566 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 567 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 568 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 569 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 570 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 571 | }, |
| 572 | "localPath": "A String", # A local path within the VM to use. |
| 573 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 574 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 575 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 576 | }, |
| 577 | }, |
| 578 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 579 | "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 580 | "name": "A String", # Required. Package name. |
| 581 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 582 | "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 583 | "name": "A String", # Required. Package name. |
| 584 | }, |
| 585 | }, |
| 586 | "repository": { # A resource that manages a package repository. # Package repository resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 587 | "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 588 | "archiveType": "A String", # Required. Type of archive files in this repository. |
| 589 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 590 | "A String", |
| 591 | ], |
| 592 | "distribution": "A String", # Required. Distribution of this repository. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 593 | "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. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 594 | "uri": "A String", # Required. URI for this repository. |
| 595 | }, |
| 596 | "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. |
| 597 | "name": "A String", # Required. The name of the repository. |
| 598 | "url": "A String", # Required. The url of the repository. |
| 599 | }, |
| 600 | "yum": { # Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| 601 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 602 | "displayName": "A String", # The display name of the repository. |
| 603 | "gpgKeys": [ # URIs of GPG keys. |
| 604 | "A String", |
| 605 | ], |
| 606 | "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 resource conflicts. |
| 607 | }, |
| 608 | "zypper": { # Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| 609 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 610 | "displayName": "A String", # The display name of the repository. |
| 611 | "gpgKeys": [ # URIs of GPG keys. |
| 612 | "A String", |
| 613 | ], |
| 614 | "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 GuestPolicy conflicts. |
| 615 | }, |
| 616 | }, |
| 617 | }, |
| 618 | ], |
| 619 | }, |
| 620 | ], |
| 621 | }, |
| 622 | ], |
| 623 | "reconciling": True or False, # Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING |
| 624 | "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. |
| 625 | "revisionId": "A String", # Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment |
| 626 | "rollout": { # Message to configure the rollout at the zonal level for the OS policy assignment. # Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted. |
| 627 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment. |
| 628 | "fixed": 42, # Specifies a fixed value. |
| 629 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 630 | }, |
| 631 | "minWaitDuration": "A String", # Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied. |
| 632 | }, |
| 633 | "rolloutState": "A String", # Output only. OS policy assignment rollout state |
| 634 | "uid": "A String", # Output only. Server generated unique id for the OS policy assignment resource. |
| 635 | }</pre> |
| 636 | </div> |
| 637 | |
| 638 | <div class="method"> |
| 639 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 640 | <pre>List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned. |
| 641 | |
| 642 | Args: |
| 643 | parent: string, Required. The parent resource name. (required) |
| 644 | pageSize: integer, The maximum number of assignments to return. |
| 645 | pageToken: string, A pagination token returned from a previous call to `ListOSPolicyAssignments` that indicates where this listing should continue from. |
| 646 | x__xgafv: string, V1 error format. |
| 647 | Allowed values |
| 648 | 1 - v1 error format |
| 649 | 2 - v2 error format |
| 650 | |
| 651 | Returns: |
| 652 | An object of the form: |
| 653 | |
| 654 | { # A response message for listing all assignments under given parent. |
| 655 | "nextPageToken": "A String", # The pagination token to retrieve the next page of OS policy assignments. |
| 656 | "osPolicyAssignments": [ # The list of assignments |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 657 | { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 658 | "baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. |
| 659 | "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment. |
| 660 | "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters. |
| 661 | "instanceFilter": { # Message to represent the filters to select VMs for an assignment # Required. Filter to select VMs. |
| 662 | "all": True or False, # Target all VMs in the project. If true, no other criteria is permitted. |
| 663 | "exclusionLabels": [ # List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM. This filter is applied last in the filtering chain and therefore a VM is guaranteed to be excluded if it satisfies one of the below label sets. |
| 664 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 665 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 666 | "a_key": "A String", |
| 667 | }, |
| 668 | }, |
| 669 | ], |
| 670 | "inclusionLabels": [ # List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM. |
| 671 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 672 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 673 | "a_key": "A String", |
| 674 | }, |
| 675 | }, |
| 676 | ], |
| 677 | "osShortNames": [ # A VM is included if it's OS short name matches with any of the values provided in this list. |
| 678 | "A String", |
| 679 | ], |
| 680 | }, |
| 681 | "name": "A String", # Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. |
| 682 | "osPolicies": [ # Required. List of OS policies to be applied to the VMs. |
| 683 | { # An OS policy defines the desired state configuration for a VM. |
| 684 | "allowNoResourceGroupMatch": True or False, # This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce. |
| 685 | "description": "A String", # Policy description. Length of the description is limited to 1024 characters. |
| 686 | "id": "A String", # Required. The id of the OS policy 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 assignment. |
| 687 | "mode": "A String", # Required. Policy mode |
| 688 | "resourceGroups": [ # Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match` |
| 689 | { # Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group. |
| 690 | "osFilter": { # The `OSFilter` is used to specify the OS filtering criteria for the resource group. # Used to specify the OS filter for a resource group |
| 691 | "osShortName": "A String", # This should match OS short name emitted by the OS inventory agent. An empty value matches any OS. |
| 692 | "osVersion": "A String", # This value should match the version emitted by the OS inventory agent. Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` |
| 693 | }, |
| 694 | "resources": [ # Required. List of resources configured for this resource group. The resources are executed in the exact order specified here. |
| 695 | { # An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state. |
| 696 | "exec": { # A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen. # Exec resource |
| 697 | "enforce": { # A file or script to execute. # What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce. |
| 698 | "args": [ # Optional arguments to pass to the source during execution. |
| 699 | "A String", |
| 700 | ], |
| 701 | "file": { # A remote or local file. # A remote or local file. |
| 702 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 703 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 704 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 705 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 706 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 707 | }, |
| 708 | "localPath": "A String", # A local path within the VM to use. |
| 709 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 710 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 711 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 712 | }, |
| 713 | }, |
| 714 | "interpreter": "A String", # Required. The script interpreter to use. |
| 715 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 716 | }, |
| 717 | "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. |
| 718 | "args": [ # Optional arguments to pass to the source during execution. |
| 719 | "A String", |
| 720 | ], |
| 721 | "file": { # A remote or local file. # A remote or local file. |
| 722 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 723 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 724 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 725 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 726 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 727 | }, |
| 728 | "localPath": "A String", # A local path within the VM to use. |
| 729 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 730 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 731 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 732 | }, |
| 733 | }, |
| 734 | "interpreter": "A String", # Required. The script interpreter to use. |
| 735 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 736 | }, |
| 737 | }, |
| 738 | "file": { # A resource that manages the state of a file. # File resource |
| 739 | "content": "A String", # A a file with this content. The size of the content is limited to 1024 characters. |
| 740 | "file": { # A remote or local file. # A remote or local source. |
| 741 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 742 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 743 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 744 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 745 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 746 | }, |
| 747 | "localPath": "A String", # A local path within the VM to use. |
| 748 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 749 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 750 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 751 | }, |
| 752 | }, |
| 753 | "path": "A String", # Required. The absolute path of the file within the VM. |
| 754 | "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 |
| 755 | "state": "A String", # Required. Desired state of the file. |
| 756 | }, |
| 757 | "id": "A String", # Required. The id of the resource 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 OS policy. |
| 758 | "pkg": { # A resource that manages a system package. # Package resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 759 | "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 760 | "name": "A String", # Required. Package name. |
| 761 | }, |
| 762 | "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 763 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 764 | "source": { # A remote or local file. # Required. A deb package. |
| 765 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 766 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 767 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 768 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 769 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 770 | }, |
| 771 | "localPath": "A String", # A local path within the VM to use. |
| 772 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 773 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 774 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 775 | }, |
| 776 | }, |
| 777 | }, |
| 778 | "desiredState": "A String", # Required. The desired state the agent should maintain for this package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 779 | "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 780 | "name": "A String", # Required. Package name. |
| 781 | }, |
| 782 | "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 783 | "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 784 | "A String", |
| 785 | ], |
| 786 | "source": { # A remote or local file. # Required. The MSI package. |
| 787 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 788 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 789 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 790 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 791 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 792 | }, |
| 793 | "localPath": "A String", # A local path within the VM to use. |
| 794 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 795 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 796 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 797 | }, |
| 798 | }, |
| 799 | }, |
| 800 | "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 801 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 802 | "source": { # A remote or local file. # Required. An rpm package. |
| 803 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 804 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 805 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 806 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 807 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 808 | }, |
| 809 | "localPath": "A String", # A local path within the VM to use. |
| 810 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 811 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 812 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 813 | }, |
| 814 | }, |
| 815 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 816 | "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 817 | "name": "A String", # Required. Package name. |
| 818 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 819 | "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 820 | "name": "A String", # Required. Package name. |
| 821 | }, |
| 822 | }, |
| 823 | "repository": { # A resource that manages a package repository. # Package repository resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 824 | "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 825 | "archiveType": "A String", # Required. Type of archive files in this repository. |
| 826 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 827 | "A String", |
| 828 | ], |
| 829 | "distribution": "A String", # Required. Distribution of this repository. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 830 | "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. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 831 | "uri": "A String", # Required. URI for this repository. |
| 832 | }, |
| 833 | "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. |
| 834 | "name": "A String", # Required. The name of the repository. |
| 835 | "url": "A String", # Required. The url of the repository. |
| 836 | }, |
| 837 | "yum": { # Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| 838 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 839 | "displayName": "A String", # The display name of the repository. |
| 840 | "gpgKeys": [ # URIs of GPG keys. |
| 841 | "A String", |
| 842 | ], |
| 843 | "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 resource conflicts. |
| 844 | }, |
| 845 | "zypper": { # Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| 846 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 847 | "displayName": "A String", # The display name of the repository. |
| 848 | "gpgKeys": [ # URIs of GPG keys. |
| 849 | "A String", |
| 850 | ], |
| 851 | "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 GuestPolicy conflicts. |
| 852 | }, |
| 853 | }, |
| 854 | }, |
| 855 | ], |
| 856 | }, |
| 857 | ], |
| 858 | }, |
| 859 | ], |
| 860 | "reconciling": True or False, # Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING |
| 861 | "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. |
| 862 | "revisionId": "A String", # Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment |
| 863 | "rollout": { # Message to configure the rollout at the zonal level for the OS policy assignment. # Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted. |
| 864 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment. |
| 865 | "fixed": 42, # Specifies a fixed value. |
| 866 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 867 | }, |
| 868 | "minWaitDuration": "A String", # Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied. |
| 869 | }, |
| 870 | "rolloutState": "A String", # Output only. OS policy assignment rollout state |
| 871 | "uid": "A String", # Output only. Server generated unique id for the OS policy assignment resource. |
| 872 | }, |
| 873 | ], |
| 874 | }</pre> |
| 875 | </div> |
| 876 | |
| 877 | <div class="method"> |
| 878 | <code class="details" id="listRevisions">listRevisions(name, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 879 | <pre>List the OS policy assignment revisions for a given OS policy assignment. |
| 880 | |
| 881 | Args: |
| 882 | name: string, Required. The name of the OS policy assignment to list revisions for. (required) |
| 883 | pageSize: integer, The maximum number of revisions to return. |
| 884 | pageToken: string, A pagination token returned from a previous call to `ListOSPolicyAssignmentRevisions` that indicates where this listing should continue from. |
| 885 | x__xgafv: string, V1 error format. |
| 886 | Allowed values |
| 887 | 1 - v1 error format |
| 888 | 2 - v2 error format |
| 889 | |
| 890 | Returns: |
| 891 | An object of the form: |
| 892 | |
| 893 | { # A response message for listing all revisions for a OS policy assignment. |
| 894 | "nextPageToken": "A String", # The pagination token to retrieve the next page of OS policy assignment revisions. |
| 895 | "osPolicyAssignments": [ # The OS policy assignment revisions |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 896 | { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 897 | "baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. |
| 898 | "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment. |
| 899 | "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters. |
| 900 | "instanceFilter": { # Message to represent the filters to select VMs for an assignment # Required. Filter to select VMs. |
| 901 | "all": True or False, # Target all VMs in the project. If true, no other criteria is permitted. |
| 902 | "exclusionLabels": [ # List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM. This filter is applied last in the filtering chain and therefore a VM is guaranteed to be excluded if it satisfies one of the below label sets. |
| 903 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 904 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 905 | "a_key": "A String", |
| 906 | }, |
| 907 | }, |
| 908 | ], |
| 909 | "inclusionLabels": [ # List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM. |
| 910 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 911 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 912 | "a_key": "A String", |
| 913 | }, |
| 914 | }, |
| 915 | ], |
| 916 | "osShortNames": [ # A VM is included if it's OS short name matches with any of the values provided in this list. |
| 917 | "A String", |
| 918 | ], |
| 919 | }, |
| 920 | "name": "A String", # Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. |
| 921 | "osPolicies": [ # Required. List of OS policies to be applied to the VMs. |
| 922 | { # An OS policy defines the desired state configuration for a VM. |
| 923 | "allowNoResourceGroupMatch": True or False, # This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce. |
| 924 | "description": "A String", # Policy description. Length of the description is limited to 1024 characters. |
| 925 | "id": "A String", # Required. The id of the OS policy 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 assignment. |
| 926 | "mode": "A String", # Required. Policy mode |
| 927 | "resourceGroups": [ # Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match` |
| 928 | { # Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group. |
| 929 | "osFilter": { # The `OSFilter` is used to specify the OS filtering criteria for the resource group. # Used to specify the OS filter for a resource group |
| 930 | "osShortName": "A String", # This should match OS short name emitted by the OS inventory agent. An empty value matches any OS. |
| 931 | "osVersion": "A String", # This value should match the version emitted by the OS inventory agent. Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` |
| 932 | }, |
| 933 | "resources": [ # Required. List of resources configured for this resource group. The resources are executed in the exact order specified here. |
| 934 | { # An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state. |
| 935 | "exec": { # A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen. # Exec resource |
| 936 | "enforce": { # A file or script to execute. # What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce. |
| 937 | "args": [ # Optional arguments to pass to the source during execution. |
| 938 | "A String", |
| 939 | ], |
| 940 | "file": { # A remote or local file. # A remote or local file. |
| 941 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 942 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 943 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 944 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 945 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 946 | }, |
| 947 | "localPath": "A String", # A local path within the VM to use. |
| 948 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 949 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 950 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 951 | }, |
| 952 | }, |
| 953 | "interpreter": "A String", # Required. The script interpreter to use. |
| 954 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 955 | }, |
| 956 | "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. |
| 957 | "args": [ # Optional arguments to pass to the source during execution. |
| 958 | "A String", |
| 959 | ], |
| 960 | "file": { # A remote or local file. # A remote or local file. |
| 961 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 962 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 963 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 964 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 965 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 966 | }, |
| 967 | "localPath": "A String", # A local path within the VM to use. |
| 968 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 969 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 970 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 971 | }, |
| 972 | }, |
| 973 | "interpreter": "A String", # Required. The script interpreter to use. |
| 974 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 975 | }, |
| 976 | }, |
| 977 | "file": { # A resource that manages the state of a file. # File resource |
| 978 | "content": "A String", # A a file with this content. The size of the content is limited to 1024 characters. |
| 979 | "file": { # A remote or local file. # A remote or local source. |
| 980 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 981 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 982 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 983 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 984 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 985 | }, |
| 986 | "localPath": "A String", # A local path within the VM to use. |
| 987 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 988 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 989 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 990 | }, |
| 991 | }, |
| 992 | "path": "A String", # Required. The absolute path of the file within the VM. |
| 993 | "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 |
| 994 | "state": "A String", # Required. Desired state of the file. |
| 995 | }, |
| 996 | "id": "A String", # Required. The id of the resource 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 OS policy. |
| 997 | "pkg": { # A resource that manages a system package. # Package resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 998 | "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 999 | "name": "A String", # Required. Package name. |
| 1000 | }, |
| 1001 | "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1002 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1003 | "source": { # A remote or local file. # Required. A deb package. |
| 1004 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1005 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1006 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1007 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1008 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1009 | }, |
| 1010 | "localPath": "A String", # A local path within the VM to use. |
| 1011 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1012 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1013 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1014 | }, |
| 1015 | }, |
| 1016 | }, |
| 1017 | "desiredState": "A String", # Required. The desired state the agent should maintain for this package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1018 | "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1019 | "name": "A String", # Required. Package name. |
| 1020 | }, |
| 1021 | "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1022 | "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1023 | "A String", |
| 1024 | ], |
| 1025 | "source": { # A remote or local file. # Required. The MSI package. |
| 1026 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1027 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1028 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1029 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1030 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1031 | }, |
| 1032 | "localPath": "A String", # A local path within the VM to use. |
| 1033 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1034 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1035 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1036 | }, |
| 1037 | }, |
| 1038 | }, |
| 1039 | "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1040 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1041 | "source": { # A remote or local file. # Required. An rpm package. |
| 1042 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1043 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1044 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1045 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1046 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1047 | }, |
| 1048 | "localPath": "A String", # A local path within the VM to use. |
| 1049 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1050 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1051 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1052 | }, |
| 1053 | }, |
| 1054 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1055 | "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1056 | "name": "A String", # Required. Package name. |
| 1057 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1058 | "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1059 | "name": "A String", # Required. Package name. |
| 1060 | }, |
| 1061 | }, |
| 1062 | "repository": { # A resource that manages a package repository. # Package repository resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1063 | "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1064 | "archiveType": "A String", # Required. Type of archive files in this repository. |
| 1065 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 1066 | "A String", |
| 1067 | ], |
| 1068 | "distribution": "A String", # Required. Distribution of this repository. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1069 | "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. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1070 | "uri": "A String", # Required. URI for this repository. |
| 1071 | }, |
| 1072 | "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. |
| 1073 | "name": "A String", # Required. The name of the repository. |
| 1074 | "url": "A String", # Required. The url of the repository. |
| 1075 | }, |
| 1076 | "yum": { # Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| 1077 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 1078 | "displayName": "A String", # The display name of the repository. |
| 1079 | "gpgKeys": [ # URIs of GPG keys. |
| 1080 | "A String", |
| 1081 | ], |
| 1082 | "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 resource conflicts. |
| 1083 | }, |
| 1084 | "zypper": { # Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| 1085 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 1086 | "displayName": "A String", # The display name of the repository. |
| 1087 | "gpgKeys": [ # URIs of GPG keys. |
| 1088 | "A String", |
| 1089 | ], |
| 1090 | "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 GuestPolicy conflicts. |
| 1091 | }, |
| 1092 | }, |
| 1093 | }, |
| 1094 | ], |
| 1095 | }, |
| 1096 | ], |
| 1097 | }, |
| 1098 | ], |
| 1099 | "reconciling": True or False, # Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING |
| 1100 | "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. |
| 1101 | "revisionId": "A String", # Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment |
| 1102 | "rollout": { # Message to configure the rollout at the zonal level for the OS policy assignment. # Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted. |
| 1103 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment. |
| 1104 | "fixed": 42, # Specifies a fixed value. |
| 1105 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 1106 | }, |
| 1107 | "minWaitDuration": "A String", # Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied. |
| 1108 | }, |
| 1109 | "rolloutState": "A String", # Output only. OS policy assignment rollout state |
| 1110 | "uid": "A String", # Output only. Server generated unique id for the OS policy assignment resource. |
| 1111 | }, |
| 1112 | ], |
| 1113 | }</pre> |
| 1114 | </div> |
| 1115 | |
| 1116 | <div class="method"> |
| 1117 | <code class="details" id="listRevisions_next">listRevisions_next(previous_request, previous_response)</code> |
| 1118 | <pre>Retrieves the next page of results. |
| 1119 | |
| 1120 | Args: |
| 1121 | previous_request: The request for the previous page. (required) |
| 1122 | previous_response: The response from the request for the previous page. (required) |
| 1123 | |
| 1124 | Returns: |
| 1125 | A request object that you can call 'execute()' on to request the next |
| 1126 | page. Returns None if there are no more items in the collection. |
| 1127 | </pre> |
| 1128 | </div> |
| 1129 | |
| 1130 | <div class="method"> |
| 1131 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1132 | <pre>Retrieves the next page of results. |
| 1133 | |
| 1134 | Args: |
| 1135 | previous_request: The request for the previous page. (required) |
| 1136 | previous_response: The response from the request for the previous page. (required) |
| 1137 | |
| 1138 | Returns: |
| 1139 | A request object that you can call 'execute()' on to request the next |
| 1140 | page. Returns None if there are no more items in the collection. |
| 1141 | </pre> |
| 1142 | </div> |
| 1143 | |
| 1144 | <div class="method"> |
| 1145 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1146 | <pre>Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1147 | |
| 1148 | Args: |
| 1149 | name: string, Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. (required) |
| 1150 | body: object, The request body. |
| 1151 | The object takes the form of: |
| 1152 | |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1153 | { # OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](/compute/docs/os-configuration-management/working-with-os-policies). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1154 | "baseline": True or False, # Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. |
| 1155 | "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment. |
| 1156 | "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters. |
| 1157 | "instanceFilter": { # Message to represent the filters to select VMs for an assignment # Required. Filter to select VMs. |
| 1158 | "all": True or False, # Target all VMs in the project. If true, no other criteria is permitted. |
| 1159 | "exclusionLabels": [ # List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM. This filter is applied last in the filtering chain and therefore a VM is guaranteed to be excluded if it satisfies one of the below label sets. |
| 1160 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 1161 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 1162 | "a_key": "A String", |
| 1163 | }, |
| 1164 | }, |
| 1165 | ], |
| 1166 | "inclusionLabels": [ # List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM. |
| 1167 | { # Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. |
| 1168 | "labels": { # Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. |
| 1169 | "a_key": "A String", |
| 1170 | }, |
| 1171 | }, |
| 1172 | ], |
| 1173 | "osShortNames": [ # A VM is included if it's OS short name matches with any of the values provided in this list. |
| 1174 | "A String", |
| 1175 | ], |
| 1176 | }, |
| 1177 | "name": "A String", # Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. |
| 1178 | "osPolicies": [ # Required. List of OS policies to be applied to the VMs. |
| 1179 | { # An OS policy defines the desired state configuration for a VM. |
| 1180 | "allowNoResourceGroupMatch": True or False, # This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce. |
| 1181 | "description": "A String", # Policy description. Length of the description is limited to 1024 characters. |
| 1182 | "id": "A String", # Required. The id of the OS policy 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 assignment. |
| 1183 | "mode": "A String", # Required. Policy mode |
| 1184 | "resourceGroups": [ # Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match` |
| 1185 | { # Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group. |
| 1186 | "osFilter": { # The `OSFilter` is used to specify the OS filtering criteria for the resource group. # Used to specify the OS filter for a resource group |
| 1187 | "osShortName": "A String", # This should match OS short name emitted by the OS inventory agent. An empty value matches any OS. |
| 1188 | "osVersion": "A String", # This value should match the version emitted by the OS inventory agent. Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` |
| 1189 | }, |
| 1190 | "resources": [ # Required. List of resources configured for this resource group. The resources are executed in the exact order specified here. |
| 1191 | { # An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state. |
| 1192 | "exec": { # A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen. # Exec resource |
| 1193 | "enforce": { # A file or script to execute. # What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce. |
| 1194 | "args": [ # Optional arguments to pass to the source during execution. |
| 1195 | "A String", |
| 1196 | ], |
| 1197 | "file": { # A remote or local file. # A remote or local file. |
| 1198 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1199 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1200 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1201 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1202 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1203 | }, |
| 1204 | "localPath": "A String", # A local path within the VM to use. |
| 1205 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1206 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1207 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1208 | }, |
| 1209 | }, |
| 1210 | "interpreter": "A String", # Required. The script interpreter to use. |
| 1211 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 1212 | }, |
| 1213 | "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. |
| 1214 | "args": [ # Optional arguments to pass to the source during execution. |
| 1215 | "A String", |
| 1216 | ], |
| 1217 | "file": { # A remote or local file. # A remote or local file. |
| 1218 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1219 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1220 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1221 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1222 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1223 | }, |
| 1224 | "localPath": "A String", # A local path within the VM to use. |
| 1225 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1226 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1227 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1228 | }, |
| 1229 | }, |
| 1230 | "interpreter": "A String", # Required. The script interpreter to use. |
| 1231 | "script": "A String", # An inline script. The size of the script is limited to 1024 characters. |
| 1232 | }, |
| 1233 | }, |
| 1234 | "file": { # A resource that manages the state of a file. # File resource |
| 1235 | "content": "A String", # A a file with this content. The size of the content is limited to 1024 characters. |
| 1236 | "file": { # A remote or local file. # A remote or local source. |
| 1237 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1238 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1239 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1240 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1241 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1242 | }, |
| 1243 | "localPath": "A String", # A local path within the VM to use. |
| 1244 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1245 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1246 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1247 | }, |
| 1248 | }, |
| 1249 | "path": "A String", # Required. The absolute path of the file within the VM. |
| 1250 | "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 |
| 1251 | "state": "A String", # Required. Desired state of the file. |
| 1252 | }, |
| 1253 | "id": "A String", # Required. The id of the resource 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 OS policy. |
| 1254 | "pkg": { # A resource that manages a system package. # Package resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1255 | "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1256 | "name": "A String", # Required. Package name. |
| 1257 | }, |
| 1258 | "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1259 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1260 | "source": { # A remote or local file. # Required. A deb package. |
| 1261 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1262 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1263 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1264 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1265 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1266 | }, |
| 1267 | "localPath": "A String", # A local path within the VM to use. |
| 1268 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1269 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1270 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1271 | }, |
| 1272 | }, |
| 1273 | }, |
| 1274 | "desiredState": "A String", # Required. The desired state the agent should maintain for this package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1275 | "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1276 | "name": "A String", # Required. Package name. |
| 1277 | }, |
| 1278 | "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1279 | "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1280 | "A String", |
| 1281 | ], |
| 1282 | "source": { # A remote or local file. # Required. The MSI package. |
| 1283 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1284 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1285 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1286 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1287 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1288 | }, |
| 1289 | "localPath": "A String", # A local path within the VM to use. |
| 1290 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1291 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1292 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1293 | }, |
| 1294 | }, |
| 1295 | }, |
| 1296 | "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1297 | "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm` |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1298 | "source": { # A remote or local file. # Required. An rpm package. |
| 1299 | "allowInsecure": True or False, # Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. |
| 1300 | "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. |
| 1301 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1302 | "generation": "A String", # Generation number of the Cloud Storage object. |
| 1303 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1304 | }, |
| 1305 | "localPath": "A String", # A local path within the VM to use. |
| 1306 | "remote": { # Specifies a file available via some URI. # A generic remote file. |
| 1307 | "sha256Checksum": "A String", # SHA256 checksum of the remote file. |
| 1308 | "uri": "A String", # Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. |
| 1309 | }, |
| 1310 | }, |
| 1311 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1312 | "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1313 | "name": "A String", # Required. Package name. |
| 1314 | }, |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1315 | "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1316 | "name": "A String", # Required. Package name. |
| 1317 | }, |
| 1318 | }, |
| 1319 | "repository": { # A resource that manages a package repository. # Package repository resource |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1320 | "apt": { # Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # An Apt Repository. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1321 | "archiveType": "A String", # Required. Type of archive files in this repository. |
| 1322 | "components": [ # Required. List of components for this repository. Must contain at least one item. |
| 1323 | "A String", |
| 1324 | ], |
| 1325 | "distribution": "A String", # Required. Distribution of this repository. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 1326 | "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. |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1327 | "uri": "A String", # Required. URI for this repository. |
| 1328 | }, |
| 1329 | "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. |
| 1330 | "name": "A String", # Required. The name of the repository. |
| 1331 | "url": "A String", # Required. The url of the repository. |
| 1332 | }, |
| 1333 | "yum": { # Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`. # A Yum Repository. |
| 1334 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 1335 | "displayName": "A String", # The display name of the repository. |
| 1336 | "gpgKeys": [ # URIs of GPG keys. |
| 1337 | "A String", |
| 1338 | ], |
| 1339 | "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 resource conflicts. |
| 1340 | }, |
| 1341 | "zypper": { # Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`. # A Zypper Repository. |
| 1342 | "baseUrl": "A String", # Required. The location of the repository directory. |
| 1343 | "displayName": "A String", # The display name of the repository. |
| 1344 | "gpgKeys": [ # URIs of GPG keys. |
| 1345 | "A String", |
| 1346 | ], |
| 1347 | "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 GuestPolicy conflicts. |
| 1348 | }, |
| 1349 | }, |
| 1350 | }, |
| 1351 | ], |
| 1352 | }, |
| 1353 | ], |
| 1354 | }, |
| 1355 | ], |
| 1356 | "reconciling": True or False, # Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING |
| 1357 | "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. |
| 1358 | "revisionId": "A String", # Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment |
| 1359 | "rollout": { # Message to configure the rollout at the zonal level for the OS policy assignment. # Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted. |
| 1360 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment. |
| 1361 | "fixed": 42, # Specifies a fixed value. |
| 1362 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 1363 | }, |
| 1364 | "minWaitDuration": "A String", # Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied. |
| 1365 | }, |
| 1366 | "rolloutState": "A String", # Output only. OS policy assignment rollout state |
| 1367 | "uid": "A String", # Output only. Server generated unique id for the OS policy assignment resource. |
| 1368 | } |
| 1369 | |
| 1370 | updateMask: string, Optional. Field mask that controls which fields of the assignment should be updated. |
| 1371 | x__xgafv: string, V1 error format. |
| 1372 | Allowed values |
| 1373 | 1 - v1 error format |
| 1374 | 2 - v2 error format |
| 1375 | |
| 1376 | Returns: |
| 1377 | An object of the form: |
| 1378 | |
| 1379 | { # This resource represents a long-running operation that is the result of a network API call. |
| 1380 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 1381 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 1382 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1383 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1384 | { |
| 1385 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1386 | }, |
| 1387 | ], |
| 1388 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 1389 | }, |
| 1390 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 1391 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1392 | }, |
| 1393 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 1394 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 1395 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1396 | }, |
| 1397 | }</pre> |
| 1398 | </div> |
| 1399 | |
| 1400 | </body></html> |