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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/windows/win_environment.rb

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #initialize, #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 ‘machine’ to set for all users.,Use ‘user’ to set for the current user that ansible is connected as.,Use ‘process’ to set for the current process. Probably not that useful.

Returns:

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

    The level at which to set the environment variable.,Use ‘machine’ to set for all users.,Use ‘user’ to set for the current user that ansible is connected as.,Use ‘process’ to set for the current process. Probably not that useful.



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

attribute :level

#name ⇒ String

Returns The name of the environment variable.

Returns:

  • (String) —

    The name of the environment variable



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

attribute :name

#state ⇒ :present, ...

Returns present to ensure environment variable is set, or absent to ensure it is removed.

Returns:

  • (:present, :absent, nil) —

    present to ensure environment variable is set, or absent to ensure it is removed



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

attribute :state

#value ⇒ String?

Returns The value to store in the environment variable. Can be omitted for state=absent.

Returns:

  • (String, nil) —

    The value to store in the environment variable. Can be omitted for state=absent



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

attribute :value