Class: Ansible::Ruby::Modules::Uri

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

Instance Method Summary collapse

Methods inherited from Base

#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

#body ⇒ String?

Returns The body of the http request/response to the web service. If C(body_format) is set to ‘json’ it will take an already formated JSON string or convert a data structure into JSON.

Returns:

  • (String, nil) —

    The body of the http request/response to the web service. If C(body_format) is set to ‘json’ it will take an already formated JSON string or convert a data structure into JSON.



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

attribute :body

#body_format ⇒ :raw, ...

Returns The serialization format of the body. When set to json, encodes the body argument, if needed, and automatically sets the Content-Type header accordingly.

Returns:

  • (:raw, :json, nil) —

    The serialization format of the body. When set to json, encodes the body argument, if needed, and automatically sets the Content-Type header accordingly.



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

attribute :body_format

#creates ⇒ Object?

Returns a filename, when it already exists, this step will not be run.

Returns:

  • (Object, nil) —

    a filename, when it already exists, this step will not be run.



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

attribute :creates

#dest ⇒ Object?

Returns path of where to download the file to (if desired). If I(dest) is a directory, the basename of the file on the remote server will be used.

Returns:

  • (Object, nil) —

    path of where to download the file to (if desired). If I(dest) is a directory, the basename of the file on the remote server will be used.



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

attribute :dest

#follow_redirects ⇒ :all, ...

Returns Whether or not the URI module should follow redirects. C(all) will follow all redirects. C(safe) will follow only “safe” redirects, where “safe” means that the client is only doing a GET or HEAD on the URI to which it is being redirected. C(none) will not follow any redirects. Note that C(yes) and C(no) choices are accepted for backwards compatibility, where C(yes) is the equivalent of C(all) and C(no) is the equivalent of C(safe). C(yes) and C(no) are deprecated and will be removed in some future version of Ansible.

Returns:

  • (:all, :safe, :none, nil) —

    Whether or not the URI module should follow redirects. C(all) will follow all redirects. C(safe) will follow only “safe” redirects, where “safe” means that the client is only doing a GET or HEAD on the URI to which it is being redirected. C(none) will not follow any redirects. Note that C(yes) and C(no) choices are accepted for backwards compatibility, where C(yes) is the equivalent of C(all) and C(no) is the equivalent of C(safe). C(yes) and C(no) are deprecated and will be removed in some future version of Ansible.



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

attribute :follow_redirects

#force_basic_auth ⇒ :yes, ...

Returns 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) —

    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.



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

attribute :force_basic_auth

#headers ⇒ Object?

Returns Add custom HTTP headers to a request in the format of a YAML hash.

Returns:

  • (Object, nil) —

    Add custom HTTP headers to a request in the format of a YAML hash



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

attribute :headers

#method ⇒ :GET, ...

Returns The HTTP method of the request or response. It MUST be uppercase.

Returns:

  • (:GET, :POST, :PUT, :HEAD, :DELETE, :OPTIONS, :PATCH, :TRACE, :CONNECT, :REFRESH, nil) —

    The HTTP method of the request or response. It MUST be uppercase.



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

attribute :method

#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



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

attribute :others

#password ⇒ String?

Returns password for the module to use for Digest, Basic or WSSE authentication.

Returns:

  • (String, nil) —

    password for the module to use for Digest, Basic or WSSE authentication.



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

attribute :password

#removes ⇒ Object?

Returns a filename, when it does not exist, this step will not be run.

Returns:

  • (Object, nil) —

    a filename, when it does not exist, this step will not be run.



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

attribute :removes

#return_content ⇒ :yes, ...

Returns Whether or not to return the body of the request as a “content” key in the dictionary result. If the reported Content-type is “application/json”, then the JSON is additionally loaded into a key called C(json) in the dictionary results.

Returns:

  • (:yes, :no, nil) —

    Whether or not to return the body of the request as a “content” key in the dictionary result. If the reported Content-type is “application/json”, then the JSON is additionally loaded into a key called C(json) in the dictionary results.



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

attribute :return_content

#status_code ⇒ Integer?

Returns A valid, numeric, HTTP status code that signifies success of the request. Can also be comma separated list of status codes.

Returns:

  • (Integer, nil) —

    A valid, numeric, HTTP status code that signifies success of the request. Can also be comma separated list of status codes.



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

attribute :status_code

#timeout ⇒ Integer?

Returns The socket level timeout in seconds.

Returns:

  • (Integer, nil) —

    The socket level timeout in seconds



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

attribute :timeout

#url ⇒ String

Returns HTTP or HTTPS URL in the form (http|https)://host.domain/path.

Returns:



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

attribute :url

#user ⇒ String?

Returns username for the module to use for Digest, Basic or WSSE authentication.

Returns:

  • (String, nil) —

    username for the module to use for Digest, Basic or WSSE authentication.



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

attribute :user

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only set to C(no) used on personally controlled sites using self-signed certificates. Prior to 1.9.2 the code defaulted to C(no).

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only set to C(no) used on personally controlled sites using self-signed certificates. Prior to 1.9.2 the code defaulted to C(no).



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

attribute :validate_certs