| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 75 | <h1><a href="osconfig_v1.html">OS Config API</a> . <a href="osconfig_v1.projects.html">projects</a> . <a href="osconfig_v1.projects.patchJobs.html">patchJobs</a></h1> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 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> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 84 | <p class="firstline">Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#close">close()</a></code></p> |
| 87 | <p class="firstline">Close httplib2 connections.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 88 | <p class="toc_element"> |
| 89 | <code><a href="#execute">execute(parent, body=None, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Patch VM instances by creating and running a patch job.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 93 | <p class="firstline">Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 94 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 95 | <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 96 | <p class="firstline">Get a list of patch jobs.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 99 | <p class="firstline">Retrieves the next page of results.</p> |
| 100 | <h3>Method Details</h3> |
| 101 | <div class="method"> |
| 102 | <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | <pre>Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 104 | |
| 105 | Args: |
| 106 | name: string, Required. Name of the patch in the form `projects/*/patchJobs/*` (required) |
| 107 | body: object, The request body. |
| 108 | The object takes the form of: |
| 109 | |
| 110 | { # Message for canceling a patch job. |
| 111 | } |
| 112 | |
| 113 | x__xgafv: string, V1 error format. |
| 114 | Allowed values |
| 115 | 1 - v1 error format |
| 116 | 2 - v2 error format |
| 117 | |
| 118 | Returns: |
| 119 | An object of the form: |
| 120 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 121 | { # A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 122 | "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters. |
| 123 | "createTime": "A String", # Time this patch job was created. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 124 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 125 | "mode": "A String", # Mode of the patch rollout. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 126 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 127 | "fixed": 42, # Specifies a fixed value. |
| 128 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 129 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 130 | }, |
| 131 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 132 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 133 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| 134 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 135 | "A String", |
| 136 | ], |
| 137 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 138 | "A String", |
| 139 | ], |
| 140 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 141 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 142 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 143 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| 144 | "A String", |
| 145 | ], |
| 146 | "excludes": [ # List of KBs to exclude from update. |
| 147 | "A String", |
| 148 | ], |
| 149 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 150 | "A String", |
| 151 | ], |
| 152 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 153 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 154 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 155 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 156 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 157 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 158 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 159 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 160 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 161 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 162 | 42, |
| 163 | ], |
| 164 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 165 | }, |
| 166 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 167 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 168 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 169 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 170 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 171 | }, |
| 172 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 173 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 174 | 42, |
| 175 | ], |
| 176 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 177 | }, |
| 178 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 179 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 180 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 181 | "A String", |
| 182 | ], |
| 183 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 184 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 185 | "A String", |
| 186 | ], |
| 187 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 188 | "A String", |
| 189 | ], |
| 190 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 191 | "excludes": [ # List of patches to exclude from update. |
| 192 | "A String", |
| 193 | ], |
| 194 | }, |
| 195 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 196 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 197 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 198 | "A String", |
| 199 | ], |
| 200 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 201 | "A String", |
| 202 | ], |
| 203 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 204 | }, |
| 205 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 206 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 207 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 208 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 209 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 210 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 211 | }, |
| 212 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 213 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 214 | 42, |
| 215 | ], |
| 216 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 217 | }, |
| 218 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 219 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 220 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 221 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 222 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 223 | }, |
| 224 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 225 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 226 | 42, |
| 227 | ], |
| 228 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 229 | }, |
| 230 | }, |
| 231 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| 232 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 233 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 234 | "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 235 | "displayName": "A String", # Display name for this patch job. This is not a unique identifier. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 236 | "state": "A String", # The current state of the PatchJob. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 237 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Instances to patch. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 238 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 239 | "A String", |
| 240 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 241 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 242 | "A String", |
| 243 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 244 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 245 | "A String", |
| 246 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 247 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. |
| 248 | { # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`. |
| 249 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 250 | "a_key": "A String", |
| 251 | }, |
| 252 | }, |
| 253 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 254 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 255 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 256 | "dryRun": True or False, # If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 257 | "errorMessage": "A String", # If this patch job failed, this message provides information about the failure. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 258 | "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. |
| 259 | "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*` |
| 260 | "instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. # Summary of instance details. |
| 261 | "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step. |
| 262 | "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step. |
| 263 | "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches. |
| 264 | "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service. |
| 265 | "succeededInstanceCount": "A String", # Number of instances that have completed successfully. |
| 266 | "rebootingInstanceCount": "A String", # Number of instances rebooting. |
| 267 | "inactiveInstanceCount": "A String", # Number of instances that are inactive. |
| 268 | "startedInstanceCount": "A String", # Number of instances that have started. |
| 269 | "notifiedInstanceCount": "A String", # Number of instances notified about patch job. |
| 270 | "failedInstanceCount": "A String", # Number of instances that failed. |
| 271 | "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly. |
| 272 | "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches. |
| 273 | "pendingInstanceCount": "A String", # Number of instances pending patch job. |
| 274 | "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch. |
| 275 | "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot. |
| 276 | }, |
| 277 | "updateTime": "A String", # Last time this patch job was updated. |
| 278 | "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 279 | }</pre> |
| 280 | </div> |
| 281 | |
| 282 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 283 | <code class="details" id="close">close()</code> |
| 284 | <pre>Close httplib2 connections.</pre> |
| 285 | </div> |
| 286 | |
| 287 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 288 | <code class="details" id="execute">execute(parent, body=None, x__xgafv=None)</code> |
| 289 | <pre>Patch VM instances by creating and running a patch job. |
| 290 | |
| 291 | Args: |
| 292 | parent: string, Required. The project in which to run this patch in the form `projects/*` (required) |
| 293 | body: object, The request body. |
| 294 | The object takes the form of: |
| 295 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 296 | { # A request message to initiate patching across Compute Engine instances. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 297 | "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 298 | "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 299 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied. If omitted, instances are patched using the default configurations. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 300 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 301 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| 302 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 303 | "A String", |
| 304 | ], |
| 305 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 306 | "A String", |
| 307 | ], |
| 308 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 309 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 310 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 311 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| 312 | "A String", |
| 313 | ], |
| 314 | "excludes": [ # List of KBs to exclude from update. |
| 315 | "A String", |
| 316 | ], |
| 317 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 318 | "A String", |
| 319 | ], |
| 320 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 321 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 322 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 323 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 324 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 325 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 326 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 327 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 328 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 329 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 330 | 42, |
| 331 | ], |
| 332 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 333 | }, |
| 334 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 335 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 336 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 337 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 338 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 339 | }, |
| 340 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 341 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 342 | 42, |
| 343 | ], |
| 344 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 345 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 346 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 347 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 348 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 349 | "A String", |
| 350 | ], |
| 351 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 352 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 353 | "A String", |
| 354 | ], |
| 355 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 356 | "A String", |
| 357 | ], |
| 358 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 359 | "excludes": [ # List of patches to exclude from update. |
| 360 | "A String", |
| 361 | ], |
| 362 | }, |
| 363 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 364 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 365 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 366 | "A String", |
| 367 | ], |
| 368 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 369 | "A String", |
| 370 | ], |
| 371 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 372 | }, |
| 373 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 374 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 375 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 376 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 377 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 378 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 379 | }, |
| 380 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 381 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 382 | 42, |
| 383 | ], |
| 384 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 385 | }, |
| 386 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 387 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 388 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 389 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 390 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 391 | }, |
| 392 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 393 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 394 | 42, |
| 395 | ], |
| 396 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 397 | }, |
| 398 | }, |
| 399 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| 400 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 401 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 402 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels. |
| 403 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| 404 | "A String", |
| 405 | ], |
| 406 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 407 | "A String", |
| 408 | ], |
| 409 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| 410 | "A String", |
| 411 | ], |
| 412 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. |
| 413 | { # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`. |
| 414 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 415 | "a_key": "A String", |
| 416 | }, |
| 417 | }, |
| 418 | ], |
| 419 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| 420 | }, |
| 421 | "dryRun": True or False, # If this patch is a dry-run only, instances are contacted but will do nothing. |
| 422 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy of the patch job. |
| 423 | "mode": "A String", # Mode of the patch rollout. |
| 424 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 425 | "fixed": 42, # Specifies a fixed value. |
| 426 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 427 | }, |
| 428 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 429 | "displayName": "A String", # Display name for this patch job. This does not have to be unique. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 430 | } |
| 431 | |
| 432 | x__xgafv: string, V1 error format. |
| 433 | Allowed values |
| 434 | 1 - v1 error format |
| 435 | 2 - v2 error format |
| 436 | |
| 437 | Returns: |
| 438 | An object of the form: |
| 439 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 440 | { # A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 441 | "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters. |
| 442 | "createTime": "A String", # Time this patch job was created. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 443 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 444 | "mode": "A String", # Mode of the patch rollout. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 445 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 446 | "fixed": 42, # Specifies a fixed value. |
| 447 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 448 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 449 | }, |
| 450 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 451 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 452 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| 453 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 454 | "A String", |
| 455 | ], |
| 456 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 457 | "A String", |
| 458 | ], |
| 459 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 460 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 461 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 462 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| 463 | "A String", |
| 464 | ], |
| 465 | "excludes": [ # List of KBs to exclude from update. |
| 466 | "A String", |
| 467 | ], |
| 468 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 469 | "A String", |
| 470 | ], |
| 471 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 472 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 473 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 474 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 475 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 476 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 477 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 478 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 479 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 480 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 481 | 42, |
| 482 | ], |
| 483 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 484 | }, |
| 485 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 486 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 487 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 488 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 489 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 490 | }, |
| 491 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 492 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 493 | 42, |
| 494 | ], |
| 495 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 496 | }, |
| 497 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 498 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 499 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 500 | "A String", |
| 501 | ], |
| 502 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 503 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 504 | "A String", |
| 505 | ], |
| 506 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 507 | "A String", |
| 508 | ], |
| 509 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 510 | "excludes": [ # List of patches to exclude from update. |
| 511 | "A String", |
| 512 | ], |
| 513 | }, |
| 514 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 515 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 516 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 517 | "A String", |
| 518 | ], |
| 519 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 520 | "A String", |
| 521 | ], |
| 522 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 523 | }, |
| 524 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 525 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 526 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 527 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 528 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 529 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 530 | }, |
| 531 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 532 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 533 | 42, |
| 534 | ], |
| 535 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 536 | }, |
| 537 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 538 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 539 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 540 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 541 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 542 | }, |
| 543 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 544 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 545 | 42, |
| 546 | ], |
| 547 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 548 | }, |
| 549 | }, |
| 550 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| 551 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 552 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 553 | "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 554 | "displayName": "A String", # Display name for this patch job. This is not a unique identifier. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 555 | "state": "A String", # The current state of the PatchJob. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 556 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Instances to patch. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 557 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 558 | "A String", |
| 559 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 560 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 561 | "A String", |
| 562 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 563 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 564 | "A String", |
| 565 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 566 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. |
| 567 | { # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`. |
| 568 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 569 | "a_key": "A String", |
| 570 | }, |
| 571 | }, |
| 572 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 573 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 574 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 575 | "dryRun": True or False, # If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 576 | "errorMessage": "A String", # If this patch job failed, this message provides information about the failure. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 577 | "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. |
| 578 | "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*` |
| 579 | "instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. # Summary of instance details. |
| 580 | "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step. |
| 581 | "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step. |
| 582 | "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches. |
| 583 | "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service. |
| 584 | "succeededInstanceCount": "A String", # Number of instances that have completed successfully. |
| 585 | "rebootingInstanceCount": "A String", # Number of instances rebooting. |
| 586 | "inactiveInstanceCount": "A String", # Number of instances that are inactive. |
| 587 | "startedInstanceCount": "A String", # Number of instances that have started. |
| 588 | "notifiedInstanceCount": "A String", # Number of instances notified about patch job. |
| 589 | "failedInstanceCount": "A String", # Number of instances that failed. |
| 590 | "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly. |
| 591 | "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches. |
| 592 | "pendingInstanceCount": "A String", # Number of instances pending patch job. |
| 593 | "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch. |
| 594 | "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot. |
| 595 | }, |
| 596 | "updateTime": "A String", # Last time this patch job was updated. |
| 597 | "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 598 | }</pre> |
| 599 | </div> |
| 600 | |
| 601 | <div class="method"> |
| 602 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 603 | <pre>Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 604 | |
| 605 | Args: |
| 606 | name: string, Required. Name of the patch in the form `projects/*/patchJobs/*` (required) |
| 607 | x__xgafv: string, V1 error format. |
| 608 | Allowed values |
| 609 | 1 - v1 error format |
| 610 | 2 - v2 error format |
| 611 | |
| 612 | Returns: |
| 613 | An object of the form: |
| 614 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 615 | { # A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 616 | "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters. |
| 617 | "createTime": "A String", # Time this patch job was created. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 618 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 619 | "mode": "A String", # Mode of the patch rollout. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 620 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 621 | "fixed": 42, # Specifies a fixed value. |
| 622 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 623 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 624 | }, |
| 625 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 626 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 627 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| 628 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 629 | "A String", |
| 630 | ], |
| 631 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 632 | "A String", |
| 633 | ], |
| 634 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 635 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 636 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 637 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| 638 | "A String", |
| 639 | ], |
| 640 | "excludes": [ # List of KBs to exclude from update. |
| 641 | "A String", |
| 642 | ], |
| 643 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 644 | "A String", |
| 645 | ], |
| 646 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 647 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 648 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 649 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 650 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 651 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 652 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 653 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 654 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 655 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 656 | 42, |
| 657 | ], |
| 658 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 659 | }, |
| 660 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 661 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 662 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 663 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 664 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 665 | }, |
| 666 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 667 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 668 | 42, |
| 669 | ], |
| 670 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 671 | }, |
| 672 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 673 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 674 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 675 | "A String", |
| 676 | ], |
| 677 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 678 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 679 | "A String", |
| 680 | ], |
| 681 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 682 | "A String", |
| 683 | ], |
| 684 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 685 | "excludes": [ # List of patches to exclude from update. |
| 686 | "A String", |
| 687 | ], |
| 688 | }, |
| 689 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 690 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 691 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 692 | "A String", |
| 693 | ], |
| 694 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 695 | "A String", |
| 696 | ], |
| 697 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 698 | }, |
| 699 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 700 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 701 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 702 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 703 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 704 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 705 | }, |
| 706 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 707 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 708 | 42, |
| 709 | ], |
| 710 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 711 | }, |
| 712 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 713 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 714 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 715 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 716 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 717 | }, |
| 718 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 719 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 720 | 42, |
| 721 | ], |
| 722 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 723 | }, |
| 724 | }, |
| 725 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| 726 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 727 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 728 | "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 729 | "displayName": "A String", # Display name for this patch job. This is not a unique identifier. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 730 | "state": "A String", # The current state of the PatchJob. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 731 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Instances to patch. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 732 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 733 | "A String", |
| 734 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 735 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 736 | "A String", |
| 737 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 738 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 739 | "A String", |
| 740 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 741 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. |
| 742 | { # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`. |
| 743 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 744 | "a_key": "A String", |
| 745 | }, |
| 746 | }, |
| 747 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 748 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 749 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 750 | "dryRun": True or False, # If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 751 | "errorMessage": "A String", # If this patch job failed, this message provides information about the failure. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 752 | "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. |
| 753 | "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*` |
| 754 | "instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. # Summary of instance details. |
| 755 | "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step. |
| 756 | "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step. |
| 757 | "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches. |
| 758 | "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service. |
| 759 | "succeededInstanceCount": "A String", # Number of instances that have completed successfully. |
| 760 | "rebootingInstanceCount": "A String", # Number of instances rebooting. |
| 761 | "inactiveInstanceCount": "A String", # Number of instances that are inactive. |
| 762 | "startedInstanceCount": "A String", # Number of instances that have started. |
| 763 | "notifiedInstanceCount": "A String", # Number of instances notified about patch job. |
| 764 | "failedInstanceCount": "A String", # Number of instances that failed. |
| 765 | "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly. |
| 766 | "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches. |
| 767 | "pendingInstanceCount": "A String", # Number of instances pending patch job. |
| 768 | "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch. |
| 769 | "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot. |
| 770 | }, |
| 771 | "updateTime": "A String", # Last time this patch job was updated. |
| 772 | "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 773 | }</pre> |
| 774 | </div> |
| 775 | |
| 776 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 777 | <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 778 | <pre>Get a list of patch jobs. |
| 779 | |
| 780 | Args: |
| 781 | parent: string, Required. In the form of `projects/*` (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 782 | pageSize: integer, The maximum number of instance status to return. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 783 | filter: string, If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 784 | pageToken: string, A pagination token returned from a previous call that indicates where this listing should continue from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 785 | x__xgafv: string, V1 error format. |
| 786 | Allowed values |
| 787 | 1 - v1 error format |
| 788 | 2 - v2 error format |
| 789 | |
| 790 | Returns: |
| 791 | An object of the form: |
| 792 | |
| 793 | { # A response message for listing patch jobs. |
| 794 | "patchJobs": [ # The list of patch jobs. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 795 | { # A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 796 | "description": "A String", # Description of the patch job. Length of the description is limited to 1024 characters. |
| 797 | "createTime": "A String", # Time this patch job was created. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 798 | "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Rollout strategy being applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 799 | "mode": "A String", # Mode of the patch rollout. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 800 | "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. |
| 801 | "fixed": 42, # Specifies a fixed value. |
| 802 | "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value. |
| 803 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 804 | }, |
| 805 | "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Patch configuration being applied. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 806 | "rebootConfig": "A String", # Post-patch reboot settings. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 807 | "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules. |
| 808 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. |
| 809 | "A String", |
| 810 | ], |
| 811 | "excludes": [ # List of packages to exclude from update. These packages will be excluded |
| 812 | "A String", |
| 813 | ], |
| 814 | "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. |
| 815 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 816 | "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules. |
| 817 | "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied. |
| 818 | "A String", |
| 819 | ], |
| 820 | "excludes": [ # List of KBs to exclude from update. |
| 821 | "A String", |
| 822 | ], |
| 823 | "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. |
| 824 | "A String", |
| 825 | ], |
| 826 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 827 | "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 828 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 829 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 830 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 831 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 832 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 833 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 834 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 835 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 836 | 42, |
| 837 | ], |
| 838 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 839 | }, |
| 840 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 841 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 842 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 843 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 844 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 845 | }, |
| 846 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 847 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 848 | 42, |
| 849 | ], |
| 850 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 851 | }, |
| 852 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 853 | "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules. |
| 854 | "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields. |
| 855 | "A String", |
| 856 | ], |
| 857 | "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`. |
| 858 | "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low. |
| 859 | "A String", |
| 860 | ], |
| 861 | "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature. |
| 862 | "A String", |
| 863 | ], |
| 864 | "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`. |
| 865 | "excludes": [ # List of patches to exclude from update. |
| 866 | "A String", |
| 867 | ], |
| 868 | }, |
| 869 | "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules. |
| 870 | "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms. |
| 871 | "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. |
| 872 | "A String", |
| 873 | ], |
| 874 | "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. |
| 875 | "A String", |
| 876 | ], |
| 877 | "minimal": True or False, # Will cause patch to run `yum update-minimal` instead. |
| 878 | }, |
| 879 | "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update. |
| 880 | "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob. |
| 881 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 882 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 883 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 884 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 885 | }, |
| 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 execution can return to indicate a success. |
| 888 | 42, |
| 889 | ], |
| 890 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 891 | }, |
| 892 | "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob. |
| 893 | "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable. |
| 894 | "bucket": "A String", # Required. Bucket of the Cloud Storage object. |
| 895 | "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. |
| 896 | "object": "A String", # Required. Name of the Cloud Storage object. |
| 897 | }, |
| 898 | "localPath": "A String", # An absolute path to the executable on the VM. |
| 899 | "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success. |
| 900 | 42, |
| 901 | ], |
| 902 | "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). |
| 903 | }, |
| 904 | }, |
| 905 | "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules. |
| 906 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 907 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 908 | "patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 909 | "displayName": "A String", # Display name for this patch job. This is not a unique identifier. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 910 | "state": "A String", # The current state of the PatchJob. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 911 | "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Instances to patch. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 912 | "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 913 | "A String", |
| 914 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 915 | "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". |
| 916 | "A String", |
| 917 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 918 | "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 919 | "A String", |
| 920 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 921 | "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. |
| 922 | { # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`. |
| 923 | "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. |
| 924 | "a_key": "A String", |
| 925 | }, |
| 926 | }, |
| 927 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 928 | "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 929 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 930 | "dryRun": True or False, # If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 931 | "errorMessage": "A String", # If this patch job failed, this message provides information about the failure. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 932 | "percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. |
| 933 | "name": "A String", # Unique identifier for this patch job in the form `projects/*/patchJobs/*` |
| 934 | "instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. # Summary of instance details. |
| 935 | "postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step. |
| 936 | "prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step. |
| 937 | "applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches. |
| 938 | "noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service. |
| 939 | "succeededInstanceCount": "A String", # Number of instances that have completed successfully. |
| 940 | "rebootingInstanceCount": "A String", # Number of instances rebooting. |
| 941 | "inactiveInstanceCount": "A String", # Number of instances that are inactive. |
| 942 | "startedInstanceCount": "A String", # Number of instances that have started. |
| 943 | "notifiedInstanceCount": "A String", # Number of instances notified about patch job. |
| 944 | "failedInstanceCount": "A String", # Number of instances that failed. |
| 945 | "ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly. |
| 946 | "downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches. |
| 947 | "pendingInstanceCount": "A String", # Number of instances pending patch job. |
| 948 | "timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch. |
| 949 | "succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot. |
| 950 | }, |
| 951 | "updateTime": "A String", # Last time this patch job was updated. |
| 952 | "duration": "A String", # Duration of the patch job. After the duration ends, the patch job times out. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 953 | }, |
| 954 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 955 | "nextPageToken": "A String", # A pagination token that can be used to get the next page of results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 956 | }</pre> |
| 957 | </div> |
| 958 | |
| 959 | <div class="method"> |
| 960 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 961 | <pre>Retrieves the next page of results. |
| 962 | |
| 963 | Args: |
| 964 | previous_request: The request for the previous page. (required) |
| 965 | previous_response: The response from the request for the previous page. (required) |
| 966 | |
| 967 | Returns: |
| 968 | A request object that you can call 'execute()' on to request the next |
| 969 | page. Returns None if there are no more items in the collection. |
| 970 | </pre> |
| 971 | </div> |
| 972 | |
| 973 | </body></html> |