W3cubDocs

/Ansible 2.11

community.general.syspatch – Manage OpenBSD system patches

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.syspatch.

Synopsis

  • Manage OpenBSD system patches using syspatch.

Parameters

Parameter Choices/Defaults Comments
apply
boolean
    Choices:
  • no
  • yes
Apply all available system patches.
By default, apply all patches.
Deprecated. Will be removed in community.general 3.0.0.
revert
string
    Choices:
  • all
  • one
Revert system patches.

Examples

- name: Apply all available system patches
  community.general.syspatch:
    apply: true

- name: Revert last patch
  community.general.syspatch:
    revert: one

- name: Revert all patches
  community.general.syspatch:
    revert: all

# NOTE: You can reboot automatically if a patch requires it:
- name: Apply all patches and store result
  community.general.syspatch:
    apply: true
  register: syspatch

- name: Reboot if patch requires it
  ansible.builtin.reboot:
  when: syspatch.reboot_needed

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
rc
integer
always
The command return code (0 means success)

reboot_needed
boolean
always
Whether or not a reboot is required after an update.

Sample:
True
stderr
string
always
syspatch standard error.

Sample:
syspatch: need root privileges
stdout
string
always
syspatch standard output.

Sample:
001_rip6cksum


Authors

  • Andrew Klaus (@precurse)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/syspatch_module.html