Class: Ansible::Ruby::Modules::Find

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/files/find.rb

Overview

Return a list files based on specific criteria. Multiple criteria are AND’d together.

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

#age ⇒ String?

Returns Select files 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 any of those words (e.g., “1w”).

Returns:

  • (String, nil) —

    Select files 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 any of those words (e.g., “1w”).



11
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 11

attribute :age

#age_stamp ⇒ :atime, ...

Returns Choose the file property against which we compare age. Default is mtime.

Returns:

  • (:atime, :mtime, :ctime, nil) —

    Choose the file property against which we compare age. Default is mtime.



38
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 38

attribute :age_stamp

#contains ⇒ Object?

Returns One or more re patterns which should be matched against the file content.

Returns:

  • (Object, nil) —

    One or more re patterns which should be matched against the file content



19
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 19

attribute :contains

#file_type ⇒ :file, ...

Returns Type of file to select.

Returns:

  • (:file, :directory, nil) —

    Type of file to select



26
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 26

attribute :file_type

#follow ⇒ Boolean?

Returns Set this to true to follow symlinks in path for systems with python 2.6+.

Returns:

  • (Boolean, nil) —

    Set this to true to follow symlinks in path for systems with python 2.6+



46
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 46

attribute :follow

#get_checksum ⇒ Boolean?

Returns Set this to true to retrieve a file’s sha1 checksum.

Returns:

  • (Boolean, nil) —

    Set this to true to retrieve a file’s sha1 checksum



50
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 50

attribute :get_checksum

#hidden ⇒ Boolean?

Returns Set this to true to include hidden files, otherwise they’ll be ignored.

Returns:

  • (Boolean, nil) —

    Set this to true to include hidden files, otherwise they’ll be ignored.



42
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 42

attribute :hidden

#paths ⇒ String

Returns List of paths to the file or directory to search. All paths must be fully qualified.

Returns:

  • (String) —

    List of paths to the file or directory to search. All paths must be fully qualified.



22
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 22

attribute :paths

#patterns ⇒ String?

Returns One or more (shell or regex) patterns, which type is controled by C(use_regex) option.,The patterns restrict the list of files to be returned to those whose basenames match at least one of the patterns specified. Multiple patterns can be specified using a list.

Returns:

  • (String, nil) —

    One or more (shell or regex) patterns, which type is controled by C(use_regex) option.,The patterns restrict the list of files to be returned to those whose basenames match at least one of the patterns specified. Multiple patterns can be specified using a list.



15
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 15

attribute :patterns

#recurse ⇒ :yes, ...

Returns If target is a directory, recursively descend into the directory looking for files.

Returns:

  • (:yes, :no, nil) —

    If target is a directory, recursively descend into the directory looking for files.



30
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 30

attribute :recurse

#size ⇒ String?

Returns Select files whose size is equal to or greater than the specified size. Use a negative size to find files equal to or less than the specified size. Unqualified values are in bytes, but b, k, m, g, and t can be appended to specify bytes, kilobytes, megabytes, gigabytes, and terabytes, respectively. Size is not evaluated for directories.

Returns:

  • (String, nil) —

    Select files whose size is equal to or greater than the specified size. Use a negative size to find files equal to or less than the specified size. Unqualified values are in bytes, but b, k, m, g, and t can be appended to specify bytes, kilobytes, megabytes, gigabytes, and terabytes, respectively. Size is not evaluated for directories.



34
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 34

attribute :size

#use_regex ⇒ Boolean?

Returns If false the patterns are file globs (shell) if true they are python regexes.

Returns:

  • (Boolean, nil) —

    If false the patterns are file globs (shell) if true they are python regexes



54
 
# File 'lib/ansible/ruby/modules/generated/core/files/find.rb', line 54

attribute :use_regex