Class: Ansible::Ruby::Modules::Win_find
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Win_find
- Defined in:
- lib/ansible/ruby/modules/generated/windows/win_find.rb
Overview
Return a list of files based on specified criteria. Multiple criteria are AND’d together. For non-Windows targets, use the M(find) module instead.
Instance Method Summary collapse
-
#age ⇒ Integer, ...
Select files or folders whose age is equal to or greater than the specified time.
-
#age_stamp ⇒ :atime, ...
Choose the file property against which we compare C(age).
-
#checksum_algorithm ⇒ :md5, ...
Algorithm to determine the checksum of a file.
-
#file_type ⇒ :directory, ...
Type of file to search for.
-
#follow ⇒ :yes, ...
Set this to C(yes) to follow symlinks in the path.,This needs to be used in conjunction with C(recurse).
-
#get_checksum ⇒ :yes, ...
Whether to return a checksum of the file in the return info (default sha1), use C(checksum_algorithm) to change from the default.
-
#hidden ⇒ :yes, ...
Set this to include hidden files or folders.
-
#paths ⇒ Array<String>, String
List of paths of directories to search for files or folders in.
-
#patterns ⇒ Array<String>, ...
One or more (powershell or regex) patterns to compare filenames with.
-
#recurse ⇒ :yes, ...
Will recursively descend into the directory looking for files or folders.
-
#size ⇒ Integer, ...
Select files or folders whose size is equal to or greater than the specified size.
-
#use_regex ⇒ :yes, ...
Will set patterns to run as a regex check if set to C(yes).
Methods inherited from Base
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
#age ⇒ Integer, ...
Returns Select files or folders whose age is equal to or greater than the specified time. Use a negative age to find files equal to or less than the specified time. You can choose seconds, minutes, hours, days or weeks by specifying the first letter of an of those words (e.g., “2s”, “10d”, 1w“).
14 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 14 attribute :age |
#age_stamp ⇒ :atime, ...
Returns Choose the file property against which we compare C(age). The default attribute we compare with is the last modification time.
18 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 18 attribute :age_stamp |
#checksum_algorithm ⇒ :md5, ...
Returns Algorithm to determine the checksum of a file. Will throw an error if the host is unable to use specified algorithm.
22 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 22 attribute :checksum_algorithm |
#file_type ⇒ :directory, ...
Returns Type of file to search for.
26 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 26 attribute :file_type |
#follow ⇒ :yes, ...
Returns Set this to C(yes) to follow symlinks in the path.,This needs to be used in conjunction with C(recurse).
30 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 30 attribute :follow |
#get_checksum ⇒ :yes, ...
Returns Whether to return a checksum of the file in the return info (default sha1), use C(checksum_algorithm) to change from the default.
34 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 34 attribute :get_checksum |
#hidden ⇒ :yes, ...
Returns Set this to include hidden files or folders.
38 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 38 attribute :hidden |
#paths ⇒ Array<String>, String
Returns List of paths of directories to search for files or folders in. This can be supplied as a single path or a list of paths.
42 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 42 attribute :paths |
#patterns ⇒ Array<String>, ...
Returns One or more (powershell or regex) patterns to compare filenames with. The type of pattern matching is controlled by C(use_regex) option. The patterns retrict the list of files or folders to be returned based on the filenames. For a file to be matched it only has to match with one pattern in a list provided.
46 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 46 attribute :patterns |
#recurse ⇒ :yes, ...
Returns Will recursively descend into the directory looking for files or folders.
50 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 50 attribute :recurse |
#size ⇒ Integer, ...
Returns Select files or folders whose size is equal to or greater than the specified size. Use a negative value to find files equal to or less than the specified size. You can specify the size with a suffix of the byte type i.e. kilo = k, mega = m… Size is not evaluated for symbolic links.
54 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 54 attribute :size |
#use_regex ⇒ :yes, ...
Returns Will set patterns to run as a regex check if set to C(yes).
58 |
# File 'lib/ansible/ruby/modules/generated/windows/win_find.rb', line 58 attribute :use_regex |