WildFly CLI Deployment Operations
Jump to navigation
Jump to search
External
Internal
Overview
Deployments are executed with the deploy command.
Undeployments are executed with the undeploy command.
In-line usage details can be obtained with:
deploy --help undeploy --help
deploy/undeploy interact with domain/AS instance's Deployment ArtifactRepository.
Deploy Usage
deploy (file_path [--script=script_name] [--name=deployment_name] [--runtime-name=deployment_runtime_name] [--force | --disabled] [--unmanaged])
| --name=deployment_name [--server-groups=group_name (,group_name)* | --all-server-groups] [--headers={operation_header (;operation_header)*}]
deploy deploys the application designated by the file_path or enables an already existing but disabled deployment.
If executed w/o arguments, will list all the existing deployments.
file_path
Absolute or relative. Not required if the repository already exists in the artifact repository.
--name - the unique name of the deployment. If the file path
argument is specified the name argument is optional with
the file name been the default value. If the file path
argument isn't specified then the command is supposed to
enable an already existing but disabled deployment, and in
this case the name argument is required.
--runtime-name - optional, the runtime name for the deployment. This will
form the basis for such things as default Java EE
application and module names. This would typically be the
same as --name, and if not specified the value used for
--name will be used. In some cases users may wish to have
two deployments with the same 'runtime-name' (e.g. two
versions of "example.war") both available in the management
configuration, in which case the deployments would need to
have distinct 'name' values but would have the same
'runtime-name'. Within an individual server, only one
deployment with a given 'runtime-name' can deployed.
However, multiple deployments with the same 'runtime-name'
can exist in the configuration, so long as only one is
enabled.
--force - if the deployment with the specified name already exists,
by default, deploy will be aborted and the corresponding
message will printed. Switch --force (or -f) will force the
replacement of the existing deployment with the one
specified in the command arguments.
--disabled - indicates that the deployment has to be added to the
repository disabled.
--unmanaged - if this argument is not specified, the deployment content
will be copied (i.e. uploaded) to the server's deployment
repository before it is deployed. If the argument is
present, the deployment content will remain at and be
deployed directly from its original location specified with
the file_path.
NOTE: exploded deployments are supported only as unmanaged.
--server-groups - comma separated list of server group names the deploy
command should apply to. Either server-groups or
all-server-groups is required in the domain mode. This
argument is not applicable in the standalone mode.
--all-server-groups - indicates that deploy should apply to all the available
server groups. Either server-groups or all-server-groups
is required in domain mode. This argument is not
applicable in the standalone mode.
-l - in case none of the required arguments is specified the
command will print all of the existing deployments in the
repository. The presence of the -l switch will make the
existing deployments printed one deployment per line,
instead of in columns (the default).
--headers - a list of operation headers separated by a semicolon. For
the list of supported headers, please, refer to the domain
management documentation or use tab-completion.
--script - optional, can appear only if the file_path points a cli
archive. The value is the name of the script contained in a
cli archive to execute. If not specified, defaults to
'deploy.scr'. A cli archive is a zip archive containing
script(s) as well as artifacts or applications to deploy.
To be recognized as a cli archive, the extension of the
archive file should be '.cli'. The deploy command will
execute the script given by the --script argument. All paths
in the scripts are relative to the root directory in the cli
archive. The script is executed as a batch.
Undeploy Usage
[domain@172.31.17.207:9999 /] undeploy --help SYNOPSIS
undeploy name [--server-groups=group_name (,group_name)* |
--all-relevant-server-groups] [--keep-content]
[--headers={operation_header (;operation_header)*}]
DESCRIPTION
Undeploys the deployment with the given name and, depending on the arguments, removes its content from the repository. If the deployment name isn't specified, prints the list of all the existing deployments.
ARGUMENTS
name - the name of the deployment to undeploy.
--server-groups - comma separated list of server group names the undeploy
command should apply to. Either server-groups or
all-relevant-server-groups is required in the domain mode.
This argument is not applicable in the standalone mode.
--all-relevant-server-groups - indicates that undeploy should apply to all
the server groups in which the deployment is
enabled. Either server-groups or all-relevant-server-groups
is required in domain mode. This argument is not applicable
in the standalone mode.
--keep-content - by default undeploy, besides disabling the deployment, also
removes its content from the repository. The presence of
--keep-content will only disable the deployment w/o removing
its content from the repository. This argument can be used
in both standalone and domain modes.
-l - in case the deployment name isn't specified, the presence of
the -l switch will make the existing deployments printed one
deployment per line, instead of in columns (the default).
--headers - a list of operation headers separated by a semicolon. For
the list of supported headers, please, refer to the domain
management documentation or use tab-completion.
--path - optional, points to a cli archive. The path can be either
absolute or relative to the current directory. A cli archive
is a zip archive containing script(s) as well as artifacts
or applications to deploy. To be recognized as a cli
archive, the extension of the archive file should be '.cli'.
The undeploy command will execute the script given by the
--script argument.
--script - optional, can appear only if the file_path points a cli
archive. The value is the name of the script contained in a
cli archive to execute. If not specified, defaults to
'undeploy.scr'. All paths in the scripts are relative to the
root directory in the cli archive. The script is executed as
a batch.
Standalone Mode
Domain Mode
Connect to the domain controller.
deploy /loca/path/to/the/applicaton/artifact/test.war [destination]
where destination can be:
- --all-server-groups
- --server-groups=...