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