win_uri – Interacts with webservices

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
body
raw
The body of the HTTP request/response to the web service.
client_cert
string
added in 2.4
The path to the client certificate (.pfx) that is used for X509 authentication. This path can either be the path to the pfx on the filesystem or the PowerShell certificate path Cert:\CurrentUser\My\<thumbprint>.
The WinRM connection must be authenticated with CredSSP or become is used on the task if the certificate file is not password protected.
Other authentication types can set client_cert_password when the cert is password protected.
client_cert_password
string
added in 2.5
The password for client_cert if the cert is password protected.
content_type
string
Sets the "Content-Type" header.
creates
path
added in 2.4
A filename, when it already exists, this step will be skipped.
dest
path
Output the response body to a file.
follow_redirects
string
added in 2.4
    Choices:
  • all
  • none
  • safe ←
Whether or the module should follow redirects.
all will follow all redirect.
none will not follow any redirect.
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.
force_basic_auth
boolean
added in 2.5
    Choices:
  • no ←
  • yes
By default the authentication header is only sent when a webservice responses 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 original request.
headers
dictionary
Extra headers to set on the request.
This should be a dictionary where the key is the header name and the value is the value for that header.
http_agent
string
added in 2.9
Default:
"ansible-httpget"
Header to identify as, generally appears in web server logs.
This is set to the User-Agent header on a HTTP request.
maximum_redirection
integer
added in 2.4
Default:
50
Specify how many times the module will redirect a connection to an alternative URI before the connection fails.
If set to 0 or follow_redirects is set to none, or safe when not doing a GET or HEAD it prevents all redirection.
method
string
Default:
"GET"
The HTTP Method of the request or response.
proxy_password
string
added in 2.9
The password for proxy_username.
proxy_url
string
added in 2.9
An explicit proxy to use for the request.
By default, the request will use the IE defined proxy unless use_proxy is set to no.
proxy_use_default_credential
boolean
added in 2.9
    Choices:
  • no ←
  • yes
Uses the current user's credentials when authenticating with a proxy host protected with NTLM, Kerberos, or Negotiate authentication.
Proxies that use Basic auth will still require explicit credentials through the proxy_username and proxy_password options.
The module will only have access to the user's credentials if using become with a password, you are connecting with SSH using a password, or connecting with WinRM using CredSSP or Kerberos with delegation.
If not using become or a different auth method to the ones stated above, there will be no default credentials available and no proxy authentication will occur.
proxy_username
string
added in 2.9
The username to use for proxy authentication.
removes
path
added in 2.4
A filename, when it does not exist, this step will be skipped.
return_content
boolean
added in 2.4
    Choices:
  • no ←
  • yes
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 json in the dictionary results.
status_code
list / elements=integer
added in 2.4
Default:
[200]
A valid, numeric, HTTP status code that signifies success of the request.
Can also be comma separated list of status codes.
timeout
integer
added in 2.4
Default:
30
Specifies how long the request can be pending before it times out (in seconds).
Set to 0 to specify an infinite timeout.
url
string / required
Supports FTP, HTTP or HTTPS URLs in the form of (ftp|http|https)://host.domain:port/path.
url_password
string
added in 2.4
The password for url_username.
Was originally called password but was changed to url_password in Ansible 2.9.
The alias password is deprecated and will be removed in Ansible 2.14.

aliases: password
url_username
string
added in 2.4
The username to use for authentication.
Was originally called user but was changed to url_username in Ansible 2.9.
The aliases user and username are deprecated and will be removed in Ansible 2.14.

aliases: user, username
use_default_credential
boolean
added in 2.9
    Choices:
  • no ←
  • yes
Uses the current user's credentials when authenticating with a server protected with NTLM, Kerberos, or Negotiate authentication.
Sites that use Basic auth will still require explicit credentials through the url_username and url_password options.
The module will only have access to the user's credentials if using become with a password, you are connecting with SSH using a password, or connecting with WinRM using CredSSP or Kerberos with delegation.
If not using become or a different auth method to the ones stated above, there will be no default credentials available and no authentication will occur.
use_proxy
boolean
added in 2.9
    Choices:
  • no
  • yes ←
If no, it will not use the proxy defined in IE for the current user.
validate_certs
boolean
added in 2.4
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using self-signed certificates.

See Also

See also

uri – Interacts with webservices
The official documentation on the uri module.
win_get_url – Downloads file from HTTP, HTTPS, or FTP to node
The official documentation on the win_get_url module.
win_inet_proxy – Manages proxy settings for WinINet and Internet Explorer
The official documentation on the win_inet_proxy module.

Examples

- name: Perform a GET and Store Output
  win_uri:
    url: http://example.com/endpoint
  register: http_output

# Set a HOST header to hit an internal webserver:
- name: Hit a Specific Host on the Server
  win_uri:
    url: http://example.com/
    method: GET
    headers:
      host: www.somesite.com

- name: Perform a HEAD on an Endpoint
  win_uri:
    url: http://www.example.com/
    method: HEAD

- name: POST a Body to an Endpoint
  win_uri:
    url: http://www.somesite.com/
    method: POST
    body: "{ 'some': 'json' }"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
content
string
success and return_content is True
The raw content of the HTTP response.

Sample:
{"foo": "bar"}
content_length
integer
success
The byte size of the response.

Sample:
54447
elapsed
float
always
The number of seconds that elapsed while performing the download.

Sample:
23.2
json
dictionary
success and Content-Type is "application/json" or "application/javascript" and return_content is True
The json structure returned under content as a dictionary.

Sample:
{'this-is-dependent': 'on the actual return content'}
status_code
integer
success
The HTTP Status Code of the response.

Sample:
200
status_description
string
success
A summary of the status.

Sample:
OK
url
string
always
The Target URL.

Sample:
https://www.ansible.com


Status

Authors

  • Corwin Brown (@blakfeld)
  • Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.