summaryrefslogtreecommitdiff
path: root/windows/win_iis_virtualdirectory.py
diff options
context:
space:
mode:
authorHenrik Wallström <henrik@wallstroms.nu>2015-10-19 16:04:17 +0200
committerHenrik Wallström <henrik@wallstroms.nu>2015-10-19 16:04:17 +0200
commit918f3fa3290f2917187929ffb1b0c9dd35055e0f (patch)
tree476948a7f486433e29da837dbb6dd2214c549827 /windows/win_iis_virtualdirectory.py
parent7ca42c0bc077ca03dd0d6cd157d67cf567501498 (diff)
downloadansible-modules-extras-918f3fa3290f2917187929ffb1b0c9dd35055e0f.tar.gz
Adds examples for win_iis_virtualdirectory
Diffstat (limited to 'windows/win_iis_virtualdirectory.py')
-rw-r--r--windows/win_iis_virtualdirectory.py20
1 files changed, 15 insertions, 5 deletions
diff --git a/windows/win_iis_virtualdirectory.py b/windows/win_iis_virtualdirectory.py
index 1ccb34a6..66810b84 100644
--- a/windows/win_iis_virtualdirectory.py
+++ b/windows/win_iis_virtualdirectory.py
@@ -22,9 +22,9 @@ DOCUMENTATION = '''
---
module: win_iis_virtualdirectory
version_added: "2.0"
-short_description: Configures a IIS virtual directories.
+short_description: Configures a virtual directory in IIS.
description:
- - Creates, Removes and configures a IIS Web site
+ - Creates, Removes and configures a virtual directory in IIS.
options:
name:
description:
@@ -37,12 +37,11 @@ options:
- absent
- present
required: false
- default: null
+ default: present
site:
description:
- The site name under which the virtual directory is created or exists.
- required: false
- default: null
+ required: true
application:
description:
- The application under which the virtual directory is created or exists.
@@ -55,3 +54,14 @@ options:
default: null
author: Henrik Wallström
'''
+
+EXAMPLES = '''
+# This creates a virtual directory if it doesn't exist.
+$ ansible -i hosts -m win_iis_virtualdirectory -a "name='somedirectory' site=somesite state=present physical_path=c:\\virtualdirectory\\some" host
+
+# This removes a virtual directory if it exists.
+$ ansible -i hosts -m win_iis_virtualdirectory -a "name='somedirectory' site=somesite state=absent" host
+
+# This creates a virtual directory on an application if it doesn't exist.
+$ ansible -i hosts -m win_iis_virtualdirectory -a "name='somedirectory' site=somesite application=someapp state=present physical_path=c:\\virtualdirectory\\some" host
+'''