Osirium PAM Osirium PAM: Profiles

Summary

This module contains actions for reading profile information from PAM.

Supported Versions

This plugin supports PAM versions 6.5.0 & newer.

Remember

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

Actions

pam.profiles.

get_all

Get all profiles from the PAM appliance.

Minimum Plugin Version: 1.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

Output

A list of Profiles.

Example
1
2
3
- pam.profiles.get_all:
    pam_address: pam.internal.net
  save: all_profiles

pam.profiles.

get_by_id

Get a profile using its ID.

Minimum Plugin Version: 1.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

profile_id: the ID of the profile

Output

A single Profile.

Example
1
2
3
4
- pam.profiles.get_by_id:
    pam_address: pam.internal.net
    profile_id: 10
  save: profile

pam.profiles.

get_by_name

Get a profile using its name.

Minimum Plugin Version: 1.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

name: the name of the device

Output

A single Profile.

Example
1
2
3
4
- pam.profiles.get_by_name:
    pam_address: pam.internal.net
    name: Windows Admins
  save: profile

pam.profiles.

input_table

Display profiles in a table, & allow the task operator to make a selection.

The table will have the following columns:

  • Name
  • Device Count
  • User Count
  • User Group Count

Minimum Plugin Version: 1.0.0

Input
  • text: The title of the table

  • profiles: a single or list of Profiles to display in the table

  • minimum: The minimum number of acceptable selections

  • maximum: The maximum number of acceptable selections

Output

A list of Profiles.

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

- pam.devices.output_table:
    text: Select a Profile
    minimum: 1
    maximum: 1
  load:
    profiles: all_profiles
  save: selected_profile

pam.profiles.

output_table

Display profiles in a table.

The table will have the following columns:

  • Name
  • Device Count
  • User Count
  • User Group Count

Minimum Plugin Version: 1.0.0

Input
  • text: the title of the table

  • profiles: a single or list of Profiles to display in the table

Output

Nothing is outputted by this action.

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

- pam.devices.output_table:
    text: All Profiles
  load:
    profiles: all_profiles

pam.profiles.

Search for profiles in the PAM appliance.

Minimum Plugin Version: 1.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

queries: a list of Queries to use in the search

Output

A list of Profiles.

Example

Finding all profiles that contain 1 or more users:

1
2
3
4
5
6
7
- pam.profiles.search:
    pam_address: pam.internal.net
    queries:
      - attribute: user_count
        query: greater_than
        value: 0
  save: profiles

Wildcard Queries

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