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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb

Overview

Interacts with HTTP and HTTPS web services and supports Digest, Basic and WSSE HTTP authentication mechanisms. For Windows targets, use the M(win_uri) module instead.

Instance Method Summary

• #body ⇒ String, ...

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

• #body_format ⇒ :"form-urlencoded", ...

  The serialization format of the body.

• #client_cert ⇒ Object^?

  PEM formatted certificate chain file to be used for SSL client authentication.

• #client_key ⇒ Object^?

  PEM formatted file that contains your private key to be used for SSL client authentication.

• #creates ⇒ Object^?

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

• #dest ⇒ Object^?

  A path of where to download the file to (if desired).

• #follow_redirects ⇒ :all, ...

  Whether or not the URI module should follow redirects.

• #force_basic_auth ⇒ :yes, ...

  The library used by the uri module only sends authentication information when a webservice responds to an initial request with a 401 status.

• #headers ⇒ Hash^?

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

• #method ⇒ :GET, ...

  The HTTP method of the request or response.

• #others ⇒ Object^?

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

• #password ⇒ String^?

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

• #remote_src ⇒ :yes, ...

  If C(no), the module will search for src on originating/master machine, if C(yes) the module will use the C(src) path on the remote/target machine.

• #removes ⇒ Object^?

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

• #return_content ⇒ :yes, ...

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

• #src ⇒ String^?

  Path to file to be submitted to the remote server.

• #status_code ⇒ Integer^?

  A list of valid, numeric, HTTP status codes that signifies success of the request.

• #timeout ⇒ Integer^?

  The socket level timeout in seconds.

• #url ⇒ String

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

• #user ⇒ String^?

  A username for the module to use for Digest, Basic or WSSE 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/net_tools/basics/uri.rb', line 28

attribute :body

#body_format ⇒ :"form-urlencoded", ...

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 32

attribute :body_format

#client_cert ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 80

attribute :client_cert

#client_key ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 83

attribute :client_key

#creates ⇒ Object^?

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

attribute :creates

#dest ⇒ Object^?

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

attribute :dest

#follow_redirects ⇒ :all, ...

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 48

attribute :follow_redirects

#force_basic_auth ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 44

attribute :force_basic_auth

#headers ⇒ Hash^?

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

attribute :headers

#method ⇒ :GET, ...

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 36

attribute :method

#others ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 73

attribute :others

#password ⇒ String^?

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

attribute :password

#remote_src ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 90

attribute :remote_src

#removes ⇒ Object^?

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

attribute :removes

#return_content ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 40

attribute :return_content

#src ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 86

attribute :src

#status_code ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 58

attribute :status_code

#timeout ⇒ Integer^?

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

attribute :timeout

#url ⇒ String

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 13

attribute :url

#user ⇒ String^?

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

attribute :user

#validate_certs ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/net_tools/basics/uri.rb', line 76

attribute :validate_certs