Current File : //lib/python2.7/site-packages/salt/modules/win_iis.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l m Z d d l
m Z m Z d d l m Z e j e � Z d Z d9 Z e e d d � � Z d Z d
� Z d d d d � Z d d � Z d � Z e d � Z d � Z d d d d d d � Z! d d d � Z# d � Z$ d � Z% d � Z& d � Z' d � Z( d d d d d d � Z) d d d d d � Z* d d d d � Z+ d! � Z, d d d" d d# � Z- d d d" d$ � Z. d% � Z/ d& � Z0 d' � Z1 d( � Z2 d) � Z3 d* � Z4 d+ � Z5 d, � Z6 d- � Z7 d d. � Z8 d/ � Z9 e d0 � Z: e d1 � Z; e d2 � Z< d3 � Z= d4 � Z> d5 � Z? d6 � Z@ d7 � ZA d8 � ZB d S(: u'
Microsoft IIS site management via WebAdministration powershell module
:maintainer: Shane Lee <slee@saltstack.com>, Robert Booth <rbooth@saltstack.com>
:platform: Windows
:depends: PowerShell
:depends: WebAdministration module (PowerShell) (IIS)
.. versionadded:: 2016.3.0
i ( t absolute_importt print_functiont unicode_literalsN( t range( t SaltInvocationErrort CommandExecutionError( t sixu /u ftpu httpu httpsi u win_iisc C@ sa t j j j � s t d f St d d t � } | d sC t d f Sd | d k r] t d f St S( uW
Load only on Windows
Requires PowerShell and the WebAdministration module
u! Only available on Windows systemsu cmd.shell_infou
powershellu installedu PowerShell not availableu WebAdministrationu modulesu IIS is not installed( t saltt utilst platformt
is_windowst Falset __salt__t Truet __virtualname__( t powershell_info( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt __virtual__# s
u u *iP c C@ s+ d j | t j | � | j d d � g � S( u8
Combine the host header, IP address, and TCP port into bindingInformation
format. Binding Information specifies information to communicate with a
site. It includes the IP address, the port number, and an optional host
header (usually a host name) to communicate with the site.
Args:
host_header (str): Usually a hostname
ip_address (str): The IP address
port (int): The port
Returns:
str: A properly formatted bindingInformation string (IP:port:hostheader)
eg: 192.168.0.12:80:www.contoso.com
u :u u ( t joinR t text_typet replace( t host_headert
ip_addresst port( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt _get_binding_info5 s u Myc
C@ s' t � } d d g } d d d j | � d d g } t d | d t � } y# t j j j | d
d t �} Wn t k
r� t
d � � n Xx� | D]� } t � } x1 | D]) } | | k r� | | | | j � <q� q� Wg | d
<| d rg | d D] } | d ^ q� | d
<n | | | d <q� W| S( u
List details of available certificates in the LocalMachine certificate
store.
Args:
certificate_store (str): The name of the certificate store on the local
machine.
Returns:
dict: A dictionary of certificates found in the store
u DnsNameListu
Thumbprintu
Get-ChildItemu -Pathu 'Cert:\LocalMachine\{0}'u |uE Select-Object DnsNameList, SerialNumber, Subject, Thumbprint, Versiont cmdt return_jsonu stdoutt strictu$ Unable to parse return data as Json.u dnsnamesu Unicode( t dictt formatt _srvmgrR
R R t jsont loadsR t
ValueErrorR t lower(
t certificate_storet rett blacklist_keyst ps_cmdt cmd_rett itemst itemt cert_infot keyt name( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt _list_certsI s* #
(c C@ s� g } | j d � | j d � t | d t �} y# t j j j | d d t �} Wn t k
rv t j
d � d SXt j d j
| d d
| d d � � S( Nu6 Get-ItemProperty HKLM:\\SOFTWARE\\Microsoft\\InetStp\\u+ | Select-Object MajorVersion, MinorVersionR u stdoutR u$ Unable to parse return data as Json.i����u {0}.{1}i u MajorVersionu MinorVersion( t appendR R
R R R R R R t logt errort decimalt DecimalR ( t pscmdR& R' ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt _iisVersiont s
#
c C@ s� t | t � r! d j | � } n | r9 d j | � } n d j | � } t d | d d d t �} | d d k r� d
j | | d � } t j | � n | S( u:
Execute a powershell command from the WebAdministration PS module.
Args:
cmd (list): The command to execute in a list
return_json (bool): True formats the return in JSON, False just returns
the output of the command.
Returns:
str: The output from the command
u u5 ConvertTo-Json -Compress -Depth 4 -InputObject @({0})u$ Import-Module WebAdministration; {0}u cmd.run_allt shellu
powershellt python_shellu retcodei u) Unable to execute command: {0}
Error: {1}u stderr( t
isinstancet listR R R R
R. R/ ( R R R# t msg( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyR � s c C@ s� t � } d d d d d g } d! } t d
| d t � } y# t j j j | d d
t �} Wn t k
r{ t d � � n Xx<| D]4} t � } x� | d d D]� } | d d" k r� q� n t � } x; | D]3 } | | k r� | j
i | | | j � 6� q� q� W| d j d d � }
g |
D] } | j
� ^ q!\ } }
} | j
i | d 6| d 6|
d 6� | | | d <q� Wi | d d 6| d 6| d d 6| d d 6| d d 6| | d <q� W| s�t j d | d � n | S(# u�
List all the currently deployed websites.
Returns:
dict: A dictionary of the IIS sites and their properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_sites
u
Get-ChildItemu -Pathu 'IIS:\Sites'u |uF Select-Object applicationPool, Bindings, ID, Name, PhysicalPath, Stateu certificateHashu certificateStoreNameu protocolu sslFlagsR R u stdoutR u$ Unable to parse return data as Json.u bindingsu
Collectionu httpu httpsu bindingInformationu :i u
hostheaderu ipaddressu portu applicationPoolu apppoolu idu stateu physicalPathu
sourcepathu nameu No sites found in output: %s( u certificateHashu certificateStoreNameu protocolu sslFlags( u httpu https( R R R
R R R R R R R t updateR! t splitt stripR. t warning( R# R% t keep_keysR& R' R( t bindingst bindingt filtered_bindingR* t binding_infot elementt ipaddressR t
hostheader( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
list_sites� sD
#
%( c C@ s� t j | � j � } d j | � } t | | | � } t � } | | k r_ t j d | � t S| t k r� d j | t � }
t
|
� � n d d d j | � d d j | � d d j | | � g } | r>| t � k r� t j d
| � n t j d | � t | � | j
d d d j | � d
d d d j | � g � n t | � } | d d k rd j | | d � }
t |
� � n t j d | � t S( ud
Create a basic website in IIS.
.. note::
This function only validates against the site name, and will return True
even if the site already exists with a different configuration. It will
not modify the configuration of an existing site.
Args:
name (str): The IIS site name.
sourcepath (str): The physical path of the IIS site.
apppool (str): The name of the IIS application pool.
hostheader (str): The host header of the binding. Usually the hostname
or website name, ie: www.contoso.com
ipaddress (str): The IP address of the binding.
port (int): The TCP port of the binding.
protocol (str): The application protocol of the binding. (http, https,
etc.)
Returns:
bool: True if successful, otherwise False.
.. note::
If an application pool is specified, and that application pool does not
already exist, it will be created.
CLI Example:
.. code-block:: bash
salt '*' win_iis.create_site name='My Test Site' sourcepath='c:\stage' apppool='TestPool'
u IIS:\Sites\{0}u Site '%s' already present.u4 Invalid protocol '{0}' specified. Valid formats: {1}u New-Itemu -Pathu '{0}'u
-PhysicalPathu -Bindingsu0 @{{ protocol='{0}'; bindingInformation='{1}' }};u+ Utilizing pre-existing application pool: %su$ Application pool will be created: %su Set-ItemPropertyu -Nameu ApplicationPoolu -Valueu retcodei u% Unable to create site: {0}
Error: {1}u stderru Site created successfully: %s( R R R! R R RE R. t debugR
t _VALID_PROTOCOLSR t
list_apppoolst create_apppoolt extendR R ( R+ t
sourcepatht apppoolRD RC R t protocolt site_pathRA t
current_sitest messageR% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt create_site� sB $
c C@ st d j | � } t � } | | k r> t j d j | � � t St � } | r� | j d d d j | � d d d d j | � g � n | r | t � k r� t j d j | � � n t j d
j | � � t | � | r� | j d � n | j d d d j | � d d d d j | � g � n t
| � } | d
d k r`d j | | d � } t | � � n t j d | � t S( uU
Modify a basic website in IIS.
.. versionadded:: 2017.7.0
Args:
name (str): The IIS site name.
sourcepath (str): The physical path of the IIS site.
apppool (str): The name of the IIS application pool.
Returns:
bool: True if successful, otherwise False.
.. note::
If an application pool is specified, and that application pool does not
already exist, it will be created.
CLI Example:
.. code-block:: bash
salt '*' win_iis.modify_site name='My Test Site' sourcepath='c:\new_path' apppool='NewTestPool'
u IIS:\Sites\{0}u Site '{0}' not defined.u Set-ItemPropertyu -Pathu '{0}'u -Nameu PhysicalPathu -Valueu, Utilizing pre-existing application pool: {0}u% Application pool will be created: {0}u ;u ApplicationPoolu retcodei u% Unable to modify site: {0}
Error: {1}u stderru Site modified successfully: %s(
R RE R. RF R R7 RJ RH RI R- R R R
( R+ RK RL RN RO R% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt modify_site1 s<
c C@ s� t � } | | k r) t j d | � t Sd d d j | � g } t | � } | d d k r� d j | | d � } t | � � n t j d | � t S(
uQ
Delete a website from IIS.
Args:
name (str): The IIS site name.
Returns:
bool: True if successful, otherwise False
.. note::
This will not remove the application pool used by the site.
CLI Example:
.. code-block:: bash
salt '*' win_iis.remove_site name='My Test Site'
u Site already absent: %su Remove-WebSiteu -Nameu '{0}'u retcodei u% Unable to remove site: {0}
Error: {1}u stderru Site removed successfully: %s( RE R. RF R
R R R ( R+ RO R% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt remove_sitev s c C@ s/ d d j | � g } t | � } | d d k S( u%
Stop a Web Site in IIS.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the website to stop.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.stop_site name='My Test Site'
u Stop-WebSiteu '{0}'u retcodei ( R R ( R+ R% R& ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt stop_site� s c C@ s/ d d j | � g } t | � } | d d k S( u(
Start a Web Site in IIS.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the website to start.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.start_site name='My Test Site'
u
Start-WebSiteu '{0}'u retcodei ( R R ( R+ R% R& ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
start_site� s c C@ s t | � o t | � S( u.
Restart a Web Site in IIS.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the website to restart.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.restart_site name='My Test Site'
( RT RU ( R+ ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt restart_site� s c C@ s] t � } t � } | | k r2 t j d | � | S| | d } | sY t j d | � n | S( u
Get all configured IIS bindings for the specified site.
Args:
site (str): The name if the IIS Site
Returns:
dict: A dictionary of the binding names and properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_bindings site
u Site not found: %su bindingsu No bindings found for site: %s( R RE R. R< ( t siteR# t sites( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
list_bindings� s c C@ s t j | � j � } t | | | � } | t k rT d j | t � } t | � � n | r� t | � } | t k r� d j | t d t d � } t | � � q� n t | � } | | k r� t
j d | � t S| r9d d d j | � d d j | � d
d j | � d d j | � d d j | � d
d j | � g
} nT d d d j | � d d j | � d
d j | � d d j | � d d j | � g } t
| � }
|
d d k r�d j | |
d � } t | � � n | t | � k r�t
j d | � t St
j d | � t S( u�
Create an IIS Web Binding.
.. note::
This function only validates against the binding
ipaddress:port:hostheader combination, and will return True even if the
binding already exists with a different configuration. It will not
modify the configuration of an existing binding.
Args:
site (str): The IIS site name.
hostheader (str): The host header of the binding. Usually a hostname.
ipaddress (str): The IP address of the binding.
port (int): The TCP port of the binding.
protocol (str): The application protocol of the binding.
sslflags (str): The flags representing certificate type and storage of
the binding.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.create_binding site='site0' hostheader='example.com' ipaddress='*' port='80'
u4 Invalid protocol '{0}' specified. Valid formats: {1}u@ Invalid sslflags '{0}' specified. Valid sslflags range: {1}..{2}i i����u Binding already present: %su New-WebBindingu -Nameu '{0}'u -HostHeaderu
-IpAddressu -Portu -Protocolu -SslFlagsu {0}u retcodeu( Unable to create binding: {0}
Error: {1}u stderru Binding created successfully: %su Unable to create binding: %s( R R R! R RG R R t intt _VALID_SSL_FLAGSRY R. RF R
R R R/ R ( RW RD RC R RM t sslflagsR+ RP t current_bindingsR% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt create_binding sP c C@ sY | d k rD | t k rD d j | t d t d � } t | � � n t � } | | k rm t j d | � t St | � } | | k r� t j d | � t S| j d � \ } }
} d j
| d k r� | n | | d k r� t j | � n t j |
� | d k r| n | g � } | | k r�d d d j | � d
d j | � d d d
d j | � g }
t
|
� } | d d k r�d j | | d � } t | � � q�n | d k rE| | | d | d k rEd d d j | � d
d j | � d d d
d j | � g }
t
|
� } | d d k rEd j | | d � } t | � � qEn t j d | � t S( u�
Modify an IIS Web Binding. Use ``site`` and ``binding`` to target the
binding.
.. versionadded:: 2017.7.0
Args:
site (str): The IIS site name.
binding (str): The binding to edit. This is a combination of the
IP address, port, and hostheader. It is in the following format:
ipaddress:port:hostheader. For example, ``*:80:`` or
``*:80:salt.com``
hostheader (str): The host header of the binding. Usually the hostname.
ipaddress (str): The IP address of the binding.
port (int): The TCP port of the binding.
sslflags (str): The flags representing certificate type and storage of
the binding.
Returns:
bool: True if successful, otherwise False
CLI Example:
The following will seat the host header of binding ``*:80:`` for ``site0``
to ``example.com``
.. code-block:: bash
salt '*' win_iis.modify_binding site='site0' binding='*:80:' hostheader='example.com'
u@ Invalid sslflags '{0}' specified. Valid sslflags range: {1}..{2}i i����u Site '%s' not defined.u Binding '%s' not defined.u :u Set-WebBindingu -Nameu '{0}'u -BindingInformationu
-PropertyNameu BindingInformationu -Valueu retcodeu( Unable to modify binding: {0}
Error: {1}u stderru bindingsu sslflagsu2 Unable to modify binding SSL Flags: {0}
Error: {1}u! Binding modified successfully: %sN( t NoneR[ R R RE R. RF R RY R: R R R R R R
( RW R? RD RC R R\ RP RO R] t it pt ht new_bindingR% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt modify_bindingV sR ' c C@ s� t | | | � } t | � } | | k r> t j d | � t Sd d d j | � d d j | � d d j | � g } t | � } | d d k r� d j | | d
� } t | � � n | t | � k r� t j d | � t St j d | � t S(
u�
Remove an IIS binding.
Args:
site (str): The IIS site name.
hostheader (str): The host header of the binding.
ipaddress (str): The IP address of the binding.
port (int): The TCP port of the binding.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.remove_binding site='site0' hostheader='example.com' ipaddress='*' port='80'
u Binding already absent: %su Remove-WebBindingu -HostHeaderu '{0}'u
-IpAddressu -Portu retcodei u( Unable to remove binding: {0}
Error: {1}u stderru Binding removed successfully: %su Unable to remove binding: %s(
R RY R. RF R
R R R R/ R ( RW RD RC R R+ R] R% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt remove_binding� s& c C@ s� t � } t � } | | k r2 t j d | � | SxE | | d D]5 } | | d | d rA | | d | | | <qA qA W| s� t j d | � n | S( u.
List certificate bindings for an IIS site.
.. versionadded:: 2016.11.0
Args:
site (str): The IIS site name.
Returns:
dict: A dictionary of the binding names and properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_bindings site
u Site not found: %su bindingsu certificatehashu* No certificate bindings found for site: %s( R RE R. R< ( RW R# RX R? ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt list_cert_bindings� s i� c C@ s� t j | � j � } t | | | � } t � d k rP | j d � d d } n d j | j d d � � } | t k r� d j | t d t d � } t | � � n t
| � } | | k r� t j d | � t
Sd }
x+ | D]# } | | k r� | | d }
q� q� Wt j d
|
� t j d | � | |
k rCt j d | � t St � } | | k rlt j d
| � t
St � d k r�| j d d � }
|
j d � r�|
d }
n d d d j |
� d d j | � g } n6 d d d j | � d d j | � d d j | � g } t | � } | d d k rJd j | | d � } t | � � n t | � } | | k rvt j d | � t
S| | | d k r�t j d | � t St j d | � t
S( u
Assign a certificate to an IIS Web Binding.
.. versionadded:: 2016.11.0
.. note::
The web binding that the certificate is being assigned to must already
exist.
Args:
name (str): The thumbprint of the certificate.
site (str): The IIS site name.
hostheader (str): The host header of the binding.
ipaddress (str): The IP address of the binding.
port (int): The TCP port of the binding.
sslflags (int): Flags representing certificate type and certificate storage of the binding.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.create_cert_binding name='AAA000' site='site0' hostheader='example.com' ipaddress='*' port='443'
i u :i u IIS:\SslBindings\{0}u !u@ Invalid sslflags '{0}' specified. Valid sslflags range: {1}..{2}i����u Binding not present: %su certificatehashu" Current certificate thumbprint: %su New certificate thumbprint: %su+ Certificate already present for binding: %su Certificate not present: %su \*!u \0.0.0.0!u New-Itemu -Pathu '{0}'u -Thumbprintu -SSLFlagsu {0}u retcodeu4 Unable to create certificate binding: {0}
Error: {1}u stderru, Certificate binding created successfully: %su( Unable to create certificate binding: %sN( R R t upperR R3 t
rpartitionR R R[ R RY R. R/ R R_ RF R
R, t endswithR R Rf ( R+ RW RD RC R R\ RA t binding_pathRP R] t current_namet current_bindingt certst iis7pathR% R& R8 t new_cert_bindings( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt create_cert_binding� sh
c
C@ sZ t j | � j � } t | | | � } d d d d d d j | � d d d j | � d
g
} t | � } | | k r� t j d | � t S| | | d k r� t j d
| � t St
| � } | d d k r� d j | | d � } t | � � n t | � }
| |
k r t j d | � t S| |
| d k rFt j d | � t St j d | � t
S( u�
Remove a certificate from an IIS Web Binding.
.. versionadded:: 2016.11.0
.. note::
This function only removes the certificate from the web binding. It does
not remove the web binding itself.
Args:
name (str): The thumbprint of the certificate.
site (str): The IIS site name.
hostheader (str): The host header of the binding.
ipaddress (str): The IP address of the binding.
port (int): The TCP port of the binding.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.remove_cert_binding name='AAA000' site='site0' hostheader='example.com' ipaddress='*' port='443'
u $Site = Get-ChildItemu -Pathu 'IIS:\Sites'u |u Where-Objectu {{ $_.Name -Eq '{0}' }};u$ $Binding = $Site.Bindings.Collectionu& | Where-Object { $_.bindingInformationu
-Eq '{0}' }};u $Binding.RemoveSslCertificate()u Binding not found: %su certificatehashu& Certificate binding already absent: %su retcodei u4 Unable to remove certificate binding: {0}
Error: {1}u stderru, Certificate binding removed successfully: %su( Unable to remove certificate binding: %s( R R Rg R R Rf R. R< R
RF R R R/ R ( R+ RW RD RC R RA R% t current_cert_bindingsR& R8 Ro ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt remove_cert_bindingn s: c C@ s� t � } g } | j d � | j d � | j d � | j d � | j d � | j d � | j d � | j d � | j d � | j d
� | j d � | j d � t d
| d t � } y# t j j j | d d t �} Wn t k
rt
d � � n Xx� | D]{ } t � } t | d t � rTd | d k re| | d d 7} qen | j | d � i | d d 6| d 6| | d <q
W| s�t
j d | d � n | S( u�
List all configured IIS application pools.
Returns:
dict: A dictionary of IIS application pools and their details.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_apppools
u? Get-ChildItem -Path 'IIS:\AppPools' | Select-Object Name, Stateu> , @{ Name = 'Applications'; Expression = { $AppPool = $_.Name;u% $AppPath = 'machine/webroot/apphost';u? $FilterBase = '/system.applicationHost/sites/site/application';u= $FilterBase += "[@applicationPool = '$($AppPool)' and @path";u0 $FilterRoot = "$($FilterBase) = '/']/parent::*";u* $FilterNonRoot = "$($FilterBase) != '/']";uL Get-WebConfigurationProperty -Filter $FilterRoot -PsPath $AppPath -Name Nameu | ForEach-Object { $_.Value };uO Get-WebConfigurationProperty -Filter $FilterNonRoot -PsPath $AppPath -Name Pathu; | ForEach-Object { $_.Value } | Where-Object { $_ -ne '/' }u } }R R u stdoutR u$ Unable to parse return data as Json.u Applicationsu valueu stateu applicationsu nameu( No application pools found in output: %s( R R- R R
R R R R R R R R7 R6 R. R< ( R# R% R& R' R( t applications( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyRH � s<
#
$ c C@ s� t � } d j | � } | | k r8 t j d | � t Sd d d j | � g } t | � } | d d k r� d j | | d � } t | � � n t j d
| � t S( u,
Create an IIS application pool.
.. note::
This function only validates against the application pool name, and will
return True even if the application pool already exists with a different
configuration. It will not modify the configuration of an existing
application pool.
Args:
name (str): The name of the IIS application pool.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.create_apppool name='MyTestPool'
u IIS:\AppPools\{0}u& Application pool '%s' already present.u New-Itemu -Pathu '{0}'u retcodei u1 Unable to create application pool: {0}
Error: {1}u stderru) Application pool created successfully: %s( RH R R. RF R
R R ( R+ t current_apppoolst apppool_pathR% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyRI � s c C@ s� t � } d j | � } | | k r8 t j d | � t Sd d d j | � d g } t | � } | d d k r� d j | | d
� } t | � � n t j d | � t S( u
Remove an IIS application pool.
Args:
name (str): The name of the IIS application pool.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.remove_apppool name='MyTestPool'
u IIS:\AppPools\{0}u# Application pool already absent: %su Remove-Itemu -Pathu '{0}'u -Recurseu retcodei u1 Unable to remove application pool: {0}
Error: {1}u stderru) Application pool removed successfully: %s( RH R R. RF R
R R ( R+ Rt Ru R% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt remove_apppool s c C@ s/ d d j | � g } t | � } | d d k S( u-
Stop an IIS application pool.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the App Pool to stop.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.stop_apppool name='MyTestPool'
u Stop-WebAppPoolu '{0}'u retcodei ( R R ( R+ R% R& ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt stop_apppoolB s c C@ s/ d d j | � g } t | � } | d d k S( u0
Start an IIS application pool.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the App Pool to start.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.start_apppool name='MyTestPool'
u Start-WebAppPoolu '{0}'u retcodei ( R R ( R+ R% R& ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
start_apppool[ s c C@ s/ d d j | � g } t | � } | d d k S( u8
Restart an IIS application pool.
.. versionadded:: 2016.11.0
Args:
name (str): The name of the IIS application pool.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.restart_apppool name='MyTestPool'
u Restart-WebAppPoolu '{0}'u retcodei ( R R ( R+ R% R& ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt restart_apppoolt s c C@ s� t � } t � } t � } d j | | � } | sD t j d � | S| j d � x� | D]� } | j d d d j | � d d j | � d d d
d g � | j d j | � � | j d
j | � � | j d � | j d � | j d � | j d � | j d j | � � | j d � qX Wt d | d t � } | d d k rYd } t | � � n | j d � t d | d t � } yS t
j j j
| d d t �}
t |
t � r�| j |
d � n
| j |
� Wn t k
r�t d � � n X| S( uk
Get the value of the setting for the IIS container.
.. versionadded:: 2016.11.0
Args:
name (str): The name of the IIS container.
container (str): The type of IIS container. The container types are:
AppPools, Sites, SslBindings
settings (dict): A dictionary of the setting names and their values.
Returns:
dict: A dictionary of the provided settings and their values.
CLI Example:
.. code-block:: bash
salt '*' win_iis.get_container_setting name='MyTestPool' container='AppPools'
settings="['processModel.identityType']"
u IIS:\{0}\{1}u No settings providedu $Settings = @{};u Get-ItemPropertyu -Pathu '{0}'u -Nameu -ErrorActionu Stopu |u Out-Null;u( $Property = Get-ItemProperty -Path '{0}'u -Name '{0}' -ErrorAction Stop;u8 if (([String]::IsNullOrEmpty($Property) -eq $False) -andu: ($Property.GetType()).Name -eq 'ConfigurationAttribute') {u% $Property = $Property | Select-Objectu -ExpandProperty Value };u& $Settings['{0}'] = [String] $Property;u $Property = $Null;R R u retcodei uM One or more invalid property names were specified for the provided container.u $Settingsu stdoutR u$ Unable to parse return data as Json.( R R7 R R. R< R- RJ R R
R R R R R R R6 R9 R R ( R+ t containert settingsR# R% t ps_cmd_validatet container_patht settingR& RP R' ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt get_container_setting� sH
c C@ s� i d d 6d d 6d d 6d d 6d d
6} i d d 6d d 6d d 6d d 6d
d 6} t � } d j | | � } | s� t j d � t Sx% | D] } t j | | � | | <q� Wt d
| d | d | j � � } | | k r� t j d � t
Sx� | D]� } y t | | � | | } Wn$ t k
r9d j | | � } n X| d k rm| | | j � k rm| | | } n | j
d d d j | � d d j | � d d j | � g � q� Wt | � }
|
d d k r�d j | | � } t | � � n t d
| d | d | j � � } t � }
x| | D]t } | d k rY| | | j � k rY| | | | | <n t j | | � t j | | � k r | | |
| <q q W|
r�t j d |
� t St j d | j � � t
S( u^
Set the value of the setting for an IIS container.
.. versionadded:: 2016.11.0
Args:
name (str): The name of the IIS container.
container (str): The type of IIS container. The container types are:
AppPools, Sites, SslBindings
settings (dict): A dictionary of the setting names and their values.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.set_container_setting name='MyTestPool' container='AppPools'
settings="{'managedPipeLineMode': 'Integrated'}"
u LocalSystemu 0u LocalServiceu 1u NetworkServiceu 2u SpecificUseru 3u ApplicationPoolIdentityu 4u IIS:\{0}\{1}u No settings providedR+ Rz R{ u- Settings already contain the provided values.u '{0}'u processModel.identityTypeu Set-ItemPropertyu -Pathu -Nameu -Valueu {0};u retcodei u# Unable to set settings for {0}: {1}u Failed to change settings: %su$ Settings configured successfully: %s( R7 R R. R< R R R R t keysRF R
t complexR RJ R R R R/ ( R+ Rz R{ t identityType_map2stringt identityType_map2numericR% R} R~ t current_settingst valueR& R8 t new_settingst failed_settings( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt set_container_setting� sV ))
"
"&c C@ sx t � } t � } | j d j | � � | j d � | j d � | j d � | j d � t d | d t � } y# t j j j | d d t
�} Wn t k
r� t d
� � n Xx� | D]� } t � } t
| d t � rd | d k r| | d d 7} qn | j | d � i | d
d 6| d d 6| d d 6| d 6| d d 6| | d <q� W| stt j d | � n | S( u
Get all configured IIS applications for the specified site.
Args:
site (str): The IIS site name.
Returns: A dictionary of the application names and properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_apps site
u Get-WebApplication -Site '{0}'uD | Select-Object applicationPool, path, PhysicalPath, preloadEnabled,u; @{ Name='name'; Expression={ $_.path.Split('/', 2)[-1] } },uC @{ Name='protocols'; Expression={ @( $_.enabledProtocols.Split(',')u$ | Foreach-Object { $_.Trim() } ) } }R R u stdoutR u$ Unable to parse return data as Json.u protocolsu valueu applicationPoolu apppoolu pathu preloadEnabledu preloadu PhysicalPathu
sourcepathu nameu No apps found in output: %s( R R7 R- R R R
R R R R R R R R6 R. R< ( RW R# R% R& R' R( t protocols( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt list_apps3 s4
#
c C@ s. t | � } | | k r, t j d | � t St j j | � sR t j d | � t Sd d d j | � d d j | � d d j | � g } | r� | j
d d j | � g � n t | � } | d d
k r� d j | | d � } t | � � n t | � } | | k rt j d
| � t St j d | � t S( u�
Create an IIS application.
.. note::
This function only validates against the application name, and will
return True even if the application already exists with a different
configuration. It will not modify the configuration of an existing
application.
Args:
name (str): The IIS application.
site (str): The IIS site name.
sourcepath (str): The physical path.
apppool (str): The name of the IIS application pool.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.create_app name='app0' site='site0' sourcepath='C:\site0' apppool='site0'
u Application already present: %su Path is not present: %su New-WebApplicationu -Nameu '{0}'u -Siteu
-PhysicalPathu -ApplicationPoolu retcodei u, Unable to create application: {0}
Error: {1}u stderru$ Application created successfully: %su Unable to create application: %s(
R� R. RF R
t ost patht isdirR/ R R RJ R R ( R+ RW RK RL t current_appsR% R& R8 t new_apps( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
create_appj s0 c C@ s� t | � } | | k r, t j d | � t Sd d d j | � d d j | � g } t | � } | d d k r� d j | | d � } t | � � n t | � } | | k r� t j d
| � t St j d | � t S( u*
Remove an IIS application.
Args:
name (str): The application name.
site (str): The IIS site name.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.remove_app name='app0' site='site0'
u Application already absent: %su Remove-WebApplicationu -Nameu '{0}'u -Siteu retcodei u, Unable to remove application: {0}
Error: {1}u stderru$ Application removed successfully: %su Unable to remove application: %s( R� R. RF R
R R R R/ R ( R+ RW R� R% R& R8 R� ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
remove_app� s$ c C@ s� t � } d d d j | � d d j | � d d d g } t d | d t � } y# t j j j | d
d t �} Wn t k
r� t
d � � n Xx' | D] } i | d
d 6| | d <q� W| s� t j d | � n | S( u�
Get all configured IIS virtual directories for the specified site, or for
the combination of site and application.
Args:
site (str): The IIS site name.
app (str): The IIS application.
Returns:
dict: A dictionary of the virtual directory names and properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_vdirs site
u Get-WebVirtualDirectoryu -Siteu '{0}'u -Applicationu |u- Select-Object PhysicalPath, @{ Name = 'name';u) Expression = { $_.path.Split('/')[-1] } }R R u stdoutR u$ Unable to parse return data as Json.u physicalPathu
sourcepathu nameu No vdirs found in output: %s(
R R R R
R R R R R R R R. R< ( RW t appR# R% R& R' R( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
list_vdirs� s #
c C@ s: t | | � } | | k r/ t j d | � t St j j | � sU t j d | � t Sd d d j | � d d j | � d d j | � g } | t
k r� | j d d j | � g � n t | � } | d d
k r� d j | | d � } t
| � � n t | | � } | | k r&t j d
| � t St j d | � t S( u�
Create an IIS virtual directory.
.. note::
This function only validates against the virtual directory name, and
will return True even if the virtual directory already exists with a
different configuration. It will not modify the configuration of an
existing virtual directory.
Args:
name (str): The virtual directory name.
site (str): The IIS site name.
sourcepath (str): The physical path.
app (str): The IIS application.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.create_vdir name='vd0' site='site0' sourcepath='C:\inetpub\vdirs\vd0'
u% Virtual directory already present: %su Path is not present: %su New-WebVirtualDirectoryu -Nameu '{0}'u -Siteu
-PhysicalPathu -Applicationu retcodei u2 Unable to create virtual directory: {0}
Error: {1}u stderru* Virtual directory created successfully: %su& Unable to create virtual directory: %s( R� R. RF R
R� R� R� R/ R R t _DEFAULT_APPRJ R R ( R+ RW RK R� t
current_vdirsR% R& R8 t new_vdirs( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt create_vdir� s0 c
C@ s t | | � } t j j | j d � j d � � } | rK d j | � } n d j | | | � } | | k r� t j d | � t Sd d d j | � d g } t
| � } | d d
k r� d j | | d � } t | � � n t | | � } | | k r t j d
| � t St j d | � t
S( u`
Remove an IIS virtual directory.
Args:
name (str): The virtual directory name.
site (str): The IIS site name.
app (str): The IIS application.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.remove_vdir name='vdir0' site='site0'
u /u {0}\u IIS:\Sites\{0}\{1}{2}u$ Virtual directory already absent: %su Remove-Itemu -Pathu '{0}'u -Recurseu retcodei u2 Unable to remove virtual directory: {0}
Error: {1}u stderru* Virtual directory removed successfully: %su& Unable to remove virtual directory: %s( R� R� R� R t rstripR: R R. RF R
R R R/ R (
R+ RW R� R� t app_patht vdir_pathR% R& R8 R� ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt remove_vdir< s, $ c C@ s� t � } d d d d g } t d | d t � } y# t j j j | d d t �} Wn t k
rr t d � � n Xx? | D]7 } | d
r� | d
| | d <qz | d | | d <qz W| s� t
j d
| � n | S( u�
List the IIS Configuration Backups on the System.
.. versionadded:: 2017.7.0
.. note::
Backups are made when a configuration is edited. Manual backups are
stored in the ``$env:Windir\System32\inetsrv\backup`` folder.
Returns:
dict: A dictionary of IIS Configurations backed up on the system.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_backups
u Get-WebConfigurationBackupu |u Select Name, CreationDate,u7 @{N="FormattedDate"; E={$_.CreationDate.ToString("G")}}R R u stdoutR u$ Unable to parse return data as Json.u
FormattedDateu Nameu CreationDateu No backups found in output: %s( R R R
R R R R R R R R. R< ( R# R% R& R' R( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt list_backupsq s" #
c C@ s� | t � k r' t d j | � � � n d d d j | � g } t | � } | d d k r� d j | | d � } t | � � n | t � k S( u�
Backup an IIS Configuration on the System.
.. versionadded:: 2017.7.0
.. note::
Backups are stored in the ``$env:Windir\System32\inetsrv\backup``
folder.
Args:
name (str): The name to give the backup
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.create_backup good_config_20170209
u Backup already present: {0}u Backup-WebConfigurationu -Nameu '{0}'u retcodei u2 Unable to backup web configuration: {0}
Error: {1}u stderr( R� R R R ( R+ R% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
create_backup� s c C@ s� | t � k r# t j d | � t Sd d d j | � g } t | � } | d d k r| d j | | d � } t | � � n | t � k S( uA
Remove an IIS Configuration backup from the System.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the backup to remove
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.remove_backup backup_20170209
u Backup already removed: %su Remove-WebConfigurationBackupu -Nameu '{0}'u retcodei u2 Unable to remove web configuration: {0}
Error: {1}u stderr( R� R. RF R
R R R ( R+ R% R& R8 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt
remove_backup� s c C@ s� d d j | � g } t d | d t � } y# t j j j | d d t �} Wn t k
rl t d � � n Xt
� } x | D] } | d | | d <q} W| s� t j d
| � n | S( u~
Returns a list of worker processes that correspond to the passed
application pool.
.. versionadded:: 2017.7.0
Args:
apppool (str): The application pool to query
Returns:
dict: A dictionary of worker processes with their process IDs
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_worker_processes 'My App Pool'
u
Get-ChildItemu# 'IIS:\AppPools\{0}\WorkerProcesses'R R u stdoutR u$ Unable to parse return data as Json.u appPoolNameu processIdu No backups found in output: %s(
R R R
R R R R R R R R R. R< ( RL R% R& R' R# R( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt list_worker_processes� s #
c C@ s- t � } t � } d } | s/ t j d � | S| j d � x| D]} | | k r)| d k sm | d k r� | j d j | | � � | j d j | � � | j d � | j d
j | � � | j d � n | d k s� | d k rV| j d j | | � � | j d
j | � � | j d � qVqC d
j | � } d | d | } t | � � qC W| j d � t d t j
� j | � d t � } yS t j
j j | d d t �}
t |
t � r�| j |
d � n
| j |
� Wn t k
r�t j d � n Xd t j | � k r)d } t | � � n | S( u�
.. versionadded:: 2017.7.0
Get the value of the setting for the IIS web application.
.. note::
Params are case sensitive
:param str name: The name of the IIS web application.
:param str site: The site name contains the web application.
Example: Default Web Site
:param str settings: A dictionary of the setting names and their values.
Available settings: physicalPath, applicationPool, userName, password
Returns:
dict: A dictionary of the provided settings and their values.
CLI Example:
.. code-block:: bash
salt '*' win_iis.get_webapp_settings name='app0' site='Default Web Site'
settings="['physicalPath','applicationPool']"
u physicalPathu applicationPoolu userNameu passwordu No settings providedu $Settings = @{};u� $Property = Get-WebConfigurationProperty -Filter "system.applicationHost/sites/site[@name='{0}']/application[@path='/{1}']/virtualDirectory[@path='/']"u. -Name "{0}" -ErrorAction Stop | select Value;u= $Property = $Property | Select-Object -ExpandProperty Value;u' $Settings['{0}'] = [String] $Property;u $Property = $Null;u* $Property = (get-webapplication {0}).{1};u , u Unexpected setting:u . Available settings are: u
$SettingsR R u stdoutR i u$ Unable to parse return data as Json.uh Some values are empty - please validate site and web application names. Some commands are case sensitive( u physicalPathu applicationPoolu userNameu passwordN( R R7 R. R< R- R R R R R R R
R R R R R R6 R9 R R/ R_ t
viewvalues( R+ RW R{ R# R2 t availableSettingsR~ t availSetStrRP R& R' ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt get_webapp_settings sF
$
c C@ s\ t � } t | � } t � } d } | | k rM d | d } t | � � n | | k rv d | d } t | � � n | s� d } t | � � n x� | j � D]y } | | k r� t j | | � | | <q� d j | � } t j d
| � t j d | � d | d
| } t | � � q� Wt
d | d | d | j � � }
| |
k rYt j d � t Sx| D]} y t
| | � | | } Wn$ t k
r�d j | | � } n X| d k s�| d k r�| j d j | | � � | j d j | | � � n | d k s| d k r`| j d j | | | | � � | d k rrt j j | | � sod | | } t | � � qoqrq`q`Wt | � } | d d k r�d j | � } t | � � n t
d | d | d | j � � }
t � } xE | D]= } t j | | � t j |
| � k r�| | | | <q�q�W| r<t j d | � t St j d j | j � � � t S( u#
.. versionadded:: 2017.7.0
Configure an IIS application.
.. note::
This function only configures an existing app. Params are case
sensitive.
:param str name: The IIS application.
:param str site: The IIS site name.
:param str settings: A dictionary of the setting names and their values.
- physicalPath: The physical path of the webapp.
- applicationPool: The application pool for the webapp.
- userName: "connectAs" user
- password: "connectAs" password for user
:return: A boolean representing whether all changes succeeded.
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' win_iis.set_webapp_settings name='app0' site='site0' settings="{'physicalPath': 'C:\site0', 'apppool': 'site0'}"
u physicalPathu applicationPoolu userNameu passwordu Applicationu
doesn't existu Siteu No settings providedu , u Unexpected setting: %s u Available settings: %su Unexpected setting:u Available settings:R+ RW R{ u- Settings already contain the provided values.u '{0}'u� Set-WebConfigurationProperty -Filter "system.applicationHost/sites/site[@name='{0}']/application[@path='/{1}']/virtualDirectory[@path='/']"u -Name "{0}" -Value {1};u< Set-ItemProperty "IIS:\Sites\{0}\{1}" -Name {2} -Value {3};u Path is not present: u retcodei u. Unable to set settings for web application {0}u Failed to change settings: %su% Settings configured successfully: {0}( u physicalPathu applicationPoolu userNameu password( R7 R� RE R R� R R R R. R/ R� R< R
R� R R R- R� R� R� R R R RF ( R+ RW R{ R2 R� RO R� R8 R~ R� R� R� R& R� R� ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt set_webapp_settingsZ sp
& ( u ftpu httpu https(C t __doc__t
__future__R R R R0 t loggingR� t salt.utils.jsonR t salt.utils.platformt salt.ext.six.movesR t salt.exceptionsR R t salt.extR t getLoggert __name__R. R� RG t tupleR[ R R R R, R3 R R RE RQ R_ RR RS RT RU RV RY R^ Rd Re Rf Rp Rr RH RI Rv Rw Rx Ry R R� R� R� R� R� R� R� R� R� R� R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_iis.pyt <module> sr + >OE ( Q X- # nH = + $ M Y 7 > , * > 5 - & # ' L
Mini Shell