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

Inherits:
Base show all
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 collapse

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

#body ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :body

#client_cert ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :client_cert

#client_cert_password ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :client_cert_password

#content_type ⇒ Object?

Returns Sets the “Content-Type” header.

Returns:

  • (Object, nil) —

    Sets the “Content-Type” header.



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

attribute :content_type

#creates ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :creates

#dest ⇒ String?

Returns Output the response body to a file.

Returns:

  • (String, nil) —

    Output the response body to a file.



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

attribute :dest

#follow_redirects ⇒ :all, ...

Returns 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.

Returns:

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

    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.



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

attribute :follow_redirects

#force_basic_auth ⇒ :yes, ...

Returns By default the authentication information is only sent 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 the initial request.

Returns:

  • (:yes, :no, nil) —

    By default the authentication information is only sent 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 the initial request.



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

attribute :force_basic_auth

#headers ⇒ Hash?

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

Returns:

  • (Hash, nil) —

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



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

attribute :headers

#maximum_redirection ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



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

attribute :maximum_redirection

#method ⇒ :CONNECT, ...

Returns The HTTP Method of the request or response.

Returns:

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

    The HTTP Method of the request or response.



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

attribute :method

#password ⇒ Object?

Returns Password to use for authentication.

Returns:

  • (Object, nil) —

    Password to use for authentication.



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

attribute :password

#removes ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :removes

#return_content ⇒ :yes, ...

Returns Whether or not to return the body of the response 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 response 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.



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

attribute :return_content

#status_code ⇒ Array<String>, ...

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

Returns:

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

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



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

attribute :status_code

#timeout ⇒ Integer?

Returns 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. If your request contains a host name that requires resolution, and you set C(timeout) to a value greater than zero, but less than 15 seconds, it can take 15 seconds or more before your request times out.

Returns:

  • (Integer, nil) —

    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. If your request contains a host name that requires resolution, and you set C(timeout) to a value greater than zero, but less than 15 seconds, it can take 15 seconds or more before your request times out.



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

attribute :timeout

#url ⇒ String

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

Returns:

  • (String) —

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



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

attribute :url

#user ⇒ Object?

Returns Username to use for authentication.

Returns:

  • (Object, nil) —

    Username to use for authentication.



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

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.

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.



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

attribute :validate_certs