Current File : //lib/python2.7/site-packages/salt/modules/win_dsc.pyc
�
���^c @@ sP 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 m
Z
e j e � Z d Z d � Z d d e d � Z d d d d d d d
� Z d d d d d d d � Z d d d � Z d
� Z e d � Z d � Z d � Z d � Z d � Z d d d d d d d d d e d d � Z d S( u�
Module for working with Windows PowerShell DSC (Desired State Configuration)
This module is Alpha
This module applies DSC Configurations in the form of PowerShell scripts or
MOF (Managed Object Format) schema files.
Use the ``psget`` module to manage PowerShell resources.
The idea is to leverage Salt to push DSC configuration scripts or MOF files to
the Minion.
:depends:
- PowerShell 5.0
i ( t absolute_importt unicode_literalst print_functionN( t CommandExecutionErrort SaltInvocationErroru dscc C@ s� t j j j � s) t j d � t d f St d d � } | d sZ t j d � t d f St j j j | d d d � r� t j d � t d f St
S(
u8
Set the system module of the kernel is Windows
u& DSC: Only available on Windows systemsu cmd.shell_infou
powershellu installedu DSC: Requires PowerShellu versionu <u 5.0u# DSC: Requires PowerShell 5 or later( t saltt utilst platformt
is_windowst logt debugt Falset __salt__t versionst comparet __virtualname__( t powershell_info( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt __virtual__% s
i c
C@ s/ d | j � k r' d j | | � } n t j d | � t d | d d d | d t d | �} d
| k ru | d
=n d | k s� | d d k r� t d
j | � d | �� n | d d k r� d | d <n y# t j j j
| d d t �} Wn# t k
rt d d | �� n Xt j
d j | � � | S( u�
Execute the desired PowerShell command and ensure that it returns data
in json format and load that into python. Either return a dict or raise a
CommandExecutionError.
u convertto-jsonu {0} | ConvertTo-Json -Depth {1}u DSC: %su cmd.run_allt shellu
powershellt cwdt python_shellt ignore_retcodeu pidu retcodei u Issue executing PowerShell {0}t infou stdoutu u {}t strictu No JSON results from PowerShellu DSC: Returning "{0}"( t lowert formatR R
R t TrueR R R t jsont loadsR t
ValueErrorR ( t cmdR t
json_depthR t resultst ret( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt _pshell< s(
#
u basec C@ sj t d | d | d | d | d | d | d | � } | j d � rb t j j | d � } t | � St Sd
S( ux
Compile a DSC Configuration in the form of a PowerShell script (.ps1) and
apply it. The PowerShell script can be cached from the master using the
``source`` option. If there is more than one config within the PowerShell
script, the desired configuration can be applied by passing the name in the
``config`` option.
This command would be the equivalent of running ``dsc.compile_config``
followed by ``dsc.apply_config``.
Args:
path (str): The local path to the PowerShell script that contains the
DSC Configuration. Required.
source (str): The path to the script on ``file_roots`` to cache at the
location specified by ``path``. The source file will be cached
locally and then executed. If source is not passed, the config
script located at ``path`` will be compiled. Optional.
config_name (str): The name of the Configuration within the script to
apply. If the script contains multiple configurations within the
file a ``config_name`` must be specified. If the ``config_name`` is
not specified, the name of the file will be used as the
``config_name`` to run. Optional.
config_data (str): Configuration data in the form of a hash table that
will be passed to the ``ConfigurationData`` parameter when the
``config_name`` is compiled. This can be the path to a ``.psd1``
file containing the proper hash table or the PowerShell code to
create the hash table.
.. versionadded:: 2017.7.0
config_data_source (str): The path to the ``.psd1`` file on
``file_roots`` to cache at the location specified by
``config_data``. If this is specified, ``config_data`` must be a
local path instead of a hash table.
.. versionadded:: 2017.7.0
script_parameters (str): Any additional parameters expected by the
configuration script. These must be defined in the script itself.
.. versionadded:: 2017.7.0
salt_env (str): The salt environment to use when copying the source.
Default is 'base'
Returns:
bool: True if successfully compiled and applied, otherwise False
CLI Example:
To compile a config from a script that already exists on the system:
.. code-block:: bash
salt '*' dsc.run_config C:\\DSC\\WebsiteConfig.ps1
To cache a config script to the system from the master and compile it:
.. code-block:: bash
salt '*' dsc.run_config C:\\DSC\\WebsiteConfig.ps1 salt://dsc/configs/WebsiteConfig.ps1
t patht sourcet config_namet config_datat config_data_sourcet script_parameterst salt_envu Existsu FullNameN( t compile_configt gett osR# t dirnamet apply_configR ( R# R$ R% R& R' R( R) R! t config_path( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt
run_config_ s I
c C@ s� | rx t j d | � t d d | d | d | d t � } | sx d j | � } t j d j | � � t | � � qx n | r� t j d | � t d d | d | d | d t � } | s� d j | � } t j d j | � � t | � � q� n t j j | � s6d j | � } t j d j | � � t | � � n | d k rgt j j t j j | � � d
} n t j j
| � } | g }
| r�|
j | � n |
j d � d j |
� }
t |
| � } | r�| j d
� r�t j d | � | Sn d | g }
| r|
j | � n |
j d | g � | r:|
j | � n |
j d � d j |
� }
t |
| � } | r�| j d
� r�t j d | � | Sn d j | � } | d j | � 7} t j d | � t | � � d S( u1
Compile a config from a PowerShell script (``.ps1``)
Args:
path (str): Path (local) to the script that will create the ``.mof``
configuration file. If no source is passed, the file must exist
locally. Required.
source (str): Path to the script on ``file_roots`` to cache at the
location specified by ``path``. The source file will be cached
locally and then executed. If source is not passed, the config
script located at ``path`` will be compiled. Optional.
config_name (str): The name of the Configuration within the script to
apply. If the script contains multiple configurations within the
file a ``config_name`` must be specified. If the ``config_name`` is
not specified, the name of the file will be used as the
``config_name`` to run. Optional.
config_data (str): Configuration data in the form of a hash table that
will be passed to the ``ConfigurationData`` parameter when the
``config_name`` is compiled. This can be the path to a ``.psd1``
file containing the proper hash table or the PowerShell code to
create the hash table.
.. versionadded:: 2017.7.0
config_data_source (str): The path to the ``.psd1`` file on
``file_roots`` to cache at the location specified by
``config_data``. If this is specified, ``config_data`` must be a
local path instead of a hash table.
.. versionadded:: 2017.7.0
script_parameters (str): Any additional parameters expected by the
configuration script. These must be defined in the script itself.
.. versionadded:: 2017.7.0
salt_env (str): The salt environment to use when copying the source.
Default is 'base'
Returns:
dict: A dictionary containing the results of the compilation
CLI Example:
To compile a config from a script that already exists on the system:
.. code-block:: bash
salt '*' dsc.compile_config C:\\DSC\\WebsiteConfig.ps1
To cache a config script to the system from the master and compile it:
.. code-block:: bash
salt '*' dsc.compile_config C:\\DSC\\WebsiteConfig.ps1 salt://dsc/configs/WebsiteConfig.ps1
u DSC: Caching %su cp.get_fileR# t destt saltenvt makedirsu Failed to cache {0}u DSC: {0}u "{0}" not foundi u� | Select-Object -Property FullName, Extension, Exists, @{Name="LastWriteTime";Expression={Get-Date ($_.LastWriteTime) -Format g}}u u Existsu DSC: Compile Config: %su .u ;u Failed to compile config: {0}u
Returned: {0}u DSC: %sN( R R R R R t errorR R, R# t existst Nonet splitextt basenameR- t appendt joinR" R+ t extend( R# R$ R% R& R' R( R) t cached_filesR4 R R R! ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyR* � sl C %
c C@ s� | } | r t j j t j j | � � } t j j t j j | � � } | j � | j � k r� d j | | � } t j d | � n t j j t j j | � � } t j d | � t
d | | | � } | sd j | � } t j d j | � � t | � � q t j j | d � } n t j j
| � sbd j | � } t j d j | � � t | � � n d j | � } t | � d
} t | � }
t j d |
� |
d k p�|
i k S(
u�
Run an compiled DSC configuration (a folder containing a .mof file). The
folder can be cached from the salt master using the ``source`` option.
Args:
path (str): Local path to the directory that contains the .mof
configuration file to apply. Required.
source (str): Path to the directory that contains the .mof file on the
``file_roots``. The source directory will be copied to the path
directory and then executed. If the path and source directories
differ, the source directory will be applied. If source is not
passed, the config located at ``path`` will be applied. Optional.
salt_env (str): The salt environment to use when copying your source.
Default is 'base'
Returns:
bool: True if successful, otherwise False
CLI Example:
To apply a config that already exists on the the system
.. code-block:: bash
salt '*' dsc.apply_config C:\\DSC\\WebSiteConfiguration
To cache a configuration from the master and apply it:
.. code-block:: bash
salt '*' dsc.apply_config C:\\DSC\\WebSiteConfiguration salt://dsc/configs/WebSiteConfiguration
u {0}\{1}u DSC: %s appended to the path.u DSC: Caching %su
cp.get_diru Failed to copy {0}u DSC: {0}i u
{0} not foundu/ Start-DscConfiguration -Path "{0}" -Wait -Forceu4 $status = Get-DscConfigurationStatus; $status.Statusu DSC: Apply Config: %su Success( R, R# R8 t normpathR R R R
R- R R R4 R R5 R" ( R# R$ R) t configt path_namet source_namet dest_pathR< R4 R R! ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyR. L s2 (
c C@ s� d } y t | d t �} Wn8 t k
rV } d | j d k rP t d � � n � n Xt � } | r� d | d k r� i | | d d <n xe | D]Z } i | | d | d <x; | D]3 } | d k r� | | | | d | d | <q� q� Wq� Wn | S(
u
Get the current DSC Configuration
Returns:
dict: A dictionary representing the DSC Configuration on the machine
Raises:
CommandExecutionError: On failure
CLI Example:
.. code-block:: bash
salt '*' dsc.get_config
u< Get-DscConfiguration | Select-Object * -ExcludeProperty Cim*R u$ Current configuration does not existu stderru Not Configuredu ConfigurationNamei u
ResourceId( u ConfigurationNameu
ResourceId( R" R R R t dict( R t
raw_configt excR> t itemt key( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt
get_config� s"
,c C@ si d } t j d � y t | � Wn[ t k
r~ } | j d d k r^ t d d | j �� n t j d j | j d � � n Xd } t j d
� y t | � Wn[ t k
r� } | j d d k r� t d d | j �� n t j d j | j d � � n X| st Sd � } d
j t j d d � � } | d j | � � | d j | � � | d j | � � t S( u�
Remove the current DSC Configuration. Removes current, pending, and previous
dsc configurations.
.. versionadded:: 2017.7.5
Args:
reset (bool):
Attempts to reset the DSC configuration by removing the following
from ``C:\Windows\System32\Configuration``:
- File: DSCStatusHistory.mof
- File: DSCEngineCache.mof
- Dir: ConfigurationStatus
Default is False
.. warning::
``remove_config`` may fail to reset the DSC environment if any
of the files in the ``ConfigurationStatus`` directory. If you
wait a few minutes and run again, it may complete successfully.
Returns:
bool: True if successful
Raises:
CommandExecutionError: On failure
CLI Example:
.. code-block:: bash
salt '*' dsc.remove_config True
u Stop-DscConfigurationu# DSC: Stopping Running Configurationu retcodei u Failed to Stop DSC ConfigurationR u DSC: {0}u stdoutuH Remove-DscConfigurationDocument -Stage Current, Pending, Previous -Forceu DSC: Removing Configurationu" Failed to remove DSC Configurationc S@ ss t j j | � ro t j d j | � � t d | � so d j | � } t j d j | � � t | � � qo n d S( Nu DSC: Removing {0}u file.removeu Failed to remove {0}u DSC: {0}( R, R# R5 R R R R R4 R ( R# R4 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt _remove_fs_obj s u {0}\System32\Configurationu
SystemRootu
C:\Windowsu {0}\DSCStatusHistory.mofu {0}\DSCEngineCache.mofu {0}\ConfigurationStatus( R R R" R R R R, t getenv( t resetR RD RH t dsc_config_dir( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt
remove_config� s6 $
!
! c C@ sY d } y t | d t �Wn8 t k
rT } d | j d k rN t d � � n � n Xt S( u�
Reapplies the previous configuration.
.. versionadded:: 2017.7.5
.. note::
The current configuration will be come the previous configuration. If
run a second time back-to-back it is like toggling between two configs.
Returns:
bool: True if successfully restored
Raises:
CommandExecutionError: On failure
CLI Example:
.. code-block:: bash
salt '*' dsc.restore_config
u Restore-DscConfigurationR u' A previous configuration does not existu stderru Previous Configuration Not Found( R" R R R ( R RD ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt restore_config s c C@ sY d } y t | d t �Wn8 t k
rT } d | j d k rN t d � � n � n Xd S( u�
Tests the current applied DSC Configuration
Returns:
bool: True if successfully applied, otherwise False
CLI Example:
.. code-block:: bash
salt '*' dsc.test_config
u Test-DscConfigurationR u$ Current configuration does not existu stderru Not ConfiguredN( R" R R R ( R RD ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt test_config7 s
c C@ sY d } y t | d t �SWn8 t k
rT } d | j d k rN t d � � n � n Xd S( u
Get the status of the current DSC Configuration
Returns:
dict: A dictionary representing the status of the current DSC
Configuration on the machine
CLI Example:
.. code-block:: bash
salt '*' dsc.get_config_status
u� Get-DscConfigurationStatus | Select-Object -Property HostName, Status, MetaData, @{Name="StartDate";Expression={Get-Date ($_.StartDate) -Format g}}, Type, Mode, RebootRequested, NumberofResourcesR u No status information availableu stderru Not ConfiguredN( R" R R R ( R RD ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt get_config_statusM s c C@ s d } t | � S( u
Get the current Local Configuration Manager settings
Returns:
dict: A dictionary representing the Local Configuration Manager settings
on the machine
CLI Example:
.. code-block:: bash
salt '*' dsc.get_lcm_config
u Get-DscLocalConfigurationManager | Select-Object -Property ConfigurationModeFrequencyMins, LCMState, RebootNodeIfNeeded, ConfigurationMode, ActionAfterReboot, RefreshMode, CertificateID, ConfigurationID, RefreshFrequencyMins, AllowModuleOverwrite, DebugMode, StatusRetentionTimeInDays ( R" ( R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt get_lcm_configg s c C@ s� t j d d j t j d � � � } d } | d 7} | d 7} | r� | d6 k rn d
j | � }
t |
� � n | d j | � 7} n | r� t | t � s� d j | � }
t |
� � n | d
j | � 7} n | r| d7 k r� t d � � n | d j | � 7} n | r>t | t � s(t d � � n | d j | � 7} n | d5 k r�t | t � sht d � � n | rwd } n d } | d j | � 7} n | r�| d8 k r�t d � � n | d j | � 7} n | d5 k r| d k r�d5 } n | d j | � 7} n | d5 k r8| d k r"d5 } n | d j | � 7} n | d5 k r�t | t � sbt d � � n | rqd } n d } | d! j | � 7} n | t k r�| d5 k r�d" } n | d9 k r�t d% � � n | d& j | � 7} n |
rt |
t � st d' � � n | d( j |
� 7} n | d) 7} | d* j | � 7} t | � d+ j | � } t
d, | d- d. d/ t �} t
d0 d1 j | � � | d2 s�t j
d3 � t St j d4 | � t Sd5 S(: uG
For detailed descriptions of the parameters see:
https://msdn.microsoft.com/en-us/PowerShell/DSC/metaConfig
config_mode (str): How the LCM applies the configuration. Valid values
are:
- ApplyOnly
- ApplyAndMonitor
- ApplyAndAutoCorrect
config_mode_freq (int): How often, in minutes, the current configuration
is checked and applied. Ignored if config_mode is set to ApplyOnly.
Default is 15.
refresh_mode (str): How the LCM gets configurations. Valid values are:
- Disabled
- Push
- Pull
refresh_freq (int): How often, in minutes, the LCM checks for updated
configurations. (pull mode only) Default is 30.
reboot_if_needed (bool): Reboot the machine if needed after a
configuration is applied. Default is False.
action_after_reboot (str): Action to take after reboot. Valid values
are:
- ContinueConfiguration
- StopConfiguration
certificate_id (guid): A GUID that specifies a certificate used to
access the configuration: (pull mode)
configuration_id (guid): A GUID that identifies the config file to get
from a pull server. (pull mode)
allow_module_overwrite (bool): New configs are allowed to overwrite old
ones on the target node.
debug_mode (str): Sets the debug level. Valid values are:
- None
- ForceModuleImport
- All
status_retention_days (int): Number of days to keep status of the
current config.
.. note::
Either ``config_mode_freq`` or ``refresh_freq`` needs to be a
multiple of the other. See documentation on MSDN for more details.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' dsc.set_lcm_config ApplyOnly
u TEMPu {0}\tempu WINDIRu Configuration SaltConfig {u Node localhost {u# LocalConfigurationManager {u ApplyOnlyu ApplyAndMonitoru ApplyAndAutoCorrectuY config_mode must be one of ApplyOnly, ApplyAndMonitor, or ApplyAndAutoCorrect. Passed {0}u& ConfigurationMode = "{0}";u/ config_mode_freq must be an integer. Passed {0}u1 ConfigurationModeFrequencyMins = {0};u Disabledu Pushu Pullu3 refresh_mode must be one of Disabled, Push, or Pullu RefreshMode = "{0}";u refresh_freq must be an integeru' RefreshFrequencyMins = {0};u( reboot_if_needed must be a boolean valueu $trueu $falseu% RebootNodeIfNeeded = {0};u ContinueConfigurationu StopConfigurationuM action_after_reboot must be one of ContinueConfiguration or StopConfigurationu% ActionAfterReboot = "{0}"u u" CertificateID = "{0}";u$ ConfigurationID = "{0}";u. allow_module_overwrite must be a boolean valueu' AllowModuleOverwrite = {0};u Noneu ForceModuleImportu AlluQ debug_mode must be one of None, ForceModuleImport, ResourceScriptBreakAll, or Allu DebugMode = "{0}";u( status_retention_days must be an integeru, StatusRetentionTimeInDays = {0};u }}};u' SaltConfig -OutputPath "{0}\SaltConfig"u7 Set-DscLocalConfigurationManager -Path "{0}\SaltConfig"u cmd.run_allR u
powershellR u file.removeu {0}\SaltConfigu retcodeu$ DSC: LCM config applied successfullyu) DSC: Failed to apply LCM config. Error %sN( u ApplyOnlyu ApplyAndMonitoru ApplyAndAutoCorrect( u Disabledu Pushu Pull( u ContinueConfigurationu StopConfiguration( u Noneu ForceModuleImportu All( R, RI R R t
isinstancet intR6 t boolR R" R R R R R4 ( t config_modet config_mode_freqt refresh_freqt reboot_if_neededt action_after_reboott refresh_modet certificate_idt configuration_idt allow_module_overwritet
debug_modet status_retention_dayst temp_dirR R4 R! ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt set_lcm_config} s� K$
( t __doc__t
__future__R R R t loggingR, t salt.utils.jsonR t salt.utils.platformt salt.utils.versionst salt.exceptionsR R t getLoggert __name__R R R R6 R R" R0 R* R. RG RL RM RN RO RP R` ( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_dsc.pyt <module> sR $ S �O ( T
Mini Shell