Blame - docs/dyn/osconfig_v1beta.projects.patchJobs.html - platform/external/python/google-api-python-client

<h1><a href="osconfig_v1beta.html">Cloud OS Config API</a> . <a href="osconfig_v1beta.projects.html">projects</a> . <a href="osconfig_v1beta.projects.patchJobs.html">patchJobs</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="osconfig_v1beta.projects.patchJobs.instanceDetails.html">instanceDetails()</a></code>

79

</p>

80

<p class="firstline">Returns the instanceDetails Resource.</p>

81

82

83

<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>

84

<p class="firstline">Cancel a patch job. The patch job must be active. Canceled patch jobs</p>

85

86

<code><a href="#execute">execute(parent, body=None, x__xgafv=None)</a></code></p>

87

<p class="firstline">Patch VM instances by creating and running a patch job.</p>

88

89

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

90

<p class="firstline">Get the patch job. This can be used to track the progress of an</p>

91

92

<code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

93

<p class="firstline">Get a list of patch jobs.</p>

94

95

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

96

<p class="firstline">Retrieves the next page of results.</p>

97

<h3>Method Details</h3>

98

99

<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>

100

<pre>Cancel a patch job. The patch job must be active. Canceled patch jobs

cannot be restarted.

Args:

name: string, Required. Name of the patch in the form `projects/*/patchJobs/*` (required)

105

body: object, The request body.

106

The object takes the form of:

107

108

{ # Message for canceling a patch job.

109

}

110

111

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

118

119

{ # A high level representation of a patch job that is either in progress

120

# or has completed.

121

#

122

# Instances details are not included in the job. To paginate through instance

123

# details, use ListPatchJobInstanceDetails.

124

#

125

# For more information about patch jobs, see

126

# [Creating patch

127

# jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).

128

"createTime": "A String", # Time this patch job was created.

129

"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has

130

# finished without running any updates on the VM instance.

131

"updateTime": "A String", # Last time this patch job was updated.

132

"patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.

133

"errorMessage": "A String", # If this patch job failed, this message provides information about the

134

# failure.

135

"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied.

136

# patch(es) to a VM instance.

137

"zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper`

138

# patch rules.

139

# See also https://en.opensuse.org/SDB:Zypper_manual.

140

"exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches

141

# that will be installed using 'zypper patch patch:<patch_name>' command.

142

# This field must not be used with any other patch configuration fields.

143

"A String",

144

],

145

"excludes": [ # List of patches to exclude from update.

146

"A String",

147

],

148

"withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.

149

"withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.

150

"severities": [ # Install only patches with these severities.

151

# Common severities include critical, important, moderate, and low.

152

"A String",

153

],

154

"categories": [ # Install only patches with these categories.

155

# Common categories include security, recommended, and feature.

"A String",

],

},

"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.

160

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

161

"localPath": "A String", # An absolute path to the executable on the VM.

162

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

163

# execution can return to indicate a success.

164

42,

165

],

166

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

167

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

168

# ensure that the ExecStep specified by this PatchJob does not change.

169

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

170

"object": "A String", # Required. Name of the Google Cloud Storage object.

171

},

172

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

173

# specified the script will be executed directly, which will likely

174

# only succeed for scripts with [shebang lines]

175

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

176

},

177

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

178

"localPath": "A String", # An absolute path to the executable on the VM.

179

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

180

# execution can return to indicate a success.

181

42,

182

],

183

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

184

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

185

# ensure that the ExecStep specified by this PatchJob does not change.

186

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

187

"object": "A String", # Required. Name of the Google Cloud Storage object.

188

},

189

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

190

# specified the script will be executed directly, which will likely

191

# only succeed for scripts with [shebang lines]

192

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

193

},

194

},

195

"apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch

196

# rules.

197

# upgrade`. Additional options can be set to control how this is executed.

198

"excludes": [ # List of packages to exclude from update. These packages will be excluded

199

"A String",

200

],

201

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

202

# that will be updated. If these packages are not installed, they will be

203

# 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

208

# using `apt-get dist-upgrade` instead.

209

},

210

"yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch

211

# rules.

212

# can be set to control how this is executed.

213

#

214

# Note that not all settings are supported on all platforms.

215

"excludes": [ # List of packages to exclude from update. These packages are excluded by

216

# using the yum `--exclude` flag.

217

"A String",

218

],

219

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

220

# that will be updated. If these packages are not installed, they will be

221

# ignored. This field must not be specified with any other patch

222

# configuration fields.

223

"A String",

224

],

225

"security": True or False, # Adds the `--security` flag to `yum update`. Not supported on

226

# all platforms.

227

"minimal": True or False, # Will cause patch to run `yum update-minimal` instead.

228

},

229

"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch

230

# rules.

231

},

232

"rebootConfig": "A String", # Post-patch reboot settings.

233

"preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.

234

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

235

"localPath": "A String", # An absolute path to the executable on the VM.

236

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

237

# execution can return to indicate a success.

238

42,

239

],

240

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

241

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

242

# ensure that the ExecStep specified by this PatchJob does not change.

243

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

244

"object": "A String", # Required. Name of the Google Cloud Storage object.

245

},

246

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

247

# specified the script will be executed directly, which will likely

248

# only succeed for scripts with [shebang lines]

249

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

250

},

251

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

252

"localPath": "A String", # An absolute path to the executable on the VM.

253

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

254

# execution can return to indicate a success.

255

42,

256

],

257

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

258

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

259

# ensure that the ExecStep specified by this PatchJob does not change.

260

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

261

"object": "A String", # Required. Name of the Google Cloud Storage object.

262

},

263

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

264

# specified the script will be executed directly, which will likely

265

# only succeed for scripts with [shebang lines]

266

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

267

},

268

},

269

"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.

270

"excludes": [ # List of KBs to exclude from update.

271

"A String",

272

],

273

"exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches

274

# that will be updated. This field must not be used with other

275

# patch configurations.

276

"A String",

277

],

278

"classifications": [ # Only apply updates of these windows update classifications. If empty, all

279

# updates are applied.

"A String",

],

},

},

"duration": "A String", # Duration of the patch job. After the duration ends, the

285

# patch job times out.

286

"instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch.

287

# VMs must meet all criteria specified. So if both labels and zones are

288

# specified, the patch job targets only VMs with those labels and in those

289

# zones.

290

"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM

291

# instances in any zone.

292

"A String",

293

],

294

"groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows

295

# targeting of disparate groups, for example "env=prod or env=staging".

296

{ # Represents a group of VMs that can be identified as having all these

297

# labels, for example "env=prod and app=web".

298

"labels": { # Google Compute Engine instance labels that must be present for a VM

299

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

"all": True or False, # Target all VM instances in the project. If true, no other criteria is

305

# permitted.

306

"instances": [ # Targets any of the VM instances specified. Instances are specified by their

307

# URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME],

308

# `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or

309

# `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`

310

"A String",

311

],

312

"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to

313

# labels, this is another way to group VMs when targeting configs, for

314

# example prefix="prod-".

"A String",

],

},

"instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details.

319

# job affects. Contains counts of instances in different states. These states

320

# map to `InstancePatchState`. List patch job instance details to see the

321

# specific states of each instance.

322

"succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.

323

"prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.

324

"noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to

325

# ensure that the agent is installed, running, and able to communicate with

326

# the service.

327

"failedInstanceCount": "A String", # Number of instances that failed.

328

"pendingInstanceCount": "A String", # Number of instances pending patch job.

329

"notifiedInstanceCount": "A String", # Number of instances notified about patch job.

330

"downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.

331

"timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.

332

"rebootingInstanceCount": "A String", # Number of instances rebooting.

333

"postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.

334

"succeededInstanceCount": "A String", # Number of instances that have completed successfully.

335

"ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.

336

"applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.

337

"startedInstanceCount": "A String", # Number of instances that have started.

338

"inactiveInstanceCount": "A String", # Number of instances that are inactive.

339

},

340

"description": "A String", # Description of the patch job. Length of the description is limited

341

# to 1024 characters.

342

"percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of

343

# 0.0 being no progress to 100.0 being complete.

344

"state": "A String", # The current state of the PatchJob .

345

"name": "A String", # Unique identifier for this patch job in the form

346

# `projects/*/patchJobs/*`

347

"displayName": "A String", # Display name for this patch job. This is not a unique identifier.

}</pre>

</div>

<code class="details" id="execute">execute(parent, body=None, x__xgafv=None)</code>

353

<pre>Patch VM instances by creating and running a patch job.

354

355

Args:

356

parent: string, Required. The project in which to run this patch in the form `projects/*` (required)

357

body: object, The request body.

358

The object takes the form of:

359

360

{ # A request message to initiate patching across Google Compute Engine

361

# instances.

362

"instanceFilter": { # A filter to target VM instances for patching. The targeted # Required. Instances to patch, either explicitly or filtered by some criteria such

363

# as zone or labels.

364

# VMs must meet all criteria specified. So if both labels and zones are

365

# specified, the patch job targets only VMs with those labels and in those

366

# zones.

367

"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM

368

# instances in any zone.

369

"A String",

370

],

371

"groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows

372

# targeting of disparate groups, for example "env=prod or env=staging".

373

{ # Represents a group of VMs that can be identified as having all these

374

# labels, for example "env=prod and app=web".

375

"labels": { # Google Compute Engine instance labels that must be present for a VM

376

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

"all": True or False, # Target all VM instances in the project. If true, no other criteria is

382

# permitted.

383

"instances": [ # Targets any of the VM instances specified. Instances are specified by their

384

# URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME],

385

# `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or

386

# `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`

387

"A String",

388

],

389

"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to

390

# labels, this is another way to group VMs when targeting configs, for

391

# example prefix="prod-".

"A String",

],

},

"duration": "A String", # Duration of the patch job. After the duration ends, the patch job

396

# times out.

397

"displayName": "A String", # Display name for this patch job. This does not have to be unique.

398

"description": "A String", # Description of the patch job. Length of the description is limited

399

# to 1024 characters.

400

"dryRun": True or False, # If this patch is a dry-run only, instances are contacted but

401

# will do nothing.

402

"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied. If omitted, instances are

403

# patched using the default configurations.

404

# patch(es) to a VM instance.

405

"zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper`

406

# patch rules.

407

# See also https://en.opensuse.org/SDB:Zypper_manual.

408

"exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches

409

# that will be installed using 'zypper patch patch:<patch_name>' command.

410

# This field must not be used with any other patch configuration fields.

411

"A String",

412

],

413

"excludes": [ # List of patches to exclude from update.

414

"A String",

415

],

416

"withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.

417

"withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.

418

"severities": [ # Install only patches with these severities.

419

# Common severities include critical, important, moderate, and low.

420

"A String",

421

],

422

"categories": [ # Install only patches with these categories.

423

# Common categories include security, recommended, and feature.

"A String",

],

},

"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.

428

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

429

"localPath": "A String", # An absolute path to the executable on the VM.

430

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

431

# execution can return to indicate a success.

432

42,

433

],

434

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

435

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

436

# ensure that the ExecStep specified by this PatchJob does not change.

437

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

438

"object": "A String", # Required. Name of the Google Cloud Storage object.

439

},

440

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

441

# specified the script will be executed directly, which will likely

442

# only succeed for scripts with [shebang lines]

443

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

444

},

445

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

446

"localPath": "A String", # An absolute path to the executable on the VM.

447

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

448

# execution can return to indicate a success.

449

42,

450

],

451

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

452

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

453

# ensure that the ExecStep specified by this PatchJob does not change.

454

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

455

"object": "A String", # Required. Name of the Google Cloud Storage object.

456

},

457

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

458

# specified the script will be executed directly, which will likely

459

# only succeed for scripts with [shebang lines]

460

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

461

},

462

},

463

"apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch

464

# rules.

465

# upgrade`. Additional options can be set to control how this is executed.

466

"excludes": [ # List of packages to exclude from update. These packages will be excluded

467

"A String",

468

],

469

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

470

# that will be updated. If these packages are not installed, they will be

471

# 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

476

# using `apt-get dist-upgrade` instead.

477

},

478

"yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch

479

# rules.

480

# can be set to control how this is executed.

481

#

482

# Note that not all settings are supported on all platforms.

483

"excludes": [ # List of packages to exclude from update. These packages are excluded by

484

# using the yum `--exclude` flag.

485

"A String",

486

],

487

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

488

# that will be updated. If these packages are not installed, they will be

489

# ignored. This field must not be specified with any other patch

490

# configuration fields.

491

"A String",

492

],

493

"security": True or False, # Adds the `--security` flag to `yum update`. Not supported on

494

# all platforms.

495

"minimal": True or False, # Will cause patch to run `yum update-minimal` instead.

496

},

497

"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch

498

# rules.

499

},

500

"rebootConfig": "A String", # Post-patch reboot settings.

501

"preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.

502

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

503

"localPath": "A String", # An absolute path to the executable on the VM.

504

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

505

# execution can return to indicate a success.

506

42,

507

],

508

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

509

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

510

# ensure that the ExecStep specified by this PatchJob does not change.

511

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

512

"object": "A String", # Required. Name of the Google Cloud Storage object.

513

},

514

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

515

# specified the script will be executed directly, which will likely

516

# only succeed for scripts with [shebang lines]

517

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

518

},

519

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

520

"localPath": "A String", # An absolute path to the executable on the VM.

521

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

522

# execution can return to indicate a success.

523

42,

524

],

525

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

526

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

527

# ensure that the ExecStep specified by this PatchJob does not change.

528

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

529

"object": "A String", # Required. Name of the Google Cloud Storage object.

530

},

531

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

532

# specified the script will be executed directly, which will likely

533

# only succeed for scripts with [shebang lines]

534

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

535

},

536

},

537

"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.

538

"excludes": [ # List of KBs to exclude from update.

539

"A String",

540

],

541

"exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches

542

# that will be updated. This field must not be used with other

543

# patch configurations.

544

"A String",

545

],

546

"classifications": [ # Only apply updates of these windows update classifications. If empty, all

547

# updates are applied.

"A String",

],

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

561

562

{ # A high level representation of a patch job that is either in progress

563

# or has completed.

564

#

565

# Instances details are not included in the job. To paginate through instance

566

# details, use ListPatchJobInstanceDetails.

567

#

568

# For more information about patch jobs, see

569

# [Creating patch

570

# jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).

571

"createTime": "A String", # Time this patch job was created.

572

"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has

573

# finished without running any updates on the VM instance.

574

"updateTime": "A String", # Last time this patch job was updated.

575

"patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.

576

"errorMessage": "A String", # If this patch job failed, this message provides information about the

577

# failure.

578

"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied.

579

# patch(es) to a VM instance.

580

"zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper`

581

# patch rules.

582

# See also https://en.opensuse.org/SDB:Zypper_manual.

583

"exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches

584

# that will be installed using 'zypper patch patch:<patch_name>' command.

585

# This field must not be used with any other patch configuration fields.

586

"A String",

587

],

588

"excludes": [ # List of patches to exclude from update.

589

"A String",

590

],

591

"withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.

592

"withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.

593

"severities": [ # Install only patches with these severities.

594

# Common severities include critical, important, moderate, and low.

595

"A String",

596

],

597

"categories": [ # Install only patches with these categories.

598

# Common categories include security, recommended, and feature.

"A String",

],

},

"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.

603

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

604

"localPath": "A String", # An absolute path to the executable on the VM.

605

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

606

# execution can return to indicate a success.

607

42,

608

],

609

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

610

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

611

# ensure that the ExecStep specified by this PatchJob does not change.

612

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

613

"object": "A String", # Required. Name of the Google Cloud Storage object.

614

},

615

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

616

# specified the script will be executed directly, which will likely

617

# only succeed for scripts with [shebang lines]

618

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

619

},

620

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

621

"localPath": "A String", # An absolute path to the executable on the VM.

622

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

623

# execution can return to indicate a success.

624

42,

625

],

626

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

627

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

628

# ensure that the ExecStep specified by this PatchJob does not change.

629

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

630

"object": "A String", # Required. Name of the Google Cloud Storage object.

631

},

632

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

633

# specified the script will be executed directly, which will likely

634

# only succeed for scripts with [shebang lines]

635

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

636

},

637

},

638

"apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch

639

# rules.

640

# upgrade`. Additional options can be set to control how this is executed.

641

"excludes": [ # List of packages to exclude from update. These packages will be excluded

642

"A String",

643

],

644

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

645

# that will be updated. If these packages are not installed, they will be

646

# 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

651

# using `apt-get dist-upgrade` instead.

652

},

653

"yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch

654

# rules.

655

# can be set to control how this is executed.

656

#

657

# Note that not all settings are supported on all platforms.

658

"excludes": [ # List of packages to exclude from update. These packages are excluded by

659

# using the yum `--exclude` flag.

660

"A String",

661

],

662

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

663

# that will be updated. If these packages are not installed, they will be

664

# ignored. This field must not be specified with any other patch

665

# configuration fields.

666

"A String",

667

],

668

"security": True or False, # Adds the `--security` flag to `yum update`. Not supported on

669

# all platforms.

670

"minimal": True or False, # Will cause patch to run `yum update-minimal` instead.

671

},

672

"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch

673

# rules.

674

},

675

"rebootConfig": "A String", # Post-patch reboot settings.

676

"preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.

677

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

678

"localPath": "A String", # An absolute path to the executable on the VM.

679

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

680

# execution can return to indicate a success.

681

42,

682

],

683

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

684

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

685

# ensure that the ExecStep specified by this PatchJob does not change.

686

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

687

"object": "A String", # Required. Name of the Google Cloud Storage object.

688

},

689

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

690

# specified the script will be executed directly, which will likely

691

# only succeed for scripts with [shebang lines]

692

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

693

},

694

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

695

"localPath": "A String", # An absolute path to the executable on the VM.

696

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

697

# execution can return to indicate a success.

698

42,

699

],

700

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

701

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

702

# ensure that the ExecStep specified by this PatchJob does not change.

703

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

704

"object": "A String", # Required. Name of the Google Cloud Storage object.

705

},

706

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

707

# specified the script will be executed directly, which will likely

708

# only succeed for scripts with [shebang lines]

709

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

710

},

711

},

712

"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.

713

"excludes": [ # List of KBs to exclude from update.

714

"A String",

715

],

716

"exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches

717

# that will be updated. This field must not be used with other

718

# patch configurations.

719

"A String",

720

],

721

"classifications": [ # Only apply updates of these windows update classifications. If empty, all

722

# updates are applied.

"A String",

],

},

},

"duration": "A String", # Duration of the patch job. After the duration ends, the

728

# patch job times out.

729

"instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch.

730

# VMs must meet all criteria specified. So if both labels and zones are

731

# specified, the patch job targets only VMs with those labels and in those

732

# zones.

733

"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM

734

# instances in any zone.

735

"A String",

736

],

737

"groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows

738

# targeting of disparate groups, for example "env=prod or env=staging".

739

{ # Represents a group of VMs that can be identified as having all these

740

# labels, for example "env=prod and app=web".

741

"labels": { # Google Compute Engine instance labels that must be present for a VM

742

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

"all": True or False, # Target all VM instances in the project. If true, no other criteria is

748

# permitted.

749

"instances": [ # Targets any of the VM instances specified. Instances are specified by their

750

# URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME],

751

# `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or

752

# `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`

753

"A String",

754

],

755

"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to

756

# labels, this is another way to group VMs when targeting configs, for

757

# example prefix="prod-".

"A String",

],

},

"instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details.

762

# job affects. Contains counts of instances in different states. These states

763

# map to `InstancePatchState`. List patch job instance details to see the

764

# specific states of each instance.

765

"succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.

766

"prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.

767

"noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to

768

# ensure that the agent is installed, running, and able to communicate with

769

# the service.

770

"failedInstanceCount": "A String", # Number of instances that failed.

771

"pendingInstanceCount": "A String", # Number of instances pending patch job.

772

"notifiedInstanceCount": "A String", # Number of instances notified about patch job.

773

"downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.

774

"timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.

775

"rebootingInstanceCount": "A String", # Number of instances rebooting.

776

"postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.

777

"succeededInstanceCount": "A String", # Number of instances that have completed successfully.

778

"ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.

779

"applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.

780

"startedInstanceCount": "A String", # Number of instances that have started.

781

"inactiveInstanceCount": "A String", # Number of instances that are inactive.

782

},

783

"description": "A String", # Description of the patch job. Length of the description is limited

784

# to 1024 characters.

785

"percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of

786

# 0.0 being no progress to 100.0 being complete.

787

"state": "A String", # The current state of the PatchJob .

788

"name": "A String", # Unique identifier for this patch job in the form

789

# `projects/*/patchJobs/*`

790

"displayName": "A String", # Display name for this patch job. This is not a unique identifier.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

796

<pre>Get the patch job. This can be used to track the progress of an

797

ongoing patch job or review the details of completed jobs.

798

799

Args:

800

name: string, Required. Name of the patch in the form `projects/*/patchJobs/*` (required)

801

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

808

809

{ # A high level representation of a patch job that is either in progress

810

# or has completed.

811

#

812

# Instances details are not included in the job. To paginate through instance

813

# details, use ListPatchJobInstanceDetails.

814

#

815

# For more information about patch jobs, see

816

# [Creating patch

817

# jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).

818

"createTime": "A String", # Time this patch job was created.

819

"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has

820

# finished without running any updates on the VM instance.

821

"updateTime": "A String", # Last time this patch job was updated.

822

"patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.

823

"errorMessage": "A String", # If this patch job failed, this message provides information about the

824

# failure.

825

"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied.

826

# patch(es) to a VM instance.

827

"zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper`

828

# patch rules.

829

# See also https://en.opensuse.org/SDB:Zypper_manual.

830

"exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches

831

# that will be installed using 'zypper patch patch:<patch_name>' command.

832

# This field must not be used with any other patch configuration fields.

833

"A String",

834

],

835

"excludes": [ # List of patches to exclude from update.

836

"A String",

837

],

838

"withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.

839

"withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.

840

"severities": [ # Install only patches with these severities.

841

# Common severities include critical, important, moderate, and low.

842

"A String",

843

],

844

"categories": [ # Install only patches with these categories.

845

# Common categories include security, recommended, and feature.

"A String",

],

},

"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.

850

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

851

"localPath": "A String", # An absolute path to the executable on the VM.

852

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

853

# execution can return to indicate a success.

854

42,

855

],

856

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

857

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

858

# ensure that the ExecStep specified by this PatchJob does not change.

859

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

860

"object": "A String", # Required. Name of the Google Cloud Storage object.

861

},

862

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

863

# specified the script will be executed directly, which will likely

864

# only succeed for scripts with [shebang lines]

865

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

866

},

867

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

868

"localPath": "A String", # An absolute path to the executable on the VM.

869

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

870

# execution can return to indicate a success.

871

42,

872

],

873

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

874

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

875

# ensure that the ExecStep specified by this PatchJob does not change.

876

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

877

"object": "A String", # Required. Name of the Google Cloud Storage object.

878

},

879

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

880

# specified the script will be executed directly, which will likely

881

# only succeed for scripts with [shebang lines]

882

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

883

},

884

},

885

"apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch

886

# rules.

887

# upgrade`. Additional options can be set to control how this is executed.

888

"excludes": [ # List of packages to exclude from update. These packages will be excluded

889

"A String",

890

],

891

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

892

# that will be updated. If these packages are not installed, they will be

893

# 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

898

# using `apt-get dist-upgrade` instead.

899

},

900

"yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch

901

# rules.

902

# can be set to control how this is executed.

903

#

904

# Note that not all settings are supported on all platforms.

905

"excludes": [ # List of packages to exclude from update. These packages are excluded by

906

# using the yum `--exclude` flag.

907

"A String",

908

],

909

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

910

# that will be updated. If these packages are not installed, they will be

911

# ignored. This field must not be specified with any other patch

912

# configuration fields.

913

"A String",

914

],

915

"security": True or False, # Adds the `--security` flag to `yum update`. Not supported on

916

# all platforms.

917

"minimal": True or False, # Will cause patch to run `yum update-minimal` instead.

918

},

919

"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch

920

# rules.

921

},

922

"rebootConfig": "A String", # Post-patch reboot settings.

923

"preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.

924

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

925

"localPath": "A String", # An absolute path to the executable on the VM.

926

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

927

# execution can return to indicate a success.

928

42,

929

],

930

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

931

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

932

# ensure that the ExecStep specified by this PatchJob does not change.

933

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

934

"object": "A String", # Required. Name of the Google Cloud Storage object.

935

},

936

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

937

# specified the script will be executed directly, which will likely

938

# only succeed for scripts with [shebang lines]

939

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

940

},

941

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

942

"localPath": "A String", # An absolute path to the executable on the VM.

943

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

944

# execution can return to indicate a success.

945

42,

946

],

947

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

948

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

949

# ensure that the ExecStep specified by this PatchJob does not change.

950

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

951

"object": "A String", # Required. Name of the Google Cloud Storage object.

952

},

953

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

954

# specified the script will be executed directly, which will likely

955

# only succeed for scripts with [shebang lines]

956

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

957

},

958

},

959

"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.

960

"excludes": [ # List of KBs to exclude from update.

961

"A String",

962

],

963

"exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches

964

# that will be updated. This field must not be used with other

965

# patch configurations.

966

"A String",

967

],

968

"classifications": [ # Only apply updates of these windows update classifications. If empty, all

969

# updates are applied.

"A String",

],

},

},

"duration": "A String", # Duration of the patch job. After the duration ends, the

975

# patch job times out.

976

"instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch.

977

# VMs must meet all criteria specified. So if both labels and zones are

978

# specified, the patch job targets only VMs with those labels and in those

979

# zones.

980

"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM

981

# instances in any zone.

982

"A String",

983

],

984

"groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows

985

# targeting of disparate groups, for example "env=prod or env=staging".

986

{ # Represents a group of VMs that can be identified as having all these

987

# labels, for example "env=prod and app=web".

988

"labels": { # Google Compute Engine instance labels that must be present for a VM

989

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

"all": True or False, # Target all VM instances in the project. If true, no other criteria is

995

# permitted.

996

"instances": [ # Targets any of the VM instances specified. Instances are specified by their

997

# URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME],

998

# `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or

999

# `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`

1000

"A String",

1001

],

1002

"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to

1003

# labels, this is another way to group VMs when targeting configs, for

1004

# example prefix="prod-".

"A String",

],

},

"instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details.

1009

# job affects. Contains counts of instances in different states. These states

1010

# map to `InstancePatchState`. List patch job instance details to see the

1011

# specific states of each instance.

1012

"succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.

1013

"prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.

1014

"noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to

1015

# ensure that the agent is installed, running, and able to communicate with

1016

# the service.

1017

"failedInstanceCount": "A String", # Number of instances that failed.

1018

"pendingInstanceCount": "A String", # Number of instances pending patch job.

1019

"notifiedInstanceCount": "A String", # Number of instances notified about patch job.

1020

"downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.

1021

"timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.

1022

"rebootingInstanceCount": "A String", # Number of instances rebooting.

1023

"postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.

1024

"succeededInstanceCount": "A String", # Number of instances that have completed successfully.

1025

"ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.

1026

"applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.

1027

"startedInstanceCount": "A String", # Number of instances that have started.

1028

"inactiveInstanceCount": "A String", # Number of instances that are inactive.

1029

},

1030

"description": "A String", # Description of the patch job. Length of the description is limited

1031

# to 1024 characters.

1032

"percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of

1033

# 0.0 being no progress to 100.0 being complete.

1034

"state": "A String", # The current state of the PatchJob .

1035

"name": "A String", # Unique identifier for this patch job in the form

1036

# `projects/*/patchJobs/*`

1037

"displayName": "A String", # Display name for this patch job. This is not a unique identifier.

}</pre>

</div>

<code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>

1043

<pre>Get a list of patch jobs.

1044

1045

Args:

1046

parent: string, Required. In the form of `projects/*` (required)

1047

filter: string, If provided, this field specifies the criteria that must be met by patch

1048

jobs to be included in the response.

1049

Currently, filtering is only available on the patch_deployment field.

1050

pageToken: string, A pagination token returned from a previous call

1051

that indicates where this listing should continue from.

1052

pageSize: integer, The maximum number of instance status to return.

1053

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1060

1061

{ # A response message for listing patch jobs.

1062

"patchJobs": [ # The list of patch jobs.

1063

{ # A high level representation of a patch job that is either in progress

1064

# or has completed.

1065

#

1066

# Instances details are not included in the job. To paginate through instance

1067

# details, use ListPatchJobInstanceDetails.

1068

#

1069

# For more information about patch jobs, see

1070

# [Creating patch

1071

# jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).

1072

"createTime": "A String", # Time this patch job was created.

1073

"dryRun": True or False, # If this patch job is a dry run, the agent reports that it has

1074

# finished without running any updates on the VM instance.

1075

"updateTime": "A String", # Last time this patch job was updated.

1076

"patchDeployment": "A String", # Output only. Name of the patch deployment that created this patch job.

1077

"errorMessage": "A String", # If this patch job failed, this message provides information about the

1078

# failure.

1079

"patchConfig": { # Patch configuration specifications. Contains details on how to apply the # Patch configuration being applied.

1080

# patch(es) to a VM instance.

1081

"zypper": { # Zypper patching is performed by running `zypper patch`. # Zypper update settings. Use this setting to override the default `zypper`

1082

# patch rules.

1083

# See also https://en.opensuse.org/SDB:Zypper_manual.

1084

"exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches

1085

# that will be installed using 'zypper patch patch:<patch_name>' command.

1086

# This field must not be used with any other patch configuration fields.

1087

"A String",

1088

],

1089

"excludes": [ # List of patches to exclude from update.

1090

"A String",

1091

],

1092

"withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.

1093

"withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.

1094

"severities": [ # Install only patches with these severities.

1095

# Common severities include critical, important, moderate, and low.

1096

"A String",

1097

],

1098

"categories": [ # Install only patches with these categories.

1099

# Common categories include security, recommended, and feature.

"A String",

],

},

"postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.

1104

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

1105

"localPath": "A String", # An absolute path to the executable on the VM.

1106

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

1107

# execution can return to indicate a success.

1108

42,

1109

],

1110

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

1111

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

1112

# ensure that the ExecStep specified by this PatchJob does not change.

1113

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

1114

"object": "A String", # Required. Name of the Google Cloud Storage object.

1115

},

1116

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

1117

# specified the script will be executed directly, which will likely

1118

# only succeed for scripts with [shebang lines]

1119

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

1120

},

1121

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

1122

"localPath": "A String", # An absolute path to the executable on the VM.

1123

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

1124

# execution can return to indicate a success.

1125

42,

1126

],

1127

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

1128

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

1129

# ensure that the ExecStep specified by this PatchJob does not change.

1130

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

1131

"object": "A String", # Required. Name of the Google Cloud Storage object.

1132

},

1133

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

1134

# specified the script will be executed directly, which will likely

1135

# only succeed for scripts with [shebang lines]

1136

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

1137

},

1138

},

1139

"apt": { # Apt patching is completed by executing `apt-get update && apt-get # Apt update settings. Use this setting to override the default `apt` patch

1140

# rules.

1141

# upgrade`. Additional options can be set to control how this is executed.

1142

"excludes": [ # List of packages to exclude from update. These packages will be excluded

1143

"A String",

1144

],

1145

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

1146

# that will be updated. If these packages are not installed, they will be

1147

# 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

1152

# using `apt-get dist-upgrade` instead.

1153

},

1154

"yum": { # Yum patching is performed by executing `yum update`. Additional options # Yum update settings. Use this setting to override the default `yum` patch

1155

# rules.

1156

# can be set to control how this is executed.

1157

#

1158

# Note that not all settings are supported on all platforms.

1159

"excludes": [ # List of packages to exclude from update. These packages are excluded by

1160

# using the yum `--exclude` flag.

1161

"A String",

1162

],

1163

"exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages

1164

# that will be updated. If these packages are not installed, they will be

1165

# ignored. This field must not be specified with any other patch

1166

# configuration fields.

1167

"A String",

1168

],

1169

"security": True or False, # Adds the `--security` flag to `yum update`. Not supported on

1170

# all platforms.

1171

"minimal": True or False, # Will cause patch to run `yum update-minimal` instead.

1172

},

1173

"goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch

1174

# rules.

1175

},

1176

"rebootConfig": "A String", # Post-patch reboot settings.

1177

"preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.

1178

"linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.

1179

"localPath": "A String", # An absolute path to the executable on the VM.

1180

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

1181

# execution can return to indicate a success.

1182

42,

1183

],

1184

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

1185

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

1186

# ensure that the ExecStep specified by this PatchJob does not change.

1187

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

1188

"object": "A String", # Required. Name of the Google Cloud Storage object.

1189

},

1190

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

1191

# specified the script will be executed directly, which will likely

1192

# only succeed for scripts with [shebang lines]

1193

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

1194

},

1195

"windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.

1196

"localPath": "A String", # An absolute path to the executable on the VM.

1197

"allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the

1198

# execution can return to indicate a success.

1199

42,

1200

],

1201

"gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.

1202

"generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to

1203

# ensure that the ExecStep specified by this PatchJob does not change.

1204

"bucket": "A String", # Required. Bucket of the Google Cloud Storage object.

1205

"object": "A String", # Required. Name of the Google Cloud Storage object.

1206

},

1207

"interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is

1208

# specified the script will be executed directly, which will likely

1209

# only succeed for scripts with [shebang lines]

1210

# (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).

1211

},

1212

},

1213

"windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.

1214

"excludes": [ # List of KBs to exclude from update.

1215

"A String",

1216

],

1217

"exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches

1218

# that will be updated. This field must not be used with other

1219

# patch configurations.

1220

"A String",

1221

],

1222

"classifications": [ # Only apply updates of these windows update classifications. If empty, all

1223

# updates are applied.

"A String",

],

},

},

"duration": "A String", # Duration of the patch job. After the duration ends, the

1229

# patch job times out.

1230

"instanceFilter": { # A filter to target VM instances for patching. The targeted # Instances to patch.

1231

# VMs must meet all criteria specified. So if both labels and zones are

1232

# specified, the patch job targets only VMs with those labels and in those

1233

# zones.

1234

"zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM

1235

# instances in any zone.

1236

"A String",

1237

],

1238

"groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows

1239

# targeting of disparate groups, for example "env=prod or env=staging".

1240

{ # Represents a group of VMs that can be identified as having all these

1241

# labels, for example "env=prod and app=web".

1242

"labels": { # Google Compute Engine instance labels that must be present for a VM

1243

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

"all": True or False, # Target all VM instances in the project. If true, no other criteria is

1249

# permitted.

1250

"instances": [ # Targets any of the VM instances specified. Instances are specified by their

1251

# URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME],

1252

# `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or

1253

# `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`

1254

"A String",

1255

],

1256

"instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to

1257

# labels, this is another way to group VMs when targeting configs, for

1258

# example prefix="prod-".

"A String",

],

},

"instanceDetailsSummary": { # A summary of the current patch state across all instances that this patch # Summary of instance details.

1263

# job affects. Contains counts of instances in different states. These states

1264

# map to `InstancePatchState`. List patch job instance details to see the

1265

# specific states of each instance.

1266

"succeededRebootRequiredInstanceCount": "A String", # Number of instances that require reboot.

1267

"prePatchStepInstanceCount": "A String", # Number of instances that are running the pre-patch step.

1268

"noAgentDetectedInstanceCount": "A String", # Number of instances that do not appear to be running the agent. Check to

1269

# ensure that the agent is installed, running, and able to communicate with

1270

# the service.

1271

"failedInstanceCount": "A String", # Number of instances that failed.

1272

"pendingInstanceCount": "A String", # Number of instances pending patch job.

1273

"notifiedInstanceCount": "A String", # Number of instances notified about patch job.

1274

"downloadingPatchesInstanceCount": "A String", # Number of instances that are downloading patches.

1275

"timedOutInstanceCount": "A String", # Number of instances that exceeded the time out while applying the patch.

1276

"rebootingInstanceCount": "A String", # Number of instances rebooting.

1277

"postPatchStepInstanceCount": "A String", # Number of instances that are running the post-patch step.

1278

"succeededInstanceCount": "A String", # Number of instances that have completed successfully.

1279

"ackedInstanceCount": "A String", # Number of instances that have acked and will start shortly.

1280

"applyingPatchesInstanceCount": "A String", # Number of instances that are applying patches.

1281

"startedInstanceCount": "A String", # Number of instances that have started.

1282

"inactiveInstanceCount": "A String", # Number of instances that are inactive.

1283

},

1284

"description": "A String", # Description of the patch job. Length of the description is limited

1285

# to 1024 characters.

1286

"percentComplete": 3.14, # Reflects the overall progress of the patch job in the range of

1287

# 0.0 being no progress to 100.0 being complete.

1288

"state": "A String", # The current state of the PatchJob .

1289

"name": "A String", # Unique identifier for this patch job in the form

1290

# `projects/*/patchJobs/*`

1291

"displayName": "A String", # Display name for this patch job. This is not a unique identifier.

1292

},

1293

],

1294

"nextPageToken": "A String", # A pagination token that can be used to get the next page of results.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1300

<pre>Retrieves the next page of results.

1301

1302

Args:

1303

previous_request: The request for the previous page. (required)

1304

previous_response: The response from the request for the previous page. (required)

1305

1306

Returns:

1307

A request object that you can call 'execute()' on to request the next

1308

page. Returns None if there are no more items in the collection.

</pre>

</div>

</body></html>