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 |
|
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
Group
- Contains information about a PPA Group
Group Keys
"id", "name", "source", "user_sync", "start_tasks", "roles_count", "images_count", "members_count",
id: internal ID in PPA
name: name of the group
source: where the group was imported from (active-directory
or a PAM Appliance)
user_sync: indicates whether users are synchronised from this group
start_tasks: indicates whether the group's users are given the can start tasks
permission when imported
roles_count: the number of roles assigned to this group
images_count: the number of tasks assigned to this group
members_count: the number of PPA users in this group
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 |
|
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 |
|
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 |
|
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
).
User
- Contains information about a PPA User
User Keys
id: internal ID in PPA
display_name: display name
username: logon name
can_start_tasks: indicates whether the user has permission to start tasks
last_logon: date & time of last logon
deleted_at: indicates whether the user has been deleted
email: email address
groups: list of groups the user is a member of
permissions: list of permissions the user has been granted in PPA