Inputs & Outputs

DelayedTask

  • Contains information about a delayed PPA Task

  • Delayed Tasks are all based on an Inventory Image

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
description: Remove John Smith's Temporary Access
id: 7
image: Remove User From Groups
image_id: 11
is_owner: false
is_pending: false
payload:
  groups:
    - Remote Desktop Users
    - Account Operators
start_time: '2021-03-25T10:33:43.244374'
task_uuid: 50d10ddc-be19-464d-8d5f-66b17ac38978
timezone: Etc/UTC
trigger: api
username: adccess.admin

DelayedTask Keys

description: a description of the delayed task

id: the delayed task ID

image: the name of the inventory image the delayed task will be started from (also known as the task name)

image_id: the ID of the inventory image

is_owner: denotes whether the delayed task was created by the current user

is_pending: denotes whether the delayed task is still pending

payload: the payload supplied to the task (if applicable)

start_time: the time the task will start

task_uuid: the UUID of the task if it (if running or complete)

timezone: the timezone of the start time

trigger: the method the delayed task was created (api, ui, or task)

username: the name of the user who created the delayed task

Image

  • Contains information about a PPA Inventory Image

  • These Inventory Images can be started as Tasks

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
author: John Smith
description: Check the status of a service on one or more Windows Servers.
deployed: true
id: 37
name: Check Windows Service
owner: domain\john.smith
tags:
- windows
- service
updated_at: 11:05:28 12/11/2020
uuid: 96979ffb-649d-4f66-a492-8a20a81eb9bc

Image Keys

author: the author of the image

description: a description of the image

deployed: denotes whether the task is deployed

id: the image ID

name: the name of the image

tags: a list of tags assigned to the image

updated_at: when the image was last updated

uuid: the image UUID

Task

  • Contains information about a PPA Task

  • Tasks are all based on an Inventory Image

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
author: John Smith
cancelled_at:
cancelled_by:
duration: '00:00:20.959942'
exit_code: 0
exit_message:
id: 1208
image: Builtin Administrator Audit
image_id: 936
started_at: '08:35:01 24/03/2021'
state: Success
stopped_at: '08:35:22 24/03/2021'
timed_out: false
timeout: 15
username: domain\john.smith
uuid: 0b6abd26-6027-49f7-a535-898159728d71

Task Keys

author: the author of the image the task was started from

cancelled_at: when the task was cancelled (if cancelled)

cancelled_by: the user who cancelled the task (if cancelled)

duration: how long the task ran for (if completed)

exit_code: the task exit code (if completed)

exit_message: the message corresponding to the exit_code (if completed & configured)

id: the task ID

image: the name of the inventory image the task was started from (also known as the task name)

image_id: the ID of the inventory image

started_at: when the task was started

state: the task state

stopped_at: when the task was stopped (if completed)

timeout: the task timeout in minutes

username: the name of the user who started the task

uuid: the task UUID

TaskResult

  • Contains a condensed view of a Task's result once it has completed

  • Also includes any result_json saved by a task

  • The result_json key contains information saved by the task when it ran

  • This is mainly used to retrieve a task's output when starting tasks via the API

Example

1
2
3
4
5
6
7
8
exit_code: 0
exit_message:
result_json:
  audited_servers:
    - server-001
    - server-002
    - server-003
state: success

TaskResult Keys

exit_code: the task exit code (if completed)

exit_message: the message corresponding to the exit_code (if completed & configured)

result_json: any JSON data saved by the task

state: the task state

TimeStamp

  • Contains submitted date picker information

All TimeStamp Keys

day: The selected day.

month: The selected month.

year: The selected year.

hour: The selected hour.

minute: The selected minute.

second: The submitted second.

timezone: The chosen timezone.

timestamp: The supplied date, time, & UTC offset in ISO-8601 format (yyyy-mm-ddThh:mm:ss+hh:mm).