Class: Ansible::Ruby::Modules::Win_get_url

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

Overview

Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server I(must) have direct access to the remote resource. For non-Windows targets, use the M(get_url) 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, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#dest ⇒ String

Returns The location to save the file at the URL.,Be sure to include a filename and extension as appropriate.

Returns:

  • (String) —

    The location to save the file at the URL.,Be sure to include a filename and extension as appropriate.



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

attribute :dest

#force ⇒ :yes, ...

Returns If C(yes), will always download the file. If C(no), will only download the file if it does not exist or the remote file has been modified more recently than the local file.,This works by sending an http HEAD request to retrieve last modified time of the requested resource, so for this to work, the remote web server must support HEAD requests.

Returns:

  • (:yes, :no, nil) —

    If C(yes), will always download the file. If C(no), will only download the file if it does not exist or the remote file has been modified more recently than the local file.,This works by sending an http HEAD request to retrieve last modified time of the requested resource, so for this to work, the remote web server must support HEAD requests.



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

attribute :force

#force_basic_auth ⇒ :yes, ...

Returns If C(yes), will add a Basic authentication header on the initial request.,If C(no), will use Microsoft’s WebClient to handle authentication.

Returns:

  • (:yes, :no, nil) —

    If C(yes), will add a Basic authentication header on the initial request.,If C(no), will use Microsoft’s WebClient to handle authentication.



37
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 37

attribute :force_basic_auth

#headers ⇒ Hash?

Returns Add custom HTTP headers to a request (as a dictionary).

Returns:

  • (Hash, nil) —

    Add custom HTTP headers to a request (as a dictionary).



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

attribute :headers

#proxy_password ⇒ String?

Returns Proxy authentication password.

Returns:

  • (String, nil) —

    Proxy authentication password.



57
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 57

attribute :proxy_password

#proxy_url ⇒ String?

Returns The full URL of the proxy server to download through.

Returns:

  • (String, nil) —

    The full URL of the proxy server to download through.



49
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 49

attribute :proxy_url

#proxy_username ⇒ String?

Returns Proxy authentication username.

Returns:

  • (String, nil) —

    Proxy authentication username.



53
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 53

attribute :proxy_username

#skip_certificate_validation ⇒ :yes, ...

Returns This option is deprecated since v2.4, please use C(validate_certs) instead.,If C(yes), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

  • (:yes, :no, nil) —

    This option is deprecated since v2.4, please use C(validate_certs) instead.,If C(yes), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.



41
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 41

attribute :skip_certificate_validation

#timeout ⇒ Integer?

Returns Timeout in seconds for URL request.

Returns:

  • (Integer, nil) —

    Timeout in seconds for URL request.



65
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 65

attribute :timeout

#url ⇒ String

Returns The full URL of a file to download.

Returns:

  • (String) —

    The full URL of a file to download.



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

attribute :url

#url_password ⇒ String?

Returns Basic authentication password.

Returns:

  • (String, nil) —

    Basic authentication password.



33
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 33

attribute :url_password

#url_username ⇒ String?

Returns Basic authentication username.

Returns:

  • (String, nil) —

    Basic authentication username.



29
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 29

attribute :url_username

#use_proxy ⇒ :yes, ...

Returns If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Returns:

  • (:yes, :no, nil) —

    If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.



61
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 61

attribute :use_proxy

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.,If C(skip_certificate_validation) was set, it overrides this option.

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.,If C(skip_certificate_validation) was set, it overrides this option.



45
 
# File 'lib/ansible/ruby/modules/generated/windows/win_get_url.rb', line 45

attribute :validate_certs