File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/win_dsc.cpython-310.pyc
Back
o ;j�s � @ s� d Z ddlZddlZddlZddlZddlZddlmZm Z e� e �Z dZ dd� Zd d d �Z d!d d �Z d!dd�Zd"dd�Zdd� Zd#dd�Zdd� Zdd� Zdd� Zd d � Z d$d d �ZdS )%a� 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 � N)�CommandExecutionError�SaltInvocationErrorZdscc C sd t jj�� s t�d� dS td d�} | d s t�d� dS t jj�| d d d �r0t�d � d S t S ) z8 Set the system module of the kernel is Windows �&DSC: Only available on Windows systems)Fr zcmd.shell_info� powershellZ installed�DSC: Requires PowerShell)Fr �version�<z5.0�#DSC: Requires PowerShell 5 or later)Fr ) �salt�utils�platformZ is_windows�log�debug�__salt__ZversionsZcompare�__virtualname__)Zpowershell_info� r �H/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/win_dsc.py� __virtual__! s r � Fc C s� d| � � vr | � d|� �} t�d| � td | d|d|d�}d|v r%|d= d |vs/|d d kr8td | � �|d ��|d dkrBd|d < z tjjj|d dd�}W n t y\ td|d ��w t� d|� |S )z� 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. zConvertTo-Jsonz | ConvertTo-Json -Depth �DSC: %s� cmd.run_allr T)�shell�cwd� python_shell�ignore_retcode�pid�retcoder zIssue executing PowerShell ��info�stdout� z{}F)�strictz No JSON results from PowerShellzDSC: Returning "%s") �lowerr r r r r r �json�loads� ValueErrorr )�cmdr Z json_depthr �results�retr r r �_pshell8 s. � � r) �basec C s< t | ||||||d�}|�d�r tj�|d �}t|�S dS )a� 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 (:obj:`str`, optional): 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. Default is ``None``. config_name (:obj:`str`, optional): 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. Default is ``None``. config_data (:obj:`str`, optional): 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. Default is ``None``. .. versionadded:: 2017.7.0 config_data_source (:obj:`str`, optional): 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. Default is ``None``. .. versionadded:: 2017.7.0 script_parameters (:obj:`str`, optional): Any additional parameters expected by the configuration script. These must be defined in the script itself. Note that these are passed to the script (the outermost scope), and not to the dsc configuration inside the script (the inner scope). Default is ``None``. .. versionadded:: 2017.7.0 salt_env (:obj:`str`, optional): The salt environment to use when copying the source. Default is ``base``. Returns: bool: ``True`` if successfully compiled and applied, otherwise ``False`` CLI Example: .. code-block:: bash # To compile a config from a script that already exists on the system salt '*' dsc.run_config 'C:\\DSC\\WebsiteConfig.ps1' .. code-block:: bash # To cache a config script to the system from the master and compile it salt '*' dsc.run_config 'C:\\DSC\\WebsiteConfig.ps1' salt://dsc/configs/WebsiteConfig.ps1 .. code-block:: bash # To cache a config script to the system from the master and compile it, passing in `script_parameters`: salt '*' dsc.run_config path='C:\\DSC\\WebsiteConfig.ps1' source=salt://dsc/configs/WebsiteConfig.ps1 script_parameters='-hostname "my-computer" -ip "192.168.1.10" -DnsArray "192.168.1.3","192.168.1.4","1.1.1.1"' )�path�source� config_name� config_data�config_data_source�script_parameters�salt_env�ExistsZFullNameF)�compile_config�get�osr+ �dirname� apply_config) r+ r, r- r. r/ r0 r1 r( Z config_pathr r r � run_config] s [� r8 c C s� |r#t �d|� td || |dd�}|s#d|� �}t �d|� t|��|rFt �d|� td |||dd�}|sFd|� �}t �d|� t|��tj�| �s[| � d�}t �d|� t|��|du rktj�tj� | ��d }tj� | �} | g} |r{| � |� | � d � d � | �} t | | �} | r�| �d �r�t �d | � | S d| g} |r�| � |� | �d|g� |r�| �d|g� | � d � d � | �} t | | �} | r�| �d �r�t �d | � | S d| � �}|d| � �7 }t �d|� t|��)a� 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. source (:obj:`str`, optional): 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. Default is ``None``. config_name (:obj:`str`, optional): 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. Default is ``None``. config_data (:obj:`str`, optional): 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. Default is ``None``. .. versionadded:: 2017.7.0 config_data_source (:obj:`str`, optional): 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. Default is ``None``. .. versionadded:: 2017.7.0 script_parameters (:obj:`str`, optional): Any additional parameters expected by the configuration script. These must be defined in the script itself. Default is ``None``. .. versionadded:: 2017.7.0 salt_env (Optional[str]): salt_env (Optional[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: .. code-block:: bash # To compile a config from a script that already exists on the system salt '*' dsc.compile_config 'C:\\DSC\\WebsiteConfig.ps1' .. code-block:: bash # To cache a config script to the system from the master and compile it: salt '*' dsc.compile_config 'C:\\DSC\\WebsiteConfig.ps1' salt://dsc/configs/WebsiteConfig.ps1 �DSC: Caching %sz cp.get_fileT)r+ �destZsaltenv�makedirszFailed to cache r � not foundNr z�| Where-Object FullName -match '(?<!\.meta)\.mof$' | Select-Object -Property FullName, Extension, Exists, @{Name='LastWriteTime';Expression={Get-Date ($_.LastWriteTime) -Format g}}� r2 zDSC: Compile Config: %s�.�;z-ConfigurationDatazFailed to compile config: z Returned: )r r r �errorr r5 r+ �exists�splitext�basenamer6 �append�joinr) r4 �extend) r+ r, r- r. r/ r0 r1 � cached_filesr@ r r& r( r r r r3 � sp N � � � � r3 c C s" | }|r^t j�t j�| ��}t j�t j�|��}|�� |�� kr-| � d|� �} t�d|� t j�t j�| ��}t�d|� t d |||�}|sVd|� �}t� d|� t |��t j�|d �}t j� |�ss|� d�}t� d|� t |��d |� d �} t | � d } t | �} t�d | � | d kp�| i kS )a" 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. source (:obj:`str`, optional): 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. Default is ``None``. salt_env (:obj:`str`, optional): The salt environment to use when copying your source. Default is ``base``. Returns: bool: ``True`` if successful, otherwise ``False`` CLI Example: .. code-block:: bash # To apply a config that already exists on the system salt '*' dsc.apply_config 'C:\\DSC\\WebSiteConfiguration' .. code-block:: bash # To cache a configuration from the master and apply it salt '*' dsc.apply_config 'C:\\DSC\\WebSiteConfiguration' salt://dsc/configs/WebSiteConfiguration �\z DSC: %s appended to the path.r9 z cp.get_dirzFailed to copy r r r< z Start-DscConfiguration -Path 'z' -Wait -Forcez4$status = Get-DscConfigurationStatus; $status.StatuszDSC: Apply Config: %sZSuccess)r5 r+ rC �normpathr" r r r6 r r r@ r rA r) ) r+ r, r1 �config� path_nameZ source_name� dest_pathrG r@ r& r( r r r r7 l s2 * r7 c C s� d} zt | dd�}W n ty" } z d|jd v r td��� d}~ww t� }|s,td��d|v rC|�d�}|�d �}|�|||i� n!|D ] }d|v rc|�d�}|�d �}|�|i � || �||� qE|sjtd ��|S ) a 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 z<Get-DscConfiguration | Select-Object * -ExcludeProperty Cim*T�r �$Current configuration does not exist�stderr�Not ConfiguredNZConfigurationNameZ ResourceIdzUnable to parse config)r) r r �dict�pop� setdefault)r& Z raw_config�excrJ r- Z resource_id�itemr r r � get_config� s4 �� �rV c C s, d}t �d� zt|� W n) ty6 } z |jd dkr#td|jd��t �d|jd � W Y d }~nd }~ww d }t �d � zt|� W n) tym } z |jd dkrZtd |jd��t �d|jd � W Y d }~nd }~ww | srd S dd� }d�t�dd��}||� d�� ||� d�� ||� d�� d S )a� Remove the current DSC Configuration. Removes current, pending, and previous dsc configurations. .. versionadded:: 2017.7.5 Args: reset (:obj:`bool`, optional): 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 are in use. 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 zStop-DscConfigurationz#DSC: Stopping Running Configurationr r z Failed to Stop DSC Configurationr r r NzHRemove-DscConfigurationDocument -Stage Current, Pending, Previous -ForcezDSC: Removing Configurationz"Failed to remove DSC ConfigurationTc S sJ t j�| �r!t�d| � td | �s#d| � �}t�d|� t|��d S d S )NzDSC: Removing %s� file.removezFailed to remove r )r5 r+ rA r r r r@ r )r+ r@ r r r �_remove_fs_obj/ s �z%remove_config.<locals>._remove_fs_objz{}\System32\ConfigurationZ SystemRootz C:\Windowsz\DSCStatusHistory.mofz\DSCEngineCache.mofz\ConfigurationStatus)r r r) r �formatr5 �getenv)�resetr& rT rX Zdsc_config_dirr r r � remove_config� sD & � �� � �� �r\ c C sH d} z t | dd� W dS ty# } z d|jd v r td��� d}~ww )a� Reapplies the previous configuration. .. versionadded:: 2017.7.5 .. note:: The current configuration will become the previous configuration. If run a second time back-to-back it is like toggling between two configs. Returns: bool: ``True`` if successfully restored, otherwise ``False`` Raises: CommandExecutionError: On failure CLI Example: .. code-block:: bash salt '*' dsc.restore_config zRestore-DscConfigurationTrM z'A previous configuration does not existrO z Previous Configuration Not FoundN�r) r r )r& rT r r r �restore_configG s ���r^ c C sV d} zt | dd�}W n ty" } z d|jd v r td��� d}~ww |s)td��dS )z� Tests the current applied DSC Configuration Returns: bool: ``True`` if successfully applied, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' dsc.test_config zTest-DscConfigurationTrM rN rO rP Nr] �r& �resultrT r r r � test_configg s ��ra c C sV d} zt | dd�}W n ty" } z d|jd v r td��� d}~ww |s)td��|S )a 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 z�Get-DscConfigurationStatus | Select-Object -Property HostName, Status, MetaData, @{Name='StartDate';Expression={Get-Date ($_.StartDate) -Format g}}, Type, Mode, RebootRequested, NumberofResourcesTrM z No status information availablerO rP Nr] r_ r r r �get_config_status� s ���rb c C s d} t | �S )a 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 a Get-DscLocalConfigurationManager | Select-Object -Property ConfigurationModeFrequencyMins, LCMState, RebootNodeIfNeeded, ConfigurationMode, ActionAfterReboot, RefreshMode, CertificateID, ConfigurationID, RefreshFrequencyMins, AllowModuleOverwrite, DebugMode, StatusRetentionTimeInDays )r) )r& r r r �get_lcm_config� s �rc c C st t �dd�t �d���} d} | d7 } | d7 } | r-| dvr%d�| �} t| ��| d | � d �7 } |rDt|t�s=d �|�} t| ��| d �|�7 } |rV|d vrNtd��| d|� d �7 } |rit|t�satd��| d|� d�7 } |dur�t|t�svtd��|r{d}nd}| d|� d�7 } |r�|dvr�td��| d|� d�7 } |dur�|d kr�d}| d |� d �7 } |dur�|d kr�d}| d |� d �7 } |dur�t|t�s�td ��|r�d}nd}| d!|� d�7 } | du r�d"} | d#vr�td$��| d%| � d �7 } | r�t| t�s�td&��| d'�| �7 } | d(7 } | d)| � d*�7 } t| � d+�| �} td, | d-d.d/�}td0 | � d1�� |d2 �s2t � d3� d.S t � d4|� d5S )6a For detailed descriptions of the parameters see: https://msdn.microsoft.com/en-us/PowerShell/DSC/metaConfig Args: config_mode (:obj:`str`, optional): How the LCM applies the configuration. Valid values are: - ApplyOnly - ApplyAndMonitor - ApplyAndAutoCorrect Default is ``None``. config_mode_freq (:obj:`int`, optional): How often, in minutes, the current configuration is checked and applied. Ignored if config_mode is set to ``ApplyOnly``. Default is 15. refresh_mode (:obj:`str`, optional): How the LCM gets configurations. Valid values are: - Disabled - Push - Pull Default is ``None``. refresh_freq (:obj:`int`, optional): How often, in minutes, the LCM checks for updated configurations (pull mode only). Default is 30. reboot_if_needed (:obj:`bool`, optional): Reboot the machine if needed after a configuration is applied. Default is ``False``. action_after_reboot (:obj:`str`, optional): Action to take after reboot. Valid values are: - ContinueConfiguration - StopConfiguration Default is ``None``. certificate_id (:obj:`guid`, optional): A GUID that specifies a certificate used to access the configuration (pull mode). Default is ``None``. configuration_id (:obj:`guid`, optional): A GUID that identifies the config file to get from a pull server (pull mode). Default is ``None``. allow_module_overwrite (:obj:`bool`, optional): New configs are allowed to overwrite old ones on the target node. Default is ``False``. debug_mode (:obj:`str`, optional): Sets the debug level. Valid values are: - None - ForceModuleImport - All Default is ``None``. status_retention_days (:obj:`int`, optional): Number of days to keep status of the current config. Default is 10 .. 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 ZTEMPz{}\tempZWINDIRzConfiguration SaltConfig {z Node localhost {z# LocalConfigurationManager {)Z ApplyOnlyZApplyAndMonitorZApplyAndAutoCorrectzXconfig_mode must be one of ApplyOnly, ApplyAndMonitor, or ApplyAndAutoCorrect. Passed {}z! ConfigurationMode = 'z';z.config_mode_freq must be an integer. Passed {}z0 ConfigurationModeFrequencyMins = {};)ZDisabledZPushZPullz3refresh_mode must be one of Disabled, Push, or Pullz RefreshMode = 'z refresh_freq must be an integerz# RefreshFrequencyMins = r? Nz(reboot_if_needed must be a boolean valuez$truez$falsez! RebootNodeIfNeeded = )ZContinueConfigurationZStopConfigurationzMaction_after_reboot must be one of ContinueConfiguration or StopConfigurationz! ActionAfterReboot = "�"r z CertificateID = "z";z ConfigurationID = "z.allow_module_overwrite must be a boolean valuez# AllowModuleOverwrite = �None)re ZForceModuleImportZAllzQdebug_mode must be one of None, ForceModuleImport, ResourceScriptBreakAll, or Allz DebugMode = "z(status_retention_days must be an integerz+ StatusRetentionTimeInDays = {};z }}};zSaltConfig -OutputPath "z \SaltConfig"z6Set-DscLocalConfigurationManager -Path "{}\SaltConfig"r r T)r r rW z \SaltConfigr z$DSC: LCM config applied successfullyz)DSC: Failed to apply LCM config. Error %sF) r5 rZ rY r � isinstance�int�boolr) r r r r@ )Z config_modeZconfig_mode_freqZ refresh_freqZreboot_if_neededZaction_after_rebootZ refresh_modeZcertificate_idZconfiguration_idZallow_module_overwriteZ debug_modeZstatus_retention_daysZtemp_dirr& r@ r( r r r �set_lcm_config� s� c� ��� � � � ri )Nr F)NNNNNr* )Nr* )F) NNNNNNNNNNN)�__doc__�loggingr5 Zsalt.utils.jsonr Zsalt.utils.platformZsalt.utils.versionsZsalt.exceptionsr r � getLogger�__name__r r r r) r8 r3 r7 rV r\ r^ ra rb rc ri r r r r �<module> sZ ' �n � $Q 2X �
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings