Class: Ansible::Ruby::Modules::Get_url

Inherits:
Base show all
Includes:
Helpers::FileAttributes
Defined in:
lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb,
lib/ansible/ruby/modules/custom/net_tools/basics/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. By default, if an environment variable C(<protocol>_proxy) is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see ‘setting the environment <docs.ansible.com/playbooks_environment.html>`_), or by using the use_proxy option. HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct. From Ansible 2.4 when run with C(–check), it will do a HEAD request to validate the URL but will not download the entire file or verify it against hashes. For Windows targets, use the M(win_get_url) module instead.

Instance Method Summary collapse

Methods included from Helpers::FileAttributes

included

Methods inherited from Base

#ansible_name

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

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

Constructor Details

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

Instance Method Details

#backup ⇒ :yes, ... 



31
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 31

attribute :backup

#checksum ⇒ String? 



39
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 39

attribute :checksum

#client_cert ⇒ Object? 



69
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 69

attribute :client_cert

#client_key ⇒ Object? 



72
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 72

attribute :client_key

#dest ⇒ String 



20
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 20

attribute :dest

#force ⇒ :yes, ... 



27
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 27

attribute :force

#force_basic_auth ⇒ :yes, ... 



65
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 65

attribute :force_basic_auth

#headers ⇒ Hash? 



55
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 55

attribute :headers

#others ⇒ Object? 



75
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 75

attribute :others

#sha256sum ⇒ String? 



35
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 35

attribute :sha256sum

#timeout ⇒ Integer? 



51
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 51

attribute :timeout

#tmp_dest ⇒ Object? 



24
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 24

attribute :tmp_dest

#to_h ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/ansible/ruby/modules/custom/net_tools/basics/get_url.rb', line 14

def to_h
  result = super
  data = result[:get_url]
  # Ansible expects a string for some reason
  if data.include? :headers
    data[:headers] = data[:headers].map do |key, value|
      "#{key}:#{value}"
    end.join ','
  end
  result
end

#url ⇒ String 



16
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 16

attribute :url

#url_password ⇒ Object? 



62
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 62

attribute :url_password

#url_username ⇒ Object? 



59
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 59

attribute :url_username

#use_proxy ⇒ :yes, ... 



43
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 43

attribute :use_proxy

#validate_certs ⇒ :yes, ... 



47
 
# File 'lib/ansible/ruby/modules/generated/net_tools/basics/get_url.rb', line 47

attribute :validate_certs