Class: Ansible::Ruby::Modules::Win_path

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

Overview

Allows element-based ordering, addition, and removal of Windows path environment variables.

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, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#elements ⇒ Array<String>, String

Returns A single path element, or a list of path elements (ie, directories) to add or remove.,When multiple elements are included in the list (and C(state) is C(present)), the elements are guaranteed to appear in the same relative order in the resultant path value.,Variable expansions (eg, C(%VARNAME%)) are allowed, and are stored unexpanded in the target path element.,Any existing path elements not mentioned in C(elements) are always preserved in their current order.,New path elements are appended to the path, and existing path elements may be moved closer to the end to satisfy the requested ordering.,Paths are compared in a case-insensitive fashion, and trailing backslashes are ignored for comparison purposes. However, note that trailing backslashes in YAML require quotes.

Returns:

  • (Array<String>, String) —

    A single path element, or a list of path elements (ie, directories) to add or remove.,When multiple elements are included in the list (and C(state) is C(present)), the elements are guaranteed to appear in the same relative order in the resultant path value.,Variable expansions (eg, C(%VARNAME%)) are allowed, and are stored unexpanded in the target path element.,Any existing path elements not mentioned in C(elements) are always preserved in their current order.,New path elements are appended to the path, and existing path elements may be moved closer to the end to satisfy the requested ordering.,Paths are compared in a case-insensitive fashion, and trailing backslashes are ignored for comparison purposes. However, note that trailing backslashes in YAML require quotes.



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_path.rb', line 16

attribute :elements

#name ⇒ String?

Returns Target path environment variable name.

Returns:

  • (String, nil) —

    Target path environment variable name.



12
 
# File 'lib/ansible/ruby/modules/generated/windows/win_path.rb', line 12

attribute :name

#scope ⇒ :machine, ...

Returns The level at which the environment variable specified by C(name) should be managed (either for the current user or global machine scope).

Returns:

  • (:machine, :user, nil) —

    The level at which the environment variable specified by C(name) should be managed (either for the current user or global machine scope).



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_path.rb', line 24

attribute :scope

#state ⇒ :absent, ...

Returns Whether the path elements specified in C(elements) should be present or absent.

Returns:

  • (:absent, :present, nil) —

    Whether the path elements specified in C(elements) should be present or absent.



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_path.rb', line 20

attribute :state