Appearance
Available Tasks
Cancelling running tasks
Abort a target to stop pending work and request cancellation of its running task. A task that cannot stop safely may need to finish before the target becomes Aborted. If the endpoint disconnects, cancellation waits for it to reconnect.
See Jobs for timeouts and error handling.
Instructions
Set/change BIOS admin password
Set or change the BIOS administrator password on supported Dell Windows devices. Set only if missing preserves an existing password; Set or change uses the endpoint's effective hardware.firmware.password to change it.
Use a retrievable secret or Generate password, then reference it in New password, for example {{ job.vars.bios_password }}. Literal passwords are stored in the job configuration and exported with it. Passwords must fit the device's supported length and character requirements.
The previous credential and proposed password appear in plain text in job output and downloaded logs. Treat those records as credentials. Successful changes update the endpoint's hardware.firmware.password override and retain the applied value in variable revisions.
If a write is interrupted, inspect the device and the job run's output before retrying. Ordyn does not automatically repeat an uncertain password change.
Intel AMT tasks
Use AMT tasks to manage provisioned devices through their assigned AMT client, including while Windows is offline.
| Task | Purpose |
|---|---|
Inspect Intel AMT | Refresh firmware state, configuration, and inventory. |
Read Intel AMT power state | Check whether the device is powered on or off. |
Run Intel AMT power action | Power on, shut down, power off, reset, or power cycle. |
Set Intel AMT one-time boot | Select a firmware-supported target for the next boot. |
Mount Intel AMT media | Attach an Ordyn ISO or raw IMG as read-only media. |
Wait on Intel AMT media | Wait for agent reconnect, a power state, a duration, or manual completion. |
Unmount Intel AMT media | Detach the mounted image. |
Use Job Operator with AMT Operator or AMT Administrator for these tasks on the intended targets. Firmware consent can require a person at the device even when the action runs from a job.
For power behavior, booting from media, and session limits, see Intel AMT Endpoint Management. KVM and SOL consoles are interactive endpoint actions.
Import Windows Firewall rules
Capture local Windows Firewall rules as the endpoint's Ordyn policy without changing the device. Each successful capture creates a revision. Simplify or remove unsupported rules before enforcing the policy.
This workflow covers local rules, not Group Policy, MDM, or connection-security rules. See Windows Firewall for capture and enforcement.
Prompt for choice
Use a choice prompt to pause for a Windows user's response and store it in job.vars. Tasks with user-confirmation settings can also let users continue or postpone disruptive work. See Pauses and endpoint availability when planning other work on the same device.
Run on another endpoint
Enable Allow individual steps to run on another endpoint when a workflow needs a fixed execution endpoint in the same tenant. For example, create a file on a server, collect it as an artifact, and place it on the original client.
Use roles covering the work on both endpoints. Templates such as {{ endpoint.hostname }} still describe the original job target.
This option is available for supported endpoint-local tasks. Deployment, PXE, updates, user-interaction, and SNMP tasks keep their normal target. Self-service jobs can use a fixed execution endpoint already configured in the job.
Enable or disable entity on endpoint
Enable or disable an alert rule, configuration profile, or job on the current target endpoint. Choose This job with Disabled to prevent future runs of the executing job on that endpoint. Enabling removes the endpoint override without changing assignments.
For alert rules, see endpoint checks. Configuration profiles can be suspended or resumed while the Agent is offline.
Disabling Intel AMT stops management and certificate maintenance while leaving firmware configured. Use deprovisioning to remove that configuration. See Configuration Profiles for disable scope and resuming checks.
Collect artifacts
Collects files as task artifacts from either the connected endpoint agent or an active preboot session, depending on job routing. To configure it, set the artifact paths to collect.
See Job artifacts for malware scanning and retention settings.
Endpoint job scripts can write logs and diagnostic files to {{ job.artifact_directory }}. Use {{ job.log_file }} for a default per-task log file, or collect multiple files later with a glob such as {{ job.artifact_directory }}\*.log.
Use {{ job.workspace }} for files that later endpoint tasks need. Endpoint scripts start in this shared workspace and also receive its path through ORDYN_WORKSPACE.
Artifact paths support runtime environment references such as {{ env.TEMP }}\DCU_ApplyUpdates.log and {{ env["ProgramFiles(x86)"] }}\Vendor\*.log on Windows, or {{ env.TMPDIR }}/ordyn.log on Linux. Ordyn resolves each reference once before matching. Windows names are case-insensitive; Linux names are case-sensitive. A missing variable fails the collection step with the variable name in the error.
Select the identity for resolving environment references and accessing files:
- Agent service uses the service identity and is the cross-platform default.
- Selected Windows user uses a configured Windows execution context.
- Same identity as earlier step uses the effective identity from a compatible earlier Windows script on the same execution path and endpoint. The collection step fails when that identity is unavailable.
The selected account must be able to read the files. Prefer {{ job.artifact_directory }} for files that do not need a user-specific location.
Directories include their contents recursively; symbolic links are skipped. Collection fails if a matched file cannot be read or exceeds the upload limit.
Control flow
If branch
Evaluates a condition and executes either the then or else branch. To configure it, build the condition in the visual editor or raw expression editor, then add the then and else branches.
String conditions support equals, does not equal, contains, does not contain, is empty, and is not empty. Conditions can also check whether a persistent variable has a direct endpoint override or any effective override for the endpoint currently running the job. See Variables for the expression syntax and override modes.
Sleep
Pauses the job for the specified number of seconds. See Pauses and endpoint availability for how other work can affect when it continues.
Generate password
Generate a random password for later steps in the same target and run. Set a variable name such as credentials.local_admin, a length from 8 to 128 characters, and the allowed character categories. The default is 24 characters with uppercase, lowercase, numbers, and ASCII punctuation.
Exclude characters or restrict punctuation to meet the destination's password policy. Every enabled category must contain an allowed character and contributes at least one character.
Use {{ job.vars.credentials.local_admin }} in a later template. The value is secret and masked in normal run context, but the consuming task can disclose it; check that task's guidance. Each target and executed loop iteration generates independently. A completed step keeps its value when the run resumes.
See Runtime job variables for scope and retention.
Set job variable
Stores a runtime value under job.vars for later steps and branches. To configure it, set the variable name and the expression that should populate job.vars. Values derived from secrets stay secret and are hidden in task output.
Set environment variable
Sets or removes an environment variable for subsequent inline and saved script steps on the same job target.
Choose Set, enter a portable environment variable name, and provide a templated value. Choose Unset to remove a value set by an earlier task. Names beginning with ORDYN_ are reserved for Ordyn-provided script context.
The value is scoped to the current target. It does not change the machine-wide environment. Secret values remain encrypted in retained run data after the target finishes. See Job Variables for persistent, inherited, and prompted values available through vars.*.
Set variable override
Creates, updates, nulls, or deletes one persistent variable override on a selected scope. The supported destinations are a tenant, endpoint folder, group, or endpoint. To configure it, choose the scope, operation, target mode when needed, and the value expression when you are setting a value.
Unassign this job from endpoint
Removes only the direct endpoint assignment for this job on the current endpoint.
End job
Ends the current Tasks or Cleanup section with the chosen result and an optional message. Ending Tasks still allows configured Cleanup to run.
Loops
For each
Iterates over an expression result and runs the body once per item. To configure it, set the items expression, item variable, optional index variable, and maximum iteration count, then add the body steps. Replay GUI automation tasks are not supported inside loop bodies. Keep GUI replay at top level or inside branches outside the loop.
While loop
Re-evaluates a condition and repeats the body until it becomes false or the maximum iterations is reached. To configure it, set the condition, optional maximum iteration count, and the body steps. Replay GUI automation tasks are not supported inside loop bodies. Keep GUI replay at top level or inside branches outside the loop. The condition editor supports the same string operators and variable override checks as If branch.
Job composition
Run endpoint job
Starts one child run of a selected endpoint job and waits for that run to finish. Use this task to reuse an endpoint workflow inside a larger endpoint or infrastructure job.
Choose one target source:
Current endpointuses the parent endpoint and is available in endpoint jobs.Endpoint groupscombines the current members of one or more groups and removes duplicates.Expressionaccepts an endpoint UUID, an endpoint object, or an array containing either form.
The endpoint set is resolved and fixed when the task starts. Configure the child concurrency to limit how many targets can execute at once, or leave it empty to use the child job's default. The child job resolves its own endpoint and job-level variables. Prompt-enabled fields are not interactive here, so every required child variable must already have an effective persistent value.
Choose whether an empty target set fails the task or succeeds without starting a child run. The task's normal error behavior controls whether the parent continues after a failed, timed-out, or aborted child run.
The run history links the parent task to its child run and the child run back to its parent. Aborting the parent cascades cancellation to an active child run.
Wait for endpoint set state
Waits until every endpoint in a resolved and fixed target set reaches the selected Edge-connected or Edge-disconnected state. It supports the same current endpoint, endpoint group, expression, and empty-set choices as Run endpoint job.
Use this task before a dependent stage when connectivity is a prerequisite. For Hyper-V workflows, {{ endpoint.hyperv_guest_endpoint_ids }} resolves to the identified guest endpoints from the host's latest Hyper-V inventory.
Job references cannot form a cycle, and nested child-job execution is limited to eight levels.
Messaging
Log message
Record a templated message in job history, using endpoint values, variables, earlier results, or loop values. For example, Deploying {{ job.vars.release }} to {{ endpoint.hostname }} records the selected release for each target.
Missing values appear as null, and large messages are truncated. Use artifacts for complete logs. Messages are available in administrative history; self-service users see the task status only.
Send email
Sends a templated email through the configured SMTP server. To configure it, set the recipient lists, subject, body, and whether the primary user should be included.
Agent management
You can cancel an Agent update or reinstall while the release downloads. Once installation starts, it cannot be interrupted.
Update Ordyn Agent
Updates the Ordyn Agent to a selected release or the latest compatible release at runtime. To configure it, select a specific agent release or leave it on the latest compatible release.
Reinstall Ordyn Agent
Reinstalls the Ordyn Agent from a selected release or the latest compatible release at runtime. To configure it, select a specific agent release or leave it on the latest compatible release.
Export Ordyn Agent logs
Exports the retained Ordyn Agent event log to a job artifact. To configure it, choose whether to export operational or audit logs.
Export Ordyn Agent database diagnostics
Collect Agent diagnostics for troubleshooting. Use Sanitized summary for routine investigation. Select Raw SQLite snapshot only when support needs a full diagnostic snapshot; it can contain sensitive operational data and expires after seven days.
The endpoint needs an assigned Cache Node. Download the result from Job Runs and protect downloaded copies.
Configuration
Read key/value file value
Reads a key from a dotenv or INI file and exposes the result for later conditions. To configure it, set the file path, file format, and key to read.
Read behavior:
- reading a missing file fails the task
- reading a missing key succeeds with
result.found = false - if the same key appears multiple times, Ordyn uses the last matching value and reports the total
Matched key count
Write key/value file value
Change a key in a dotenv or INI file. Choose set to create or replace it, update to change only an existing key, null to keep the key with an empty value, or delete to remove it.
For example, set APP_ENV to production in /etc/app.env, or set enabled in the app section of /etc/app.ini. Use update when missing configuration must stay absent.
Filesystem
Inspect file
Checks whether a file exists and returns its metadata. To configure it, set the file path.
Read file
Reads the content of a text file from the endpoint filesystem. To configure it, set the file path. You can also choose the encoding and limit how many bytes to read.
Write file
Creates or overwrites a file with inline content on an endpoint or in an infrastructure job’s managed Runner workspace. Infrastructure destinations must be workspace-relative, such as input/event.json; subsequent host and Docker tasks share the file. To configure it, set the file path, content, encoding, overwrite behavior, and whether Ordyn should create the parent folder. Use Place file for a stored file or previous artifact. See Write inline content for a runtime webhook example.
Place file
Places a stored file on the endpoint or in the infrastructure job’s managed Runner workspace.
For endpoint jobs, set Destination path to the endpoint location. For infrastructure jobs, set Workspace destination to a relative path such as input/setup.exe. Later host and Docker steps share the placed file.
Select the source and configure overwrite and template rendering as needed. Endpoint placement also supports an optional file name and parent-folder handling.
Supported file sources:
Ordyn file- places a global Ordyn-managed file
Endpoint file- places a file retrieved from a selected endpoint; available in endpoint jobs only
Software package- places the package's primary file or one of its staged install archives
Previous task artifact- places a file collected by an earlier task in the same job target
For a software package source, select the package and then select its primary file or a staged install archive. A staged archive is placed as a complete ZIP; use a later extraction step when its contents are needed. Ordyn resolves the current file in the selected package location when the task runs, so content published later to the same primary location or archive slot is used automatically.
Enable Render selected file as template only for valid UTF-8 text files of up to 10 MiB. Files placed without this option are copied verbatim. Selected content must pass malware scanning; software-package approval does not affect placement.
Placement waits for malware verification and cache synchronization within the task timeout. A failed scan or unavailable file prevents placement.
When multi-endpoint job mode is enabled, Run on endpoint controls where the file is placed. Previous task artifact still refers to an earlier artifact from the same job target, so this can be used for flows where one step collects a generated file from another endpoint and a later placement step writes it onto the original target endpoint.
Delete file
Deletes a file from the endpoint filesystem. To configure it, set the file path.
Retrieve file
Copies one or more files from the endpoint into Ordyn files. To configure it, set one or more source paths and an optional archive name.
Each retrieved file is limited to 15 GiB by default.
Inspect directory
Checks whether a directory exists and returns its metadata. To configure it, set the directory path.
List directory
Lists the contents of a directory on the endpoint filesystem. To configure it, set the directory path and, if needed, recursive listing, maximum depth, and entry limits.
Create directory
Creates a directory on the endpoint filesystem. To configure it, set the directory path and whether recursive handling is allowed.
Delete directory
Deletes a directory from the endpoint filesystem, optionally recursively. To configure it, set the directory path and whether recursive handling is allowed.
Retrieve directory
Archives a directory on the endpoint and stores it in Ordyn as a zip file. To configure it, set the directory path and an optional archive name.
Directory retrieval is limited by entry count, path depth, source size, and completed ZIP size. Symbolic links are not included.
Registry
Inspect registry key
Checks whether a Windows registry key exists and reports its metadata. To configure it, set the registry hive and path.
List registry key
Lists subkeys and values under a Windows registry key. To configure it, set the registry hive and path.
Create registry key
Creates a Windows registry key if it does not already exist. To configure it, set the registry hive and path.
Delete registry key
Deletes a Windows registry key, optionally recursively. To configure it, set the registry hive and path, and choose whether recursive deletion is allowed.
Inspect registry value
Checks whether a Windows registry value exists and reports its metadata. To configure it, set the registry hive, key path, and value name.
Read registry value
Reads a Windows registry value from the endpoint. To configure it, set the registry hive, key path, and value name.
Write registry value
Creates or updates a Windows registry value on the endpoint. To configure it, set the registry hive, key path, value name, value type, and value data.
Delete registry value
Deletes a Windows registry value from the endpoint. To configure it, set the registry hive, key path, and value name.
Retrieve registry key
Exports a Windows registry key into Ordyn as a .reg file. To configure it, set the registry hive, key path, and an optional file name for the export.
System
Reboot endpoint
Requests a reboot on the target endpoint.
For Telematik devices, use the assigned service client. A Konnektor reboot completes when the device is back up. See Telematik reboot.
When another task enables automatic reboot handling, the visible runtime reboot sequence uses that task's configured error behavior. A failed reboot wait is reported on the originating task, and the remaining automatic steps in that sequence are skipped. See Step error behavior for the three available outcomes.
Shutdown endpoint
Requests a shutdown on the target endpoint.
Linux
Install APT updates
Installs applicable package updates on Debian-style Linux endpoints.
Configure:
- the upgrade mode:
Upgraderunsapt-get upgrade --with-new-pkgs, whileFull upgraderunsapt-get dist-upgrade - recovery behavior:
None,Repair on error, orAlways repair first - release-information change handling
- whether to run
apt-get autoremove -yafter a successful upgrade
APT runs noninteractively and preserves existing configuration files when packages prompt about replacements. Recovery uses dpkg --configure -a followed by apt-get -f install -y. The endpoint variable linux.apt.releaseinfo_change_policy can override the configured release-information policy at runtime.
Automatic reboot orchestration is disabled by default. When enabled, Ordyn can restart the endpoint only after APT reports that a reboot is required. The job waits for the restart and reconnection before continuing.
Windows
Export Windows Update log
Generates the full readable WindowsUpdate.log from the Windows Update traces currently available on the endpoint and returns it as a job artifact.
The export does not force Windows to flush in-memory traces first. As a result, the newest Windows Update activity may not appear in the generated file yet.
Install Windows updates
Installs applicable updates offered by Windows Update without requiring a ring approval.
The task respects the endpoint's Windows update blacklist.
Choose an update source:
Default sourceuses the source configured by the endpoint's effective Windows Update policyMicrosoft Updatescans Microsoft Update for this taskWSUSuses the endpoint's configured WSUS service and fails when WSUS is not configured
Select at least one classification. Drivers includes automatic and optional Windows Update driver offers, including firmware delivered through the driver channel. Other classifications select software updates. An optional product filter further restricts the offers.
Windows makes the final applicability decision for the endpoint. An update that matches the job filters but is not offered as applicable on that endpoint is not installed.
The task waits for Windows to finish installation. Configure the task timeout for the expected scan, download, and installation duration. If the timeout expires first, Ordyn times out the step and requests cancellation. Windows servicing work that Windows has already accepted may continue independently.
Jobs with durable result spooling enabled can retain a completed update result locally and retry delivery during the configured recovery window. The job target timeout remains the outer deadline.
Automatic reboot orchestration is disabled by default. When enabled, Ordyn restarts only after Windows reports that a reboot is required, waits for the restart and Windows Update readiness, then follows the selected one-reboot or rerun-until-clean strategy.
Install approved Windows updates
Install revisions approved in each target's effective update ring. Choose Windows Update for direct Microsoft downloads or Ordyn repository for prepared content delivered through Cache. Optional classification and product filters narrow the approved set.
The endpoint needs an enabled ring without assignment conflicts. Its update blacklist takes precedence. Windows determines applicability; success with nothing installed can mean the approved revisions do not apply at execution time.
Repository installation requires current offline inventory, a catalog no older than 45 days, and verified imported content. It supports Security Updates, Service Packs, and Update Rollups. Use Windows Update for other classifications.
Automatic reboot handling is disabled by default. Enable it only where job-initiated restarts are acceptable. See Windows Updates for the complete setup, source requirements, and troubleshooting.
Download offline Windows update catalog
Downloads Microsoft's offline scan catalog on a Runner and imports it into Ordyn.
Select a Runner pool in the job overview and schedule the task about once every seven days when offline inventory or the Ordyn repository installation source is used. Offline inventory and repository installation reject catalogs older than 45 days.
Download approved Windows updates
Downloads missing content for revisions that are approved in enabled Windows update rings and reported by current offline endpoint inventory.
The Runner downloads content from Microsoft and stages it through its pool Cache Node. Ordyn imports each file and submits it for malware verification. Files that are already imported are skipped.
Download Microsoft Defender updates
Downloads x64 Microsoft Defender intelligence and included engine updates through a Windows or Linux Runner. Packages appear in the repository's Defender tab after verification.
Install Microsoft Defender updates
Installs a verified Defender intelligence package on Windows endpoints through Cache. Endpoints already current or without available Defender are skipped.
See Update Defender on offline endpoints for requirements and setup.
Download Microsoft certificate updates
Downloads Microsoft certificate updates through a Windows or Linux Runner and adds a verified bundle to the repository's Certificates tab.
Deploy Microsoft certificate updates
Applies the latest valid Microsoft certificate bundle to Windows endpoints.
See Maintain certificates on offline endpoints for setup.
Refresh Intel ODCA trust
Downloads an Intel firmware trust and revocation bundle for administrator review. This task runs in infrastructure jobs on a Windows or Linux Runner with HTTPS access to tsci.intel.com.
See Intel ODCA Trust for setup, offline import, and the limitation on firmware revocation checking.
Inventory
Collect software inventory
Refreshes the installed software inventory.
Collect hardware inventory
Refreshes the hardware inventory.
Collect firmware settings inventory
Read supported firmware settings without changing them. Dell firmware on Windows is supported. Use the reported values to inspect settings such as Secure Boot, virtualization, and Wake-on-LAN. Unsupported settings are omitted with a warning.
Collect service inventory
Refresh services and their state. On supported Linux systems, needrestart can identify services needing a restart. Use Any service restart required in a later condition to start a remediation branch.
Collect process inventory
Refresh running processes for investigation or later process-management tasks.
Collect system status
Refresh device state before work that depends on it. For example, collect status and branch on Power source = ac before a Windows upgrade, or inspect free disk space before downloading media.
For filesystem conditions, enter the mount point or drive letter, such as C:, /, or /var. Expressions can use normalized results such as result.filesystems_by_mount.c.used_percent.
Windows Server status also identifies installed server roles for dynamic groups.
Collect APT update inventory
Refreshes the installed and available APT package update inventory on Debian-style Linux endpoints. This task has no configurable update source or Windows filters.
Collect Windows update inventory
Refreshes installed and missing Windows Update inventory.
Choose Default source, Offline catalog, Microsoft Update, or WSUS, then select at least one classification. Optional product filters restrict software offers further.
Online sources return the updates Windows offers under the endpoint's effective Windows Update policy. Quality-update deferral can temporarily exclude newly released updates. The task reports the policy with its inventory result.
Offline catalog uses the latest verified catalog imported the Download offline Windows update catalog infrastructure task. Ordyn synchronizes the catalog through the endpoint's assigned Cache Node. The task fails when no current catalog is available. Catalogs older than 45 days are not used. Offline inventory supports Security Updates, Service Packs, and Update Rollups.
The offline catalog contains only the update categories published by Microsoft for offline scanning. It does not provide the complete Microsoft Update catalog, definition updates, drivers, firmware, feature packs, tools, general updates, or upgrades. Select Default source, Microsoft Update, or WSUS to inventory those classifications.
When WSUS is selected, you can require the task to fail if the endpoint is not configured for WSUS. Ring approvals can use only revisions and applicability details that endpoints have reported through this inventory task.
Collect Docker inventory
Refresh containers, images, and Compose projects on a Linux endpoint. Configure a reachable Docker socket or TLS endpoint first. See Docker Inventory.
Start Docker container
Starts a Docker container on the endpoint. To configure it, select an inventoried container.
Stop Docker container
Stops a Docker container on the endpoint. To configure it, select an inventoried container.
Restart Docker container
Restarts a Docker container on the endpoint. To configure it, select an inventoried container.
Tail Docker container logs
Reads the latest Docker container log lines and stores them in the task result. To configure it, select a container and optionally change the line count. The default is 200 lines.
Docker Compose up
Runs docker compose -f <compose file> ... up -d --remove-orphans on the endpoint. To configure it, provide one or more compose file paths that already exist on the host. Enable Force recreate containers to add --force-recreate.
Docker Compose down
Runs docker compose -f <compose file> ... down --remove-orphans on the endpoint. To configure it, provide one or more compose file paths that already exist on the host.
Docker Compose stop
Runs docker compose -f <compose file> ... stop on the endpoint. To configure it, provide one or more compose file paths that already exist on the host.
Docker Compose restart
Runs docker compose -f <compose file> ... restart on the endpoint. To configure it, provide one or more compose file paths that already exist on the host.
Docker Compose update
Runs a pull-and-recreate flow for a compose project on the endpoint:
docker compose -f <compose file> ... pulldocker compose -f <compose file> ... up -d --remove-orphans
To configure it, provide one or more compose file paths that already exist on the host. Compose file paths support job templating. Enable Force recreate containers to add --force-recreate to the up command.
Update Ordyn API
Updates the Ordyn API containers and updates the database. This Linux task is available in endpoint jobs and always runs on the job target endpoint. It cannot use Run on another endpoint.
The editor provides these settings:
- Compose file paths, defaulting to
/opt/ordyn-compose/api/compose.yml - Working directory, defaulting to
/opt/ordyn-compose/api - Force recreate containers, disabled by default
Update the Compose files and pull the selected release's images in earlier job steps.
The task puts Ordyn into maintenance mode, lets running work finish, and updates the application and database. Allow for downtime while it runs.
After the task finishes and the agent reconnects, view its result and update log in the job run. Logs are available for successful and failed updates. For troubleshooting while Ordyn is unavailable, use the endpoint agent log.
A failed update can leave Ordyn in maintenance mode. Review the task result and log for any required recovery before retrying.
Use Job Designer or Platform Admin to configure this step.
See Endpoint infrastructure roles.
Docker Compose exec
Runs a non-interactive command inside a service from a Docker Compose project:
docker compose -f <compose file> ... exec -T <service name> sh -lc <command>
To configure it, provide:
- one or more compose file paths that already exist on the host
- the compose service name
- the shell command to run inside the service container
The compose file paths, service name, and command support job templating. The command output is stored on the job step as stdout and stderr.
Compose management intentionally does not upload or edit compose files. Store and maintain the compose file on the endpoint itself, then use the job step to operate it.
To refresh every Compose project in the latest stored Docker inventory, loop over endpoint.docker.compose_projects. The example requests a new inventory report first, skips configured working directories, updates known dotenv tag keys, and then refreshes each project. Use a JSON array variable such as vars.refresh_compose_projects_ignore_list when some project working directories should be skipped.
json
[
{
"id": "collect-docker-inventory",
"name": "Collect Docker inventory",
"kind": "instruction",
"capability": "docker.container.inventory",
"payload": {},
"error_behavior": "stop_and_fail",
"expires_in_seconds": 900
},
{
"id": "refresh-compose-projects",
"name": "Refresh Docker Compose projects",
"kind": "for_each",
"payload": {
"items_expression": "endpoint.docker.compose_projects",
"item_name": "compose_project",
"index_name": "compose_project_index",
"max_iterations": 100
},
"body_tasks": [
{
"id": "skip-ignored-compose-projects",
"name": "Skip ignored Compose projects",
"kind": "if",
"payload": {
"condition": "!contains(vars.refresh_compose_projects_ignore_list, loop.vars.compose_project.working_dir)"
},
"then_tasks": [
{
"id": "write-compose-image-versions",
"name": "Write Compose image versions",
"kind": "for_each",
"payload": {
"items_source": "expression",
"items_expression": "loop.vars.compose_project.image_updates",
"item_name": "image_update",
"index_name": "image_update_index",
"max_iterations": 100
},
"body_tasks": [
{
"id": "write-updateable-compose-tag",
"name": "Write updateable Compose tag",
"kind": "if",
"payload": {
"condition": "loop.vars.image_update.compose_tag.is_updateable == true"
},
"then_tasks": [
{
"id": "update-compose-tag-variable",
"name": "Update Compose tag variable",
"kind": "instruction",
"capability": "config.write_key_value",
"payload": {
"path": "{{ loop.vars.compose_project.working_dir }}/.env",
"format": "dotenv",
"key": "{{ loop.vars.image_update.compose_tag.variable_name }}",
"operation": "update",
"value": "{{ loop.vars.image_update.newest_available_tag }}",
"allow_duplicate_keys": false
},
"error_behavior": "stop_and_fail",
"expires_in_seconds": 900
}
],
"error_behavior": "stop_and_fail",
"expires_in_seconds": null
}
],
"error_behavior": "stop_and_fail",
"expires_in_seconds": null
},
{
"id": "update-compose-project",
"name": "Update compose project",
"kind": "instruction",
"capability": "docker.compose.update",
"payload": {
"compose_file_paths": [
"{{ loop.vars.compose_project.config_files }}"
],
"working_directory": "{{ loop.vars.compose_project.working_dir }}"
},
"error_behavior": "stop_and_fail",
"expires_in_seconds": 1800
}
],
"error_behavior": "stop_and_fail",
"expires_in_seconds": null
}
],
"error_behavior": "stop_and_fail",
"expires_in_seconds": null
}
]The ignore-list variable contains exact Compose project working directory paths:
json
[
"/opt/local-build",
"/opt/test-stack"
]When the ignore list is empty, every detected Compose project is refreshed.
The example explicitly chooses the project .env file and updates only tags that map safely to one environment variable. Change the path when a project uses another dotenv file. Literal and complex Compose tag expressions remain unchanged because compose_tag.is_updateable is false.
Each project’s image_updates list contains the latest successful cached registry results for images used by that project. An empty list leaves the configured tags unchanged. A scan and registry checks may not have finished before the loop starts. Review the stored inventory and update results before relying on them for a rollout.
Collect Microsoft Hyper-V VM inventory
Refresh VMs and their configuration from a Windows Hyper-V host. Collect hardware inventory on guest endpoints to identify them by system UUID. Ambiguous matches need investigation before relying on guest links.
See Microsoft Hyper-V VMs for host setup and inventory limits.
Services
Inspect service
Checks whether the selected service exists and reports its current state. To configure it, select the service name.
Start service
Starts the selected service. To configure it, select the service name.
Stop service
Stops the selected service. To configure it, select the service name.
Restart service
Restarts the selected service. To configure it, select the service name.
Processes
Inventory Windows sessions
Lists logged-in Windows sessions on the endpoint. Use it before user prompts, notifications, or session-scoped process termination when the job needs to decide which Windows session to target.
The result contains summary fields that can be used in later If branch steps:
result.session_countresult.active_session_countresult.active_rdp_session_countresult.active_console_session_countresult.disconnected_session_countresult.has_active_sessionresult.has_multiple_active_sessionsresult.single_active_session_id
The task also returns a sessions list in the job result for review. Each entry includes the Windows session ID, state, principal, and whether the session is the console session or a remote desktop session.
Inspect process
Checks whether a matching process is running by name or PID and reports the matches. To configure it, choose whether to look up the process by name or PID, then set the match mode if you use the name search.
Terminate process
Terminates one or more matching processes on the endpoint. Set the process name, match mode, force behavior, and whether child processes should be included.
You can choose the termination scope:
- Device: terminate matching processes across the endpoint.
- Windows account: terminate matching processes in all logged-in sessions for the selected Windows account.
- Specific Windows session ID: terminate matching processes only in the selected Windows session.
For self-service jobs, set the scope to Specific Windows session ID and use {{ trigger.self_service.source_session_id }} to target the session that launched the portal request.
process.terminate exposes a normalized runtime result:
result.outcometerminatednot_runningfailed
result.matched_process_countresult.terminated_process_count
That makes the common "terminate if running, otherwise continue" pattern much less brittle than matching free-form stderr text.
If the task is configured to prompt first, Ordyn asks the logged-in user to close the blocking application before it falls back to termination. That is the version used when an update flow needs a gentler first attempt.
One example flow:
- terminate process
AcmeApp.exe - add a
Set job variabletask that stores the task'sOutcomeasjob.vars.process_state - add an
iftask that checks whetherjob.vars.process_stateequalsnot_runningorterminated - run uninstall only in the selected
thenbranch
User messages
Choice prompt
Shows a prompt on the endpoint and waits for the user to select one of the configured choices. The selected value can be stored in a job variable for later branches and tasks.
Choose the display target:
- All active sessions: show the prompt to every active signed-in Windows session.
- Specific Windows session ID: show the prompt only in the selected Windows session.
On Windows endpoints with multiple active sessions, choose a specific Windows session ID for choice prompts so Ordyn knows which user should answer. In self-service jobs, use {{ trigger.self_service.source_session_id }} to target the session that launched the portal request.
Notification
Shows a non-blocking message on the endpoint. Notifications can auto-close after the configured duration.
Choose the display target:
- All active sessions: show the notification to every active signed-in Windows session.
- Specific Windows session ID: show the notification only in the selected Windows session.
In self-service jobs, use {{ trigger.self_service.source_session_id }} to show the notification in the session that launched the portal request.
Microsoft Hyper-V
See host requirements and roles before running Hyper-V tasks.
Start Microsoft Hyper-V VM
Starts an inventoried Microsoft Hyper-V virtual machine on the target endpoint. To configure it, select a VM from the inventoried Hyper-V VM combobox.
Shut down Microsoft Hyper-V VM
Requests a graceful guest shutdown for an inventoried Microsoft Hyper-V virtual machine. To configure it, select a VM from the inventoried Hyper-V VM combobox.
This action asks the guest to shut down. It depends on the guest and Hyper-V integration services behaving correctly.
Reboot Microsoft Hyper-V VM
Requests a reboot for an inventoried Microsoft Hyper-V virtual machine. To configure it, select a VM from the inventoried Hyper-V VM combobox.
Stop Microsoft Hyper-V VM
Stops an inventoried Microsoft Hyper-V virtual machine without guest shutdown. To configure it, select a VM from the inventoried Hyper-V VM combobox.
Use this as the force-off style action. Prefer Shut down Microsoft Hyper-V VM when the guest should be allowed to shut down cleanly.
Create Microsoft Hyper-V VM snapshot
Creates a full Hyper-V snapshot/checkpoint for an inventoried virtual machine. To configure it, select a VM from the inventoried Hyper-V VM combobox and provide a snapshot name. The snapshot name supports templating.
Delete Microsoft Hyper-V VM snapshot
Deletes a Hyper-V snapshot/checkpoint from an inventoried virtual machine. To configure it, select a VM and provide a snapshot name. The snapshot name supports templating.
Hyper-V snapshot names are not guaranteed to be unique. This task requires exactly one snapshot on the selected VM to match the rendered snapshot name. It fails when no snapshot or multiple snapshots match. Hyper-V keeps dependent snapshots and merges the selected snapshot's checkpoint data.
Apply Microsoft Hyper-V VM snapshot
Applies a Hyper-V snapshot/checkpoint to an inventoried virtual machine. To configure it, select a VM and provide a snapshot name. The snapshot name supports templating.
This reverts the VM to the selected snapshot and can discard current VM state. For a healthy running VM, Ordyn turns the VM off without a guest shutdown, applies the snapshot, and starts the VM again. If applying fails after power-off, or if restarting fails after the snapshot is applied, the task fails and the VM remains off for inspection.
A VM that is off, saved, or suspended can be restored directly and is not started automatically by Ordyn. A paused VM must be started or stopped before running this task. The task rejects unhealthy, transitional, and unknown VM states.
Because Hyper-V snapshot names are not guaranteed to be unique, this task requires exactly one snapshot on the selected VM to match the rendered snapshot name. It fails when no snapshot or multiple snapshots match.
Desktop
Replay GUI automation
Replays an uploaded Windows GUI automation definition in an interactive desktop session. To configure it, upload the recorder JSON, set the launch executable path and arguments, choose the Windows execution context, and decide whether Ordyn should manage desktop preparation.
Credential-backed replay can use a reusable Windows Account or a templated user. A templated user selects a plain username variable and a secret password variable; both resolve from the replay task's complete job context.
Keep Manage desktop preparation enabled to let Ordyn prepare and clean up the session.
Disable managed preparation only when you intentionally add the desktop-control steps yourself. The replay task then expects a usable unlocked Windows desktop to already exist. Do not use this task when job desktop execution is set to not required. Replay GUI automation is not supported inside For each or While loop bodies.
When replay uses the same credential selection, resolved Windows user, and elevation mode as an earlier task in the job target, it shares that task's Windows logon session. This allows user-session state such as mapped drives to remain available. See Windows Execution Contexts.
Wait for Windows desktop readiness
Waits until Windows has finished setup/OOBE handoff, Windows Update is not actively servicing updates, no shutdown or restart is in progress, and either a usable desktop or a normal logon screen remains stable. Use it before manual desktop automation after OS installation or any other flow where Windows may still be showing post-setup screens.
A pending-reboot report is informational. It does not mean that a restart is imminent, does not make this task restart the endpoint, and does not prevent readiness once update servicing is idle. Review task diagnostics if readiness takes longer than expected.
Inspect desktop session
Inspects the active Windows console session and reports whether Ordyn can reuse it or must perform a managed desktop logon.
Desktop logon
Logs on the selected Windows execution context when a managed desktop session is required. Managed GUI replay adds this step when a desktop logon is required. Add it manually for custom desktop flows. Select a Windows Account for reusable catalog credentials, or select Templated user and provide a plain username variable and secret password variable. Templated credentials resolve from the desktop-logon task's complete job context. When Ordyn creates a managed login, it preserves the Windows sign-in identity selected before the task. When you author it manually, add a matching Desktop logoff cleanup step unless the job intentionally leaves the user session active.
Lock desktop input
Locks local keyboard and mouse input for the active Windows desktop session. Use this before automation that runs under a privileged desktop account. When you author it manually, add a matching Unlock desktop input cleanup step that runs even when replay fails.
Unlock desktop input
Releases the current Ordyn desktop input lock. Use it as cleanup when you author desktop-control steps manually.
Desktop logoff
Logs off the managed Windows desktop session and releases the associated desktop control. Use it as cleanup when a manual desktop flow created a managed login.
Scripting
Run Inline Script On An Endpoint
Run PowerShell, CMD, Bash, or POSIX shell content directly in the job. Choose its Windows execution context where applicable. Inline content supports runtime templates such as {{ vars.release }}.
Use blocking execution when later steps need the result, output bindings, timeout, or cancellation. Non-blocking Windows scripts confirm only that the interpreter started; later failures are not tracked and job cancellation does not stop them.
For visible Windows programs, use existing active desktop execution. For infrastructure maintenance, follow Jobs and mark the endpoint's infrastructure role before enabling maintenance handling.
See Scripts for outputs, secrets, and execution limits.
Run endpoint script
Select a saved endpoint script and bind its parameters and outputs. Saved content runs unchanged; supply run values through parameters or environment variables.
The saved script controls its execution context, desktop, and blocking mode. Output bindings and infrastructure maintenance require blocking execution. Avoid printing secrets or passing them to tools that expose command arguments.
Mark the endpoint's infrastructure role before enabling maintenance handling. Windows scripts do not survive an Agent service restart merely because result recovery is enabled.
Run Inline Script On A Runner
Executes inline Bash, POSIX shell, or PowerShell content on the Runner reserved for an infrastructure job.
Select the interpreter, enter the script content, and configure text or JSON output, output bindings, exit-code mappings, and timeout as needed. Runner inline scripts always use blocking execution. Host execution uses the Runner service identity; Docker execution uses the image user or the configured Container user.
Inline script content supports runtime templates, including prompted and inherited vars.* values. In supported infrastructure Runner fields, {{ job.workspace }} provides the absolute host or container workspace path.
The script can use ORDYN_WORKSPACE to share files with later Runner-backed steps in the same run.
For Docker user selection, workspace permissions, and ownership restoration, see Run Linux Runner Scripts In Docker.
Run Runner Script
Executes a saved PowerShell, Bash, or POSIX shell script on an eligible Ordyn Runner. To configure it, select a saved script and provide any parameters or output bindings the script expects.
Pass run values through the saved script's configured parameter bindings or through environment variables set by an earlier task. Saved script content is executed verbatim. Use ORDYN_WORKSPACE for the shared Runner workspace, or pass {{ job.workspace }} through a string parameter.
For an endpoint-scoped job, the task uses the endpoint's effective Runner pool assignment. For an infrastructure-scoped job, select the Runner pool in the job overview. All Runner-backed steps for a target run on the same reserved Runner.
The selected script determines whether the task needs a Windows PowerShell Runner or a Linux Runner with the selected Bash or POSIX shell capability.
Runner scripts executed on the host use the Runner service identity. Docker execution uses the image user or the configured Container user. Treat Runner scripts as trusted code and do not print secrets.
See Runners, Run Linux Runner Scripts In Docker, and Scripts for pool selection, shared workspaces, container users, parameters, output, and runtime variables.
Sync file folder in Runner workspace
Copies the contents of one global File-library folder into a workspace-relative directory for later steps in an infrastructure job. The task can include nested folders and can prune target files that are absent from the source. Source file contents are copied verbatim.
A sync accepts up to 100 files and 100 GiB of declared input. See Infrastructure Jobs for placement and pruning behavior.
Collect Runner artifacts
Collects named files, directories, or glob matches from the shared infrastructure-job workspace. Paths are workspace-relative. Directories and glob results are returned as ZIP artifacts.
Artifact names and paths support templating. For example, release-{{ job.run.id }} includes the run ID in the artifact name.
Set Publish to file on an output to add a version to a selected Library file. Set Folder per output to organize artifacts without a publication destination.
See Job artifacts for malware scanning and retention settings.
Publish artifacts to software package
Maps named artifacts from an earlier top-level Collect runner artifacts step to the selected package's primary installer or staged ZIP archives. Changed content replaces the mapped package assets and applies the product's package-approval policy. Identical content is a successful no-op.
The selected artifacts must still be available and unexpired when publication runs.
See Infrastructure Jobs for the offline package workflow, limits, and extraction behavior.
Delete collected artifacts
Deletes every artifact produced by a selected earlier Collect artifacts or Collect runner artifacts step for the current job target. The task succeeds when those artifacts are already absent, so it can safely run again.
Use this step after a later task has consumed a transferred bundle. See Artifacts for retention and deletion behavior.
Run collector
Runs a collector definition and stores its values in collector history. To configure it, select the collector definition to run.
A Runner-targeted collector uses the endpoint's effective Runner pool assignment and runs on an eligible Windows or Linux Runner while keeping the endpoint as the collector target.
OS deployment
PXE boot endpoint
Publishes PXE boot configuration for the selected boot image to the assigned net node. The publish step stays in progress until the net node confirms that it applied the configuration. If the net node cannot apply it, the step fails or reaches its configured timeout.
For Windows boot images, the step waits for the temporary WinPE preboot client to connect. The next step is Install OS image.
For Linux boot images, this is the operating-system installation step. Select the Linux operating system and install answer file. Ordyn boots the Linux installer, serves the install answer file through the assigned net node, and installs the newest approved Ordyn Agent release that exactly matches the operating system distribution, release, and architecture. Before later job steps run, Ordyn automatically waits for endpoint enrollment and agent instruction readiness. Do not add Install OS image to a Linux deployment.
To configure it, choose whether to use the latest boot image for Windows or Linux, or select a specific boot image.
Install OS image
Run a Windows installation workflow in the endpoint's active WinPE session. Select the OS image, product-key mode, answer file, and driver profiles.
Ordyn waits for enrollment and Windows readiness before post-install work continues. Allow enough job time for PXE, downloads, setup, restarts, and enrollment. Explicit workflow-step timeouts also apply.
Use Net for PXE setup and OS Images for workflow authoring.
Build WinPE boot image
Builds a managed WinPE boot image asset set on a capable Windows Runner.
This task requires an infrastructure-scoped job with a Runner pool selected in the job overview. Select the WIMBoot image and an agent release mode, then set the output name and version and optionally select driver profiles. The job's pool must contain an available Windows Runner that reports the Windows ADK and WinPE build capability.
Windows in-place upgrade
Starts an in-place Windows upgrade from the selected OS image. Set the OS image to use for the upgrade.
The Windows in-place upgrade step executes the selected OS image's upgrade workflow on the existing Windows installation.
Ordyn expects the selected OS image to be:
- platform
windows - backed by an ISO
- configured with a non-empty
upgrade workflow - contain at least one
Run OS image commandstep that launches the mounted Windows setup path
Run OS image command supports cmd or powershell, plus placeholders such as:
{setup_path}{mounted_drive}{iso_path}{package_path}{package_dir}{package_filename}
Ordyn does not block the upgrade automatically based on battery or AC state. If you want that guard, use Collect system status before the upgrade and branch on:
Power sourceCharging stateBattery charge percent
Endpoint
Refresh dynamic group memberships
Re-evaluates every dynamic group available to the current endpoint and applies any membership changes before the next job step starts.
Use this after a step changes a persistent variable or another value that a dynamic group query uses when the same workflow needs the new membership immediately. For example, one job can set a variable, refresh group memberships, and thereby assign a second job whose Run when assigned automation starts it.
The refresh covers all dynamic groups for the endpoint's tenant. In environments with many dynamic groups, it can add noticeable work to every target, so include it only in jobs that need an immediate refresh. Routine background evaluation continues without this step.
Wait for endpoint enrollment
Waits for an endpoint agent to enroll and reconnect. OS installation tasks include this wait automatically. Add it manually when another custom workflow creates or replaces an endpoint agent identity.
Ping endpoint
Requests a one-shot ping probe through the assigned net node using the endpoint’s latest IPv4 address.
Power on endpoint
Requests power on using Automatic or a chosen method. See Powering on endpoints for requirements and method selection.
The step completes when the power-on request succeeds. This does not confirm that the endpoint agent is connected. Add Wait for endpoint state with Edge connected before steps that need a running agent.
Wait for endpoint state
Waits until the endpoint reaches the selected Edge, preboot, ping reachability, or agent instruction-readiness state. Choose Agent instruction ready before tasks that need the Agent to accept work. Resolve any reported Agent recovery requirement if this wait does not complete.
Check endpoint connection
Checks whether the endpoint is currently connected. The task succeeds even when the endpoint is disconnected and exposes the result for later conditions:
result.connectedresult.outcomeresult.endpoint_idresult.checked_at
Use this before an if task when a job should branch based on current endpoint connectivity.
Telematik
See Telematik for supported devices and setup. The SMC-B verification guide explains execution endpoints, result references, slot-mode cleanup, and retry handling.
Collect card terminal system status
Refresh status from a Telematik card terminal through its assigned service.
Collect Konnektor inventory
Collect device facts, network interfaces, licences, card terminals, and SMC-B card details from the target Konnektor. Review the results in its overview and Card Terminals tab. This does not verify card PINs.
Set card slot PIN mode
Set the selected terminal slot to Local PIN entry, PP-1516, or Remote web PIN entry and confirm the saved setting. The selected mode remains in place until explicitly changed.
Read SMC-B PIN status
Read the card's PIN status and remaining attempts from the Konnektor using its Mandant ID and the card's ICCSN. Use the result to decide whether verification is needed.
Open SMC-B PIN session
Open the PIN channel on the execution card terminal for the selected Mandant ID and ICCSN. The slot must already use Remote web PIN entry. Pass the returned PIN session reference to the following verification steps.
Start SMC-B verification
Start verification on the Konnektor using the PIN session reference. The task returns a Verification reference while the request waits for PIN entry.
Submit SMC-B PIN
Submit a PIN once to the matching prompt on the session's card terminal. Enter the session reference and a PIN template, such as {{ vars.telematik.smcb_pin }}. Automated entry requires at least two confirmed remaining attempts; see the SMC-B verification guide for handling the final attempt. Success confirms terminal acceptance; use the wait task to confirm card verification.
Wait for SMC-B verification
Wait for the Konnektor result using both the PIN session reference and verification reference. Success confirms the card is verified; the result includes its PIN status and remaining attempts.
Network inventory
Collect switch system status
Refresh switch status through its assigned SNMP service and credentials. See SNMP for setup and automatic collection.
Collect printer system status
Refresh read-only printer status through its assigned SNMP service and credentials. See Printer Endpoints for setup and interpretation.
Inventory switch ports
Refresh physical and link aggregation interfaces, connectivity, and endpoint attachments through the assigned SNMP service. See SNMP port inventory for matching and uplink interpretation.
Set switch port admin state
Enables or disables an inventoried switch port through the assigned SNMP service client.
This task only applies to switch endpoints. The switch endpoint must have a hostname, an assigned SNMP service client, an active credential profile, and the credential profile must be enabled for write operations.
To configure it, provide:
- the switch port
ifIndex - the desired admin state, either
upordown
The selected port must already exist from a previous Inventory switch ports result. If the switch rejects the write, for example with NoAccess, the task records the SNMP error in the job result.
Port alias updates are available from the switch Ports view when the assigned credential profile is write-enabled. They are not a separate job task.
Software management
Install software
Installs a managed software package. To configure it, select the package to act on.
Packages waiting on approval are rejected here unless the workflow explicitly allows pending approval packages.
Uninstall software
Uninstalls a managed software package. To configure it, select the package to act on.
Packages waiting on approval are rejected here unless the workflow explicitly allows pending approval packages.
The package's uninstall workflow is always authoritative. Endpoint inventory uninstall strings are passed into the workflow, but Ordyn does not execute them automatically. Reference {{ inventory.quiet_uninstall_string }}, {{ inventory.uninstall_string }}, or {{ inventory.msi_product_code }} from a package command when the uninstaller should come from endpoint inventory.
Install latest product
Installs the newest compatible managed package for a product without hard-coding a package version. Ordyn picks the package at runtime by matching the product, platform, architecture, and newest available version that still fits the endpoint. To configure it, select the product to act on, and choose a variant if the product has one.
Check product presence
Checks whether the selected product is detected in the latest software inventory snapshot. Set the product to act on, and choose a variant if the product has one.
Check software product presence evaluates the selected managed product against the endpoint's latest software inventory snapshot.
It succeeds with a normalized result even when the product is not detected:
result.is_installedresult.match_countresult.detected_version
If the endpoint does not have a software inventory snapshot yet, the task fails because the check cannot be resolved reliably.
One example flow:
- run
Check product presence - select the managed product to inspect
- add an
iftask - select the check step as the source task
- select
Installed - branch to install in
elsewhen the product is missing, or uninstall/remediate inthenwhen it is present
Uninstall product
Removes a product without forcing the job to name a specific package. Ordyn looks at the installed product and chooses the best matching managed uninstaller, preferring a version-specific package when one exists and falling back to a generic managed uninstaller otherwise. To configure it, select the product to act on, and choose a variant if the product has one.
The selected managed package still provides the uninstall workflow. Inventory uninstall metadata is available to that workflow as template data, but it is not used unless the workflow references it.
Update software packages
Plans and optionally executes managed software updates from endpoint inventory. Select the software update policy that should control allowed products, packages, publishers, channel upgrades, pending approval behavior, and self-updating software exclusions.
For MSI/MSP package chains, the task installs every missing package in order. It installs the full MSI baseline and patch chain when the endpoint does not match a chain ancestor, or only the missing MSP suffix when an ancestor is already installed. A pending, non-installable, or explicitly excluded required link blocks newer patches that depend on it.
Packages waiting on approval are rejected here unless the workflow explicitly allows pending approval packages.
For packages configured with Uninstall then install, update planning first tries to uninstall using the matched managed package for the installed version. If the installed version is not represented by a managed package, Ordyn can fall back to the latest package's uninstall workflow only when that uninstall workflow does not require a package file. That fallback is intended for generic inventory-based uninstall commands such as {{ inventory.quiet_uninstall_string }} or msiexec.exe /x "{{ inventory.msi_product_code }}" /qn /norestart.
Enable interactive prompting to notify users before package updates.
That prompt can:
- inform the user that updates are about to start
- allow the user to continue immediately
- allow the user to postpone by one of the configured durations
If the generated package workflow contains terminate_process steps, a Prompt user first setting gives the logged-in user one chance to close the blocking application before Ordyn falls back to termination.