Class: Ansible::Ruby::Modules::Win_stat

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

Overview

Returns information about a Windows file. For non-Windows targets, use the M(stat) module instead.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#checksum_algorithm ⇒ :md5, ...

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

Returns:

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

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



25
 
# File 'lib/ansible/ruby/modules/generated/windows/win_stat.rb', line 25

attribute :checksum_algorithm

#get_checksum ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



21
 
# File 'lib/ansible/ruby/modules/generated/windows/win_stat.rb', line 21

attribute :get_checksum

#get_md5 ⇒ :yes, ...

Returns Whether to return the checksum sum of the file. Between Ansible 1.9 and 2.2 this is no longer an MD5, but a SHA1 instead. As of Ansible 2.3 this is back to an MD5. Will return None if host is unable to use specified algorithm.,The default of this option changed from C(yes) to C(no) in Ansible 2.5 and will be removed altogether in Ansible 2.9.,Use C(get_checksum=true) with C(checksum_algorithm=md5) to return an md5 hash under the C(checksum) return value.

Returns:

  • (:yes, :no, nil) —

    Whether to return the checksum sum of the file. Between Ansible 1.9 and 2.2 this is no longer an MD5, but a SHA1 instead. As of Ansible 2.3 this is back to an MD5. Will return None if host is unable to use specified algorithm.,The default of this option changed from C(yes) to C(no) in Ansible 2.5 and will be removed altogether in Ansible 2.9.,Use C(get_checksum=true) with C(checksum_algorithm=md5) to return an md5 hash under the C(checksum) return value.



17
 
# File 'lib/ansible/ruby/modules/generated/windows/win_stat.rb', line 17

attribute :get_md5

#path ⇒ String

Returns The full path of the file/object to get the facts of; both forward and back slashes are accepted.

Returns:

  • (String) —

    The full path of the file/object to get the facts of; both forward and back slashes are accepted.



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_stat.rb', line 13

attribute :path