Class: Ansible::Ruby::Modules::Win_environment

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Win_environment

Defined in:

lib/ansible/ruby/modules/generated/windows/win_environment.rb

Overview

Uses .net Environment to set or remove environment variables and can set at User, Machine or Process level. User level environment variables will be set, but not available until the user has logged off and on again.

Instance Method Summary

• #level ⇒ :machine, ...

  The level at which to set the environment variable.,Use C(machine) to set for all users.,Use C(user) to set for the current user that ansible is connected as.,Use C(process) to set for the current process.

• #name ⇒ String

  The name of the environment variable.

• #state ⇒ :absent, ...

  Set to C(present) to ensure environment variable is set.,Set to C(absent) to ensure it is removed.

• #value ⇒ String^?

  The value to store in the environment variable.,Must be set when C(state=present) and cannot be an empty string.,Can be omitted for C(state=absent).

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#level ⇒ :machine, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_environment.rb', line 25

attribute :level

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/windows/win_environment.rb', line 17

attribute :name

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_environment.rb', line 13

attribute :state

#value ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_environment.rb', line 21

attribute :value