Reference - Metadata

The metadata dictionary is required in the root of the Playbook.

Summary

Metadata is used by PPA to:

  • Uniquely identify the task
  • Display the task to users
  • Allow users to search for the task

Example

The metadata below contains all required & optional keys.

All Metadata Keys
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
metadata:
  name: An Example Task
  description: This is the description of the task.
  icon: active_directory
  cost: 15 minutes
  tags:
    - using
    - tags
    - helps
    - people
    - search
  author: Dean Learner
  exit_codes:
    "0": The operation completed successfully
    "1": Failed to connect to Active Directory

Required Keys

name

A name used to uniquely identify the task in the PPA Appliance (free-text)

description

A description for the task (free-text)

author

The name of the task author (free-text)

Validation will fail without all required keys

Optional Keys

icon

  • The icon to display on the PPA task card
  • Defaults to a task identicon if not supplied
  • Must be in the icon list below
Valid Icons
  • active_directory
  • hashicorp_vault
  • ppa
  • pxm
  • service_now

Validation will fail if an invalid icon is used

exit_codes

  • A dictionary of exit codes & status messages
  • Used to give business process failures a human-readable message in PPA

Tip

Use the built-in exit action to end a task with custom exit codes.

cost

  • The length of time the task would take when performed manually
  • The value is a human readable string

Examples

  • 5 minutes
  • 2 hours

tags

  • A list of search tags (free-text)
  • These are displayed on both the task card & the PPA Appliance Tasks page
  • Tags make it easy for users to search for your task