Quick Guide #
A Provisioner Role in XOAP is a higher-level construct that allows you to group together multiple Provisioner Groups into a single unit.
Add a new Provisioner Role #
- Click + Create Provisioner Role.
- Enter the required parameters, such as Name and Description.
- Assign Provisioner Groups by clicking + Assign Provisioner Groups.
- Click Save to create the new Provisioner Role.
Edit a Provisioner Role #
- Right-click the Provisioner Role and select Details.
- Update the parameters or change the assigned groups.
- Click Save to apply the changes.
Delete a Provisioner Role #
- Right-click the Provisioner Role and select Delete.
- Confirm the deletion.
Additional useful information #
Provisioner Role: #
Only one Provisioner Role can be used in an Image Definition. The Provisioner Role is therefore the highest-level construct for running provisioners during image creation. You cannot delete a Provisioner Role if it is currently used in an Image Definition.
Provisioner Group: #
Each Provisioner Group can only be added once to a given Provisioner Role.
Order of execution: #
During image creation, provisioners are executed in order from top to bottom within the role: all provisioners in the first group run first, followed by the second group, third group, and so on.
Order of groups: #
You can change the order of groups in a Provisioner Role by dragging and dropping them in the Provisioner Role details view.
Technical documentation #
A Provisioner Role in XOAP is a higher-level construct that allows you to group together multiple Provisioner Groups into a single unit. It defines which provisioner groups will be executed during the image build process and in what order.
Provisioner Roles are especially useful when:
- You want to reuse predefined group sets across different image definitions
- You need to combine complex sequences of provisioning steps into a manageable unit
When creating a Provisioner Role, you define:
- Role name – a unique identifier for the role
- Description – a short explanation of the role’s purpose (e.g., “Join domain and apply baseline”)
- Tags – optional labels to help categorize or search roles
- Selected Provisioner Groups – choose the groups that should run during the build
Provisioner Groups within a role are executed in the order they are listed, and the entire role can then be reused across multiple image definitions.
A single Provisioner Role can be used in multiple Image Definitions, just like provisioner groups and provisioners themselves. This promotes reusability and consistency across builds.