Osirium PAM: Connections

Summary

This module contains actions for reading connection information from PAM.

This module requires PAM version 8.2.9 or newer

Remember

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

Actions

pam.connections.

display

Display connections in a table.

The table will have the following columns:

• Username
• Protocol
• Account
• Device ID
• Start Time
• End Time
• Screenshot Count

Minimum Plugin Version: 6.0.0

Input

• text: the title of the table

• connections: any number of Connections

Output

Nothing is outputted by this action.

Example

- pam.connections.get_all:
    pam_address: pam.internal.net
  save: connections

- pam.connections.display:
    text: Users
  load:
    connections: connections

pam.connections.

get_all

Get all connections from the PAM appliance.

This action requires PAM version 8.2.9 or newer

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

Output

A list of Connections.

Example

- pam.connections.get_all:
    pam_address: pam.internal.net
  save: all_connections

pam.connections.

get_by_device_id

Get all connections associated with the supplied device ID.

This action requires PAM version 8.2.9 or newer

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

device_id: the ID of the device

Output

A single Connection.

Example

- pam.connections.get_by_device_id:
    pam_address: pam.internal.net
    device_id: 123
  save: connections

pam.connections.

get_by_id

Get a connection using its ID.

This action requires PAM version 8.2.9 or newer

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

connection_id: the ID of the connection

Output

A single Connection.

Example

- pam.connections.get_by_id:
    pam_address: pam.internal.net
    connection_id: 123
  save: connection

pam.connections.

get_by_session_id

Get all connections associated with the supplied session ID.

This action requires PAM version 8.2.9 or newer

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

session_id: the ID of the device

Output

A single Connection.

Example

- pam.connections.get_by_session_id:
    pam_address: pam.internal.net
    session_id: 123
  save: connections

pam.connections.

get_by_username

Get all connections for the supplied user.

This action requires PAM version 8.2.9 or newer

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

username: the name of the user who made the connection

Output

A single Connection.

Example

- pam.connections.get_by_username:
    pam_address: pam.internal.net
    username: example.user
  save: connections

pam.connections.

select

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

The table will have the following columns:

• Username
• Protocol
• Account
• Device ID
• Start Time
• End Time
• Screenshot Count

Minimum Plugin Version: 6.0.0

Input

• text: The title of the table

• connections: any number of Connections

• minimum: The minimum number of acceptable selections

• maximum: The maximum number of acceptable selections

Output

A Selection containing:

• total: the number of selected Connections

• all: a list of selected Connections

• first: the first selected Connection

Example

- pam.connections.get_all:
    pam_address: pam.internal.net
  save: connections

- pam.connections.select:
    text: Select Users
  load:
    connections: connections
  save: selection

pam.connections.

select_one

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

The table will have the following columns:

• Username
• Protocol
• Account
• Device ID
• Start Time
• End Time
• Screenshot Count

Minimum Plugin Version: 6.0.0

Input

• text: The title of the table

• connections: any number of Connections

Output

A single Connection.

Example

- pam.connections.get_all:
    pam_address: pam.internal.net
  save: connections

- pam.connections.select_one:
    text: Select User
  load:
    connections: connections
  save: connection