This section describes the Application Manager commands that install, uninstall, and manage applications. When using the Application Manager, the basic format of the command is:
xpressworkx_app_manager <command> <variable>
A variable can be an IP address or hostname, application short name, version, file, role, or a combination of these. The variables required for each command are noted in the following descriptions.
add <role> <hostname or IP address>
Adds a server with the specified role. Standard roles include app-server, niu, and secondary-niu. Additional application-specific roles may also exist and will be accepted by this command. For example, add-app-server <hostname> adds the provided hostname to the list of Application-Processing Servers (AS) in this cluster. Using this command allows the Application Manager to install an application across all AS components that are registered. Use the list-app-servers command to view the AS components currently configured in the cluster.
help <value>
Displays detailed help on the specified command.
info <app name> <version>
Displays details of the specified application and version of that application.
install <app name> <version>
Installs and deploys the specified application and version from the Application Manager registry database onto the Application Server.
Tip
You can use this command to roll back to a previous version of an application if that previous version is still registered.
install <app name> latest
Installs and deploys the latest version of the specified application from the Application Manager registry database onto the Application Server.
list
Lists all known objects stored in the Application Manager registry database. The install state of each application is included in the listing. The install state will be “Fully Installed” if the install was successful, “Not Installed” if the uninstall was successful, or “Partially Installed” if the install or uninstall was not successful.
list-app-servers
Lists all the configured AS components in this cluster.
list-installed
Lists all installed applications in the Application Manager registry database.
list-registered
Lists all the registered applications in the Application Manager registry database. Applications can be registered if they are installed, uninstalled, or purged. The install state of each application is included in the listing. The install state will be “Fully Installed” if the install was successful, “Not Installed” if the uninstall was successful, or “Partially Installed” if the install or uninstall was not successful.
prepare offline
Sets the environment for an offline installation, including searching for all the required dependencies.
purge <app name>
Completely uninstalls the application and removes the application database.
Warning
Before using this command, be sure that you want to remove all traces of the application. If you re-install an application after using this command, you will have to recreate the required application database.
register <app name> <version>
Adds the provided application package to the Application Manager registry database.
remove <hostname>
Removes the specified hostname for all roles it has been registered for.
remove-app-server <hostname or IP address>
Removes the provided hostname or IP address from the list of AS components in this cluster.
set <flag name> <value>
Sets the specified flag for use. The value argument is optional. If only the flag name is provided, the value will default to True.
synchronize
Ensures that each component’s configuration includes all of the files and packages required to support the installed applications in the Application Manager registry database. This command does not affect application databases.
uninstall <app name>
Uninstalls the specified application from the Application Server but does not remove the application database. If you re-install the application after using this command and that application is started, it will be in the same operational state as before the uninstall.
unregister <app name> <version>
Removes the specified application version from the Application Manager registry database.
unset <flag name>
Removes the specified flag from the database.
version
Outputs the Application Manager version information and exits.
The following is a table of return values that you will see for any exceptions or errors that are specific to operations within the Application Manager.
Return Value |
Description |
|---|---|
1 |
The bootstrap or update synchronization process failed to complete. Any displayed errors will need to be resolved before reattempting. |
2 |
An unknown exception occurred during registration, registration could not be removed, or the application could not be installed or removed. |
3 |
The specified application does not exist in the registry or has no identifying information included in the registry and therefore could not be found. |
4 |
The version string format is not supported or not recognized. |
5 |
The package format is not supported or not recognized. |
6 |
The specified host name is not resolvable, is not reachable, or does not exist. |