Skip to content

Osirium PAM Osirium PAM: Sessions

Summary

This module contains actions for reading session 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.sessions.

display

Display sessions in a table.

The table will have the following columns:

  • Username
  • Client IP Address
  • Start Time
  • End Time
  • Connection Count

Minimum Plugin Version: 2.0.0

Input
  • text: the title of the table

  • sessions: any number of Sessions

Output

Nothing is outputted by this action.

Example
1
2
3
4
5
6
7
8
- pam.sessions.get_all:
    pam_address: pam.internal.net
  save: sessions

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

pam.sessions.

get_all

Get all sessions 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 Sessions.

Example
1
2
3
- pam.sessions.get_all:
    pam_address: pam.internal.net
  save: all_sessions

pam.sessions.

get_by_client_ip

Get all sessions associated with the supplied client IP address.

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

client_ip: the client IP address

Output

A list of Sessions.

Example
1
2
3
4
- pam.sessions.get_by_device_id:
    pam_address: pam.internal.net
    device_id: 123
  save: sessions

pam.sessions.

get_by_id

Get a session 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

session_id: the ID of the session

Output

A single Session.

Example
1
2
3
4
- pam.sessions.get_by_id:
    pam_address: pam.internal.net
    session_id: 123
  save: session

pam.sessions.

get_by_username

Get all sessions 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 session

Output

A single Session.

Example
1
2
3
4
- pam.sessions.get_by_username:
    pam_address: pam.internal.net
    username: example.user
  save: sessions

pam.sessions.

select

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

The table will have the following columns:

  • Username
  • Client IP Address
  • Start Time
  • End Time
  • Connection Count

Minimum Plugin Version: 2.0.0

Input
  • text: The title of the table

  • sessions: any number of Sessions

  • 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
- pam.sessions.get_all:
    pam_address: pam.internal.net
  save: sessions

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

pam.sessions.

select_one

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

The table will have the following columns:

  • Username
  • Client IP Address
  • Start Time
  • End Time
  • Connection Count

Minimum Plugin Version: 2.0.0

Input
  • text: The title of the table

  • sessions: any number of Sessions

Output

A single Session.

Example
1
2
3
4
5
6
7
8
9
- pam.sessions.get_all:
    pam_address: pam.internal.net
  save: sessions

- pam.sessions.select_one:
    text: Select User
  load:
    sessions: sessions
  save: session