Class: Ansible::Ruby::Modules::Win_uri

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/windows/win_uri.rb

Overview

Interacts with FTP, HTTP and HTTPS web services. Supports Digest, Basic and WSSE HTTP authentication mechanisms. For non-Windows targets, use the M(uri) module instead.

Instance Method Summary

• #body ⇒ String^?

  The body of the HTTP request/response to the web service.

• #client_cert ⇒ String^?

  Specifies the client certificate (.pfx) that is used for a secure web request.,The WinRM connection must be authenticated with C(CredSSP) if the certificate file is not password protected.,Other authentication types can set I(client_cert_password) when the cert is password protected.

• #client_cert_password ⇒ Object^?

  The password for the client certificate (.pfx) file that is used for a secure web request.

• #content_type ⇒ Object^?

  Sets the “Content-Type” header.

• #creates ⇒ String^?

  A filename, when it already exists, this step will be skipped.

• #dest ⇒ String^?

  Output the response body to a file.

• #follow_redirects ⇒ :all, ...

  Whether or not the C(win_uri) module should follow redirects.,C(all) will follow all redirects.,C(none) will not follow any redirects.,C(safe) will follow only “safe” redirects, where “safe” means that the client is only doing a C(GET) or C(HEAD) on the URI to which it is being redirected.

• #force_basic_auth ⇒ :yes, ...

  By default the authentication information is only sent when a webservice responds to an initial request with a 401 status.

• #headers ⇒ Hash^?

  Extra headers to set on the request, see the examples for more details on how to set this.

• #maximum_redirection ⇒ Integer^?

  Specifies how many times C(win_uri) redirects a connection to an alternate Uniform Resource Identifier (URI) before the connection fails.,If C(maximum_redirection) is set to 0 (zero) or C(follow_redirects) is set to C(none), or set to C(safe) when not doing C(GET) or C(HEAD) it prevents all redirection.

• #method ⇒ :CONNECT, ...

  The HTTP Method of the request or response.

• #password ⇒ Object^?

  Password to use for authentication.

• #removes ⇒ String^?

  A filename, when it does not exist, this step will be skipped.

• #return_content ⇒ :yes, ...

  Whether or not to return the body of the response as a “content” key in the dictionary result.

• #status_code ⇒ Array<String>, ...

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

• #timeout ⇒ Integer^?

  Specifies how long the request can be pending before it times out (in seconds).,The value 0 (zero) specifies an indefinite time-out.,A Domain Name System (DNS) query can take up to 15 seconds to return or time out.

• #url ⇒ String

  Supports FTP, HTTP or HTTPS URLs in the form of (ftp|http|https)://host.domain:port/path.

• #user ⇒ Object^?

  Username to use for authentication.

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

Constructor Details

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

Instance Method Details

#body ⇒ String^?

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

attribute :body

#client_cert ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 79

attribute :client_cert

#client_cert_password ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 83

attribute :client_cert_password

#content_type ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 22

attribute :content_type

#creates ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 47

attribute :creates

#dest ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 39

attribute :dest

#follow_redirects ⇒ :all, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 67

attribute :follow_redirects

#force_basic_auth ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 35

attribute :force_basic_auth

#headers ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 43

attribute :headers

#maximum_redirection ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 71

attribute :maximum_redirection

#method ⇒ :CONNECT, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 18

attribute :method

#password ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 32

attribute :password

#removes ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 51

attribute :removes

#return_content ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 55

attribute :return_content

#status_code ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 59

attribute :status_code

#timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 63

attribute :timeout

#url ⇒ String

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 14

attribute :url

#user ⇒ Object^?

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

attribute :user

#validate_certs ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_uri.rb', line 75

attribute :validate_certs