summaryrefslogtreecommitdiff
path: root/windows/win_uri.py
diff options
context:
space:
mode:
authorCorwin Brown <blakfeld@d-cbrown.corp.maxpointinteractive.com>2015-10-13 09:47:56 -0500
committerCorwin Brown <blakfeld@d-cbrown.corp.maxpointinteractive.com>2015-10-13 09:47:56 -0500
commitc35c37258f0b46ef8cbecd8c38ffc733160fa019 (patch)
tree78a0c30ea2e11e4b6a031cf8c088eb37ba9fdcc5 /windows/win_uri.py
parent205115ea1fc85b99fd7e505b58e84db3a4377f5f (diff)
downloadansible-modules-extras-c35c37258f0b46ef8cbecd8c38ffc733160fa019.tar.gz
Adding win_uri module
Diffstat (limited to 'windows/win_uri.py')
-rw-r--r--windows/win_uri.py93
1 files changed, 93 insertions, 0 deletions
diff --git a/windows/win_uri.py b/windows/win_uri.py
new file mode 100644
index 00000000..451c9658
--- /dev/null
+++ b/windows/win_uri.py
@@ -0,0 +1,93 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2015, Corwin Brown <blakfeld@gmail.com>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
+
+# this is a windows documentation stub. actual code lives in the .ps1
+# file of the same name
+
+DOCUMENTATION = """
+---
+module: win_uri
+version_added: ""
+short_description: Interacts with webservices.
+description:
+ - Interacts with HTTP and HTTPS services.
+options:
+ url:
+ description:
+ - HTTP or HTTPS URL in the form of (http|https)://host.domain:port/path
+ method:
+ description:
+ - The HTTP Method of the request or response.
+ default: GET
+ choices:
+ - GET
+ - POST
+ - PUT
+ - HEAD
+ - DELETE
+ - OPTIONS
+ - PATCH
+ - TRACE
+ - CONNECT
+ - REFRESH
+ content_type:
+ description:
+ - Sets the "Content-Type" header.
+ body:
+ description:
+ - The body of the HTTP request/response to the web service.
+ headers:
+ description:
+ - Key Value pairs for headers. Example "Host: www.somesite.com"
+author: Corwin Brown
+"""
+
+Examples= """
+# Send a GET request and store the output:
+---
+- name: Perform a GET and Store Output
+ win_uri:
+ url: http://www.somesite.com/myendpoint
+ register: http_output
+
+# Set a HOST header to hit an internal webserver:
+---
+- name: Hit a Specific Host on the Server
+ win_uri:
+ url: http://my.internal.server.com
+ method: GET
+ headers:
+ host: "www.somesite.com
+
+# Do a HEAD request on an endpoint
+---
+- name: Perform a HEAD on an Endpoint
+ win_uri:
+ url: http://www.somesite.com
+ method: HEAD
+
+# Post a body to an endpoint
+---
+- name: POST a Body to an Endpoint
+ win_uri:
+ url: http://www.somesite.com
+ method: POST
+ body: "{ 'some': 'json' }"
+"""