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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb

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, #to_h, validates

Constructor Details

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

Instance Method Details

#backup ⇒ :yes, ...

Returns Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.

Returns:

  • (:yes, :no, nil) —

    Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.



26
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 26

attribute :backup

#checksum ⇒ String?

Returns If a checksum is passed to this parameter, the digest of the destination file will be calculated after it is downloaded to ensure its integrity and verify that the transfer completed successfully. Format: <algorithm>:<checksum>, e.g.: checksum=“sha256:D98291ACB6DC7B97“ If you worry about portability, only the sha1 algorithm is available on all platforms and python versions. The third party hashlib library can be installed for access to additional algorithms. Additionaly, if a checksum is passed to this parameter, and the file exist under the C(dest) location, the destination_checksum would be calculated, and if checksum equals destination_checksum, the file download would be skipped (unless C(force) is true).

Returns:

  • (String, nil) —

    If a checksum is passed to this parameter, the digest of the destination file will be calculated after it is downloaded to ensure its integrity and verify that the transfer completed successfully. Format: <algorithm>:<checksum>, e.g.: checksum=“sha256:D98291ACB6DC7B97“ If you worry about portability, only the sha1 algorithm is available on all platforms and python versions. The third party hashlib library can be installed for access to additional algorithms. Additionaly, if a checksum is passed to this parameter, and the file exist under the C(dest) location, the destination_checksum would be calculated, and if checksum equals destination_checksum, the file download would be skipped (unless C(force) is true).



33
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 33

attribute :checksum

#dest ⇒ String

Returns absolute path of where to download the file to.,If C(dest) is a directory, either the server provided filename or, if none provided, the base name of the URL on the remote server will be used. If a directory, C(force) has no effect. If C(dest) is a directory, the file will always be downloaded (regardless of the force option), but replaced only if the contents changed.

Returns:

  • (String) —

    absolute path of where to download the file to.,If C(dest) is a directory, either the server provided filename or, if none provided, the base name of the URL on the remote server will be used. If a directory, C(force) has no effect. If C(dest) is a directory, the file will always be downloaded (regardless of the force option), but replaced only if the contents changed.



14
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 14

attribute :dest

#force ⇒ :yes, ...

Returns If C(yes) and C(dest) is not a directory, will download the file every time and replace the file if the contents change. If C(no), the file will only be downloaded if the destination does not exist. Generally should be C(yes) only for small local files. Prior to 0.6, this module behaved as if C(yes) was the default.

Returns:

  • (:yes, :no, nil) —

    If C(yes) and C(dest) is not a directory, will download the file every time and replace the file if the contents change. If C(no), the file will only be downloaded if the destination does not exist. Generally should be C(yes) only for small local files. Prior to 0.6, this module behaved as if C(yes) was the default.



22
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 22

attribute :force

#force_basic_auth ⇒ :yes, ...

Returns httplib2, the library used by the uri module only sends authentication information when a webservice responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request.

Returns:

  • (:yes, :no, nil) —

    httplib2, the library used by the uri module only sends authentication information when a webservice responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request.



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

attribute :force_basic_auth

#headers ⇒ Array<String>, ...

Returns Add custom HTTP headers to a request in the format “key:value,key:value”.

Returns:

  • (Array<String>, String, nil) —

    Add custom HTTP headers to a request in the format “key:value,key:value”



49
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 49

attribute :headers

#others ⇒ Object?

Returns all arguments accepted by the M(file) module also work here.

Returns:

  • (Object, nil) —

    all arguments accepted by the M(file) module also work here



63
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 63

attribute :others

#sha256sum ⇒ Object?

Returns If a SHA-256 checksum is passed to this parameter, the digest of the destination file will be calculated after it is downloaded to ensure its integrity and verify that the transfer completed successfully. This option is deprecated. Use ‘checksum’.

Returns:

  • (Object, nil) —

    If a SHA-256 checksum is passed to this parameter, the digest of the destination file will be calculated after it is downloaded to ensure its integrity and verify that the transfer completed successfully. This option is deprecated. Use ‘checksum’.



30
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 30

attribute :sha256sum

#timeout ⇒ Integer?

Returns Timeout in seconds for URL request.

Returns:

  • (Integer, nil) —

    Timeout in seconds for URL request



45
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 45

attribute :timeout

#tmp_dest ⇒ String?

Returns absolute path of where temporary file is downloaded to.,Defaults to TMPDIR, TEMP or TMP env variables or a platform specific value,docs.python.org/2/library/tempfile.html#tempfile.tempdir.

Returns:



18
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 18

attribute :tmp_dest

#url ⇒ String

Returns HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user]@host.domain/path.

Returns:



10
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 10

attribute :url

#url_password ⇒ Object?

Returns The password for use in HTTP basic authentication. If the C(url_username) parameter is not specified, the C(url_password) parameter will not be used.

Returns:

  • (Object, nil) —

    The password for use in HTTP basic authentication. If the C(url_username) parameter is not specified, the C(url_password) parameter will not be used.



56
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 56

attribute :url_password

#url_username ⇒ Object?

Returns The username for use in HTTP basic authentication. This parameter can be used without C(url_password) for sites that allow empty passwords.

Returns:

  • (Object, nil) —

    The username for use in HTTP basic authentication. This parameter can be used without C(url_password) for sites that allow empty passwords.



53
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 53

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.



37
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 37

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.

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.



41
 
# File 'lib/ansible/ruby/modules/generated/core/network/basics/get_url.rb', line 41

attribute :validate_certs