summaryrefslogtreecommitdiff
path: root/lib/chef/resource/windows_path.rb
blob: 7f2e79d9d2610415f1c28f74a21d9743dee4c28f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#
# Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
# Copyright:: Copyright 2008-2017, Chef Software 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 "chef/resource"

class Chef
  class Resource
    class WindowsPath < Chef::Resource
      resource_name :windows_path
      provides(:windows_path) { true }

      description "Use the windows_path resource to manage the path environment variable on Microsoft Windows."
      introduced "13.4"

      allowed_actions :add, :remove
      default_action :add

      property :path, String,
               description: "The name of the value to add to the system path",
               name_property: true
    end
  end
end