Appearance
Available Steps
Use this reference when authoring Windows installation and upgrade workflows. For setup, see OS Images.
OS image workflows come in two flavors:
- install workflows, which run in WinPE
- upgrade workflows, which run on an already installed Windows system
Use install steps for WinPE preparation and upgrade steps for work on the installed system.
Install workflow
Follow Scripts for parameter, output, and secret-handling guidance.
Control flow
End job
Ends the current endpoint target after any remaining Always steps finish. Use it when the install should stop cleanly after a validation failure, a hard stop condition, or because no further work is required. Choose whether the target should finish as aborted or succeeded.
If branch
Run the then or else branch based on endpoint values, variables, or earlier results. Use expressions to write the condition; store a reused result in job.vars when several later steps need it.
For each
Iterates over an expression result and runs the body once per item. Set the items expression, item variable, optional index variable, and maximum iteration count, then add body steps.
While loop
Re-evaluates a condition and repeats the body until it becomes false or the maximum iterations is reached. Set the condition, optional maximum iteration count, and the body steps. The condition editor supports the same string operators and variable override checks as If branch.
Runtime values
Set job variable
Stores a runtime value under job.vars for later steps and branches. Set the variable name and the expression that should populate job.vars.
Messaging
Log message
Record a templated message in job history to explain the values used by this workflow. Use Log message for shared behavior and output limits.
Execution
Run OS image command
Runs a command in the WinPE install environment. Use it for setup checks, preparation work, or the command that launches Windows Setup. Set the command, interpreter, timeout, and any paths the command needs.
OS image install workflow commands can write logs and diagnostics to {{ os_image.artifact_directory }}. {{ os_image.log_file }} points at the default install workflow log file.
Returned command output uses the endpoint agent's bounded process capture. See Agent Runtime Limits.
Run script
Runs a saved script during the install workflow. Select the script and provide the inputs it expects.
Run inline script
Runs inline script content during the install workflow. Set the interpreter, script content, output mode, optional output schema, output bindings, and reboot-success exit codes.
Inline script stdout, stderr, and cancellation follow the agent process limits.
Artifacts
Collect artifact
Collects files or logs as workflow artifacts. Set the artifact paths to collect.
Use {{ os_image.artifact_directory }} to collect files written by earlier install workflow steps, for example {{ os_image.artifact_directory }}\*.log.
Artifact paths support runtime environment references exposed in WinPE, such as {{ env.TEMP }}\setupact.log. Variables are resolved once before glob matching. A missing variable fails the collection step with the variable name in the error.
In WinPE, variables are resolved from the WinPE provisioning runtime environment. For files produced by Ordyn workflow steps, prefer {{ os_image.artifact_directory }} and {{ os_image.log_file }} so the collect step is not coupled to machine-specific temp paths.
Directories are collected recursively, duplicate source files are collected once, and symbolic links are skipped. A matched file that cannot be read or staged fails the collection step.
Upgrade workflow
Control flow
End job
Ends the current endpoint target after any remaining Always steps finish. Use it when the upgrade should stop cleanly after a validation failure, a hard stop condition, or because no further work is required. Choose whether the target should finish as aborted or succeeded.
If branch
Run the then or else branch based on endpoint values, variables, or earlier results. Use expressions to write the condition; store a reused result in job.vars when several later steps need it.
For each
Iterates over an expression result and runs the body once per item. Set the items expression, item variable, optional index variable, and maximum iteration count, then add body steps.
While loop
Re-evaluates a condition and repeats the body until it becomes false or the maximum iterations is reached. Set the condition, optional maximum iteration count, and the body steps. The condition editor supports the same string operators and variable override checks as If branch.
Runtime values
Set job variable
Stores a runtime value under job.vars for later steps and branches. Set the variable name and the expression that should populate job.vars.
Messaging
Log message
Record a templated message in job history to explain the values used by this workflow. Use Log message for shared behavior and output limits.
Execution
Run OS image command
Runs an OS image command in the Windows upgrade context.
Returned command output uses the endpoint agent's bounded process capture. See Agent Runtime Limits. Use it for the upgrade command itself and any supporting command-line work around the in-place upgrade flow. Set the command, interpreter, timeout, and any paths the command needs.
Run script
Runs a saved script during the upgrade workflow. Select the script and provide the inputs it expects.
Run inline script
Runs inline script content during the upgrade workflow. Set the interpreter, script content, output mode, optional output schema, output bindings, and reboot-success exit codes.
Inline script stdout, stderr, and cancellation follow the agent process limits.
Processes
Inspect process
Checks whether matching processes are running by name or PID and reports the matches. Choose whether to search by name or PID, then set the match mode when you use the name search.
Terminate process
Terminates one or more matching processes before or after upgrade execution. Set the process name, match mode, force behavior, and whether child processes should be included. Use the scope setting to target the whole device, all sessions for a Windows account, or a specific Windows session ID. In self-service workflows, {{ trigger.self_service.source_session_id }} targets the session that launched the portal request.
User messages
Notification
Shows a non-blocking message on the endpoint during an OS image workflow. 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 workflows, use {{ trigger.self_service.source_session_id }} to show the notification in the session that launched the portal request.
Services
Inspect service
Checks whether the selected service exists and reports its current state. Select the service name.
Start service
Starts the selected service. Select the service name.
Stop service
Stops the selected service. Select the service name.
Restart service
Restarts the selected service. Select the service name.
Configuration
Read key/value file value
Reads a key from a dotenv or INI file. Set the file path, file format, and key to read.
Write key/value file value
Sets, updates, clears, or deletes a key in a dotenv or INI file. Set the file path, file format, key, write operation, and value when you choose Set or Update existing. Update existing succeeds without writing when the file, section, or key is missing, and never creates them.
Filesystem
Inspect file
Checks whether a file exists and reports its metadata. Set the file path.
Read file
Reads a text file from the endpoint filesystem. Set the file path, and choose the encoding and read limit if needed.
Write file
Writes inline content to a file on the endpoint filesystem. Set the file path, content, encoding, overwrite behavior, and whether Ordyn should create the parent folder. Use Place file when the source is a stored Ordyn file.
Place file
Places a stored Ordyn file onto the endpoint filesystem. Set the target path, uploaded file, optional file name, overwrite behavior, and parent-folder handling. Template rendering accepts valid UTF-8 text files of up to 10 MiB. Leave it disabled to copy the file bytes unchanged.
Delete file
Deletes a file from the endpoint filesystem. Set the file path.
Retrieve file
Retrieves one or more files from the endpoint into Ordyn storage. Set one or more source paths and an optional archive name.
Inspect directory
Checks whether a directory exists and reports its metadata. Set the directory path.
List directory
Lists files and folders from the endpoint filesystem. Set the directory path and, if needed, recursive listing, maximum depth, and entry limits.
Create directory
Creates a directory on the endpoint filesystem. Set the directory path and whether recursive handling is allowed.
Delete directory
Deletes a directory from the endpoint filesystem. Set the directory path and whether recursive handling is allowed.
Retrieve directory
Retrieves a directory as a ZIP from the endpoint into Ordyn storage. Set the directory path and an optional archive name.
Registry
Inspect registry key
Checks whether a Windows registry key exists and reports its metadata. Set the registry hive and path.
List registry key
Lists subkeys and values under a Windows registry key. Set the registry hive and path.
Create registry key
Creates a Windows registry key if it does not exist. Set the registry hive and path.
Delete registry key
Deletes a Windows registry key, optionally recursively. 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. Set the registry hive, key path, and value name.
Read registry value
Reads a Windows registry value from the endpoint. Set the registry hive, key path, and value name.
Write registry value
Creates or updates a Windows registry value on the endpoint. Set the registry hive, key path, value name, value type, and value data.
Delete registry value
Deletes a Windows registry value from the endpoint. Set the registry hive, key path, and value name.
Retrieve registry key
Exports a Windows registry key into Ordyn as a .reg file. Set the registry hive, key path, and an optional file name for the export.
Artifacts
Collect artifact
Collects files or logs as workflow artifacts. Set the artifact paths to collect.