The asadmin Deployment Subcommands

This appendix lists the asadmin deployment subcommands that are included with this release of the Payara Server software. For information on additional asadmin subcommands, see "Subcommands for the asadmin Utility" in the Payara Server General Administration section.

add-library

Adds one or more library JAR files to Payara Server. You can specify whether the libraries are added to the Common class loader directory, the Jakarta optional package directory, or the application-specific class loader directory.

create-application-ref

Creates a reference from a cluster or an un-clustered server instance to a previously deployed Jakarta EE application or module. This effectively results in the application element being deployed and made available on the targeted instance or cluster.

create-lifecycle-module

Creates a lifecycle module. A lifecycle module provides a means of running a short or long duration Jakarta-based task at a specific stage in the server life cycle.

delete-application-ref

Removes a reference from a cluster or an un-clustered server instance to a previously deployed Jakarta EE application or module. This effectively results in the application element being un-deployed on the targeted instance or cluster.

delete-lifecycle-module

Deletes a lifecycle module.

deploy

Deploys an enterprise application, web application, EJB module, connector module, or application client module. If the component is already deployed or already exists, you can forcefully redeploy if you set the --force option to true. A directory can also be deployed. Supported in remote mode only. For usage instructions, see To Deploy an Application or Module.

deploy-remote-archive

Deploys an enterprise application, web application, EJB module, connector module, or application client module from a remote location, either using a URL or a set of Maven GAV coordinates. For usage instructions, see To Deploy from a URL and To Deploy using a Maven Artifact.

deploydir

This subcommand is deprecated. Use the deploy subcommand instead.

disable

Immediately deactivates the named application or module. If the component has not been deployed, an error message is returned. Supported in remote mode only. For usage instructions, see To Disable an Application or Module.

enable

Enables the specified application or module. If the component has not been deployed, an error message is returned. If the component is already enabled, then it is re-enabled. Supported in remote mode only. For usage instructions, see To Enable an Application or Module.

get-client-stubs

Gets the client stubs JAR file for an application client module or an application containing the application client module, from the server machine to the local directory. For usage instructions, see EJB Module Deployment Guidelines.

list-applications

Lists deployed Jakarta EE applications and modules. Optionally lists subcomponents and scoped resources. If the --type option is not specified, all applications and modules are listed. Supported in remote mode only. For usage instructions, see To List Deployed Applications or Modules.

list-application-refs

Lists Jakarta EE applications and modules deployed on the specified target server instance or cluster.

list-libraries

Lists library JAR files that have been added to Payara Server. You can specify whether to list libraries in the Common class loader directory, the Jakarta optional package directory, or the application-specific class loader directory.

list-lifecycle-modules

Lists lifecycle modules.

list-components

This subcommand is deprecated. Use the list-applications subcommand instead.

list-sub-components

Lists EJBs or servlets in a deployed module or in a module of the deployed application. If a module is not identified, all modules are listed. To display a specific module in an application, you must specify the module name and the --appname option. Supported in remote mode only. For usage instructions, see To List Deployed Applications or Modules.

list-web-context-param

Lists servlet context-initialization parameters of a deployed web application or module. Supported in remote mode only. For usage instructions, see To List Web Context Parameters.

list-web-env-entry

Lists environment entries for a deployed web application or module. Supported in remote mode only. For usage instructions, see To List Web Environment Entries.

redeploy

Overwrites an application or module that is already deployed. Supported in remote mode only. For usage instructions, see To Redeploy an Application or Module.

remove-library

Removes one or more library JAR files from Payara Server. You can specify whether the libraries are removed from the Common class loader directory, the Jakarta optional package directory, or the application-specific class loader directory.

set-web-context-param

Sets a servlet context-initialization parameter of a deployed web application or module. Supported in remote mode only. For usage instructions, see To Set a Web Context Parameter.

set-web-env-entry

Sets an environment entry for a deployed web application or module. Supported in remote mode only. For usage instructions, see To Set a Web Environment Entry.

show-component-status

Shows the status of a deployed component. The possible statuses include enabled or disabled. Supported in remote mode only. For usage instructions, see To List Deployed Applications or Modules.

undeploy

Uninstalls the specified deployed application or module. Supported in remote mode only. For usage instructions, see To Undeploy an Application or Module.

unset-web-context-param

Unsets a servlet context-initialization parameter of a deployed web application or module. Supported in remote mode only. For usage instructions, see To Unset a Web Context Parameter.

unset-web-env-entry

Unsets an environment entry for a deployed web application or module. Supported in remote mode only. For usage instructions, see To Unset a Web Environment Entry.