Osirium PAM (BETA) Osirium PAM (BETA): Devices

Summary

This module contains actions for reading device information from PAM.

Supported Versions

This plugin supports PAM versions 6.5.0 & newer.

Remember

You must have a PAM Server provisioned as a Vault inside PPA to use this plugin.

Actions

pam.devices.

get_all

Get all devices from the PAM appliance.

Minimum Plugin Version: 0.1.0

Input

pam_address: the IP or DNS address of the PAM Appliance

Output

A list of Device dictionaries.

Example
1
2
3
- pam.devices.get_all:
    pam_address: pam.internal.net
  save: all_devices

pam.devices.

get_by_hostname

Get a device using its hostname.

Minimum Plugin Version: 0.1.0

Input

pam_address: the IP or DNS address of the PAM Appliance

hostname: the hostname of the device

Output

A single Device dictionary.

Example
1
2
3
4
- pam.devices.get_by_hostname:
    pam_address: pam.internal.net
    hostname: uat-iis.internal.net
  save: uat_iis_server

pam.devices.

get_by_id

Get a device using its ID.

Minimum Plugin Version: 0.1.0

Input

pam_address: the IP or DNS address of the PAM Appliance

device_id: the ID of the device

Output

A single Device dictionary.

Example
1
2
3
4
- pam.devices.get_by_id:
    pam_address: pam.internal.net
    device_id: 10
  save: device

pam.devices.

get_by_name

Get a device using its name.

Minimum Plugin Version: 0.1.0

Input

pam_address: the IP or DNS address of the PAM Appliance

name: the name of the device

Output

A single Device dictionary.

Example
1
2
3
4
- pam.devices.get_by_name:
    pam_address: pam.internal.net
    name: uat-iis
  save: uat_iis_server

pam.devices.

input_table

Display a list of devices in a table, & allow the task operator to make a selection.

The table will have the following columns:

  • Name
  • Host Name
  • Address
  • Active Directory
  • Profile Count

Minimum Plugin Version: 0.1.0

Input
  • text: The title of the table

  • device_list: A list of Device dictionaries to display in the table

  • minimum: The minimum number of acceptable selections

  • maximum: The maximum number of acceptable selections

Output

A list of Device 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
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
- pam.devices.search:
    pam_address: pam.internal.net
    queries:
      - attribute: authentication_service_name
        query: equal
        value: example.domain.com
  save: example_domain_devices

- pam.devices.input_table:
    text: Select a Device
    minimum: 1
    maximum: 1
  load:
    device_list: example_domain_devices
  save: selected_devices

pam.devices.

output_table

Display a list of devices in a table.

The table will have the following columns:

  • Name
  • Host Name
  • Address
  • Active Directory
  • Profile Count

Minimum Plugin Version: 0.1.0

Input
  • text: the title of the table

  • device_list: a list of Device dictionaries to display in the table

Output

Nothing is outputted by this action.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
- pam.devices.search:
    pam_address: pam.internal.net
    queries:
      - attribute: authentication_service_name
        query: equal
        value: example.domain.com
  save: example_domain_devices

- pam.devices.output_table:
    text: Devices on Example Domain
  load:
  load:
    device_list: example_domain_devices

pam.devices.

reveal_control_account

Reveal a device's control account secrets using its ID.

Minimum Plugin Version: 0.1.0

Input

pam_address: the IP or DNS address of the PAM Appliance

device_id: the ID of the device

Output

A single Secret dictionary.

Example
1
2
3
4
- pam.devices.reveal_control_account:
    pam_address: pam.internal.net
    device_id: 10
  save: device_secrets

pam.devices.

Search for devices in the PAM appliance.

Minimum Plugin Version: 0.1.0

Input

pam_address: the IP or DNS address of the PAM Appliance

queries: a list of Query dictionaries to use in the search

Output

A list of Device dictionaries.

Example

Finding all devices in the example.domain.com domain whose template name includes windows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- pam.devices.search:
    pam_address: pam.internal.net
    queries:
      - attribute: device_template_name
        query: like
        value: %windows%
      - attribute: authentication_service_name
        query: equal
        value: example.domain.com
  save: windows_domain_devices

Wildcard Queries

You can use the % character as a wildcard in the value of each query.