-
Notifications
You must be signed in to change notification settings - Fork 0
1.0 xadm help
Chris Lasell edited this page Oct 2, 2025
·
2 revisions
Name:
xadm, A command-line tool for managing Software Titles and Versions in Xolo.
Usage:
xadm [global-options] command [target] [command-options]
Global Options:
-v, --version Print version and exit
-h, --help Show this help and exit
-w, --walkthru Run xadm in interactive mode when adding or editing titles or versions.
This causes xadm to present an interactive, menu-and-
prompt-driven interface. All command-options given on the
command line are ignored, and will be gathered
interactively.
The 'config' command is always interactive, even without --walkthru.
-a, --auto-confirm Do not ask for confirmation before making changes or using server-
admin commands.
This is mostly used for automating xadm.
Ignored if using --walkthru: if you're interactive you must confirm
your changes.
WARNING: Be careful that all values are correct.
-p, --proxy-admin=<s> Used for automated workflows that connect to the xolo server using a
service account, not a user account. Most such automations have a way to
ascertain the identity of the user triggering the automation. They can use
that name here, and then it will be used on the server combined with the
actually authenticated service acct name for use in logging and status.
For example, if you have a CI/CD job that runs xadm commands, it will
connect to the xolo server using a service account such as 'xolo-cicd-runner'.
That job can get the name of the user triggering the job from an environment
variable, (or elsewhere) and pass that as the value of this option, like so:
xadm --proxy-admin $CICD_USER_NAME add-version my-title 1.2.3 [options...]
On the xolo server, the user will be recorded as
cicduser-via-xolo-cicd-runner
which will be used as the "added_by" value for the new version, and will show up
in the various logs.
-q, --quiet Run xadm in quiet mode
When used with add-, edit-, delete-, and release-
commands, nothing will be printed to standard output.
Ignored for other commands, the purpose of which is to print
something to standard output.
Also ignored if --debug is given
WARNING: For long-running processes, you may not see server errors!
-j, --json For commands that output lists or info about titles and versions,
such as 'list-titles' or 'info <title> <version>',
return the data as raw JSON.
-d, --debug Run xadm in debug mode
This causes more verbose output and full backtraces
to be printed on errors. Overrides --quiet
Commands:
list-titles List all software titles in xolo.
add-title Add a new software title to xolo
edit-title Edit an exising xolo software title
delete-title Delete a software title, and all of its versions
freeze Prevent computers from updating the currently installed version of a title.
thaw Un-freeze computers, allowing them to resume updates of a title.
list-frozen List all computers that are frozen for a title.
list-versions List all versions of a title.
add-version Add a new version to a title, making it available for piloting
edit-version Edit a version of a title
release Take a version out of pilot and make it 'live'.
delete-version Delete a version from a title.
deploy Use MDM to install a version on one or more computers or computer groups.
search Search for titles.
info Show details about a title, or a version of a title
report Show a patch-report for a title, or a version of a title
repair Ensure all Title Editor and Jamf Objects exist and are correctly configured
changelog Show the changelog for a title
config Configure xadm. Always interactive, implies --walkthru
list-groups List all computer groups in Jamf pro
list-categories List all categories in Jamf pro
save-client Save the xolo client tool to a directory for packaging and deployment.
help Get help for a specific command
server-status [Server Admins Only] Show status of Xolo server.
run-server-cleanup [Server Admins Only] Run the server's cleanup process now.
update-client-data [Server Admins Only] Make the server update the client-data package now.
rotate-server-logs [Server Admins Only] Rotate the logs on the server now.
set-server-log-level [Server Admins Only] Set the log level of the server logger.
shutdown-server [Server Admins Only] Shutdown or restart the server gracefully.
Command Targets:
title: The unique name of a title in Xolo, e.g. 'google-chrome'
version: The version of the title you are working with. e.g. '12.34.5'
Command Options:
Use 'xadm help command' or 'xadm command --help' to see command-specific help.
Examples:
xadm add-title google-chrome <options...>
Add a new title 'google-chrome' to Xolo,
specifying all options on the command line
xadm --walkthru add-title google-chrome
Add a new title 'google-chrome' to Xolo,
providing options interactively
xadm edit-title google-chrome <options...>
Edit the existing title 'google-chrome',
specifying all options on the command line
xadm delete-title google-chrome
Delete the existing title 'google-chrome' from Xolo,
along with all of its versions.
xadm add-version google-chrome 95.144.21194 <options...>
Add a new version number 95.144.21194 to the title 'google-chrome'
specifying all options on the command line.
Options not provided are inherited from the previous version, if available.
xadm edit-version google-chrome 95.144.21194 <options...>
Edit version number 95.144.21194 of the title 'google-chrome'
specifying all options on the command line
xadm delete-version google-chrome 95.144.21194
Delete version 95.144.21194 from the title 'google-chrome'
xadm search chrome
List all titles that contain the string 'chrome'
and its available versions
xadm report google-chrome
Report computers with any version of title 'google-chrome' installed
xadm report google-chrome 95.144.21194
Report computers with version 95.144.21194 of title 'google-chrome' installed
xadm list-groups
List all computer groups in Jamf Pro