REFERENCE

Complete built-in task reference

Source-defined task fields, targets, outputs, constraints and examples.

Examples use remoteops.example.com and fictional systems. Adapt them to your tenant.

Screen reference#

The Alexa task accepts a speaker, announcement action and text message. It submits speech to the linked Alexa device; it does not run on a Windows agent.

Configure other built-in tasks in Packages

The YAML contracts below define inputs and outputs; use the package editor to compose them and Job History to verify execution.

Every built-in also has a purpose, example and result walkthrough in Built-in tasks.

How to use this reference#

These definitions describe package YAML built-ins, not directly callable public HTTP APIs. Use the exact built-in keyword, supported target and inputs. Replace placeholders and example targets before execution. Saved Activities have their own user-defined contracts.

Common fields#

name: Unique step name used by =step.output references
skip: Boolean, output reference or comma-separated OR group
continue_on_error: Default true; use false for prerequisites that must succeed
parallel: Optional asynchronous task execution; wait and control flow act as barriers
inputs: Mapping of scalar inputs or earlier task-output references. llm.images also accepts a list.
saved_activities: Saved PowerShell Activities run on a named Windows agent; Bash/Python Activities require a saved SSH profile. Use the exact saved Activity name.

`capture-rtsp-frame`#

Capture one JPEG from RTSP/RTSPS on Orchestrator; use its image output with llm instead of writing a capture script.

Execution target: Orchestrator.

Aliases: capture_rtsp_frame.

Required fields#

inputs.url (or url)

Supported fields#

url or inputs.url: RTSP/RTSPS URL or task-output reference
inputs.timeout_seconds: 1-60 (default 30)
skip: boolean or output reference
continue_on_error: boolean
parallel: boolean

Outputs#

image: JPEG base64 data URL
captured_at: UTC timestamp
transport: rtsps, rtsp, or unifi-rtsp-compatibility
bytes: integer

Example#

- task: capture-rtsp-frame
  name: camera
  continue_on_error: false
  inputs:
    url: 'rtsps://camera.example/stream'
    timeout_seconds: 30

`llm`#

Call a configured LLM connection with text or images; credentials are resolved by the server.

Execution target: Orchestrator.

Required fields#

inputs.prompt

Supported fields#

name: identifier (optional)
inputs.connection: saved LLM connection name (default: default)
inputs.model: model ID override (default from the selected connection)
inputs.prompt: text or output reference (required; up to 16384 bytes)
inputs.system: text or output reference (up to 4096 bytes)
inputs.<name>: value or output reference; use $name or ${name} in prompt/system; $$ escapes a dollar
inputs.image: PNG/JPEG/WebP base64 data URL, HTTPS URL, or output reference
inputs.images: YAML/JSON list of 1-4 images or per-image task references; or one array output reference
inputs.max_tokens: positive integer up to the selected model's output limit (default from Settings)
inputs.thinking: boolean (default false)
inputs.format: 'text' | 'json'
skip: boolean or output reference
continue_on_error: boolean

Outputs#

text: string
json: parsed JSON or null
model: alias
promptTokens: integer
completionTokens: integer
truncated: boolean

Example#

- task: llm
  name: analyse_logs
  continue_on_error: false
  inputs:
    connection: 'gemini-fast'
    role: 'IT operations engineer'
    event: 'Disk free space is 5 percent.'
    system: 'You are an $role. Summarise the event concisely.'
    prompt: 'Analyse this event: $event'
    max_tokens: 256
    thinking: false

`wait`#

Wait for a bounded duration. A sequential barrier that waits for pending work.

Execution target: Orchestrator.

Required fields#

duration (or inputs.duration)

Supported fields#

name: identifier (optional)
duration or inputs.duration: positive integer with ms, s, m, h, or d (1ms to 24h), or output reference
skip: boolean or output reference
continue_on_error: boolean
parallel: false (wait is a sequential barrier)

Outputs#

duration: string
durationMilliseconds: integer
waited: boolean

Example#

- task: wait
  name: pause
  inputs:
    duration: '30s'

`monitor`#

Read persisted monitor-trigger context. Must be the first task and requires a monitor-triggered run.

Execution target: Orchestrator.

Supported fields#

name: identifier (optional; task must be first)

Outputs#

name: string
monitor_id: string
monitor_name: string
event: event type
event_type: event type
device_id: string
device_name: string
agent_id: string
agent_name: string
group_id: string or null
group_name: string or null
package_name: string
selector: string or null
operator: string or null
threshold: number or null
value: string, number, or boolean
previous_state: string
state: string
triggered_at: server-local ISO 8601 string
triggered_at_utc: UTC ISO 8601 string
timezone: server timezone name
mode: 'once' | 'recurring'
cooldown_seconds: integer
create_alert: boolean
alert_id: string or null
summary: string

Example#

- task: monitor

`agents`#

List Windows agents or saved SSH profiles with filters.

Execution target: Orchestrator.

Supported fields#

name: identifier
type: 'agent' | 'ssh'
group: string (agent only)
status: 'online' | 'offline'
tags: CSV string
continue_on_error: boolean

Outputs#

agents: array
count: integer

Example#

- task: agents
  name: list_agents
  type: 'agent'
  group: 'Workstations'
  status: 'online'
  tags: 'managed'
  continue_on_error: true

`keyvault`#

Read, add or delete a named encrypted Key Vault value. Do not embed secret values in generated scripts.

Execution target: Orchestrator.

Required fields#

key
value when action=add

Supported fields#

name: identifier
action: 'get' | 'add' | 'delete'
key: string
value: string (add only)
continue_on_error: boolean

Outputs#

key: string
value: string (get)
added: boolean
deleted: boolean

Example#

- task: keyvault
  name: read_secret
  action: 'get'
  key: 'EXAMPLE_KEY'
  continue_on_error: true

`get_data`#

Read a text value from the package Data Store.

Execution target: Orchestrator.

Required fields#

key

Supported fields#

name: identifier
package: printable namespace or output reference (optional)
key: identifier or output reference
skip: boolean or output reference
continue_on_error: boolean

Outputs#

package: string
key: string
value: string

Example#

- task: get_data
  name: read_value
  package: 'example'
  key: 'keyname'
  skip: false
  continue_on_error: true

`store_data`#

Save text to a package Data Store namespace. Stored data is not encrypted.

Execution target: Orchestrator.

Required fields#

key
value

Supported fields#

name: identifier
package: printable namespace or output reference (optional)
key: identifier or output reference
value: string or output reference
skip: boolean or output reference
continue_on_error: boolean

Outputs#

package: string
key: string
stored: boolean
sizeBytes: integer

Example#

- task: store_data
  name: save_value
  package: 'example'
  key: 'keyname'
  value: 'replace with a value'
  skip: false
  continue_on_error: true

`alexa`#

Control an existing Echo through the configured Alexa integration.

Execution target: Orchestrator.

Required fields#

inputs.device
inputs.message for announce/speak/music; inputs.volume for volume

Supported fields#

name: identifier
inputs.device: unique Echo name, serial number or output reference
inputs.action: 'announce' | 'speak' | 'music' | 'volume' | 'play' | 'pause' | 'next' | 'previous'
inputs.message: string or output reference
inputs.volume: integer (0-100)
inputs.provider: AMAZON_MUSIC | SPOTIFY | TUNEIN
skip: boolean or output reference
continue_on_error: boolean

Outputs#

submitted: boolean
device: string
action: string

Example#

- task: alexa
  name: announce_complete
  inputs:
    device: 'Kitchen Echo'
    action: 'announce'
    message: 'RemoteOps task completed.'

`email`#

Send email through the configured SMTP settings; no mail script is needed.

Execution target: Orchestrator.

Required fields#

subject
recipient
data

Supported fields#

name: identifier
subject: string or output reference
recipient: CSV string or output reference
cc: CSV string or output reference
bcc: CSV string or output reference
format: 'plain' | 'html'
data: string or output reference
skip: boolean or output reference
continue_on_error: boolean

Outputs#

sent: boolean
recipientCount: integer
ccCount: integer
bccCount: integer
totalRecipientCount: integer

Example#

- task: email
  name: send_email
  subject: 'Subject'
  recipient: 'recipient@example.com'
  format: 'html'
  data: |
    <html><body><p>HTML email body</p></body></html>
  skip: false
  continue_on_error: true

`notification`#

Display a notification or a yes/no question to a user on a Windows agent.

Execution target: Windows agent.

Required fields#

agent
message

Supported fields#

name: identifier
agent: string or output reference
group: string
message: string or output reference
type: 'normal' | 'large' | 'yes_or_no'
skip: boolean or output reference
continue_on_error: boolean

Outputs#

displayed: boolean
type: 'normal' | 'large' | 'yes_or_no'
response: 'yes' | 'no' | null (yes_or_no)
messageLength: integer

Example#

- task: notification
  name: notify_user
  agent: 'agent-name'
  group: 'group-name'
  message: 'Notification message'
  type: 'normal'
  skip: false
  continue_on_error: true

`rtsps_stream`#

Display an RTSPS camera stream on a Windows agent.

Execution target: Windows agent.

Required fields#

agent
url
display_for_seconds

Supported fields#

name: identifier
agent: string or output reference
group: string
url: rtsps URL
display_for_seconds: integer
bell: boolean
max_age_seconds: integer
skip: boolean or output reference
continue_on_error: boolean

Outputs#

dispatched: boolean
jobId: string

Example#

- task: rtsps_stream
  name: show_camera
  agent: 'agent-name'
  group: 'group-name'
  url: 'rtsps://camera.example/stream'
  display_for_seconds: 30
  bell: false
  max_age_seconds: 60
  skip: false
  continue_on_error: true

`goto`#

Jump to an earlier named task if its condition is true.

Execution target: Orchestrator.

Required fields#

activity
condition

Supported fields#

name: identifier
activity: prior task name
condition: boolean or output reference

Outputs#

condition: boolean
activity: string
jumped: boolean
targetIndex: integer

Example#

- task: goto
  name: repeat_step
  activity: previous_task
  condition: false

`stop`#

Stop the package successfully if its condition is true.

Execution target: Orchestrator.

Required fields#

condition

Supported fields#

name: identifier
condition: boolean or output reference

Outputs#

condition: boolean
stopped: boolean

Example#

- task: stop
  name: stop_if_needed
  condition: false

`event`#

Execution target: Orchestrator.

Required fields#

type

Supported fields#

name: identifier
type: 'agent.online' | 'agent.offline' | 'cpu.usage' | 'memory.usage' | 'disk.free' | 'process.running' | 'process.stopped' | 'service.running' | 'service.stopped' | 'network.adapter' | 'inventory.stale' | 'eventlog.match'
agent: string or output reference
group: string or output reference
continue_on_error: boolean

Outputs#

type: event type
agent: string or null
group: string or null
triggered: boolean

Example#

- task: event
  name: monitor_event
  type: 'cpu.usage'
  agent: 'agent-name'
  group: 'group-name'
  continue_on_error: true

`bash`#

Run an inline Bash script through a saved SSH profile.

Execution target: saved SSH profile.

Required fields#

ssh
inputs.script

Supported fields#

name: identifier
ssh: profile name
skip: boolean or output reference
continue_on_error: boolean
inputs.*: scalar or output reference
inputs.script: string

Outputs#

standardOutput: string
standardError: string
exitCode: integer
JSON stdout properties

Example#

- task: bash
  name: run_bash
  ssh: 'ssh-profile'
  skip: false
  continue_on_error: true
  inputs:
    script: |
      printf '{"result":"ok"}'

`python`#

Run an inline Python script through a saved SSH profile.

Execution target: saved SSH profile.

Required fields#

ssh
inputs.script

Supported fields#

name: identifier
ssh: profile name
skip: boolean or output reference
continue_on_error: boolean
inputs.*: scalar or output reference
inputs.script: string

Outputs#

standardOutput: string
standardError: string
exitCode: integer
JSON stdout properties

Example#

- task: python
  name: run_python
  ssh: 'ssh-profile'
  skip: false
  continue_on_error: true
  inputs:
    script: |
      import json
      print(json.dumps({"result": "ok"}))

`inline_powershell`#

Run inline PowerShell on Orchestrator, not on a Windows agent. Use a saved PowerShell Activity with agent to query an endpoint.

Execution target: Orchestrator.

Required fields#

inputs.script

Supported fields#

inputs.script: PowerShell code
inputs.<name>: scalar or earlier output reference
skip: boolean or reference
continue_on_error: boolean

Outputs#

Named properties of the returned object

Example#

- task: inline_powershell
  name: transform
  inputs:
    script: |
      return @{ rows = @(@{ Name = 'Example'; Count = 1 }) }

`form`#

Interactive form step. Use form: instead of task:. Runs after earlier queries; pauses for operator submission in Trigger Automations.

Execution target: interactive portal.

Required fields#

form
fields (unless referencing an existing library form)

Supported fields#

form: unique form name
fields: list of named controls
width, height: optional canvas dimensions
hide_run: boolean
field types: text, toggle, dropdown, button, radio, checkbox, listbox, date, time, datetime, progress, label, table
table columns: ordered [{key: property,label: Heading}]
table values: row-object array, JSON array string, or =earlier.rows
hide: boolean on every control; hidden required fields do not block submission

Outputs#

Named submitted input controls; table and label controls produce no input outputs

Example#

- form: report
  fields:
    - name: grid
      label: Results
      type: table
      columns: [{key: Name, label: Name}]
      values: '[{"Name":"Example"}]'

`RemoteOpsSoftware`#

Built-in managed software Activity. Prefer this over inventing installation scripts when the managed software operation is suitable. User-scope operations need the expected logged-on user and runas:user.

Execution target: Windows agent.

Required fields#

agent
inputs.Operation
inputs.Scope

Supported fields#

inputs.Operation: scan | install | update | uninstall
inputs.Scope: machine | user
inputs.PackageId: package identifier for install/update
inputs.EntryId: inventory entry identifier for uninstall
inputs.ExpectedUser: expected logged-on user for user scope
runas: system | user

Outputs#

report: structured object with operation, scope, status, items, truncated, collectedAt, rebootRequired; failures include error

Example#

- task: RemoteOpsSoftware
  name: scan_software
  agent: 'exact-agent-name'
  inputs:
    Operation: scan
    Scope: machine

Complete built-in task reference

Screen reference#

Related walkthroughs#

How to use this reference#

Common fields#

capture-rtsp-frame#

Required fields#

Supported fields#

Outputs#

Example#

llm#

Required fields#

Supported fields#

Outputs#

Example#

wait#

Required fields#

Supported fields#

Outputs#

Example#

monitor#

Supported fields#

Outputs#

Example#

agents#

Supported fields#

Outputs#

Example#

keyvault#

Required fields#

Supported fields#

Outputs#

Example#

get_data#

Required fields#

Supported fields#

Outputs#

Example#

store_data#

Required fields#

Supported fields#

Outputs#

Example#

alexa#

Required fields#

Supported fields#

Outputs#

Example#

email#

Required fields#

Supported fields#

Outputs#

Example#

notification#

Required fields#

Supported fields#

Outputs#

Example#

rtsps_stream#

Required fields#

Supported fields#

Outputs#

Example#

goto#

Required fields#

Supported fields#

Outputs#

Example#

stop#

Required fields#

Supported fields#

Outputs#

Example#

event#

Required fields#

Supported fields#

Outputs#

Example#

bash#

Required fields#

`capture-rtsp-frame`#

`llm`#

`wait`#

`monitor`#

`agents`#

`keyvault`#

`get_data`#

`store_data`#

`alexa`#

`email`#

`notification`#

`rtsps_stream`#

`goto`#

`stop`#

`event`#

`bash`#

`python`#

`inline_powershell`#

`form`#

`RemoteOpsSoftware`#