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

Inherits:
Base show all
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 collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#level ⇒ :machine, ...

Returns 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. Probably not that useful.

Returns:

  • (:machine, :user, :process) —

    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. Probably not that useful.



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

attribute :level

#name ⇒ String

Returns The name of the environment variable.

Returns:

  • (String) —

    The name of the environment variable.



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

attribute :name

#state ⇒ :absent, ...

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

Returns:

  • (:absent, :present, nil) —

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



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

attribute :state

#value ⇒ String?

Returns 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).

Returns:

  • (String, nil) —

    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).



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

attribute :value