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/extras/windows/win_uri.rb

Overview

Interacts with HTTP and HTTPS web services and supports Digest, Basic and WSSE HTTP authentication mechanisms.

Instance Method Summary

• #body ⇒ Object^?

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

• #content_type ⇒ Object^?

  Sets the “Content-Type” header.

• #headers ⇒ Object^?

  Key Value pairs for headers.

• #method ⇒ :GET, ...

  The HTTP Method of the request or response.

• #url ⇒ String^?

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

• #use_basic_parsing ⇒ Boolean^?

  This module relies upon ‘Invoke-WebRequest’, which by default uses the Internet Explorer Engine to parse a webpage.

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 ⇒ Object^?

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

Returns:

• (Object, nil) —

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

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

attribute :body

#content_type ⇒ Object^?

Returns Sets the “Content-Type” header.

Returns:

• (Object, nil) —

  Sets the “Content-Type” header.

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

attribute :content_type

#headers ⇒ Object^?

Returns Key Value pairs for headers. Example “Host: www.somesite.com”.

Returns:

• (Object, nil) —

  Key Value pairs for headers. Example “Host: www.somesite.com”

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

attribute :headers

#method ⇒ :GET, ...

Returns The HTTP Method of the request or response.

Returns:

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

  The HTTP Method of the request or response.

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

attribute :method

#url ⇒ String^?

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

Returns:

• (String, nil) —

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

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

attribute :url

#use_basic_parsing ⇒ Boolean^?

Returns This module relies upon ‘Invoke-WebRequest’, which by default uses the Internet Explorer Engine to parse a webpage. There’s an edge-case where if a user hasn’t run IE before, this will fail. The only advantage to using the Internet Explorer praser is that you can traverse the DOM in a powershell script. That isn’t useful for Ansible, so by default we toggle ‘UseBasicParsing’. However, you can toggle that off here.

Returns:

• (Boolean, nil) —

  This module relies upon ‘Invoke-WebRequest’, which by default uses the Internet Explorer Engine to parse a webpage. There’s an edge-case where if a user hasn’t run IE before, this will fail. The only advantage to using the Internet Explorer praser is that you can traverse the DOM in a powershell script. That isn’t useful for Ansible, so by default we toggle ‘UseBasicParsing’. However, you can toggle that off here.

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

attribute :use_basic_parsing