Actions

Actions are effectively “commands” for AME Wizard to execute, and are written in YAML using the camelCase naming convention (ex. appx, scheduledTask).

To get started using actions, follow our playbook creation guide.

Optional Parameters

All actions have the following optional parameters.

Parameter	Description	Type	Default
weight	Specifies how much impact the action will have on the progress bar once completed.	integer	2-5 for most actions
status	Alternative to status </developers/actions/WriteStatus>.	string	None
errorAction	Specifies what happens if the action fails.	Enum: Ignore (Ignore error) Log (Log error) Notify (Show at end) Halt (Halt Playbook)	varies
option	See Features In YAML.	string	None
options	Similar to option, however multiple options can be specified to trigger an action.	string array	None
builds	Specifies which Windows builds the action should apply to. Builds can be specified using either a basic array of builds (ex. builds: ['22621', '22622']), or more dynamic versions can be specified like in the following example: builds: [ '>=22621' ] Any of the following conditions can be used: >= - greater than or equal to <= - less than or equal to > - greater than < - less than You can also use negative expressions like in the following example: builds: [ '>=22621', '!>22625' ]. You can also specify an update build release number: 22621.1265.	string array	None
cpuArch	Specifies to only run an action if the specified architecture matches the system architecture.	string Must match a value from here. (Ex. “X64”)	None
onUpgrade	Specifies whether or not to run action during an upgrade. See Upgrades.	bool	false
onUpgradeVersions	Specifies on what previous version(s) onUpgrade should be triggered. See Upgrades Versions can be specified using either a basic array of versions (ex. onUpgradeVersions: ['1.0', '1.1']), or more dynamic versions can be specified like in the following example: onUpgradeVersions: [ '>=1.0' ] Any of the following conditions can be used: >= - greater than or equal to <= - less than or equal to > - greater than < - less than You can also use negative expressions like in the following example: onUpgradeVersions: [ '>=1.0', '!>1.1' ].	string array	None
previousOption	Specifies what previous option to match during an upgrade. See Upgrades.	string	None
iso	Specifies whether or not an action is run during ISO injection. See ISO Compatibility true: Always run during ISO injection false: Never run during ISO injection only: Only run during ISO injection	Enum: true false only	false
oobe	Specifies whether or not an action is run during OOBE after installing from a custom ISO. See ISO Compatibility null: Run during OOBE unless iso: true/only is specified true: Always run during OOBE false: Never run during OOBE only: Only run during OOBE	Enum?: null true false only	null

Navigate to an action below for examples and/or parameters.

Actions overview

• !run: runs a specified executable or file.

• !registryKey: adds or deletes a specified registry key.

• !registryValue: modifies a specified registry value.

• !appx: removes, or clears the cache of a given APPX component.

• !service: executes a specified cmd command.

• !scheduledTask: deletes a task folder, or modifies a specific task.

• !taskKill: terminates a specified process.

• !systemPackage: removes a specified Windows component.

• !cmd: executes a specified cmd command.

• !powerShell: executes a specified PowerShell command.

• !download: downloads a file from a URL or git repository.

• !software: installs software from sources like chocolatey.

• !status: writes a status message for AME Wizard.

• !task: runs a YAML task file.