Contents

#
# Author:: Chris Doherty <[e-mail]>)
# Copyright:: Copyright 2014-2016, Chef, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require_relative "../resource"
require_relative "../dist"

class Chef
  class Resource
    class Reboot < Chef::Resource
      unified_mode true

      resource_name :reboot

      description "Use the reboot resource to reboot a node, a necessary step with some"\
                  " installations on certain platforms. This resource is supported for use on"\
                  " the Microsoft Windows, macOS, and Linux platforms.\n"\
                  "In using this resource via notifications, it's important to *only* use"\
                  " immediate notifications. Delayed notifications produce unintuitive and"\
                  " probably undesired results."
      introduced "12.0"

      allowed_actions :request_reboot, :reboot_now, :cancel
      default_action :nothing # make sure people are quite clear what they want

      property :reason, String,
        description: "A string that describes the reboot action.",
        default: "Reboot by #{Chef::Dist::PRODUCT}"

      property :delay_mins, Integer,
        description: "The amount of time (in minutes) to delay a reboot request.",
        default: 0
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
chef-15.5.9	lib/chef/resource/reboot.rb
chef-15.5.9-universal-mingw32	lib/chef/resource/reboot.rb