saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
salt/salt/states/win_iis.py
Mapel88 b31d1377ab Update win_iis.py 
added 'r'
2017-03-14 18:24:52 +02:00

852 lines
27 KiB
Python
Raw Blame History

# -*- coding: utf-8 -*-
'''
Microsoft IIS site management
This module provides the ability to add/remove websites and application pools
from Microsoft IIS.
.. versionadded:: 2016.3.0
'''
# Import python libs
from __future__ import absolute_import
# Define the module's virtual name
__virtualname__ = 'win_iis'
def __virtual__():
'''
Load only on minions that have the win_iis module.
'''
if 'win_iis.create_site' in __salt__:
return __virtualname__
return False
def _get_binding_info(hostheader='', ipaddress='*', port=80):
'''
Combine the host header, IP address, and TCP port into bindingInformation format.
'''
ret = r'{0}:{1}:{2}'.format(ipaddress, port, hostheader.replace(' ', ''))
return ret
def deployed(name, sourcepath, apppool='', hostheader='', ipaddress='*', port=80, protocol='http'):
'''
Ensure the website has been deployed.
.. 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.
:param str name: The IIS site name.
:param str sourcepath: The physical path of the IIS site.
:param str apppool: The name of the IIS application pool.
:param str hostheader: The host header of the binding.
:param str ipaddress: The IP address of the binding.
:param str port: The TCP port of the binding.
:param str protocol: The application protocol of the binding.
.. note:
If an application pool is specified, and that application pool does not already exist,
it will be created.
Example of usage with only the required arguments. This will default to using the default application pool
assigned by IIS:
.. code-block:: yaml
site0-deployed:
win_iis.deployed:
- name: site0
- sourcepath: C:\\inetpub\\site0
Example of usage specifying all available arguments:
.. code-block:: yaml
site0-deployed:
win_iis.deployed:
- name: site0
- sourcepath: C:\\inetpub\\site0
- apppool: site0
- hostheader: site0.local
- ipaddress: '*'
- port: 443
- protocol: https
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
current_sites = __salt__['win_iis.list_sites']()
if name in current_sites:
ret['comment'] = 'Site already present: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Site will be created: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
else:
ret['comment'] = 'Created site: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
ret['result'] = __salt__['win_iis.create_site'](name, sourcepath, apppool,
hostheader, ipaddress, port,
protocol)
return ret
def remove_site(name):
'''
Delete a website from IIS.
:param str name: The IIS site name.
Usage:
.. code-block:: yaml
defaultwebsite-remove:
win_iis.remove_site:
- name: Default Web Site
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
current_sites = __salt__['win_iis.list_sites']()
if name not in current_sites:
ret['comment'] = 'Site has already been removed: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Site will be removed: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
else:
ret['comment'] = 'Removed site: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
ret['result'] = __salt__['win_iis.remove_site'](name)
return ret
def create_binding(name, site, hostheader='', ipaddress='*', port=80, protocol='http', sslflags=0):
'''
Create an IIS 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.
:param str site: The IIS site name.
:param str hostheader: The host header of the binding.
:param str ipaddress: The IP address of the binding.
:param str port: The TCP port of the binding.
:param str protocol: The application protocol of the binding.
:param str sslflags: The flags representing certificate type and storage of the binding.
Example of usage with only the required arguments:
.. code-block:: yaml
site0-https-binding:
win_iis.create_binding:
- site: site0
Example of usage specifying all available arguments:
.. code-block:: yaml
site0-https-binding:
win_iis.create_binding:
- site: site0
- hostheader: site0.local
- ipaddress: '*'
- port: 443
- protocol: https
- sslflags: 0
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
binding_info = _get_binding_info(hostheader, ipaddress, port)
current_bindings = __salt__['win_iis.list_bindings'](site)
if binding_info in current_bindings:
ret['comment'] = 'Binding already present: {0}'.format(binding_info)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Binding will be created: {0}'.format(binding_info)
ret['changes'] = {'old': None,
'new': binding_info}
else:
ret['comment'] = 'Created binding: {0}'.format(binding_info)
ret['changes'] = {'old': None,
'new': binding_info}
ret['result'] = __salt__['win_iis.create_binding'](site, hostheader, ipaddress,
port, protocol, sslflags)
return ret
def remove_binding(name, site, hostheader='', ipaddress='*', port=80):
'''
Remove an IIS binding.
:param str site: The IIS site name.
:param str hostheader: The host header of the binding.
:param str ipaddress: The IP address of the binding.
:param str port: The TCP port of the binding.
Example of usage with only the required arguments:
.. code-block:: yaml
site0-https-binding-remove:
win_iis.remove_binding:
- site: site0
Example of usage specifying all available arguments:
.. code-block:: yaml
site0-https-binding-remove:
win_iis.remove_binding:
- site: site0
- hostheader: site0.local
- ipaddress: '*'
- port: 443
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
binding_info = _get_binding_info(hostheader, ipaddress, port)
current_bindings = __salt__['win_iis.list_bindings'](site)
if binding_info not in current_bindings:
ret['comment'] = 'Binding has already been removed: {0}'.format(binding_info)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Binding will be removed: {0}'.format(binding_info)
ret['changes'] = {'old': binding_info,
'new': None}
else:
ret['comment'] = 'Removed binding: {0}'.format(binding_info)
ret['changes'] = {'old': binding_info,
'new': None}
ret['result'] = __salt__['win_iis.remove_binding'](site, hostheader,
ipaddress, port)
return ret
def create_cert_binding(name, site, hostheader='', ipaddress='*', port=443, sslflags=0):
'''
Assign a certificate to an IIS binding.
.. note:
The web binding that the certificate is being assigned to must already exist.
:param str name: The thumbprint of the certificate.
:param str site: The IIS site name.
:param str hostheader: The host header of the binding.
:param str ipaddress: The IP address of the binding.
:param str port: The TCP port of the binding.
:param str sslflags: Flags representing certificate type and certificate storage of the binding.
Example of usage with only the required arguments:
.. code-block:: yaml
site0-cert-binding:
win_iis.create_cert_binding:
- name: 9988776655443322111000AAABBBCCCDDDEEEFFF
- site: site0
Example of usage specifying all available arguments:
.. code-block:: yaml
site0-cert-binding:
win_iis.create_cert_binding:
- name: 9988776655443322111000AAABBBCCCDDDEEEFFF
- site: site0
- hostheader: site0.local
- ipaddress: 192.168.1.199
- port: 443
- sslflags: 1
.. versionadded:: 2016.11.0
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
binding_info = _get_binding_info(hostheader, ipaddress, port)
current_cert_bindings = __salt__['win_iis.list_cert_bindings'](site)
if binding_info in current_cert_bindings:
current_name = current_cert_bindings[binding_info]['certificatehash']
if name == current_name:
ret['comment'] = 'Certificate binding already present: {0}'.format(name)
ret['result'] = True
return ret
ret['comment'] = ('Certificate binding already present with a different'
' thumbprint: {0}'.format(current_name))
ret['result'] = False
elif __opts__['test']:
ret['comment'] = 'Certificate binding will be created: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
else:
ret['comment'] = 'Created certificate binding: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
ret['result'] = __salt__['win_iis.create_cert_binding'](name, site, hostheader,
ipaddress, port, sslflags)
return ret
def remove_cert_binding(name, site, hostheader='', ipaddress='*', port=443):
'''
Remove a certificate from an IIS binding.
.. note:
This function only removes the certificate from the web binding. It does
not remove the web binding itself.
:param str name: The thumbprint of the certificate.
:param str site: The IIS site name.
:param str hostheader: The host header of the binding.
:param str ipaddress: The IP address of the binding.
:param str port: The TCP port of the binding.
Example of usage with only the required arguments:
.. code-block:: yaml
site0-cert-binding-remove:
win_iis.remove_cert_binding:
- name: 9988776655443322111000AAABBBCCCDDDEEEFFF
- site: site0
Example of usage specifying all available arguments:
.. code-block:: yaml
site0-cert-binding-remove:
win_iis.remove_cert_binding:
- name: 9988776655443322111000AAABBBCCCDDDEEEFFF
- site: site0
- hostheader: site0.local
- ipaddress: 192.168.1.199
- port: 443
.. versionadded:: 2016.11.0
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
binding_info = _get_binding_info(hostheader, ipaddress, port)
current_cert_bindings = __salt__['win_iis.list_cert_bindings'](site)
if binding_info not in current_cert_bindings:
ret['comment'] = 'Certificate binding has already been removed: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Certificate binding will be removed: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
else:
current_name = current_cert_bindings[binding_info]['certificatehash']
if name == current_name:
ret['comment'] = 'Removed certificate binding: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
ret['result'] = __salt__['win_iis.remove_cert_binding'](name, site, hostheader,
ipaddress, port)
return ret
def create_apppool(name):
'''
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.
:param str name: The name of the IIS application pool.
Usage:
.. code-block:: yaml
site0-apppool:
win_iis.create_apppool:
- name: site0
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
current_apppools = __salt__['win_iis.list_apppools']()
if name in current_apppools:
ret['comment'] = 'Application pool already present: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Application pool will be created: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
else:
ret['comment'] = 'Created application pool: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
ret['result'] = __salt__['win_iis.create_apppool'](name)
return ret
def remove_apppool(name):
# Remove IIS AppPool
'''
Remove an IIS application pool.
:param str name: The name of the IIS application pool.
Usage:
.. code-block:: yaml
defaultapppool-remove:
win_iis.remove_apppool:
- name: DefaultAppPool
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
current_apppools = __salt__['win_iis.list_apppools']()
if name not in current_apppools:
ret['comment'] = 'Application pool has already been removed: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Application pool will be removed: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
else:
ret['comment'] = 'Removed application pool: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
ret['result'] = __salt__['win_iis.remove_apppool'](name)
return ret
def container_setting(name, container, settings=None):
'''
Set the value of the setting for an IIS container.
:param str name: The name of the IIS container.
:param str container: The type of IIS container. The container types are:
AppPools, Sites, SslBindings
:param str settings: A dictionary of the setting names and their values.
Example of usage for the ``AppPools`` container:
.. code-block:: yaml
site0-apppool-setting:
win_iis.container_setting:
- name: site0
- container: AppPools
- settings:
managedPipelineMode: Integrated
processModel.maxProcesses: 1
processModel.userName: TestUser
processModel.password: TestPassword
Example of usage for the ``Sites`` container:
.. code-block:: yaml
site0-site-setting:
win_iis.container_setting:
- name: site0
- container: Sites
- settings:
logFile.logFormat: W3C
logFile.period: Daily
limits.maxUrlSegments: 32
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
if not settings:
ret['comment'] = 'No settings to change provided.'
ret['result'] = True
return ret
ret_settings = {
'changes': {},
'failures': {},
}
current_settings = __salt__['win_iis.get_container_setting'](name=name,
container=container,
settings=settings.keys())
for setting in settings:
if str(settings[setting]) != str(current_settings[setting]):
ret_settings['changes'][setting] = {'old': current_settings[setting],
'new': settings[setting]}
if not ret_settings['changes']:
ret['comment'] = 'Settings already contain the provided values.'
ret['result'] = True
return ret
elif __opts__['test']:
ret['comment'] = 'Settings will be changed.'
ret['changes'] = ret_settings
return ret
__salt__['win_iis.set_container_setting'](name=name, container=container,
settings=settings)
new_settings = __salt__['win_iis.get_container_setting'](name=name,
container=container,
settings=settings.keys())
for setting in settings:
if str(settings[setting]) != str(new_settings[setting]):
ret_settings['failures'][setting] = {'old': current_settings[setting],
'new': new_settings[setting]}
ret_settings['changes'].pop(setting, None)
if ret_settings['failures']:
ret['comment'] = 'Some settings failed to change.'
ret['changes'] = ret_settings
ret['result'] = False
else:
ret['comment'] = 'Set settings to contain the provided values.'
ret['changes'] = ret_settings['changes']
ret['result'] = True
return ret
def create_app(name, site, sourcepath, apppool=None):
'''
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.
:param str name: The IIS application.
:param str site: The IIS site name.
:param str sourcepath: The physical path.
:param str apppool: The name of the IIS application pool.
Example of usage with only the required arguments:
.. code-block:: yaml
site0-v1-app:
win_iis.create_app:
- name: v1
- site: site0
- sourcepath: C:\\inetpub\\site0\\v1
Example of usage specifying all available arguments:
.. code-block:: yaml
site0-v1-app:
win_iis.create_app:
- name: v1
- site: site0
- sourcepath: C:\\inetpub\\site0\\v1
- apppool: site0
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
current_apps = __salt__['win_iis.list_apps'](site)
if name in current_apps:
ret['comment'] = 'Application already present: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Application will be created: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
else:
ret['comment'] = 'Created application: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
ret['result'] = __salt__['win_iis.create_app'](name, site, sourcepath,
apppool)
return ret
def remove_app(name, site):
'''
Remove an IIS application.
:param str name: The application name.
:param str site: The IIS site name.
Usage:
.. code-block:: yaml
site0-v1-app-remove:
win_iis.remove_app:
- name: v1
- site: site0
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
current_apps = __salt__['win_iis.list_apps'](site)
if name not in current_apps:
ret['comment'] = 'Application has already been removed: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Application will be removed: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
else:
ret['comment'] = 'Removed application: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
ret['result'] = __salt__['win_iis.remove_app'](name, site)
return ret
def create_vdir(name, site, sourcepath, app='/'):
'''
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.
:param str name: The virtual directory name.
:param str site: The IIS site name.
:param str sourcepath: The physical path.
:param str app: The IIS application.
Example of usage with only the required arguments:
.. code-block:: yaml
site0-foo-vdir:
win_iis.create_vdir:
- name: foo
- site: site0
- sourcepath: C:\\inetpub\\vdirs\\foo
Example of usage specifying all available arguments:
.. code-block:: yaml
site0-foo-vdir:
win_iis.create_vdir:
- name: foo
- site: site0
- sourcepath: C:\\inetpub\\vdirs\\foo
- app: v1
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
current_vdirs = __salt__['win_iis.list_vdirs'](site, app)
if name in current_vdirs:
ret['comment'] = 'Virtual directory already present: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Virtual directory will be created: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
else:
ret['comment'] = 'Created virtual directory: {0}'.format(name)
ret['changes'] = {'old': None,
'new': name}
ret['result'] = __salt__['win_iis.create_vdir'](name, site, sourcepath,
app)
return ret
def remove_vdir(name, site, app='/'):
'''
Remove an IIS virtual directory.
:param str name: The virtual directory name.
:param str site: The IIS site name.
:param str app: The IIS application.
Example of usage with only the required arguments:
.. code-block:: yaml
site0-foo-vdir-remove:
win_iis.remove_vdir:
- name: foo
- site: site0
Example of usage specifying all available arguments:
.. code-block:: yaml
site0-foo-vdir-remove:
win_iis.remove_vdir:
- name: foo
- site: site0
- app: v1
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
current_vdirs = __salt__['win_iis.list_vdirs'](site, app)
if name not in current_vdirs:
ret['comment'] = 'Virtual directory has already been removed: {0}'.format(name)
ret['result'] = True
elif __opts__['test']:
ret['comment'] = 'Virtual directory will be removed: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
else:
ret['comment'] = 'Removed virtual directory: {0}'.format(name)
ret['changes'] = {'old': name,
'new': None}
ret['result'] = __salt__['win_iis.remove_vdir'](name, site, app)
return ret
def set_app(name, site, settings=None):
r'''
Set the value of the setting for an IIS web application.
.. note::
This function only configures 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.
:available settings: physicalPath: The physical path of the webapp.
: applicationPool: The application pool for the webapp.
: userName: "connectAs" user
: password: "connectAs" password for user
:rtype: bool
.. versionadded:: Nitrogen
Example of usage:
.. code-block:: yaml
site0-webapp-setting:
win_iis.set_app:
- name: app0
- site: Default Web Site
- settings:
userName: domain\user
password: pass
physicalPath: c:\inetpub\wwwroot
applicationPool: appPool0
'''
ret = {'name': name,
'changes': {},
'comment': str(),
'result': None}
if not settings:
ret['comment'] = 'No settings to change provided.'
ret['result'] = True
return ret
ret_settings = {
'changes': {},
'failures': {},
}
current_settings = __salt__['win_iis.get_webapp_settings'](name=name,
site=site,
settings=settings.keys())
for setting in settings:
if str(settings[setting]) != str(current_settings[setting]):
ret_settings['changes'][setting] = {'old': current_settings[setting],
'new': settings[setting]}
if not ret_settings['changes']:
ret['comment'] = 'Settings already contain the provided values.'
ret['result'] = True
return ret
elif __opts__['test']:
ret['comment'] = 'Settings will be changed.'
ret['changes'] = ret_settings
return ret
__salt__['win_iis.set_webapp_settings'](name=name, site=site,
settings=settings)
new_settings = __salt__['win_iis.get_webapp_settings'](name=name, site=site, settings=settings.keys())
for setting in settings:
if str(settings[setting]) != str(new_settings[setting]):
ret_settings['failures'][setting] = {'old': current_settings[setting],
'new': new_settings[setting]}
ret_settings['changes'].pop(setting, None)
if ret_settings['failures']:
ret['comment'] = 'Some settings failed to change.'
ret['changes'] = ret_settings
ret['result'] = False
else:
ret['comment'] = 'Set settings to contain the provided values.'
ret['changes'] = ret_settings['changes']
ret['result'] = True
return ret
Reference in a new issue View git blame Copy permalink