Resource Type: reboot

Defined in:
lib/puppet/type/reboot.rb
Providers:
linux
posix
windows

Overview

Properties

  • when (defaults to: refreshed)

    When to check for, and if needed, perform a reboot. If ‘pending`, then the provider will check if a reboot is pending, and only if needed, reboot the system. If `refreshed` then the reboot will only be performed in response to a refresh event from another resource, e.g. `package`.

    Supported values:
    • refreshed
    • pending

Parameters

  • apply (defaults to: immediately)

    When to apply the reboot. If ‘immediately`, then the provider will stop applying additional resources and apply the reboot once puppet has finished syncing. If `finished`, it will continue applying resources and then perform a reboot at the end of the run. The default is `immediately`.

    Supported values:
    • immediately
    • finished
  • message (defaults to: Puppet is rebooting the computer)
  • name (namevar)
  • onlyif

    For pending reboots, only reboot if the reboot is pending for one of the supplied reasons.

  • provider

    The specific backend to use for this ‘reboot` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

  • timeout (defaults to: 60)

    The amount of time in seconds to wait between the time the reboot is requested and when the reboot is performed. The default timeout is 60 seconds. Note that this time starts once puppet has exited the current run.

  • unless

    For pending reboots, ignore the supplied reasons when checking pennding reboot