Contents

#
# Author:: Doug MacEachern (<[e-mail]>)
# Author:: Tyler Cloke (<[e-mail]>)
# Copyright:: Copyright 2010-2016, VMware, 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 WindowsEnv < Chef::Resource
      resource_name :windows_env
      provides :windows_env
      provides :env # backwards compat with the pre-Chef 14 resource name

      description "Use the env resource to manage environment keys in Microsoft Windows. After an environment key is set, Microsoft Windows must be restarted before the environment key will be available to the Task Scheduler."

      default_action :create
      allowed_actions :create, :delete, :modify

      property :key_name, String,
               description: "The name of the key that is to be created, deleted, or modified.",
               identity: true, name_property: true

      property :value, String,
               description: "The value of the environmental variable to set.",
               required: true

      property :delim, [ String, nil, false ],
               description: "The delimiter that is used to separate multiple values for a single key.",
               desired_state: false

      property :user, String, default: "<System>"
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
chef-14.10.9	lib/chef/resource/windows_env.rb
chef-14.9.13	lib/chef/resource/windows_env.rb
chef-14.8.12	lib/chef/resource/windows_env.rb
chef-14.7.17	lib/chef/resource/windows_env.rb