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

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

76

<h2>Instance Methods</h2>

77

78

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

79

</p>

80

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

81

82

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

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

129

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

130

# `projects/*/patchJobs/*`

131

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

132

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

133

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

134

# finished without running any updates on the VM instance.

135

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

136

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

137

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

138

# failure.

139

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

140

# patch(es) to a VM instance.

141

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

142

# rules.

143

},

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

},

153

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

154

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

155

# only succeed for scripts with [shebang lines]

156

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

157

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

158

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

159

# execution can return to indicate a success.

42,

],

},

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

164

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

165

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

166

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

167

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

168

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

169

},

170

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

171

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

172

# only succeed for scripts with [shebang lines]

173

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

174

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

175

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

176

# execution can return to indicate a success.

42,

],

},

},

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

182

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

183

"A String",

184

],

185

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

186

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

187

# patch configurations.

188

"A String",

189

],

190

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

191

# updates are applied.

"A String",

],

},

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

196

# patch rules.

197

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

198

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

199

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

200

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

201

"A String",

202

],

203

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

204

"A String",

205

],

206

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

207

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

208

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

209

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

210

"A String",

211

],

212

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

213

# 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.

218

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

219

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

220

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

221

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

222

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

223

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

224

},

225

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

226

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

227

# only succeed for scripts with [shebang lines]

228

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

229

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

230

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

231

# execution can return to indicate a success.

42,

],

},

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

236

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

237

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

238

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

239

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

240

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

241

},

242

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

243

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

244

# only succeed for scripts with [shebang lines]

245

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

246

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

247

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

248

# execution can return to indicate a success.

42,

],

},

},

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

254

# rules.

255

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

256

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

257

"A String",

258

],

259

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

260

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

261

# 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

266

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

267

},

268

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

269

# rules.

270

# can be set to control how this is executed.

271

#

272

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

273

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

274

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

275

# using the yum `--exclude` flag.

276

"A String",

277

],

278

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

279

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

280

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

281

# configuration fields.

282

"A String",

283

],

284

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

# all platforms.

},

},

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

289

# patch job times out.

290

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

291

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

292

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

293

# zones.

294

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

295

# permitted.

296

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

297

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

298

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

299

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

300

"A String",

301

],

302

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

303

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

304

# example prefix="prod-".

305

"A String",

306

],

307

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

308

# instances in any zone.

309

"A String",

310

],

311

"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows

312

# targeting of disparate groups of VM instances.

313

{ # Targets a group of VM instances by using their [assigned

314

# labels](https://cloud.google.com/compute/docs/labeling-resources). Labels

315

# are key-value pairs. A `GroupLabel` is a combination of labels

316

# that is used to target VMs for a patch job.

317

#

318

# For example, a patch job can target VMs that have the following

319

# `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job

320

# is applied to VMs that have both the labels `env=test` and `app=web`.

321

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

322

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

},

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

329

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

330

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

331

# specific states of each instance.

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

# the service.

349

},

350

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

351

# to 1024 characters.

352

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

353

# 0.0 being no progress to 100.0 being complete.

}</pre>

</div>

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

359

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

360

361

Args:

362

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

363

body: object, The request body.

364

The object takes the form of:

365

366

{ # A request message to initiate patching across Compute Engine

367

# instances.

368

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

369

# will do nothing.

370

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

371

# patched using the default configurations.

372

# patch(es) to a VM instance.

373

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

374

# rules.

375

},

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

},

385

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

386

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

387

# only succeed for scripts with [shebang lines]

388

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

389

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

390

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

391

# execution can return to indicate a success.

42,

],

},

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

396

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

397

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

398

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

399

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

400

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

401

},

402

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

403

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

404

# only succeed for scripts with [shebang lines]

405

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

406

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

407

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

408

# execution can return to indicate a success.

42,

],

},

},

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

414

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

415

"A String",

416

],

417

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

418

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

419

# patch configurations.

420

"A String",

421

],

422

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

423

# updates are applied.

"A String",

],

},

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

428

# patch rules.

429

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

430

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

431

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

432

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

433

"A String",

434

],

435

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

436

"A String",

437

],

438

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

439

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

440

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

441

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

442

"A String",

443

],

444

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

445

# 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.

450

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

451

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

452

"generationNumber": "A String", # Required. Generation number of the 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 Cloud Storage object.

455

"object": "A String", # Required. Name of the 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

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

462

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

463

# execution can return to indicate a success.

42,

],

},

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

468

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

469

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

470

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

471

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

472

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

473

},

474

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

475

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

476

# only succeed for scripts with [shebang lines]

477

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

478

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

479

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

480

# execution can return to indicate a success.

42,

],

},

},

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

486

# rules.

487

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

488

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

489

"A String",

490

],

491

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

492

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

493

# 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

498

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

499

},

500

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

501

# rules.

502

# can be set to control how this is executed.

503

#

504

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

505

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

506

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

507

# using the yum `--exclude` flag.

508

"A String",

509

],

510

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

511

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

512

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

513

# configuration fields.

514

"A String",

515

],

516

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

# all platforms.

},

},

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

521

# as zone or labels.

522

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

523

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

524

# zones.

525

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

526

# permitted.

527

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

528

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

529

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

530

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

531

"A String",

532

],

533

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

534

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

535

# example prefix="prod-".

536

"A String",

537

],

538

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

539

# instances in any zone.

540

"A String",

541

],

542

"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows

543

# targeting of disparate groups of VM instances.

544

{ # Targets a group of VM instances by using their [assigned

545

# labels](https://cloud.google.com/compute/docs/labeling-resources). Labels

546

# are key-value pairs. A `GroupLabel` is a combination of labels

547

# that is used to target VMs for a patch job.

548

#

549

# For example, a patch job can target VMs that have the following

550

# `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job

551

# is applied to VMs that have both the labels `env=test` and `app=web`.

552

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

553

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

},

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

560

# times out.

561

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

562

# to 1024 characters.

563

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

564

}

565

566

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

573

574

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

575

# or has completed.

576

#

577

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

578

# details, use ListPatchJobInstanceDetails.

579

#

580

# For more information about patch jobs, see

581

# [Creating patch

582

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

583

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

584

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

585

# `projects/*/patchJobs/*`

586

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

587

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

588

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

589

# finished without running any updates on the VM instance.

590

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

591

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

592

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

593

# failure.

594

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

595

# patch(es) to a VM instance.

596

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

597

# rules.

598

},

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

},

608

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

609

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

610

# only succeed for scripts with [shebang lines]

611

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

612

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

613

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

614

# execution can return to indicate a success.

42,

],

},

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

619

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

620

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

621

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

622

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

623

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

624

},

625

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

626

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

627

# only succeed for scripts with [shebang lines]

628

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

629

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

630

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

631

# execution can return to indicate a success.

42,

],

},

},

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

637

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

638

"A String",

639

],

640

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

641

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

642

# patch configurations.

643

"A String",

644

],

645

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

646

# updates are applied.

"A String",

],

},

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

651

# patch rules.

652

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

653

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

654

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

655

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

656

"A String",

657

],

658

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

659

"A String",

660

],

661

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

662

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

663

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

664

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

665

"A String",

666

],

667

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

668

# 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.

673

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

674

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

675

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

676

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

677

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

678

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

679

},

680

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

681

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

682

# only succeed for scripts with [shebang lines]

683

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

684

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

685

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

686

# execution can return to indicate a success.

42,

],

},

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

691

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

692

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

693

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

694

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

695

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

696

},

697

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

698

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

699

# only succeed for scripts with [shebang lines]

700

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

701

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

702

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

703

# execution can return to indicate a success.

42,

],

},

},

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

709

# rules.

710

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

711

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

712

"A String",

713

],

714

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

715

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

716

# 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

721

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

722

},

723

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

724

# rules.

725

# can be set to control how this is executed.

726

#

727

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

728

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

729

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

730

# using the yum `--exclude` flag.

731

"A String",

732

],

733

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

734

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

735

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

736

# configuration fields.

737

"A String",

738

],

739

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

# all platforms.

},

},

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

744

# patch job times out.

745

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

746

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

747

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

748

# zones.

749

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

750

# permitted.

751

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

752

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

753

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

754

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

755

"A String",

756

],

757

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

758

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

759

# example prefix="prod-".

760

"A String",

761

],

762

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

763

# instances in any zone.

764

"A String",

765

],

766

"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows

767

# targeting of disparate groups of VM instances.

768

{ # Targets a group of VM instances by using their [assigned

769

# labels](https://cloud.google.com/compute/docs/labeling-resources). Labels

770

# are key-value pairs. A `GroupLabel` is a combination of labels

771

# that is used to target VMs for a patch job.

772

#

773

# For example, a patch job can target VMs that have the following

774

# `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job

775

# is applied to VMs that have both the labels `env=test` and `app=web`.

776

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

777

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

},

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

784

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

785

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

786

# specific states of each instance.

787

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

788

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

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

# the service.

804

},

805

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

806

# to 1024 characters.

807

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

808

# 0.0 being no progress to 100.0 being complete.

}</pre>

</div>

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

814

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

815

ongoing patch job or review the details of completed jobs.

816

817

Args:

818

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

819

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

826

827

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

828

# or has completed.

829

#

830

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

831

# details, use ListPatchJobInstanceDetails.

832

#

833

# For more information about patch jobs, see

834

# [Creating patch

835

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

836

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

837

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

838

# `projects/*/patchJobs/*`

839

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

840

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

841

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

842

# finished without running any updates on the VM instance.

843

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

844

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

845

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

846

# failure.

847

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

848

# patch(es) to a VM instance.

849

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

850

# rules.

851

},

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

},

861

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

862

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

863

# only succeed for scripts with [shebang lines]

864

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

865

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

866

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

867

# execution can return to indicate a success.

42,

],

},

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

872

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

873

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

874

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

875

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

876

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

877

},

878

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

879

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

880

# only succeed for scripts with [shebang lines]

881

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

882

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

883

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

884

# execution can return to indicate a success.

42,

],

},

},

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

890

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

891

"A String",

892

],

893

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

894

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

895

# patch configurations.

896

"A String",

897

],

898

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

899

# updates are applied.

"A String",

],

},

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

904

# patch rules.

905

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

906

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

907

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

908

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

909

"A String",

910

],

911

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

912

"A String",

913

],

914

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

915

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

916

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

917

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

918

"A String",

919

],

920

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

921

# 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.

926

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

927

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

928

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

929

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

930

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

931

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

932

},

933

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

934

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

935

# only succeed for scripts with [shebang lines]

936

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

937

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

938

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

939

# execution can return to indicate a success.

42,

],

},

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

944

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

945

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

946

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

947

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

948

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

949

},

950

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

951

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

952

# only succeed for scripts with [shebang lines]

953

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

954

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

955

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

956

# execution can return to indicate a success.

42,

],

},

},

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

962

# rules.

963

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

964

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

965

"A String",

966

],

967

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

968

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

969

# 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

974

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

975

},

976

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

977

# rules.

978

# can be set to control how this is executed.

979

#

980

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

981

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

982

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

983

# using the yum `--exclude` flag.

984

"A String",

985

],

986

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

987

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

988

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

989

# configuration fields.

990

"A String",

991

],

992

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

# all platforms.

},

},

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

997

# patch job times out.

998

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

999

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

1000

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

1001

# zones.

1002

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

1003

# permitted.

1004

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

1005

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

1006

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

1007

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

1008

"A String",

1009

],

1010

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

1011

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

1012

# example prefix="prod-".

1013

"A String",

1014

],

1015

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

1016

# instances in any zone.

1017

"A String",

1018

],

1019

"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows

1020

# targeting of disparate groups of VM instances.

1021

{ # Targets a group of VM instances by using their [assigned

1022

# labels](https://cloud.google.com/compute/docs/labeling-resources). Labels

1023

# are key-value pairs. A `GroupLabel` is a combination of labels

1024

# that is used to target VMs for a patch job.

1025

#

1026

# For example, a patch job can target VMs that have the following

1027

# `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job

1028

# is applied to VMs that have both the labels `env=test` and `app=web`.

1029

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

1030

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

},

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

1037

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

1038

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

1039

# specific states of each instance.

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

# the service.

1057

},

1058

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

1059

# to 1024 characters.

1060

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

1061

# 0.0 being no progress to 100.0 being complete.

}</pre>

</div>

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

1067

<pre>Get a list of patch jobs.

1068

1069

Args:

1070

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

1071

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

1072

jobs to be included in the response.

1073

Currently, filtering is only available on the patch_deployment field.

1074

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

1075

that indicates where this listing should continue from.

1076

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

1077

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1084

1085

{ # A response message for listing patch jobs.

1086

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

1087

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

1088

# or has completed.

1089

#

1090

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

1091

# details, use ListPatchJobInstanceDetails.

1092

#

1093

# For more information about patch jobs, see

1094

# [Creating patch

1095

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

1096

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

1097

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

1098

# `projects/*/patchJobs/*`

1099

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

1100

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

1101

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

1102

# finished without running any updates on the VM instance.

1103

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

1104

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

1105

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

1106

# failure.

1107

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

1108

# patch(es) to a VM instance.

1109

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

1110

# rules.

1111

},

1112

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

1113

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

1114

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

1115

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

1116

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

1117

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

1118

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

1119

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

1120

},

1121

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

1122

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

1123

# only succeed for scripts with [shebang lines]

1124

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

1125

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

1126

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

1127

# execution can return to indicate a success.

42,

],

},

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

},

1138

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

1139

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

1140

# only succeed for scripts with [shebang lines]

1141

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

1142

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

1143

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

1144

# execution can return to indicate a success.

42,

],

},

},

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

1150

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

1151

"A String",

1152

],

1153

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

1154

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

1155

# patch configurations.

1156

"A String",

1157

],

1158

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

1159

# updates are applied.

"A String",

],

},

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

1164

# patch rules.

1165

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

1166

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

1167

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

1168

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

1169

"A String",

1170

],

1171

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

1172

"A String",

1173

],

1174

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

1175

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

1176

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

1177

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

1178

"A String",

1179

],

1180

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

1181

# 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.

1186

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

1187

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

1188

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

1189

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

1190

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

1191

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

1192

},

1193

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

1194

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

1195

# only succeed for scripts with [shebang lines]

1196

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

1197

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

1198

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

1199

# execution can return to indicate a success.

42,

],

},

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

1204

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

1205

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

1206

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

1207

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

1208

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

1209

},

1210

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

1211

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

1212

# only succeed for scripts with [shebang lines]

1213

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

1214

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

1215

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

1216

# execution can return to indicate a success.

42,

],

},

},

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

1222

# rules.

1223

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

1224

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

1225

"A String",

1226

],

1227

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

1228

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

1229

# 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

1234

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

1235

},

1236

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

1237

# rules.

1238

# can be set to control how this is executed.

1239

#

1240

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

1241

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

1242

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

1243

# using the yum `--exclude` flag.

1244

"A String",

1245

],

1246

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

1247

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

1248

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

1249

# configuration fields.

1250

"A String",

1251

],

1252

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

# all platforms.

},

},

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

1257

# patch job times out.

1258

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

1259

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

1260

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

1261

# zones.

1262

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

1263

# permitted.

1264

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

1265

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

1266

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

1267

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

1268

"A String",

1269

],

1270

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

1271

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

1272

# example prefix="prod-".

1273

"A String",

1274

],

1275

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

1276

# instances in any zone.

1277

"A String",

1278

],

1279

"groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows

1280

# targeting of disparate groups of VM instances.

1281

{ # Targets a group of VM instances by using their [assigned

1282

# labels](https://cloud.google.com/compute/docs/labeling-resources). Labels

1283

# are key-value pairs. A `GroupLabel` is a combination of labels

1284

# that is used to target VMs for a patch job.

1285

#

1286

# For example, a patch job can target VMs that have the following

1287

# `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job

1288

# is applied to VMs that have both the labels `env=test` and `app=web`.

1289

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

1290

# instance to be targeted by this filter.

"a_key": "A String",

},

},

],

},

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

1297

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

1298

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

1299

# specific states of each instance.

1300

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

1301

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

1302

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

1303

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

1304

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

1305

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

1306

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

1307

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

1308

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

1309

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

1310

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

1311

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

1312

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

1313

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

1314

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

1315

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

1316

# the service.

1317

},

1318

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

1319

# to 1024 characters.

1320

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

1321

# 0.0 being no progress to 100.0 being complete.

1322

},

1323

],

1324

"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>

1330

<pre>Retrieves the next page of results.

1331

1332

Args:

1333

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

1334

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

1335

1336

Returns:

1337

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

1338

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

</pre>

</div>

</body></html>