Windows Server Windows Server: Users

Summary

This module contains actions for auditing local users on a Windows Server.

Actions

windows_server.users.

display

Display users in a table.

The table will have the following columns:

  • Name
  • Full Name
  • Description
  • Disabled
  • Locked

Minimum Plugin Version: 3.0.0

Input

  • text: the title of the table

  • users: any number of Users

Output

Nothing is outputted by this action.

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

- windows_server.users.display:
    text: All Local Users
  load:
    users: all_users

windows_server.users.

display_tabbed

Display users in a table with multiple tabs.

This action can be used to display user lists from multiple servers.

The table will have the following columns:

  • Name
  • Full Name
  • Description
  • Disabled
  • Locked

Minimum Plugin Version: 3.0.0

Input

  • text: the title of the table

  • tabs: a dictionary where each key is a tab name & each value is any number of Users

Output

Nothing is outputted by this action.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
- set:
    name: tabs
    value: {}

- windows_server.users.get_all:
  load:
    windows_server: windows_server
  save: all_users

- ppa_tools.dictionaries.insert:
    name: My Server
  load:
    value: all_users
    dictionary: tabs
  save: tabs

- windows_server.users.display_tabbed:
    text: All Local Users
  load:
    tabs: tabs

windows_server.users.

get_all

Get all local users from a Windows Server.

Minimum Plugin Version: 2.0.0

Domain Controllers

Running this action against a Domain Controller will return an empty list.

Input
Output

A list of User dictionaries.

Example
1
2
3
4
- windows_server.users.get_all:
  load:
    windows_server: windows_server
  save: all_users

windows_server.users.

output_tabbed_table

Display a users table with multiple tabs.

This action can be used to display user lists from multiple servers.

The table will have the following columns:

  • Name
  • Full Name
  • Description
  • Disabled
  • Locked

Deprecation Warning

This action will soon be deprecated in favour of display_tabbed.

Minimum Plugin Version: 1.5.0

Input

  • text: the title of the table

  • tabs: a dictionary where each key is a tab name & each value is a list of User dictionaries

Output

Nothing is outputted by this action.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
- set:
    name: tabbed_table
    value: {}

- windows_server.users.get_all:
  load:
    windows_server: windows_server
  save: all_users

- ppa_tools.dictionaries.insert:
    name: My Server
  load:
    value: all_users
    dictionary: tabbed_table
  save: tabbed_table

- windows_server.users.output_tabbed_table:
    text: All Local Users
  load:
    tabs: tabbed_table

windows_server.users.

output_table

Display a list of users in a table.

The table will have the following columns:

  • Name
  • Full Name
  • Description
  • Disabled
  • Locked

Deprecation Warning

This action will soon be deprecated in favour of display.

Minimum Plugin Version: 1.4.0

Input

  • text: the title of the table

  • users: a list of User dictionaries

Output

Nothing is outputted by this action.

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

- windows_server.users.output_table:
    text: All Local Users
  load:
    users: all_users

windows_server.users.

select

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

The table will have the following columns:

  • Name
  • Full Name
  • Description
  • Disabled
  • Locked

Minimum Plugin Version: 3.0.0

Input

  • text: the title of the table

  • users: any number of Users

  • minimum: the minimum number of selections

  • maximum: the maximum number of selections

Output

A Selection containing:

  • total: the number of selected Users

  • all: a list of selected Users

  • first: the first selected User

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

- windows_server.users.select:
    text: Select Users
  load:
    users: users
  save: selection

windows_server.users.

select_one

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

The table will have the following columns:

  • Name
  • Full Name
  • Description
  • Disabled
  • Locked

Minimum Plugin Version: 3.0.0

Input

  • text: the title of the table

  • users: any number of Users

Output

A single User.

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

- windows_server.users.select_one:
    text: Select a User
  load:
    users: users
  save: user