Windows Service module.
Changed in version 2016.11.0: - Rewritten to use PyWin32
salt.modules.win_service.
available
(name)¶Check if a service is available on the system.
Parameters: | name (str) -- The name of the service to check |
---|---|
Returns: | True if the service is available, False otherwise |
Return type: | bool |
CLI Example:
salt '*' service.available <service name>
salt.modules.win_service.
config
(name, bin_path=None, display_name=None, svc_type=None, start_type=None, error=None, group=None, tag=None, depend=None, obj=None, password=None, **kwargs)¶Deprecated since version 2016.11.0: Use service.modify
instead
Modify the named service. Because this is deprecated it will use the passed
parameters to run service.modify
instead.
Parameters: |
|
---|---|
Returns: | a dictionary of changes made |
Return type: |
CLI Example:
salt '*' service.config <service name> <path to exe> display_name='<display name>'
salt.modules.win_service.
create
(name, bin_path, exe_args=None, display_name=None, description=None, service_type='own', start_type='manual', start_delayed=False, error_control='normal', load_order_group=None, dependencies=None, account_name='.\\LocalSystem', account_password=None, run_interactive=False, **kwargs)¶Create the named service.
New in version 2015.8.0.
Parameters: |
|
---|---|
Returns: | A dictionary containing information about the new service |
Return type: |
CLI Example:
salt '*' service.create <service name> <path to exe> display_name='<display name>'
salt.modules.win_service.
create_win_salt_restart_task
()¶Create a task in Windows task scheduler to enable restarting the salt-minion
Returns: | True if successful, otherwise False |
---|---|
Return type: | bool |
CLI Example:
salt '*' service.create_win_salt_restart_task()
salt.modules.win_service.
delete
(name, timeout=90)¶Delete the named service
Parameters: | |
---|---|
Returns: |
|
Return type: |
CLI Example:
salt '*' service.delete <service name>
salt.modules.win_service.
disable
(name, **kwargs)¶Disable the named service to start at boot
Parameters: | name (str) -- The name of the service to disable |
---|---|
Returns: | True if disabled, False otherwise |
Return type: | bool |
CLI Example:
salt '*' service.disable <service name>
salt.modules.win_service.
disabled
(name)¶Check to see if the named service is disabled to start on boot
Parameters: | name (str) -- The name of the service to check |
---|---|
Returns: | True if the service is disabled |
Return type: | bool |
CLI Example:
salt '*' service.disabled <service name>
salt.modules.win_service.
enable
(name, **kwargs)¶Enable the named service to start at boot
Parameters: | name (str) -- The name of the service to enable. |
---|---|
Returns: | True if successful, False otherwise |
Return type: | bool |
CLI Example:
salt '*' service.enable <service name>
salt.modules.win_service.
enabled
(name, **kwargs)¶Check to see if the named service is enabled to start on boot
Parameters: | name (str) -- The name of the service to check |
---|---|
Returns: | True if the service is set to start |
Return type: | bool |
CLI Example:
salt '*' service.enabled <service name>
salt.modules.win_service.
execute_salt_restart_task
()¶Run the Windows Salt restart task
Returns: | True if successful, otherwise False |
---|---|
Return type: | bool |
CLI Example:
salt '*' service.execute_salt_restart_task()
salt.modules.win_service.
get_all
()¶Return all installed services
Returns: | Returns a list of all services on the system. |
---|---|
Return type: | list |
CLI Example:
salt '*' service.get_all
salt.modules.win_service.
get_disabled
()¶Return a list of disabled services. Disabled is defined as a service that is marked 'Disabled' or 'Manual'.
Returns: | A list of disabled services. |
---|---|
Return type: | list |
CLI Example:
salt '*' service.get_disabled
salt.modules.win_service.
get_enabled
()¶Return a list of enabled services. Enabled is defined as a service that is marked to Auto Start.
Returns: | A list of enabled services |
---|---|
Return type: | list |
CLI Example:
salt '*' service.get_enabled
salt.modules.win_service.
get_service_name
(*args)¶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: | A dictionary of display names and service names |
---|---|
Return type: | dict |
CLI Examples:
salt '*' service.get_service_name
salt '*' service.get_service_name 'Google Update Service (gupdate)' 'DHCP Client'
salt.modules.win_service.
getsid
(name)¶Return the SID for this windows service
Parameters: | name (str) -- The name of the service for which to return the SID |
---|---|
Returns: | A string representing the SID for the service |
Return type: | str |
CLI Example:
salt '*' service.getsid <service name>
salt.modules.win_service.
info
(name)¶Get information about a service on the system
Parameters: | name (str) -- The name of the service. This is not the display name. Use
get_service_name to find the service name. |
---|---|
Returns: | A dictionary containing information about the service. |
Return type: | dict |
CLI Example:
salt '*' service.info spooler
salt.modules.win_service.
missing
(name)¶The inverse of service.available.
Parameters: | name (str) -- The name of the service to check |
---|---|
Returns: | True if the service is missing, False otherwise |
Return type: | bool |
CLI Example:
salt '*' service.missing <service name>
salt.modules.win_service.
modify
(name, bin_path=None, exe_args=None, display_name=None, description=None, service_type=None, start_type=None, start_delayed=None, error_control=None, load_order_group=None, dependencies=None, account_name=None, account_password=None, run_interactive=None)¶Modify a service's parameters. Changes will not be made for parameters that are not passed.
New in version 2016.11.0.
Parameters: |
|
---|---|
Returns: | a dictionary of changes made |
Return type: |
CLI Example:
salt '*' service.modify spooler start_type=disabled
salt.modules.win_service.
restart
(name, timeout=90)¶Restart the named service. This issues a stop command followed by a start.
Parameters: |
|
---|---|
Returns: |
|
Return type: |
CLI Example:
salt '*' service.restart <service name>
salt.modules.win_service.
start
(name, timeout=90)¶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.
Parameters: | |
---|---|
Returns: |
|
Return type: |
CLI Example:
salt '*' service.start <service name>
salt.modules.win_service.
status
(name, *args, **kwargs)¶Return the status for a service
Parameters: | name (str) -- The name of the service to check |
---|---|
Returns: | True if running, False otherwise |
Return type: | bool |
CLI Example:
salt '*' service.status <service name> [service signature]
salt.modules.win_service.
stop
(name, timeout=90)¶Stop the specified service
Parameters: | |
---|---|
Returns: |
|
Return type: |
CLI Example:
salt '*' service.stop <service name>