Class: Ansible::Ruby::Modules::Stat

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

Overview

Retrieves facts for a file similar to the linux/unix ‘stat’ command.

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

#checksum_algorithm ⇒ :sha1, ...

Returns Algorithm to determine checksum of file. Will throw an error if the host is unable to use specified algorithm.

Returns:

  • (:sha1, :sha224, :sha256, :sha384, :sha512, nil) —

    Algorithm to determine checksum of file. Will throw an error if the host is unable to use specified algorithm.



27
 
# File 'lib/ansible/ruby/modules/generated/core/files/stat.rb', line 27

attribute :checksum_algorithm

#follow ⇒ Boolean?

Returns Whether to follow symlinks.

Returns:

  • (Boolean, nil) —

    Whether to follow symlinks



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

attribute :follow

#get_checksum ⇒ Boolean?

Returns Whether to return a checksum of the file (default sha1).

Returns:

  • (Boolean, nil) —

    Whether to return a checksum of the file (default sha1)



23
 
# File 'lib/ansible/ruby/modules/generated/core/files/stat.rb', line 23

attribute :get_checksum

#get_md5 ⇒ Boolean?

Returns Whether to return the md5 sum of the file. Will return None if we’re unable to use md5 (Common for FIPS-140 compliant systems).

Returns:

  • (Boolean, nil) —

    Whether to return the md5 sum of the file. Will return None if we’re unable to use md5 (Common for FIPS-140 compliant systems)



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

attribute :get_md5

#mime ⇒ Boolean?

Returns Use file magic and return data about the nature of the file. this uses the ‘file’ utility found on most Linux/Unix systems.,This will add both ‘mime_type` and ’charset’ fields to the return, if possible.

Returns:

  • (Boolean, nil) —

    Use file magic and return data about the nature of the file. this uses the ‘file’ utility found on most Linux/Unix systems.,This will add both ‘mime_type` and ’charset’ fields to the return, if possible.



31
 
# File 'lib/ansible/ruby/modules/generated/core/files/stat.rb', line 31

attribute :mime

#path ⇒ String

Returns The full path of the file/object to get the facts of.

Returns:

  • (String) —

    The full path of the file/object to get the facts of



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

attribute :path