Quick guide #
XOAP Resources is a central file repository used across XOAP. You can upload any file type (scripts, configuration files, templates, archives, binaries, etc.). Resources are commonly referenced by other XOAP features (for example, script selection in “Run Script”).
Create a new Resource #
- Go to Resources and click + New Resource.
- Upload your file(s) using Click to upload or drag and drop.
- (Optional) In the Resource details step, add:
- Description
- Tags
- (Optional) Version message
- Click Next/Confirm to finish and create the resource.
Edit a Resource #
- In the Resources table, click the Action menu (⋮) for the resource.
- Select Details.
- If the resource is an editable type (PowerShell, Shell script, JSON, YAML, Text file), update the content and/or metadata as needed.
- Save the changes (a new version may be created depending on the update workflow).
Delete a Resource #
- In the Resources table, click the Action menu (⋮) for the resource.
- Select Delete.
- Confirm the deletion.
Additional useful information #
Upload anything #
XOAP Resources supports uploading any file type (not limited to scripts).
Editable formats #
You can edit and maintain these resource types directly: PowerShell, Shell scripts, JSON, YAML, Text files.
Use tags for organization #
Tag resources by purpose/environment (e.g., ImageManagement, ScriptedAction, PoC, Prod) to keep the library searchable and governed.
Resources are reused across XOAP #
Many UI workflows that require a file/script (for example script execution flows) will reference content stored in Resources.
Technical documentation #
XOAP Resources is a central repository for files used across the platform. You can upload any file type (scripts, configs, templates, binaries, archives, etc.). Resources are versioned and can be referenced by other XOAP features (commonly Scripted Actions and Image Management).
Resource Categories and Filtering #
The Resources page provides filters/tabs for common file categories such as:
- All resources
- PowerShell
- Shell scripts
- JSON
- YAML
- ZIP
- Text files
- Activity log
These are primarily for organization and faster discovery; XOAP still allows uploading any format.
Core Resource Properties #
Each resource typically has:
- Resource name
- Resource type (MIME/type classification)
- Description
- Tags
- Version and Version message
- Audit info (Created by / Updated by + timestamps)
Upload and Overwrite Behavior #
When adding resources:
- You can upload files via drag & drop or file picker.
- Allow overwrite if already exists controls whether an upload can replace an existing resource with the same identity/name (depending on your XOAP behavior and constraints). If you overwrite an already existing file a new version is created with the uploaded resource.
Resource List Actions #
From the Resource list (⋮ action menu), you typically can:
- View details
- Download
- Delete
Resource Details Page #
The Resource Details page is the main control surface for a resource.
Latest Version Panel #
Shows:
- Latest version number
- Version message
- Creation / update metadata
Edit Resource Content #
- Edit resource content opens an editor for supported text-based resource types (for example: PowerShell, Shell, JSON, YAML, Text).
- This allows in-place editing without re-uploading a file.
Save / Confirm and Versioning #
When you save changes to resource content, XOAP prompts to create a new resource version:
- You can set the New Version (including Custom Version segments).
- You can provide a Version message describing the change.
- Confirming publishes the updated version as the latest.
Versioning is critical because other XOAP components can depend on a specific resource version for reproducibility.
View all versions and compare #
From Resource Details, View all opens Versioning history where you can:
- See all historical versions
- Review version messages, dates, and authors
- Compare versions (diff view) to understand exactly what changed between revisions
Download Resource #
- Download resource retrieves the currently selected/latest resource file.
Tags #
- Tags support classification, filtering, and governance (e.g., vSphere, Image.XO, Prod, PoC).
Assigned to #
The Assigned to section lists where the resource is currently referenced (commonly under Platform Management, e.g., Scripted Actions). This helps impact analysis before changes:
- “Who uses this resource?”
- “Which version is currently referenced?”
Practical notes and best practices #
- Use version messages consistently (what changed + why).
- Prefer editing via Edit resource content for small controlled changes in scripts/config files; prefer re-upload for large structural changes or binary artifacts.
- Treat shared resources as “interfaces”: changing behavior can affect downstream runs—use versioning to keep rollbacks easy.
- Use tags to separate environments and purposes (e.g., Prod, Test, CustomerX, AVD, Build, Deploy).