Windows Server: Services
Summary
This module contains actions for viewing & managing services on a Windows Server.
Actions
windows_server.services.
get_all
Get all services.
Minimum Plugin Version: 1.2.0
Input
- windows_server: a WindowsServer dictionary
Output
A list of Service dictionaries.
Example
1 2 3 4 |
|
windows_server.services.
get_by_name
Get a service using its name.
Minimum Plugin Version: 1.2.0
Input
-
windows_server: a WindowsServer dictionary
-
name: the name of the service
Output
A single Service dictionary.
Example
1 2 3 4 5 |
|
windows_server.services.
input_table
Display a list of Windows services in a table, & allow the task operator to make a selection.
The table will have the following columns:
- Display Name
- Name
- State
- Status
Minimum Plugin Version: 1.1.0
Input
-
text: the title of the table
-
service_list: a list of Service dictionaries to display in the table
-
minimum: the minimum number of acceptable selections
-
maximum: the maximum number of acceptable selections
Output
A list of Service dictionaries.
Tip
-
If neither a minimum or maximum is provided, the task operator will be able to submit 0 selections.
-
If minimum or maximum are provided, the operation will repeat until the task operator makes a valid number of selections.
Example
-
Getting all services & saving them as
all_services
-
Using this action to display them in a table, & saving the selection as
selected_service
1 2 3 4 5 6 7 8 9 10 11 12 |
|
windows_server.services.
output_table
Display one or more Windows services in a table.
The table will have the following columns:
- Display Name
- Name
- State
- Status
Minimum Plugin Version: 1.2.0
Input
-
text: the title of the table
-
services: a single or list of Service dictionaries to display in the table
Output
Nothing is outputted by this action.
Example
-
Getting all services & saving them as
all_services
-
Using this action to display them in a table
1 2 3 4 5 6 7 8 9 |
|
windows_server.services.
restart
Restart a service using its name.
Minimum Plugin Version: 1.2.0
Input
-
windows_server: a WindowsServer dictionary
-
name: the name of the service to restart
Output
Nothing is outputted by this action.
Example
1 2 3 4 |
|
windows_server.services.
start
Start a service using its name.
Minimum Plugin Version: 1.2.0
Input
-
windows_server: a WindowsServer dictionary
-
name: the name of the service to start
Output
Nothing is outputted by this action.
Example
1 2 3 4 |
|
windows_server.services.
stop
Stop a service using its name.
Minimum Plugin Version: 1.6.0
Input
-
windows_server: a WindowsServer dictionary
-
name: the name of the service to stop
-
force: set to
true
to force-stop the service (defaults tofalse
)
Output
Nothing is outputted by this action.
Example
1 2 3 4 |
|