Osirium PAM: Device Templates

Summary

This module contains actions for reading device template information from PAM.

Supported Versions

This plugin supports PAM versions 9.0.0 & newer.

Remember

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

Actions

pam.templates.

display

Display templates in a table.

The table will have the following columns:

• Display Name
• Name
• Major Version
• Minor Version

Minimum Plugin Version: 6.0.0

Input

• text: the title of the table

• templates: any number of Templates

Output

Nothing is outputted by this action.

Example

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

- pam.templates.display:
    text: Templates
  load:
    templates: templates

pam.templates.

get_all

Get all templates from the PAM appliance.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

Output

A list of Templates.

Example

- pam.templates.get_all:
    pam_address: pam.internal.net
  save: all_templates

pam.templates.

get_by_auth_scheme

Get all templates with the supplied authentication scheme.

Valid authentication schemes are:

• active_directory

• static_vault

• local

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

auth_scheme: either active_directory, static_vault, or local

Output

A list of Templates.

Example

- pam.templates.get_by_auth_scheme:
    pam_address: pam.internal.net
    auth_scheme: active_directory
  save: active_directory_templates

pam.templates.

get_by_display_name

Get templates with the supplied display name.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

display_name: the display name of the template

latest: set to true to only output the latest version of the template (defaults to false)

Output

A list of Templates if latest is false, or a single Template if it is true.

Example

- pam.templates.get_by_display_name:
    pam_address: pam.internal.net
    display_name: example.template
  save: templates

pam.templates.

get_by_id

Get a template using its ID.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

template_id: the ID of the template

Output

A single Template.

Example

- pam.templates.get_by_id:
    pam_address: pam.internal.net
    template_id: 123
  save: template

pam.templates.

get_by_name

Get a template using its name.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

name: the name of the template

latest: set to true to only output the latest version of the template (defaults to false)

Output

A list of Templates if latest is false, or a single Template if it is true.

Example

- pam.templates.get_by_name:
    pam_address: pam.internal.net
    name: example.template
  save: templates

pam.templates.

get_by_vendor

Get all templates with the supplied vendor.

You may also provide an authentication scheme for further filtering.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

vendor: the template vendor

auth_scheme: optional auth scheme (either active_directory, static_vault, or local)

Output

A list of Templates.

Example

- pam.templates.get_by_vendor:
    pam_address: pam.internal.net
    vendor: Microsoft
  save: templates

pam.templates.

select

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

The table will have the following columns:

• Display Name
• Name
• Major Version
• Minor Version

Minimum Plugin Version: 6.0.0

Input

• text: The title of the table

• templates: any number of Templates

• minimum: The minimum number of acceptable selections

• maximum: The maximum number of acceptable selections

Output

A Selection containing:

• total: the number of selected Templates

• all: a list of selected Templates

• first: the first selected Template

Example

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

- pam.templates.select:
    text: Select Templates
  load:
    templates: templates
  save: selection

pam.templates.

select_one

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

The table will have the following columns:

• Display Name
• Name
• Major Version
• Minor Version

Minimum Plugin Version: 6.0.0

Input

• text: The title of the table

• templates: any number of Templates

Output

A single Template.

Example

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

- pam.templates.select_one:
    text: Select Template
  load:
    templates: templates
  save: template

pam.templates.

supply_connection_parameters

Warning

This action is not documented yet!