Skip to content

Windows Server Windows Server: Services

Summary

This module contains actions for viewing & managing services on a Windows Server.

Actions

windows_server.services.

display

Display Windows services in a table.

The table will have the following columns:

  • Display Name
  • Name
  • Service Account
  • State
  • Status

Minimum Plugin Version: 4.0.0

Input

  • text: the title of the table

  • services: any number of Services

Output

Nothing is outputted by this action.

Example
1
2
3
4
5
6
7
8
9
- windows_server.services.get_all:
  load:
    windows_server: windows_server
  save: all_services

- windows_server.services.display:
    text: All Services
  load:
    services: all_services

windows_server.services.

get_all

Get all services.

Minimum Plugin Version: 1.2.0

Input
Output

A list of Services.

Example
1
2
3
4
- windows_server.services.get_all:
  load:
    windows_server: windows_server
  save: all_services

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.get_by_name:
    name: spooler
  load:
    windows_server: windows_server
  save: spooler_service

windows_server.services.

get_using_domain_account

Get all services that run under an account on the supplied domain.

Minimum Plugin Version: 5.1.0

Input

  • windows_server: a WindowsServer dictionary

  • domain: the FQDN of the Active Directory domain

Output

A list of Services.

Example
1
2
3
4
5
- windows_server.services.get_using_domain_account:
    domain: internal.domain.net
  load:
    windows_server: windows_server
  save: services

windows_server.services.

get_using_local_account

Get all services that run under a local non-system account.

Minimum Plugin Version: 5.1.0

Input
Output

A list of Services.

Example
1
2
3
4
- windows_server.services.get_using_local_account:
  load:
    windows_server: windows_server
  save: services

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.restart:
    name: spooler
  load:
    windows_server: windows_server

windows_server.services.

select

Display Windows services in a table & prompt the task operator to make a selection.

The table will have the following columns:

  • Display Name
  • Name
  • Service Account
  • State
  • Status

Minimum Plugin Version: 4.0.0

Input

  • text: the title of the table

  • services: any number of Services

  • minimum: the minimum number of acceptable selections

  • maximum: the maximum number of acceptable selections

Output

A Selection containing:

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- windows_server.services.get_all:
  load:
    windows_server: windows_server
  save: all_services

- windows_server.services.select:
    text: Select Services
  load:
    services: all_services
  save: selection

windows_server.services.

select_one

Display Windows services in a table & prompt the task operator to select one.

The table will have the following columns:

  • Display Name
  • Name
  • Service Account
  • State
  • Status

Minimum Plugin Version: 4.0.0

Input

  • text: the title of the table

  • services: any number of Services

Output

A single Service.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- windows_server.services.get_all:
  load:
    windows_server: windows_server
  save: all_services

- windows_server.services.select_one:
    text: Select a Service
  load:
    session_list: all_services
  save: service

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.start:
    name: spooler
  load:
    windows_server: windows_server

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 to false)

Output

Nothing is outputted by this action.

Example
1
2
3
4
- windows_server.services.stop:
    name: spooler
  load:
    windows_server: windows_server