Blame - docs/dyn/osconfig_v1beta.projects.patchDeployments.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.patchDeployments.html">patchDeployments</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

<p class="firstline">Create an OS Config patch deployment.</p>

80

81

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

82

<p class="firstline">Delete an OS Config patch deployment.</p>

83

84

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

85

<p class="firstline">Get an OS Config patch deployment.</p>

86

87

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

88

<p class="firstline">Get a page of OS Config patch deployments.</p>

89

90

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

91

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

92

<h3>Method Details</h3>

93

94

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

95

<pre>Create an OS Config patch deployment.

96

97

Args:

98

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

99

body: object, The request body.

100

The object takes the form of:

101

102

{ # Patch deployments are configurations that individual patch jobs use to

103

# complete a patch. These configurations include instance filter, package

104

# repository settings, and a schedule. For more information about creating and

105

# managing patch deployments, see [Scheduling patch

106

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

107

"createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in

108

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

109

"updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in

110

# [RFC3339]("https://www.ietf.org/rfc/rfc3339.txt) text format.

111

"name": "A String", # Unique name for the patch deployment resource in a project. The patch

112

# deployment name is in the form:

113

# `projects/{project_id}/patchDeployments/{patch_deployment_id}`.

114

# This field is ignored when you create a new patch deployment.

115

"recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.

116

"weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.

117

"dayOfWeek": "A String", # Required. Day of the week.

118

},

119

"timeOfDay": { # Represents a time of day. The date and time zone are either not significant # Required. Time of the day to run a recurring deployment.

120

# or are specified elsewhere. An API may choose to allow leap seconds. Related

121

# types are google.type.Date and `google.protobuf.Timestamp`.

122

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

123

# allow the value 60 if it allows leap-seconds.

124

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

125

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

126

# to allow the value "24:00:00" for scenarios like business closing time.

127

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

128

},

129

"lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.

130

"frequency": "A String", # Required. The frequency unit of this recurring schedule.

131

"endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer

132

# active.

133

"timeZone": { # Represents a time zone from the # Required. Defines the time zone that `time_of_day` is relative to.

134

# The rules for daylight saving time are determined by the chosen time zone.

135

# [IANA Time Zone Database](https://www.iana.org/time-zones).

136

"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".

137

"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".

138

},

139

"nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.

140

"startTime": "A String", # Optional. The time that the recurring schedule becomes effective.

141

# Defaults to `create_time` of the patch deployment.

142

"monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is # Required. Schedule with monthly executions.

143

# "on the third Tuesday of the month" or "on the 15th of the month".

144

"monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1

145

# indicates the last day of the month.

146

# Months without the target day will be skipped. For example, a schedule to

147

# run "every month on the 31st" will not run in February, April, June, etc.

148

"weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.

149

"dayOfWeek": "A String", # Required. A day of the week.

150

"weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1

151

# indicates the last week of the month.

},

},

},

"oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in # Required. Schedule a one-time execution.

156

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

157

"executeTime": "A String", # Required. The desired patch job execution time.

158

},

159

"lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment.

160

# Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text

161

# format.

162

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

163

# patch(es) to a VM instance.

164

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

165

# patch rules.

166

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

167

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

168

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

169

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

170

"A String",

171

],

172

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

173

"A String",

174

],

175

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

176

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

177

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

178

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

179

"A String",

180

],

181

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

182

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

187

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

188

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

189

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

190

# execution can return to indicate a success.

191

42,

192

],

193

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

194

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

195

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

196

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

197

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

198

},

199

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

200

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

201

# only succeed for scripts with [shebang lines]

202

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

203

},

204

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

205

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

206

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

207

# execution can return to indicate a success.

208

42,

209

],

210

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

211

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

212

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

213

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

214

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

215

},

216

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

217

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

218

# only succeed for scripts with [shebang lines]

219

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

220

},

221

},

222

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

223

# rules.

224

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

225

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

226

"A String",

227

],

228

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

229

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

230

# 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

235

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

236

},

237

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

238

# rules.

239

# can be set to control how this is executed.

240

#

241

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

242

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

243

# using the yum `--exclude` flag.

244

"A String",

245

],

246

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

247

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

248

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

249

# configuration fields.

250

"A String",

251

],

252

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

253

# all platforms.

254

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

255

},

256

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

257

# rules.

258

},

259

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

260

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

261

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

262

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

263

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

264

# execution can return to indicate a success.

265

42,

266

],

267

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

268

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

269

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

270

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

271

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

272

},

273

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

274

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

275

# only succeed for scripts with [shebang lines]

276

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

277

},

278

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

279

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

280

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

281

# execution can return to indicate a success.

282

42,

283

],

284

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

285

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

286

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

287

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

288

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

289

},

290

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

291

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

292

# only succeed for scripts with [shebang lines]

293

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

294

},

295

},

296

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

297

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

298

"A String",

299

],

300

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

301

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

302

# patch configurations.

303

"A String",

304

],

305

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

306

# updates are applied.

"A String",

],

},

},

"duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.

312

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

313

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

314

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

315

# zones.

316

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

317

# instances in any zone.

318

"A String",

319

],

320

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

321

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

322

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

323

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

324

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

325

# 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

331

# permitted.

332

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

333

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

334

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

335

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

336

"A String",

337

],

338

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

339

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

340

# example prefix="prod-".

"A String",

],

},

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

345

# to 1024 characters.

346

}

347

348

patchDeploymentId: string, Required. A name for the patch deployment in the project. When creating a name

349

the following rules apply:

350

* Must contain only lowercase letters, numbers, and hyphens.

351

* Must start with a letter.

352

* Must be between 1-63 characters.

353

* Must end with a number or a letter.

354

* Must be unique within the project.

355

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

362

363

{ # Patch deployments are configurations that individual patch jobs use to

364

# complete a patch. These configurations include instance filter, package

365

# repository settings, and a schedule. For more information about creating and

366

# managing patch deployments, see [Scheduling patch

367

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

368

"createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in

369

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

370

"updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in

371

# [RFC3339]("https://www.ietf.org/rfc/rfc3339.txt) text format.

372

"name": "A String", # Unique name for the patch deployment resource in a project. The patch

373

# deployment name is in the form:

374

# `projects/{project_id}/patchDeployments/{patch_deployment_id}`.

375

# This field is ignored when you create a new patch deployment.

376

"recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.

377

"weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.

378

"dayOfWeek": "A String", # Required. Day of the week.

379

},

380

"timeOfDay": { # Represents a time of day. The date and time zone are either not significant # Required. Time of the day to run a recurring deployment.

381

# or are specified elsewhere. An API may choose to allow leap seconds. Related

382

# types are google.type.Date and `google.protobuf.Timestamp`.

383

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

384

# allow the value 60 if it allows leap-seconds.

385

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

386

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

387

# to allow the value "24:00:00" for scenarios like business closing time.

388

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

389

},

390

"lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.

391

"frequency": "A String", # Required. The frequency unit of this recurring schedule.

392

"endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer

393

# active.

394

"timeZone": { # Represents a time zone from the # Required. Defines the time zone that `time_of_day` is relative to.

395

# The rules for daylight saving time are determined by the chosen time zone.

396

# [IANA Time Zone Database](https://www.iana.org/time-zones).

397

"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".

398

"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".

399

},

400

"nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.

401

"startTime": "A String", # Optional. The time that the recurring schedule becomes effective.

402

# Defaults to `create_time` of the patch deployment.

403

"monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is # Required. Schedule with monthly executions.

404

# "on the third Tuesday of the month" or "on the 15th of the month".

405

"monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1

406

# indicates the last day of the month.

407

# Months without the target day will be skipped. For example, a schedule to

408

# run "every month on the 31st" will not run in February, April, June, etc.

409

"weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.

410

"dayOfWeek": "A String", # Required. A day of the week.

411

"weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1

412

# indicates the last week of the month.

},

},

},

"oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in # Required. Schedule a one-time execution.

417

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

418

"executeTime": "A String", # Required. The desired patch job execution time.

419

},

420

"lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment.

421

# Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text

422

# format.

423

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

424

# patch(es) to a VM instance.

425

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

426

# patch rules.

427

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

428

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

429

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

430

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

431

"A String",

432

],

433

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

434

"A String",

435

],

436

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

437

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

438

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

439

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

440

"A String",

441

],

442

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

443

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

448

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

449

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

450

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

451

# execution can return to indicate a success.

452

42,

453

],

454

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

455

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

456

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

457

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

458

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

459

},

460

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

461

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

462

# only succeed for scripts with [shebang lines]

463

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

464

},

465

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

466

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

467

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

468

# execution can return to indicate a success.

469

42,

470

],

471

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

472

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

473

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

474

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

475

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

476

},

477

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

478

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

479

# only succeed for scripts with [shebang lines]

480

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

481

},

482

},

483

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

484

# rules.

485

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

486

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

487

"A String",

488

],

489

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

490

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

491

# 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

496

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

497

},

498

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

499

# rules.

500

# can be set to control how this is executed.

501

#

502

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

503

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

504

# using the yum `--exclude` flag.

505

"A String",

506

],

507

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

508

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

509

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

510

# configuration fields.

511

"A String",

512

],

513

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

514

# all platforms.

515

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

516

},

517

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

518

# rules.

519

},

520

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

521

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

522

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

523

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

524

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

525

# execution can return to indicate a success.

526

42,

527

],

528

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

529

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

530

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

531

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

532

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

533

},

534

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

535

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

536

# only succeed for scripts with [shebang lines]

537

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

538

},

539

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

540

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

541

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

542

# execution can return to indicate a success.

543

42,

544

],

545

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

546

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

547

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

548

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

549

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

550

},

551

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

552

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

553

# only succeed for scripts with [shebang lines]

554

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

555

},

556

},

557

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

558

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

559

"A String",

560

],

561

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

562

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

563

# patch configurations.

564

"A String",

565

],

566

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

567

# updates are applied.

"A String",

],

},

},

"duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.

573

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

574

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

575

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

576

# zones.

577

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

578

# instances in any zone.

579

"A String",

580

],

581

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

582

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

583

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

584

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

585

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

586

# 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

592

# permitted.

593

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

594

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

595

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

596

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

597

"A String",

598

],

599

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

600

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

601

# example prefix="prod-".

"A String",

],

},

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

606

# to 1024 characters.

}</pre>

</div>

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

612

<pre>Delete an OS Config patch deployment.

613

614

Args:

615

name: string, Required. The resource name of the patch deployment in the form

616

`projects/*/patchDeployments/*`. (required)

617

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

624

625

{ # A generic empty message that you can re-use to avoid defining duplicated

626

# empty messages in your APIs. A typical example is to use it as the request

627

# or the response type of an API method. For instance:

628

#

629

# service Foo {

630

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

631

# }

632

#

633

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

639

<pre>Get an OS Config patch deployment.

640

641

Args:

642

name: string, Required. The resource name of the patch deployment in the form

643

`projects/*/patchDeployments/*`. (required)

644

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

651

652

{ # Patch deployments are configurations that individual patch jobs use to

653

# complete a patch. These configurations include instance filter, package

654

# repository settings, and a schedule. For more information about creating and

655

# managing patch deployments, see [Scheduling patch

656

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

657

"createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in

658

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

659

"updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in

660

# [RFC3339]("https://www.ietf.org/rfc/rfc3339.txt) text format.

661

"name": "A String", # Unique name for the patch deployment resource in a project. The patch

662

# deployment name is in the form:

663

# `projects/{project_id}/patchDeployments/{patch_deployment_id}`.

664

# This field is ignored when you create a new patch deployment.

665

"recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.

666

"weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.

667

"dayOfWeek": "A String", # Required. Day of the week.

668

},

669

"timeOfDay": { # Represents a time of day. The date and time zone are either not significant # Required. Time of the day to run a recurring deployment.

670

# or are specified elsewhere. An API may choose to allow leap seconds. Related

671

# types are google.type.Date and `google.protobuf.Timestamp`.

672

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

673

# allow the value 60 if it allows leap-seconds.

674

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

675

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

676

# to allow the value "24:00:00" for scenarios like business closing time.

677

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

678

},

679

"lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.

680

"frequency": "A String", # Required. The frequency unit of this recurring schedule.

681

"endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer

682

# active.

683

"timeZone": { # Represents a time zone from the # Required. Defines the time zone that `time_of_day` is relative to.

684

# The rules for daylight saving time are determined by the chosen time zone.

685

# [IANA Time Zone Database](https://www.iana.org/time-zones).

686

"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".

687

"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".

688

},

689

"nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.

690

"startTime": "A String", # Optional. The time that the recurring schedule becomes effective.

691

# Defaults to `create_time` of the patch deployment.

692

"monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is # Required. Schedule with monthly executions.

693

# "on the third Tuesday of the month" or "on the 15th of the month".

694

"monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1

695

# indicates the last day of the month.

696

# Months without the target day will be skipped. For example, a schedule to

697

# run "every month on the 31st" will not run in February, April, June, etc.

698

"weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.

699

"dayOfWeek": "A String", # Required. A day of the week.

700

"weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1

701

# indicates the last week of the month.

},

},

},

"oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in # Required. Schedule a one-time execution.

706

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

707

"executeTime": "A String", # Required. The desired patch job execution time.

708

},

709

"lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment.

710

# Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text

711

# format.

712

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

713

# patch(es) to a VM instance.

714

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

715

# patch rules.

716

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

717

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

718

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

719

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

720

"A String",

721

],

722

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

723

"A String",

724

],

725

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

726

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

727

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

728

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

729

"A String",

730

],

731

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

732

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

737

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

738

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

739

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

740

# execution can return to indicate a success.

741

42,

742

],

743

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

744

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

745

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

746

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

747

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

748

},

749

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

750

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

751

# only succeed for scripts with [shebang lines]

752

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

753

},

754

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

755

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

756

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

757

# execution can return to indicate a success.

758

42,

759

],

760

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

761

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

762

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

763

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

764

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

765

},

766

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

767

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

768

# only succeed for scripts with [shebang lines]

769

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

770

},

771

},

772

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

773

# rules.

774

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

775

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

776

"A String",

777

],

778

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

779

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

780

# 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

785

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

786

},

787

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

788

# rules.

789

# can be set to control how this is executed.

790

#

791

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

792

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

793

# using the yum `--exclude` flag.

794

"A String",

795

],

796

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

797

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

798

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

799

# configuration fields.

800

"A String",

801

],

802

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

803

# all platforms.

804

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

805

},

806

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

807

# rules.

808

},

809

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

810

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

811

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

812

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

813

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

814

# execution can return to indicate a success.

815

42,

816

],

817

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

818

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

819

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

820

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

821

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

822

},

823

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

824

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

825

# only succeed for scripts with [shebang lines]

826

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

827

},

828

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

829

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

830

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

831

# execution can return to indicate a success.

832

42,

833

],

834

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

835

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

836

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

837

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

838

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

839

},

840

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

841

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

842

# only succeed for scripts with [shebang lines]

843

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

844

},

845

},

846

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

847

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

848

"A String",

849

],

850

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

851

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

852

# patch configurations.

853

"A String",

854

],

855

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

856

# updates are applied.

"A String",

],

},

},

"duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.

862

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

863

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

864

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

865

# zones.

866

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

867

# instances in any zone.

868

"A String",

869

],

870

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

871

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

872

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

873

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

874

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

875

# 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

881

# permitted.

882

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

883

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

884

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

885

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

886

"A String",

887

],

888

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

889

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

890

# example prefix="prod-".

"A String",

],

},

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

895

# to 1024 characters.

}</pre>

</div>

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

901

<pre>Get a page of OS Config patch deployments.

902

903

Args:

904

parent: string, Required. The resource name of the parent in the form `projects/*`. (required)

905

pageToken: string, Optional. A pagination token returned from a previous call to ListPatchDeployments

906

that indicates where this listing should continue from.

907

pageSize: integer, Optional. The maximum number of patch deployments to return. Default is 100.

908

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

915

916

{ # A response message for listing patch deployments.

917

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

918

# deployments.

919

"patchDeployments": [ # The list of patch deployments.

920

{ # Patch deployments are configurations that individual patch jobs use to

921

# complete a patch. These configurations include instance filter, package

922

# repository settings, and a schedule. For more information about creating and

923

# managing patch deployments, see [Scheduling patch

924

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

925

"createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in

926

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

927

"updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in

928

# [RFC3339]("https://www.ietf.org/rfc/rfc3339.txt) text format.

929

"name": "A String", # Unique name for the patch deployment resource in a project. The patch

930

# deployment name is in the form:

931

# `projects/{project_id}/patchDeployments/{patch_deployment_id}`.

932

# This field is ignored when you create a new patch deployment.

933

"recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.

934

"weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.

935

"dayOfWeek": "A String", # Required. Day of the week.

936

},

937

"timeOfDay": { # Represents a time of day. The date and time zone are either not significant # Required. Time of the day to run a recurring deployment.

938

# or are specified elsewhere. An API may choose to allow leap seconds. Related

939

# types are google.type.Date and `google.protobuf.Timestamp`.

940

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

941

# allow the value 60 if it allows leap-seconds.

942

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

943

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

944

# to allow the value "24:00:00" for scenarios like business closing time.

945

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

946

},

947

"lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.

948

"frequency": "A String", # Required. The frequency unit of this recurring schedule.

949

"endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer

950

# active.

951

"timeZone": { # Represents a time zone from the # Required. Defines the time zone that `time_of_day` is relative to.

952

# The rules for daylight saving time are determined by the chosen time zone.

953

# [IANA Time Zone Database](https://www.iana.org/time-zones).

954

"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".

955

"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".

956

},

957

"nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.

958

"startTime": "A String", # Optional. The time that the recurring schedule becomes effective.

959

# Defaults to `create_time` of the patch deployment.

960

"monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is # Required. Schedule with monthly executions.

961

# "on the third Tuesday of the month" or "on the 15th of the month".

962

"monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1

963

# indicates the last day of the month.

964

# Months without the target day will be skipped. For example, a schedule to

965

# run "every month on the 31st" will not run in February, April, June, etc.

966

"weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.

967

"dayOfWeek": "A String", # Required. A day of the week.

968

"weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1

969

# indicates the last week of the month.

},

},

},

"oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in # Required. Schedule a one-time execution.

974

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

975

"executeTime": "A String", # Required. The desired patch job execution time.

976

},

977

"lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment.

978

# Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text

979

# format.

980

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

981

# patch(es) to a VM instance.

982

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

983

# patch rules.

984

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

985

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

986

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

987

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

988

"A String",

989

],

990

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

991

"A String",

992

],

993

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

994

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

995

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

996

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

997

"A String",

998

],

999

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

1000

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

1005

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

1006

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

1007

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

1008

# execution can return to indicate a success.

1009

42,

1010

],

1011

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

1012

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

1013

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

1014

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

1015

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

1016

},

1017

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

1018

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

1019

# only succeed for scripts with [shebang lines]

1020

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

1021

},

1022

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

1023

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

1024

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

1025

# execution can return to indicate a success.

1026

42,

1027

],

1028

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

1029

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

1030

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

1031

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

1032

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

1033

},

1034

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

1035

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

1036

# only succeed for scripts with [shebang lines]

1037

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

1038

},

1039

},

1040

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

1041

# rules.

1042

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

1043

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

1044

"A String",

1045

],

1046

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

1047

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

1048

# 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

1053

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

1054

},

1055

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

1056

# rules.

1057

# can be set to control how this is executed.

1058

#

1059

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

1060

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

1061

# using the yum `--exclude` flag.

1062

"A String",

1063

],

1064

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

1065

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

1066

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

1067

# configuration fields.

1068

"A String",

1069

],

1070

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

1071

# all platforms.

1072

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

1073

},

1074

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

1075

# rules.

1076

},

1077

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

1078

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

1079

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

1080

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

1081

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

1082

# execution can return to indicate a success.

1083

42,

1084

],

1085

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

1086

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

1087

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

1088

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

1089

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

1090

},

1091

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

1092

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

1093

# only succeed for scripts with [shebang lines]

1094

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

1095

},

1096

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

1097

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

1098

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

1099

# execution can return to indicate a success.

1100

42,

1101

],

1102

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

1103

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

1104

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

1105

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

1106

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

1107

},

1108

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

1109

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

1110

# only succeed for scripts with [shebang lines]

1111

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

1112

},

1113

},

1114

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

1115

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

1116

"A String",

1117

],

1118

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

1119

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

1120

# patch configurations.

1121

"A String",

1122

],

1123

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

1124

# updates are applied.

"A String",

],

},

},

"duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.

1130

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

1131

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

1132

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

1133

# zones.

1134

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

1135

# instances in any zone.

1136

"A String",

1137

],

1138

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

1139

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

1140

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

1141

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

1142

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

1143

# 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

1149

# permitted.

1150

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

1151

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

1152

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

1153

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

1154

"A String",

1155

],

1156

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

1157

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

1158

# example prefix="prod-".

"A String",

],

},

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

1163

# to 1024 characters.

},

],

}</pre>

</div>

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

1171

<pre>Retrieves the next page of results.

1172

1173

Args:

1174

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

1175

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

1176

1177

Returns:

1178

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

1179

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

</pre>

</div>

</body></html>