Skip to content

Commit

Permalink
Add Extra Information for IIS parameters. (ansible-collections#9)
Browse files Browse the repository at this point in the history
* Add Extra Information for IIS parameters.

hen configuring a website with custom site parameters, for people who are not familiar with PowerShell or IIS, it would be great to add in the documentation some examples to show them how to use these parameters.

* Slight tweaks to the docs

Co-authored-by: Emir Madrueno Peregrina <[email protected]>
  • Loading branch information
2 people authored and shahargolshani committed Jan 5, 2025
1 parent 6868f70 commit 52177e2
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions plugins/modules/win_iis_website.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@
parameters:
description:
- Custom site Parameters from string where properties are separated by a pipe and property name/values by colon Ex. "foo:1|bar:2"
- Some custom parameters that you can use are listed below, this isn't a definitive list but some common parameters.
- C(logfile.directory) - Physical path to store Logs, e.g. C(D:\IIS-LOGs\).
- C(logfile.period) - Log file rollover scheduled accepting these values, how frequently the log file should be rolled-over,
e.g. C(Hourly, Daily, Weekly, Monthly).
- C(logfile.LogFormat) - Log file format, by default IIS uses C(W3C).
- C(logfile.truncateSize) - The size at which the log file contents will be trunsted, expressed in bytes.
type: str
seealso:
- module: community.windows.win_iis_virtualdirectory
Expand Down Expand Up @@ -86,6 +92,19 @@
name: "Default Web Site"
state: absent
# Create a WebSite with custom Logging configuration (Logs Location, Format and Rolling Over).
- name: Creating WebSite with Custom Log location, Format 3WC and rolling over every hour.
community.windows.win_iis_website:
name: MyCustom_Web_Shop_Site
state: started
port: 80
ip: '*'
hostname: '*'
physical_path: D:\wwwroot\websites\my-shop-site
parameters: logfile.directory:D:\IIS-LOGS\websites\my-shop-site|logfile.period:Hourly|logFile.logFormat:W3C
application_pool: my-shop-site
# Some commandline examples:
# This return information about an existing host
Expand Down

0 comments on commit 52177e2

Please sign in to comment.