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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Win_get_url

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

• #dest ⇒ String

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

• #force ⇒ :yes, ...

  If C(yes), will always download the file.

• #force_basic_auth ⇒ :yes, ...

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

• #headers ⇒ Hash^?

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

• #proxy_password ⇒ String^?

  Proxy authentication password.

• #proxy_url ⇒ String^?

  The full URL of the proxy server to download through.

• #proxy_username ⇒ String^?

  Proxy authentication username.

• #skip_certificate_validation ⇒ :yes, ...

  This option is deprecated since v2.4, please use C(validate_certs) instead.,If C(yes), SSL certificates will not be validated.

• #timeout ⇒ Integer^?

  Timeout in seconds for URL request.

• #url ⇒ String

  The full URL of a file to download.

• #url_password ⇒ String^?

  Basic authentication password.

• #url_username ⇒ String^?

  Basic authentication username.

• #use_proxy ⇒ :yes, ...

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

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates will not be validated.

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

#dest ⇒ String

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

attribute :dest

#force ⇒ :yes, ...

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

attribute :force

#force_basic_auth ⇒ :yes, ...

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

attribute :force_basic_auth

#headers ⇒ Hash^?

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

attribute :headers

#proxy_password ⇒ String^?

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

attribute :proxy_password

#proxy_url ⇒ String^?

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

attribute :proxy_url

#proxy_username ⇒ String^?

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

attribute :proxy_username

#skip_certificate_validation ⇒ :yes, ...

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

attribute :skip_certificate_validation

#timeout ⇒ Integer^?

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

attribute :timeout

#url ⇒ String

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

attribute :url

#url_password ⇒ String^?

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

attribute :url_password

#url_username ⇒ String^?

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

attribute :url_username

#use_proxy ⇒ :yes, ...

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

attribute :use_proxy

#validate_certs ⇒ :yes, ...

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

attribute :validate_certs