File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/win_service.cpython-310.pyc
Back
o ;jň � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddl m Z zddl Z ddl Z ddl Z dZW n ey? dZY nw e�e�ZdZejjjZejjjZejjjZdd� Zd d � Zd d � Zd d� Z dd� Z dd� Z dd� Z dd� Z dd� Z!dd� Z"dd � Z#d?d d �Z$d?d d!�Z%d?d"d#�Z&d$d%� Z'd&d'� Z(d(d)� Z)d*d+� Z* d@d,d-�Z+dAd/d0�Z,d1d2� Z-d3d4� Z.d5d6� Z/ 7 8 9 : dBd;d<�Z0d?d=d>�Z1dS )CzV Windows Service module. .. versionchanged:: 2016.11.0 Rewritten to use PyWin32 � N)�CommandExecutionErrorTF�servicec C s t jj�� sdS ts dS tS )z> Only works on Windows systems with PyWin32 installed )Fz1Module win_service: module only works on Windows.)Fz0Module win_service: failed to load win32 modules)�salt�utils�platformZ is_windows�HAS_WIN32_MODS�__virtualname__� r r �L/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/win_service.py� __virtual__& s r c C s� t | �}|d |v r>t�� |k r>|d }|r|d nd}|dk r#d}n|dkr)d}t�|� t | �}|d |v r>t�� |k s|S )aX Helper function that will wait for the status of the service to match the provided status before an end time expires. Used for service stop and start .. versionadded:: 2017.7.9,2018.3.4 Args: service_name (str): The name of the service end_time (float): A future time. e.g. time.time() + 10 service_states (list): Services statuses to wait for as returned by info() Returns: dict: A dictionary containing information about the service. :codeauthor: Damon Atkins <https://github.com/damon-atkins> �StatusZStatus_WaitHinti� r � � )�info�time�sleep)� service_name�end_time�service_statesZ info_resultsZ wait_timer r r � _status_wait3 s �r c C sF t �d�}|�| �dur| �d��d�} |�| �dus d| � d�} | S )aQ Helper function to properly format the path to the binary for the service Must be wrapped in double quotes to account for paths that have spaces. For example: ``"C:\Program Files\Path\to\bin.exe"`` Args: cmd (str): Full path to the binary Returns: str: Properly quoted path to the binary z^(\"|').*|.*(\"|')$N�"�')�re�compile�match�strip)�cmd�patternr r r � _cmd_quotea s � r c C �@ t � } t� }| D ]}t|d �d dv r|�|d � qt|�S )z� Return a list of enabled services. Enabled is defined as a service that is marked to Auto Start. Returns: list: A list of enabled services CLI Example: .. code-block:: bash salt '*' service.get_enabled � ServiceName� StartType)�Auto�� _get_services�setr �add�sorted�� raw_services�servicesr r r r � get_enabledz � �r+ c C r )a Return a list of disabled services. Disabled is defined as a service that is marked 'Disabled' or 'Manual'. Returns: list: A list of disabled services. CLI Example: .. code-block:: bash salt '*' service.get_disabled r r! )�Manual�Disabledr# r( r r r � get_disabled� r, r/ c C s& t � D ] }| �� |�� kr dS qdS )a. Check if a service is available on the system. Args: name (str): The name of the service to check Returns: bool: ``True`` if the service is available, ``False`` otherwise CLI Example: .. code-block:: bash salt '*' service.available <service name> TF)�get_all�lower)�namer r r r � available� s �r3 c C s | t � vS )a The inverse of service.available. Args: name (str): The name of the service to check Returns: bool: ``True`` if the service is missing, ``False`` otherwise CLI Example: .. code-block:: bash salt '*' service.missing <service name> )r0 �r2 r r r �missing� � r5 c C sj t �ddt j�} z&zt �| �}W n ty t �| �}Y n w W t �| � |S W t �| � |S t �| � w )z7 Returns a list of all services on the system. N)� win32service� OpenSCManagerZ SC_MANAGER_ENUMERATE_SERVICEZEnumServicesStatusEx�AttributeErrorZEnumServicesStatus�CloseServiceHandle)� handle_scmr* r r r r$ � s � �� � �r$ c C s, t � } t� }| D ] }|�|d � qt|�S )z� Return all installed services Returns: list: Returns a list of all services on the system. CLI Example: .. code-block:: bash salt '*' service.get_all r )r$ r% r& r' )r* �retr r r r r0 � s r0 c G sh t � }t� }|D ])}| r)|d | v s |d | v s |d �� | v r(|d ||d < q|d ||d < q|S )aG The Display Name is what is displayed in Windows when services.msc is executed. Each Display Name has an associated Service Name which is the actual name of the service. This function allows you to discover the Service Name by returning a dictionary of Display Names and Service Names, or filter by adding arguments of Display Names. If no args are passed, return a dict of all services where the keys are the service Display Names and the values are the Service Names. If arguments are passed, create a dict of Display Names and Service Names Returns: dict: A dictionary of display names and service names CLI Examples: .. code-block:: bash salt '*' service.get_service_name salt '*' service.get_service_name 'Google Update Service (gupdate)' 'DHCP Client' � DisplayNamer )r$ �dictr1 )�argsr) r* Z raw_servicer r r �get_service_name� s �r@ c C s t jjj| d�S )a Get information about a service on the system Args: name (str): The name of the service. This is not the display name. Use ``get_service_name`` to find the service name. Returns: dict: A dictionary containing information about the service. CLI Example: .. code-block:: bash salt '*' service.info spooler r4 )r r � win_servicer r4 r r r r $ s r �Z c C s� t | �r t| dd� zt�| � W n) tjy: } z |jdkr*td| � d|j� ���t � d| � W Y d}~nd}~ww t | t � � t |� dd gd �}|d d kS ) a� Start the specified service. .. warning:: You cannot start a disabled service in Windows. If the service is disabled, it will be changed to ``Manual`` start. Args: name (str): The name of the service to start timeout (:obj:`int`, optional): The time in seconds to wait for the service to start before returning. .. versionadded:: 2017.7.9,2018.3.4 Default is 90 seconds. Returns: bool: ``True`` if successful, otherwise ``False``. Also returns ``True`` if the service is already started CLI Example: .. code-block:: bash salt '*' service.start <service name> r- �� start_typei zFailed To Start �: zService "%s" is runningNz Start Pending�Stopped�r r r r �Running)�disabled�modify�win32serviceutilZ StartService� pywintypes�error�winerrorr �strerror�log�debugr r �int�r2 �timeout�excZ srv_statusr r r �start: s ��� rV c C s� zt �| � W n) tjy0 } z |jdkr td| � d|j� ���t�d| � W Y d}~nd}~ww t | t � � t |� ddgd�}|d d kS ) a' Stop the specified service Args: name (str): The name of the service to stop timeout (:obj:`int`, optional): The time in seconds to wait for the service to stop before returning. .. versionadded:: 2017.7.9,2018.3.4 Default is 90 seconds. Returns: bool: ``True`` if successful, otherwise ``False``. Also returns ``True`` if the service is already stopped CLI Example: .. code-block:: bash salt '*' service.stop <service name> i& zFailed To Stop rE zService "%s" is not runningNrH � Stop PendingrG r rF ) rK Z StopServicerL rM rN r rO rP rQ r r rR rS r r r �stopl s ��� rX c C s, d| v r t � t� S t| |d�ot| |d�S )a� Restart the named service. This issues a stop command followed by a start. Args: name: The name of the service to restart. .. note:: If the name passed is ``salt-minion`` a scheduled task is created and executed to restart the salt-minion service. timeout (:obj:`int`, optional): The time in seconds to wait for the service to stop and start before returning. .. note:: The timeout is cumulative meaning it is applied to the stop and then to the start command. A timeout of 90 could take up to 180 seconds if the service is long in stopping and starting .. versionadded:: 2017.7.9,2018.3.4 Default is 90 seconds. Returns: bool: ``True`` if successful, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' service.restart <service name> z salt-minion�r2 rT )� create_win_salt_restart_task�execute_salt_restart_taskrX rV rY r r r �restart� s "r\ c C s0 t jj�d�} d}td dddd| |dd d d � S ) a Create a task in Windows task scheduler to enable restarting the salt-minion Returns: bool: ``True`` if successful, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' service.create_win_salt_restart_task() r zG/c ping -n 3 127.0.0.1 && net stop salt-minion && net start salt-minionztask.create_task�restart-salt-minion�SystemTZExecuteZOncez 1975-01-01z01:00) r2 Z user_name�forceZ action_typer Z argumentsZ trigger_typeZ start_dateZ start_time)r r �path�which�__salt__)r r? r r r rZ � s �rZ c C s t d dd�S )z� Run the Windows Salt restart task Returns: bool: ``True`` if successful, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' service.execute_salt_restart_task() ztask.runr] r4 )rb r r r r r[ � s r[ c O s~ i }t � }tt�d| ��}|rt�|| �}n| g}|D ]}z t|�d dv ||< W q ty6 d||< Y qw |r;|S || S )a� Return the status for a service. If the name contains globbing, a dict mapping service name to True/False values is returned. .. versionchanged:: 2018.3.0 The service name can now be a glob (e.g. ``salt*``) .. versionchanged:: 3006.0 Returns "Not Found" if the service is not found on the system Args: name (str): The name of the service to check Returns: bool: True if running, False otherwise dict: Maps service name to True if running, False otherwise str: Not Found if the service is not found on the system CLI Example: .. code-block:: bash salt '*' service.status <service name> z \*|\?|\[.+\]r )rH rW z Not Found)r0 �boolr �search�fnmatch�filterr r )r2 r? �kwargs�resultsZ all_servicesZcontains_globbingr* r r r r �status� s �ri c C s t | �d S )a* Return the SID for this windows service Args: name (str): The name of the service for which to return the SID Returns: str: A string representing the SID for the service CLI Example: .. code-block:: bash salt '*' service.getsid <service name> Zsid�r r4 r r r �getsid s rk c C s� t �ddt j�}z t �|| t jt jB �}W n tjy- } z td| � d|j � ���d}~ww t � |�}t � }|durMt |�}|durI|� d|� �}||d< |durl|� � tv ret|� � }| rd|t jB }n"td|� ���| du rx|d t jB }n| d u r�|d t jA }nt j}|t jur�t� }tD ]}t|t�r�||@ r�|�t| � q�|r�|n||d < |dur�|� � tv r�t|� � }ntd |� ���t| |d < nt j}|dur�|� � tv r�t|� � }ntd |� ���t| |d< nt j}| dur�| |d< | dv r�d} | du�rd|d< | du�r| |d< | du�r| |d< |du�r"||d< t �|||||| d| | | |� |du�rBt �|t j|� ||d< |du�ri|dk�rS|d dk�sX|dk�ret �|t j|� ||d< nd |d < t �|� t �|� |S ) a' Modify a service's parameters. Changes will not be made for parameters that are not passed. .. versionadded:: 2016.11.0 Args: name (str): The name of the service. Can be found using the ``service.get_service_name`` function. bin_path (:obj:`str`, optional): The path to the service executable. Backslashes must be escaped, eg: ``C:\path\to\binary.exe``. Default is ``None``. exe_args (:obj:`str`, optional): Any arguments required by the service executable. Default is ``None``. display_name (:obj:`str`, optional): The name to display in the service manager. Default is ``None``. description (:obj:`str`, optional): The description to display for the service. Default is ``None``. service_type (:obj:`str`, optional): Specifies the service type. ``None`` defaults to ``own``. Valid options are as follows: - kernel: Driver service - filesystem: File system driver service - adapter: Adapter driver service (reserved) - recognizer: Recognizer driver service (reserved) - own (default): Service runs in its own process - share: Service shares a process with one or more other services Default is ``None``. start_type (:obj:`str`, optional): Specifies the service start type. Valid options are as follows: - boot: Device driver that is loaded by the boot loader - system: Device driver that is started during kernel initialization - auto: Service that automatically starts - manual: Service must be started manually - disabled: Service cannot be started Default is ``None``. start_delayed (:obj:`bool`, optional): Set the service to Auto(Delayed Start). Only valid if the start_type is set to ``Auto``. If service_type is not passed, but the service is already set to ``Auto``, then the flag will be set. Default is ``None``. error_control (:obj:`str`, optional): The severity of the error, and action taken, if this service fails to start. Valid options are as follows: - normal: Error is logged and a message box is displayed - severe: Error is logged and computer attempts a restart with the last known good configuration - critical: Error is logged, computer attempts to restart with the last known good configuration, system halts on failure - ignore: Error is logged and startup continues. No notification is given to the user Default is ``None``. load_order_group (:obj:`str`, optional): The name of the load order group to which this service belongs. Default is ``None``. dependencies (:obj:`list`, optional): A list of services or load ordering groups that must start before this service. Default is ``None``. account_name (:obj:`str`, optional): The name of the account under which the service should run. For ``own`` type services this should be in the ``domain\username`` format. The following are examples of valid built-in service accounts: - NT Authority\LocalService - NT Authority\NetworkService - NT Authority\LocalSystem - .\LocalSystem Default is ``None``. account_password (:obj:`str`, optional): The password for the account name specified in ``account_name``. For the above built-in accounts, this can be None. Otherwise, a password must be specified. Default is ``None``. run_interactive (:obj:`bool`, optional): If this setting is True, the service will be allowed to interact with the user. Not recommended for services that run with elevated privileges. Default is ``None``. Returns: dict: a dictionary of changes made CLI Example: .. code-block:: bash salt '*' service.modify spooler start_type=disabled NzFailed To Open rE � Z BinaryPath�Invalid Service Type: Tr FZ ServiceType�Invalid Start Type: r! �Invalid Error Control: Z ErrorControlZServiceAccount)� LocalSystem� LocalService�NetworkService� zXXX-REDACTED-XXXZServiceAccountPasswordZLoadOrderGroupZ Dependenciesr= Z Description���r � �StartTypeDelayedz)start_delayed: Requires start_type "auto"�Warning) r7 r8 �SC_MANAGER_CONNECT� OpenServiceZSERVICE_CHANGE_CONFIGZSERVICE_QUERY_CONFIGrL rM r rO ZQueryServiceConfigr> r r1 � SERVICE_TYPE�SERVICE_INTERACTIVE_PROCESSZSERVICE_NO_CHANGE�list� isinstancerR �append�SERVICE_START_TYPE�SERVICE_ERROR_CONTROLZChangeServiceConfig�ChangeServiceConfig2�SERVICE_CONFIG_DESCRIPTION�&SERVICE_CONFIG_DELAYED_AUTO_START_INFOr: )r2 �bin_path�exe_args� display_name� description� service_typerD � start_delayed� error_control�load_order_group� dependencies� account_name�account_password�run_interactiver; � handle_svcrU Z config_infoZchanges�flags�bitr r r rJ - s� ��� � � � � "� rJ �autoc K sV t | ||d� t| �}|�� dkr!|d �� |�� ko |d |kS |d �� |�� kS )a Enable the named service to start at boot Args: name (str): The name of the service to enable. start_type (:obj:`str`, optional): Specifies the service start type. Valid options are as follows: - boot: Device driver that is loaded by the boot loader - system: Device driver that is started during kernel initialization - auto: Service that automatically starts - manual: Service must be started manually - disabled: Service cannot be started Default is "auto". start_delayed (:obj:`bool`, optional): Set the service to Auto(Delayed Start). Only valid if the start_type is set to ``Auto``. If service_type is not passed, but the service is already set to ``Auto``, then the flag will be set. Default is ``False``. Returns: bool: ``True`` if successful, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' service.enable <service name> )rD r� r� r! rv )rJ r r1 )r2 rD r� rg Zsvcstatr r r �enable8 s $ �r� c K s t | dd� t| �d dkS )a Disable the named service to start at boot Args: name (str): The name of the service to disable. Returns: bool: ``True`` if disabled, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' service.disable <service name> r. rC r! )rJ r �r2 rg r r r �disableg s r� c K s t | �d dkS )a> Check to see if the named service is enabled to start on boot Args: name (str): The name of the service to check Returns: bool: ``True`` if the service is set to start, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' service.enabled <service name> r! r" rj r� r r r �enabled| s r� c C s t | � S )a< Check to see if the named service is disabled to start on boot Args: name (str): The name of the service to check Returns: bool: ``True`` if the service is disabled, otherwise ``False`` CLI Example: .. code-block:: bash salt '*' service.disabled <service name> )r� r4 r r r rI � r6 rI �own�manual�normal� .\LocalSystemc K sp |du r| }| t � v rtd| � ���t|�}|dur!|� d|� �}|�� tv r5t|�� }| r4|tjB }ntd|� ���|�� tv rIt|�� }ntd|� ���|�� tv r]t|�� }ntd|� ���|rn|dkrntd��| d v rtd } t� ddtj �}t� || |tj ||||| d | | | � }|dur�t� |tj|� |dur�|dkr�t� |tj|� t�|� t�|� t| �S ) a� Create the named service. .. versionadded:: 2015.8.0 Args: name (str): Specifies the service name. This is not the display_name. bin_path (str): Specifies the path to the service binary file. Backslashes must be escaped, eg: ``C:\path\to\binary.exe``. exe_args (:obj:`str`, optional): Any additional arguments required by the service binary. Default is ``None``. display_name (:obj:`str`, optional): The name to be displayed in the service manager. If not passed, the ``name`` will be used. Default is ``None``. description (:obj:`str`, optional): A description of the service. Default is ``None``. service_type (:obj:`str`, optional): Specifies the service type. Valid options are as follows: - kernel: Driver service - filesystem: File system driver service - adapter: Adapter driver service (reserved) - recognizer: Recognizer driver service (reserved) - own (default): Service runs in its own process - share: Service shares a process with one or more other services Default is "own". start_type (:obj:`str`, optional): Specifies the service start type. Valid options are as follows: - boot: Device driver that is loaded by the bootloader - system: Device driver that is started during kernel initialization - auto: Service that automatically starts - manual (default): Service must be started manually - disabled: Service cannot be started Default is "manual". start_delayed (:obj:`bool`, optional): Set the service to Auto(Delayed Start). Only valid if the start_type is set to ``Auto``. If service_type is not passed, but the service is already set to ``Auto``, then the flag will be set. Default is ``False``. error_control (:obj:`str`, optional): The severity of the error, and action taken, if this service fails to start. Valid options are as follows: - normal (default): Error is logged and a message box is displayed - severe: Error is logged and computer attempts a restart with the last known good configuration - critical: Error is logged, computer attempts to restart with the last known good configuration, system halts on failure - ignore: Error is logged and startup continues, no notification is given to the user Default is "normal". load_order_group (:obj:`str`, optional): The name of the load order group to which this service belongs. Default is ``None``. dependencies (:obj:`list`, optional): A list of services or load ordering groups that must start before this service. Default is ``None``. account_name (:obj:`str`, optional): The name of the account under which the service should run. For ``own`` type services this should be in the ``domain\username`` format. The following are examples of valid built-in service accounts: - NT Authority\LocalService - NT Authority\NetworkService - NT Authority\LocalSystem - .\LocalSystem Default is ``\LocalSystem``. account_password (:obj:`str`, optional): The password for the account name specified in ``account_name``. For the above built-in accounts, this can be None. Otherwise, a password must be specified. Default is ``None``. run_interactive (:obj:`bool`, optional): If this setting is ``True``, the service will be allowed to interact with the user. Not recommended for services that run with elevated privileges. Default is ``False``. Returns: dict: A dictionary containing information about the new service CLI Example: .. code-block:: bash salt '*' service.create <service name> <path to exe> display_name='<display name>' NzService Already Exists: rl rm rn ro ru z;Invalid Parameter: start_delayed requires start_type "auto")rp r� rq z.\LocalServicerr z.\NetworkServicers r )r0 r r r1 rz r7 r{ r r� r8 ZSC_MANAGER_ALL_ACCESSZ CreateService�SERVICE_ALL_ACCESSr� r� r� r: r )r2 r� r� r� r� r� rD r� r� r� r� r� r� r� rg r; r� r r r �create� sv � ����� r� c C sX t �ddt j�}z t �|| t j�}W n/ tjyA } z"t �|� |jdkr0t d| � d|j � ���t � d| � W Y d}~dS d}~ww z1zt � |� W n tjyb } z t d| � d|j � ���d}~ww W t � d� t �|� t �|� nt � d� t �|� t �|� w t�� t|� }| t� v r�t�� |k r�t�d � | t� v r�t�� |k s�| t� vS ) a� Delete the named service Args: name (str): The name of the service to delete timeout (:obj:`int`, optional): The time in seconds to wait for the service to be deleted before returning. This is necessary because a service must be stopped before it can be deleted. .. versionadded:: 2017.7.9,2018.3.4 Default is 90 seconds. Returns: bool: ``True`` if successful, otherwise ``False``. Also returns ``True`` if the service is not present CLI Example: .. code-block:: bash salt '*' service.delete <service name> Ni$ zFailed to open z. zService "%s" is not presentTzFailed to delete z Cleaning upr )r7 r8 rx ry r� rL rM r: rN r rO rP rQ Z DeleteServicer rR r0 r )r2 rT r; r� rU r r r r �delete� s> � ����� � � r� )rB ) NNNNNNNNNNNNN)r� F) NNNr� r� Fr� NNr� NF)2�__doc__re �loggingr r Zsalt.utils.pathr Zsalt.utils.platformZsalt.utils.win_serviceZsalt.exceptionsr rL r7 rK r � ImportError� getLogger�__name__rP r r rA rz r r� r r r r+ r/ r3 r5 r$ r0 r@ r rV rX r\ rZ r[ ri rk rJ r� r� r� rI r� r� r r r r �<module> s� � .( 2 *) - � / � b
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings