| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="osconfig_v1.html">Cloud OS Config API</a> . <a href="osconfig_v1.projects.html">projects</a> . <a href="osconfig_v1.projects.patchJobs.html">patchJobs</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="osconfig_v1.projects.patchJobs.instanceDetails.html">instanceDetails()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the instanceDetails Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Cancel a patch job. The patch job must be active. Canceled patch jobs</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#execute">execute(parent, body=None, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Patch VM instances by creating and running a patch job.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Get the patch job. This can be used to track the progress of an</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Get a list of patch jobs.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <h3>Method Details</h3> |
| 98 | <div class="method"> |
| 99 | <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code> |
| 100 | <pre>Cancel a patch job. The patch job must be active. Canceled patch jobs |
| 101 | cannot be restarted. |
| 102 | |
| 103 | Args: |
| 104 | name: string, Required. Name of the patch in the form `projects/*/patchJobs/*` (required) |
| 105 | body: object, The request body. |
| 106 | The object takes the form of: |
| 107 | |
| 108 | { # Message for canceling a patch job. |
| 109 | } |
| 110 | |
| 111 | x__xgafv: string, V1 error format. |
| 112 | Allowed values |
| 113 | 1 - v1 error format |
| 114 | 2 - v2 error format |
| 115 | |
| 116 | Returns: |
| 117 | An object of the form: |
| 118 | |
| 119 | { # A high level representation of a patch job that is either in progress |
| 120 | # or has completed. |
| 121 | # |
| 122 | # Instances details are not included in the job. To paginate through instance |
| 123 | # details, use ListPatchJobInstanceDetails. |
| 124 | # |
| 125 | # For more information about patch jobs, see |
| 126 | # [Creating patch |
| 127 | # jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 128 | "displayName": "A String", # Display name for this patch job. This is not a unique identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | "dryRun": True or False, # If this patch job is a dry run, the agent reports that it has |
| 130 | # finished without running any updates on the VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 131 | "createTime": "A String", # Time this patch job was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | "updateTime": "A String", # Last time this patch job was updated. |
| 133 | "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job. |
| 134 | "errorMessage": "A String", # If this patch job failed, this message provides information about the |
| 135 | # failure. |
| 136 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied. |
| 137 | # patch(es) to a VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 138 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 139 | # rules. |
| 140 | # upgrade`. Additional options can be set to control how this is executed. |
| 141 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 142 | "A String", |
| 143 | ], |
| 144 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 145 | # that will be updated. If these packages are not installed, they will be |
| 146 | # ignored. This field cannot be specified with any other patch configuration |
| 147 | # fields. |
| 148 | "A String", |
| 149 | ], |
| 150 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 151 | # using `apt-get dist-upgrade` instead. |
| 152 | }, |
| 153 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 154 | # rules. |
| 155 | # can be set to control how this is executed. |
| 156 | # |
| 157 | # Note that not all settings are supported on all platforms. |
| 158 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 159 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 160 | # using the yum `--exclude` flag. |
| 161 | "A String", |
| 162 | ], |
| 163 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 164 | # that will be updated. If these packages are not installed, they will be |
| 165 | # ignored. This field must not be specified with any other patch |
| 166 | # configuration fields. |
| 167 | "A String", |
| 168 | ], |
| 169 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 170 | # all platforms. |
| 171 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 173 | # rules. |
| 174 | }, |
| 175 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 176 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 177 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 179 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 180 | # execution can return to indicate a success. |
| 181 | 42, |
| 182 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 183 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 184 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 185 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 186 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 187 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 188 | }, |
| 189 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 190 | # specified the script will be executed directly, which will likely |
| 191 | # only succeed for scripts with [shebang lines] |
| 192 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 193 | }, |
| 194 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 195 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 196 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 197 | # execution can return to indicate a success. |
| 198 | 42, |
| 199 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 200 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 201 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 202 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 203 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 204 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 205 | }, |
| 206 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 207 | # specified the script will be executed directly, which will likely |
| 208 | # only succeed for scripts with [shebang lines] |
| 209 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 210 | }, |
| 211 | }, |
| 212 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 213 | "excludes": [ # List of KBs to exclude from update. |
| 214 | "A String", |
| 215 | ], |
| 216 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 217 | # that will be updated. This field must not be used with other |
| 218 | # patch configurations. |
| 219 | "A String", |
| 220 | ], |
| 221 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 222 | # updates are applied. |
| 223 | "A String", |
| 224 | ], |
| 225 | }, |
| 226 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 227 | # patch rules. |
| 228 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 229 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 230 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 231 | # This field must not be used with any other patch configuration fields. |
| 232 | "A String", |
| 233 | ], |
| 234 | "excludes": [ # List of patches to exclude from update. |
| 235 | "A String", |
| 236 | ], |
| 237 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 238 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 239 | "severities": [ # Install only patches with these severities. |
| 240 | # Common severities include critical, important, moderate, and low. |
| 241 | "A String", |
| 242 | ], |
| 243 | "categories": [ # Install only patches with these categories. |
| 244 | # Common categories include security, recommended, and feature. |
| 245 | "A String", |
| 246 | ], |
| 247 | }, |
| 248 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 249 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 250 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 251 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 252 | # execution can return to indicate a success. |
| 253 | 42, |
| 254 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 255 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 256 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 257 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 258 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 259 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 260 | }, |
| 261 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 262 | # specified the script will be executed directly, which will likely |
| 263 | # only succeed for scripts with [shebang lines] |
| 264 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 265 | }, |
| 266 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 267 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 268 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 269 | # execution can return to indicate a success. |
| 270 | 42, |
| 271 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 272 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 273 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 274 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 275 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 276 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 277 | }, |
| 278 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 279 | # specified the script will be executed directly, which will likely |
| 280 | # only succeed for scripts with [shebang lines] |
| 281 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 282 | }, |
| 283 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 284 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 285 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch. |
| 286 | # VMs must meet all criteria specified. So if both labels and zones are |
| 287 | # specified, the patch job targets only VMs with those labels and in those |
| 288 | # zones. |
| 289 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 290 | # permitted. |
| 291 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 292 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME], |
| 293 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 294 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 295 | "A String", |
| 296 | ], |
| 297 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 298 | # labels, this is another way to group VMs when targeting configs, for |
| 299 | # example prefix="prod-". |
| 300 | "A String", |
| 301 | ], |
| 302 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 303 | # instances in any zone. |
| 304 | "A String", |
| 305 | ], |
| 306 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows |
| 307 | # targeting of disparate groups of VM instances. |
| 308 | { # Targets a group of VM instances by using their [assigned |
| 309 | # labels](https://cloud.google.com/compute/docs/labeling-resources). Labels |
| 310 | # are key-value pairs. A `GroupLabel` is a combination of labels |
| 311 | # that is used to target VMs for a patch job. |
| 312 | # |
| 313 | # For example, a patch job can target VMs that have the following |
| 314 | # `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job |
| 315 | # is applied to VMs that have both the labels `env=test` and `app=web`. |
| 316 | "labels": { # Compute Engine instance labels that must be present for a VM |
| 317 | # instance to be targeted by this filter. |
| 318 | "a_key": "A String", |
| 319 | }, |
| 320 | }, |
| 321 | ], |
| 322 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 323 | "duration": "A String", # Duration of the patch job. After the duration ends, the |
| 324 | # patch job times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 325 | "instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details. |
| 326 | # job affects. Contains counts of instances in different states. These states |
| 327 | # map to `InstancePatchState`. List patch job instance details to see the |
| 328 | # specific states of each instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 329 | "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot. |
| 330 | "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step. |
| 331 | "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to |
| 332 | # ensure that the agent is installed, running, and able to communicate with |
| 333 | # the service. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 334 | "failedInstanceCount": "A String", # Number of instances that failed. |
| 335 | "pendingInstanceCount": "A String", # Number of instances pending patch job. |
| 336 | "notifiedInstanceCount": "A String", # Number of instances notified about patch job. |
| 337 | "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches. |
| 338 | "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch. |
| 339 | "rebootingInstanceCount": "A String", # Number of instances rebooting. |
| 340 | "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step. |
| 341 | "succeededInstanceCount": "A String", # Number of instances that have completed successfully. |
| 342 | "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly. |
| 343 | "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches. |
| 344 | "startedInstanceCount": "A String", # Number of instances that have started. |
| 345 | "inactiveInstanceCount": "A String", # Number of instances that are inactive. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 346 | }, |
| 347 | "description": "A String", # Description of the patch job. Length of the description is limited |
| 348 | # to 1024 characters. |
| 349 | "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of |
| 350 | # 0.0 being no progress to 100.0 being complete. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 351 | "state": "A String", # The current state of the PatchJob . |
| 352 | "name": "A String", # Unique identifier for this patch job in the form |
| 353 | # `projects/*/patchJobs/*` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 354 | }</pre> |
| 355 | </div> |
| 356 | |
| 357 | <div class="method"> |
| 358 | <code class="details" id="execute">execute(parent, body=None, x__xgafv=None)</code> |
| 359 | <pre>Patch VM instances by creating and running a patch job. |
| 360 | |
| 361 | Args: |
| 362 | parent: string, Required. The project in which to run this patch in the form `projects/*` (required) |
| 363 | body: object, The request body. |
| 364 | The object takes the form of: |
| 365 | |
| 366 | { # A request message to initiate patching across Compute Engine |
| 367 | # instances. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 368 | "displayName": "A String", # Display name for this patch job. This does not have to be unique. |
| 369 | "description": "A String", # Description of the patch job. Length of the description is limited |
| 370 | # to 1024 characters. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 371 | "dryRun": True or False, # If this patch is a dry-run only, instances are contacted but |
| 372 | # will do nothing. |
| 373 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied. If omitted, instances are |
| 374 | # patched using the default configurations. |
| 375 | # patch(es) to a VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 376 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 377 | # rules. |
| 378 | # upgrade`. Additional options can be set to control how this is executed. |
| 379 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 380 | "A String", |
| 381 | ], |
| 382 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 383 | # that will be updated. If these packages are not installed, they will be |
| 384 | # ignored. This field cannot be specified with any other patch configuration |
| 385 | # fields. |
| 386 | "A String", |
| 387 | ], |
| 388 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 389 | # using `apt-get dist-upgrade` instead. |
| 390 | }, |
| 391 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 392 | # rules. |
| 393 | # can be set to control how this is executed. |
| 394 | # |
| 395 | # Note that not all settings are supported on all platforms. |
| 396 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 397 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 398 | # using the yum `--exclude` flag. |
| 399 | "A String", |
| 400 | ], |
| 401 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 402 | # that will be updated. If these packages are not installed, they will be |
| 403 | # ignored. This field must not be specified with any other patch |
| 404 | # configuration fields. |
| 405 | "A String", |
| 406 | ], |
| 407 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 408 | # all platforms. |
| 409 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 410 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 411 | # rules. |
| 412 | }, |
| 413 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 414 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 415 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 416 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 417 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 418 | # execution can return to indicate a success. |
| 419 | 42, |
| 420 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 421 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 422 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 423 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 424 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 425 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 426 | }, |
| 427 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 428 | # specified the script will be executed directly, which will likely |
| 429 | # only succeed for scripts with [shebang lines] |
| 430 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 431 | }, |
| 432 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 434 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 435 | # execution can return to indicate a success. |
| 436 | 42, |
| 437 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 438 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 439 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 440 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 441 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 442 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 443 | }, |
| 444 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 445 | # specified the script will be executed directly, which will likely |
| 446 | # only succeed for scripts with [shebang lines] |
| 447 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 448 | }, |
| 449 | }, |
| 450 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 451 | "excludes": [ # List of KBs to exclude from update. |
| 452 | "A String", |
| 453 | ], |
| 454 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 455 | # that will be updated. This field must not be used with other |
| 456 | # patch configurations. |
| 457 | "A String", |
| 458 | ], |
| 459 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 460 | # updates are applied. |
| 461 | "A String", |
| 462 | ], |
| 463 | }, |
| 464 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 465 | # patch rules. |
| 466 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 467 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 468 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 469 | # This field must not be used with any other patch configuration fields. |
| 470 | "A String", |
| 471 | ], |
| 472 | "excludes": [ # List of patches to exclude from update. |
| 473 | "A String", |
| 474 | ], |
| 475 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 476 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 477 | "severities": [ # Install only patches with these severities. |
| 478 | # Common severities include critical, important, moderate, and low. |
| 479 | "A String", |
| 480 | ], |
| 481 | "categories": [ # Install only patches with these categories. |
| 482 | # Common categories include security, recommended, and feature. |
| 483 | "A String", |
| 484 | ], |
| 485 | }, |
| 486 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 487 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 488 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 489 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 490 | # execution can return to indicate a success. |
| 491 | 42, |
| 492 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 493 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 494 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 495 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 496 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 497 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 498 | }, |
| 499 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 500 | # specified the script will be executed directly, which will likely |
| 501 | # only succeed for scripts with [shebang lines] |
| 502 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 503 | }, |
| 504 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 505 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 506 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 507 | # execution can return to indicate a success. |
| 508 | 42, |
| 509 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 510 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 511 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 512 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 513 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 514 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 515 | }, |
| 516 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 517 | # specified the script will be executed directly, which will likely |
| 518 | # only succeed for scripts with [shebang lines] |
| 519 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 520 | }, |
| 521 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 522 | }, |
| 523 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Required. Instances to patch, either explicitly or filtered by some criteria such |
| 524 | # as zone or labels. |
| 525 | # VMs must meet all criteria specified. So if both labels and zones are |
| 526 | # specified, the patch job targets only VMs with those labels and in those |
| 527 | # zones. |
| 528 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 529 | # permitted. |
| 530 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 531 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME], |
| 532 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 533 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 534 | "A String", |
| 535 | ], |
| 536 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 537 | # labels, this is another way to group VMs when targeting configs, for |
| 538 | # example prefix="prod-". |
| 539 | "A String", |
| 540 | ], |
| 541 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 542 | # instances in any zone. |
| 543 | "A String", |
| 544 | ], |
| 545 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows |
| 546 | # targeting of disparate groups of VM instances. |
| 547 | { # Targets a group of VM instances by using their [assigned |
| 548 | # labels](https://cloud.google.com/compute/docs/labeling-resources). Labels |
| 549 | # are key-value pairs. A `GroupLabel` is a combination of labels |
| 550 | # that is used to target VMs for a patch job. |
| 551 | # |
| 552 | # For example, a patch job can target VMs that have the following |
| 553 | # `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job |
| 554 | # is applied to VMs that have both the labels `env=test` and `app=web`. |
| 555 | "labels": { # Compute Engine instance labels that must be present for a VM |
| 556 | # instance to be targeted by this filter. |
| 557 | "a_key": "A String", |
| 558 | }, |
| 559 | }, |
| 560 | ], |
| 561 | }, |
| 562 | "duration": "A String", # Duration of the patch job. After the duration ends, the patch job |
| 563 | # times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 564 | } |
| 565 | |
| 566 | x__xgafv: string, V1 error format. |
| 567 | Allowed values |
| 568 | 1 - v1 error format |
| 569 | 2 - v2 error format |
| 570 | |
| 571 | Returns: |
| 572 | An object of the form: |
| 573 | |
| 574 | { # A high level representation of a patch job that is either in progress |
| 575 | # or has completed. |
| 576 | # |
| 577 | # Instances details are not included in the job. To paginate through instance |
| 578 | # details, use ListPatchJobInstanceDetails. |
| 579 | # |
| 580 | # For more information about patch jobs, see |
| 581 | # [Creating patch |
| 582 | # jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 583 | "displayName": "A String", # Display name for this patch job. This is not a unique identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 584 | "dryRun": True or False, # If this patch job is a dry run, the agent reports that it has |
| 585 | # finished without running any updates on the VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 586 | "createTime": "A String", # Time this patch job was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 587 | "updateTime": "A String", # Last time this patch job was updated. |
| 588 | "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job. |
| 589 | "errorMessage": "A String", # If this patch job failed, this message provides information about the |
| 590 | # failure. |
| 591 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied. |
| 592 | # patch(es) to a VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 593 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 594 | # rules. |
| 595 | # upgrade`. Additional options can be set to control how this is executed. |
| 596 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 597 | "A String", |
| 598 | ], |
| 599 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 600 | # that will be updated. If these packages are not installed, they will be |
| 601 | # ignored. This field cannot be specified with any other patch configuration |
| 602 | # fields. |
| 603 | "A String", |
| 604 | ], |
| 605 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 606 | # using `apt-get dist-upgrade` instead. |
| 607 | }, |
| 608 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 609 | # rules. |
| 610 | # can be set to control how this is executed. |
| 611 | # |
| 612 | # Note that not all settings are supported on all platforms. |
| 613 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 614 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 615 | # using the yum `--exclude` flag. |
| 616 | "A String", |
| 617 | ], |
| 618 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 619 | # that will be updated. If these packages are not installed, they will be |
| 620 | # ignored. This field must not be specified with any other patch |
| 621 | # configuration fields. |
| 622 | "A String", |
| 623 | ], |
| 624 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 625 | # all platforms. |
| 626 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 627 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 628 | # rules. |
| 629 | }, |
| 630 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 631 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 632 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 633 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 634 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 635 | # execution can return to indicate a success. |
| 636 | 42, |
| 637 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 638 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 639 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 640 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 641 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 642 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 643 | }, |
| 644 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 645 | # specified the script will be executed directly, which will likely |
| 646 | # only succeed for scripts with [shebang lines] |
| 647 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 648 | }, |
| 649 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 650 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 651 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 652 | # execution can return to indicate a success. |
| 653 | 42, |
| 654 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 655 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 656 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 657 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 658 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 659 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 660 | }, |
| 661 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 662 | # specified the script will be executed directly, which will likely |
| 663 | # only succeed for scripts with [shebang lines] |
| 664 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 665 | }, |
| 666 | }, |
| 667 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 668 | "excludes": [ # List of KBs to exclude from update. |
| 669 | "A String", |
| 670 | ], |
| 671 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 672 | # that will be updated. This field must not be used with other |
| 673 | # patch configurations. |
| 674 | "A String", |
| 675 | ], |
| 676 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 677 | # updates are applied. |
| 678 | "A String", |
| 679 | ], |
| 680 | }, |
| 681 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 682 | # patch rules. |
| 683 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 684 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 685 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 686 | # This field must not be used with any other patch configuration fields. |
| 687 | "A String", |
| 688 | ], |
| 689 | "excludes": [ # List of patches to exclude from update. |
| 690 | "A String", |
| 691 | ], |
| 692 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 693 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 694 | "severities": [ # Install only patches with these severities. |
| 695 | # Common severities include critical, important, moderate, and low. |
| 696 | "A String", |
| 697 | ], |
| 698 | "categories": [ # Install only patches with these categories. |
| 699 | # Common categories include security, recommended, and feature. |
| 700 | "A String", |
| 701 | ], |
| 702 | }, |
| 703 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 704 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 705 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 706 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 707 | # execution can return to indicate a success. |
| 708 | 42, |
| 709 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 710 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 711 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 712 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 713 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 714 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 715 | }, |
| 716 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 717 | # specified the script will be executed directly, which will likely |
| 718 | # only succeed for scripts with [shebang lines] |
| 719 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 720 | }, |
| 721 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 722 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 723 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 724 | # execution can return to indicate a success. |
| 725 | 42, |
| 726 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 727 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 728 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 729 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 730 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 731 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 732 | }, |
| 733 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 734 | # specified the script will be executed directly, which will likely |
| 735 | # only succeed for scripts with [shebang lines] |
| 736 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 737 | }, |
| 738 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 739 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 740 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch. |
| 741 | # VMs must meet all criteria specified. So if both labels and zones are |
| 742 | # specified, the patch job targets only VMs with those labels and in those |
| 743 | # zones. |
| 744 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 745 | # permitted. |
| 746 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 747 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME], |
| 748 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 749 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 750 | "A String", |
| 751 | ], |
| 752 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 753 | # labels, this is another way to group VMs when targeting configs, for |
| 754 | # example prefix="prod-". |
| 755 | "A String", |
| 756 | ], |
| 757 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 758 | # instances in any zone. |
| 759 | "A String", |
| 760 | ], |
| 761 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows |
| 762 | # targeting of disparate groups of VM instances. |
| 763 | { # Targets a group of VM instances by using their [assigned |
| 764 | # labels](https://cloud.google.com/compute/docs/labeling-resources). Labels |
| 765 | # are key-value pairs. A `GroupLabel` is a combination of labels |
| 766 | # that is used to target VMs for a patch job. |
| 767 | # |
| 768 | # For example, a patch job can target VMs that have the following |
| 769 | # `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job |
| 770 | # is applied to VMs that have both the labels `env=test` and `app=web`. |
| 771 | "labels": { # Compute Engine instance labels that must be present for a VM |
| 772 | # instance to be targeted by this filter. |
| 773 | "a_key": "A String", |
| 774 | }, |
| 775 | }, |
| 776 | ], |
| 777 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 778 | "duration": "A String", # Duration of the patch job. After the duration ends, the |
| 779 | # patch job times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 780 | "instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details. |
| 781 | # job affects. Contains counts of instances in different states. These states |
| 782 | # map to `InstancePatchState`. List patch job instance details to see the |
| 783 | # specific states of each instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 784 | "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot. |
| 785 | "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step. |
| 786 | "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to |
| 787 | # ensure that the agent is installed, running, and able to communicate with |
| 788 | # the service. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 789 | "failedInstanceCount": "A String", # Number of instances that failed. |
| 790 | "pendingInstanceCount": "A String", # Number of instances pending patch job. |
| 791 | "notifiedInstanceCount": "A String", # Number of instances notified about patch job. |
| 792 | "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches. |
| 793 | "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch. |
| 794 | "rebootingInstanceCount": "A String", # Number of instances rebooting. |
| 795 | "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step. |
| 796 | "succeededInstanceCount": "A String", # Number of instances that have completed successfully. |
| 797 | "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly. |
| 798 | "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches. |
| 799 | "startedInstanceCount": "A String", # Number of instances that have started. |
| 800 | "inactiveInstanceCount": "A String", # Number of instances that are inactive. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 801 | }, |
| 802 | "description": "A String", # Description of the patch job. Length of the description is limited |
| 803 | # to 1024 characters. |
| 804 | "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of |
| 805 | # 0.0 being no progress to 100.0 being complete. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 806 | "state": "A String", # The current state of the PatchJob . |
| 807 | "name": "A String", # Unique identifier for this patch job in the form |
| 808 | # `projects/*/patchJobs/*` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 809 | }</pre> |
| 810 | </div> |
| 811 | |
| 812 | <div class="method"> |
| 813 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 814 | <pre>Get the patch job. This can be used to track the progress of an |
| 815 | ongoing patch job or review the details of completed jobs. |
| 816 | |
| 817 | Args: |
| 818 | name: string, Required. Name of the patch in the form `projects/*/patchJobs/*` (required) |
| 819 | x__xgafv: string, V1 error format. |
| 820 | Allowed values |
| 821 | 1 - v1 error format |
| 822 | 2 - v2 error format |
| 823 | |
| 824 | Returns: |
| 825 | An object of the form: |
| 826 | |
| 827 | { # A high level representation of a patch job that is either in progress |
| 828 | # or has completed. |
| 829 | # |
| 830 | # Instances details are not included in the job. To paginate through instance |
| 831 | # details, use ListPatchJobInstanceDetails. |
| 832 | # |
| 833 | # For more information about patch jobs, see |
| 834 | # [Creating patch |
| 835 | # jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 836 | "displayName": "A String", # Display name for this patch job. This is not a unique identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 837 | "dryRun": True or False, # If this patch job is a dry run, the agent reports that it has |
| 838 | # finished without running any updates on the VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 839 | "createTime": "A String", # Time this patch job was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 840 | "updateTime": "A String", # Last time this patch job was updated. |
| 841 | "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job. |
| 842 | "errorMessage": "A String", # If this patch job failed, this message provides information about the |
| 843 | # failure. |
| 844 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied. |
| 845 | # patch(es) to a VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 846 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 847 | # rules. |
| 848 | # upgrade`. Additional options can be set to control how this is executed. |
| 849 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 850 | "A String", |
| 851 | ], |
| 852 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 853 | # that will be updated. If these packages are not installed, they will be |
| 854 | # ignored. This field cannot be specified with any other patch configuration |
| 855 | # fields. |
| 856 | "A String", |
| 857 | ], |
| 858 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 859 | # using `apt-get dist-upgrade` instead. |
| 860 | }, |
| 861 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 862 | # rules. |
| 863 | # can be set to control how this is executed. |
| 864 | # |
| 865 | # Note that not all settings are supported on all platforms. |
| 866 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 867 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 868 | # using the yum `--exclude` flag. |
| 869 | "A String", |
| 870 | ], |
| 871 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 872 | # that will be updated. If these packages are not installed, they will be |
| 873 | # ignored. This field must not be specified with any other patch |
| 874 | # configuration fields. |
| 875 | "A String", |
| 876 | ], |
| 877 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 878 | # all platforms. |
| 879 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 880 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 881 | # rules. |
| 882 | }, |
| 883 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 884 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 885 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 886 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 887 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 888 | # execution can return to indicate a success. |
| 889 | 42, |
| 890 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 891 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 892 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 893 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 894 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 895 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 896 | }, |
| 897 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 898 | # specified the script will be executed directly, which will likely |
| 899 | # only succeed for scripts with [shebang lines] |
| 900 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 901 | }, |
| 902 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 903 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 904 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 905 | # execution can return to indicate a success. |
| 906 | 42, |
| 907 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 908 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 909 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 910 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 911 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 912 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 913 | }, |
| 914 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 915 | # specified the script will be executed directly, which will likely |
| 916 | # only succeed for scripts with [shebang lines] |
| 917 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 918 | }, |
| 919 | }, |
| 920 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 921 | "excludes": [ # List of KBs to exclude from update. |
| 922 | "A String", |
| 923 | ], |
| 924 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 925 | # that will be updated. This field must not be used with other |
| 926 | # patch configurations. |
| 927 | "A String", |
| 928 | ], |
| 929 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 930 | # updates are applied. |
| 931 | "A String", |
| 932 | ], |
| 933 | }, |
| 934 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 935 | # patch rules. |
| 936 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 937 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 938 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 939 | # This field must not be used with any other patch configuration fields. |
| 940 | "A String", |
| 941 | ], |
| 942 | "excludes": [ # List of patches to exclude from update. |
| 943 | "A String", |
| 944 | ], |
| 945 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 946 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 947 | "severities": [ # Install only patches with these severities. |
| 948 | # Common severities include critical, important, moderate, and low. |
| 949 | "A String", |
| 950 | ], |
| 951 | "categories": [ # Install only patches with these categories. |
| 952 | # Common categories include security, recommended, and feature. |
| 953 | "A String", |
| 954 | ], |
| 955 | }, |
| 956 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 957 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 958 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 959 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 960 | # execution can return to indicate a success. |
| 961 | 42, |
| 962 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 963 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 964 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 965 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 966 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 967 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 968 | }, |
| 969 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 970 | # specified the script will be executed directly, which will likely |
| 971 | # only succeed for scripts with [shebang lines] |
| 972 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 973 | }, |
| 974 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 975 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 976 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 977 | # execution can return to indicate a success. |
| 978 | 42, |
| 979 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 980 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 981 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 982 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 983 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 984 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 985 | }, |
| 986 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 987 | # specified the script will be executed directly, which will likely |
| 988 | # only succeed for scripts with [shebang lines] |
| 989 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 990 | }, |
| 991 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 992 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 993 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch. |
| 994 | # VMs must meet all criteria specified. So if both labels and zones are |
| 995 | # specified, the patch job targets only VMs with those labels and in those |
| 996 | # zones. |
| 997 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 998 | # permitted. |
| 999 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 1000 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME], |
| 1001 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 1002 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 1003 | "A String", |
| 1004 | ], |
| 1005 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 1006 | # labels, this is another way to group VMs when targeting configs, for |
| 1007 | # example prefix="prod-". |
| 1008 | "A String", |
| 1009 | ], |
| 1010 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 1011 | # instances in any zone. |
| 1012 | "A String", |
| 1013 | ], |
| 1014 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows |
| 1015 | # targeting of disparate groups of VM instances. |
| 1016 | { # Targets a group of VM instances by using their [assigned |
| 1017 | # labels](https://cloud.google.com/compute/docs/labeling-resources). Labels |
| 1018 | # are key-value pairs. A `GroupLabel` is a combination of labels |
| 1019 | # that is used to target VMs for a patch job. |
| 1020 | # |
| 1021 | # For example, a patch job can target VMs that have the following |
| 1022 | # `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job |
| 1023 | # is applied to VMs that have both the labels `env=test` and `app=web`. |
| 1024 | "labels": { # Compute Engine instance labels that must be present for a VM |
| 1025 | # instance to be targeted by this filter. |
| 1026 | "a_key": "A String", |
| 1027 | }, |
| 1028 | }, |
| 1029 | ], |
| 1030 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1031 | "duration": "A String", # Duration of the patch job. After the duration ends, the |
| 1032 | # patch job times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1033 | "instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details. |
| 1034 | # job affects. Contains counts of instances in different states. These states |
| 1035 | # map to `InstancePatchState`. List patch job instance details to see the |
| 1036 | # specific states of each instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1037 | "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot. |
| 1038 | "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step. |
| 1039 | "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to |
| 1040 | # ensure that the agent is installed, running, and able to communicate with |
| 1041 | # the service. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1042 | "failedInstanceCount": "A String", # Number of instances that failed. |
| 1043 | "pendingInstanceCount": "A String", # Number of instances pending patch job. |
| 1044 | "notifiedInstanceCount": "A String", # Number of instances notified about patch job. |
| 1045 | "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches. |
| 1046 | "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch. |
| 1047 | "rebootingInstanceCount": "A String", # Number of instances rebooting. |
| 1048 | "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step. |
| 1049 | "succeededInstanceCount": "A String", # Number of instances that have completed successfully. |
| 1050 | "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly. |
| 1051 | "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches. |
| 1052 | "startedInstanceCount": "A String", # Number of instances that have started. |
| 1053 | "inactiveInstanceCount": "A String", # Number of instances that are inactive. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1054 | }, |
| 1055 | "description": "A String", # Description of the patch job. Length of the description is limited |
| 1056 | # to 1024 characters. |
| 1057 | "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of |
| 1058 | # 0.0 being no progress to 100.0 being complete. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1059 | "state": "A String", # The current state of the PatchJob . |
| 1060 | "name": "A String", # Unique identifier for this patch job in the form |
| 1061 | # `projects/*/patchJobs/*` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1062 | }</pre> |
| 1063 | </div> |
| 1064 | |
| 1065 | <div class="method"> |
| 1066 | <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 1067 | <pre>Get a list of patch jobs. |
| 1068 | |
| 1069 | Args: |
| 1070 | parent: string, Required. In the form of `projects/*` (required) |
| 1071 | filter: string, If provided, this field specifies the criteria that must be met by patch |
| 1072 | jobs to be included in the response. |
| 1073 | Currently, filtering is only available on the patch_deployment field. |
| 1074 | pageToken: string, A pagination token returned from a previous call |
| 1075 | that indicates where this listing should continue from. |
| 1076 | pageSize: integer, The maximum number of instance status to return. |
| 1077 | x__xgafv: string, V1 error format. |
| 1078 | Allowed values |
| 1079 | 1 - v1 error format |
| 1080 | 2 - v2 error format |
| 1081 | |
| 1082 | Returns: |
| 1083 | An object of the form: |
| 1084 | |
| 1085 | { # A response message for listing patch jobs. |
| 1086 | "patchJobs": [ # The list of patch jobs. |
| 1087 | { # A high level representation of a patch job that is either in progress |
| 1088 | # or has completed. |
| 1089 | # |
| 1090 | # Instances details are not included in the job. To paginate through instance |
| 1091 | # details, use ListPatchJobInstanceDetails. |
| 1092 | # |
| 1093 | # For more information about patch jobs, see |
| 1094 | # [Creating patch |
| 1095 | # jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1096 | "displayName": "A String", # Display name for this patch job. This is not a unique identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1097 | "dryRun": True or False, # If this patch job is a dry run, the agent reports that it has |
| 1098 | # finished without running any updates on the VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1099 | "createTime": "A String", # Time this patch job was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1100 | "updateTime": "A String", # Last time this patch job was updated. |
| 1101 | "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job. |
| 1102 | "errorMessage": "A String", # If this patch job failed, this message provides information about the |
| 1103 | # failure. |
| 1104 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied. |
| 1105 | # patch(es) to a VM instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1106 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch |
| 1107 | # rules. |
| 1108 | # upgrade`. Additional options can be set to control how this is executed. |
| 1109 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 1110 | "A String", |
| 1111 | ], |
| 1112 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 1113 | # that will be updated. If these packages are not installed, they will be |
| 1114 | # ignored. This field cannot be specified with any other patch configuration |
| 1115 | # fields. |
| 1116 | "A String", |
| 1117 | ], |
| 1118 | "type": "A String", # By changing the type to DIST, the patching is performed |
| 1119 | # using `apt-get dist-upgrade` instead. |
| 1120 | }, |
| 1121 | "yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch |
| 1122 | # rules. |
| 1123 | # can be set to control how this is executed. |
| 1124 | # |
| 1125 | # Note that not all settings are supported on all platforms. |
| 1126 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 1127 | "excludes": [ # List of packages to exclude from update. These packages are excluded by |
| 1128 | # using the yum `--exclude` flag. |
| 1129 | "A String", |
| 1130 | ], |
| 1131 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages |
| 1132 | # that will be updated. If these packages are not installed, they will be |
| 1133 | # ignored. This field must not be specified with any other patch |
| 1134 | # configuration fields. |
| 1135 | "A String", |
| 1136 | ], |
| 1137 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on |
| 1138 | # all platforms. |
| 1139 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1140 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch |
| 1141 | # rules. |
| 1142 | }, |
| 1143 | "rebootConfig": "A String", # Post-patch reboot settings. |
| 1144 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 1145 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1146 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 1147 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 1148 | # execution can return to indicate a success. |
| 1149 | 42, |
| 1150 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1151 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 1152 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1153 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1154 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 1155 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 1156 | }, |
| 1157 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 1158 | # specified the script will be executed directly, which will likely |
| 1159 | # only succeed for scripts with [shebang lines] |
| 1160 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1161 | }, |
| 1162 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1163 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 1164 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 1165 | # execution can return to indicate a success. |
| 1166 | 42, |
| 1167 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1168 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 1169 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1170 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1171 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 1172 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 1173 | }, |
| 1174 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 1175 | # specified the script will be executed directly, which will likely |
| 1176 | # only succeed for scripts with [shebang lines] |
| 1177 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1178 | }, |
| 1179 | }, |
| 1180 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 1181 | "excludes": [ # List of KBs to exclude from update. |
| 1182 | "A String", |
| 1183 | ], |
| 1184 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches |
| 1185 | # that will be updated. This field must not be used with other |
| 1186 | # patch configurations. |
| 1187 | "A String", |
| 1188 | ], |
| 1189 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all |
| 1190 | # updates are applied. |
| 1191 | "A String", |
| 1192 | ], |
| 1193 | }, |
| 1194 | "zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper` |
| 1195 | # patch rules. |
| 1196 | # See also https://en.opensuse.org/SDB:Zypper_manual. |
| 1197 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches |
| 1198 | # that will be installed using 'zypper patch patch:<patch_name>' command. |
| 1199 | # This field must not be used with any other patch configuration fields. |
| 1200 | "A String", |
| 1201 | ], |
| 1202 | "excludes": [ # List of patches to exclude from update. |
| 1203 | "A String", |
| 1204 | ], |
| 1205 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 1206 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 1207 | "severities": [ # Install only patches with these severities. |
| 1208 | # Common severities include critical, important, moderate, and low. |
| 1209 | "A String", |
| 1210 | ], |
| 1211 | "categories": [ # Install only patches with these categories. |
| 1212 | # Common categories include security, recommended, and feature. |
| 1213 | "A String", |
| 1214 | ], |
| 1215 | }, |
| 1216 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| 1217 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1218 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 1219 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 1220 | # execution can return to indicate a success. |
| 1221 | 42, |
| 1222 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1223 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 1224 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1225 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1226 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 1227 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 1228 | }, |
| 1229 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 1230 | # specified the script will be executed directly, which will likely |
| 1231 | # only succeed for scripts with [shebang lines] |
| 1232 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1233 | }, |
| 1234 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1235 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 1236 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the |
| 1237 | # execution can return to indicate a success. |
| 1238 | 42, |
| 1239 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1240 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 1241 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 1242 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 1243 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to |
| 1244 | # ensure that the ExecStep specified by this PatchJob does not change. |
| 1245 | }, |
| 1246 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is |
| 1247 | # specified the script will be executed directly, which will likely |
| 1248 | # only succeed for scripts with [shebang lines] |
| 1249 | # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1250 | }, |
| 1251 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1252 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1253 | "instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch. |
| 1254 | # VMs must meet all criteria specified. So if both labels and zones are |
| 1255 | # specified, the patch job targets only VMs with those labels and in those |
| 1256 | # zones. |
| 1257 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is |
| 1258 | # permitted. |
| 1259 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their |
| 1260 | # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME], |
| 1261 | # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or |
| 1262 | # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 1263 | "A String", |
| 1264 | ], |
| 1265 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to |
| 1266 | # labels, this is another way to group VMs when targeting configs, for |
| 1267 | # example prefix="prod-". |
| 1268 | "A String", |
| 1269 | ], |
| 1270 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM |
| 1271 | # instances in any zone. |
| 1272 | "A String", |
| 1273 | ], |
| 1274 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows |
| 1275 | # targeting of disparate groups of VM instances. |
| 1276 | { # Targets a group of VM instances by using their [assigned |
| 1277 | # labels](https://cloud.google.com/compute/docs/labeling-resources). Labels |
| 1278 | # are key-value pairs. A `GroupLabel` is a combination of labels |
| 1279 | # that is used to target VMs for a patch job. |
| 1280 | # |
| 1281 | # For example, a patch job can target VMs that have the following |
| 1282 | # `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job |
| 1283 | # is applied to VMs that have both the labels `env=test` and `app=web`. |
| 1284 | "labels": { # Compute Engine instance labels that must be present for a VM |
| 1285 | # instance to be targeted by this filter. |
| 1286 | "a_key": "A String", |
| 1287 | }, |
| 1288 | }, |
| 1289 | ], |
| 1290 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1291 | "duration": "A String", # Duration of the patch job. After the duration ends, the |
| 1292 | # patch job times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1293 | "instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details. |
| 1294 | # job affects. Contains counts of instances in different states. These states |
| 1295 | # map to `InstancePatchState`. List patch job instance details to see the |
| 1296 | # specific states of each instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1297 | "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot. |
| 1298 | "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step. |
| 1299 | "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to |
| 1300 | # ensure that the agent is installed, running, and able to communicate with |
| 1301 | # the service. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1302 | "failedInstanceCount": "A String", # Number of instances that failed. |
| 1303 | "pendingInstanceCount": "A String", # Number of instances pending patch job. |
| 1304 | "notifiedInstanceCount": "A String", # Number of instances notified about patch job. |
| 1305 | "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches. |
| 1306 | "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch. |
| 1307 | "rebootingInstanceCount": "A String", # Number of instances rebooting. |
| 1308 | "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step. |
| 1309 | "succeededInstanceCount": "A String", # Number of instances that have completed successfully. |
| 1310 | "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly. |
| 1311 | "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches. |
| 1312 | "startedInstanceCount": "A String", # Number of instances that have started. |
| 1313 | "inactiveInstanceCount": "A String", # Number of instances that are inactive. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1314 | }, |
| 1315 | "description": "A String", # Description of the patch job. Length of the description is limited |
| 1316 | # to 1024 characters. |
| 1317 | "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of |
| 1318 | # 0.0 being no progress to 100.0 being complete. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1319 | "state": "A String", # The current state of the PatchJob . |
| 1320 | "name": "A String", # Unique identifier for this patch job in the form |
| 1321 | # `projects/*/patchJobs/*` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1322 | }, |
| 1323 | ], |
| 1324 | "nextPageToken": "A String", # A pagination token that can be used to get the next page of results. |
| 1325 | }</pre> |
| 1326 | </div> |
| 1327 | |
| 1328 | <div class="method"> |
| 1329 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1330 | <pre>Retrieves the next page of results. |
| 1331 | |
| 1332 | Args: |
| 1333 | previous_request: The request for the previous page. (required) |
| 1334 | previous_response: The response from the request for the previous page. (required) |
| 1335 | |
| 1336 | Returns: |
| 1337 | A request object that you can call 'execute()' on to request the next |
| 1338 | page. Returns None if there are no more items in the collection. |
| 1339 | </pre> |
| 1340 | </div> |
| 1341 | |
| 1342 | </body></html> |