Miscellaneous Commands
This is a non-exhaustive list of asadmin commands for Payara Server.
add-library
Since Payara Server 4.1.2.173
- Usage
-
asadmin> add-library <options> file - Aim
-
This command adds a jar library to Payara Server Community and loads it
| Options | Type | Description | Default | Mandatory |
|---|---|---|---|---|
type |
String |
Specifies the type of library. The supported values are |
common |
No |
create-iiop-listener
- Usage
-
asadmin > create-iiop-listener <options> listener_id - Aim
-
Creates a listener for IIOP network traffic
generate-bash-autocomplete
Since 5.183
- Usage
-
asadmin >generate-bash-autocomplete output_file - Aim
-
Creates an asadmin autocompletion script for bash.
The created file will be on the server and not the client.
If they are on different hosts, then the file will be needed
to copied from the server to the client.
Add the resulting file to your bash path by adding
source path/to/outputfile to your .bashrc
or copy the file into the /etc/bash_completion.d folder.
This means that you can run asadmin commands by typing
asadmin in a terminal and you can use double-tab to autocomplete a command,
similar to other bash commands.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
force |
boolean |
Whether to write over a file if one already exists |
false |
No |
file |
File path |
The path for the resulting file |
${payara.home}/glassfish/bin/bash_autocomplete |
No |
localCommands |
boolean |
This option will include local asadmin commands |
false |
No |
get-domain-xml
- Usage
-
asadmin > get-domain-xml - Aim
-
Gets the text of the domain.xml file. This command will only run against a local instance.
list-rest-endpoints
Since Payara Server 4.1.2.172
- Aim
-
Lists all the rest endpoints of an application
- Usage
-
asadmin > list-rest-endpoints applicationName
restart-cluster
Since Payara Server 4.1.1.163
- Aim
-
Restarts all instances in a cluster. Must be run from the DAS.
- Usage
-
asadmin > restart-cluster clusterName
set-network-listener-configuration
Since Payara Server 5.182
- Usage
-
asadmin> set-network-listener-configuration <options> network_listener_name - Aim
-
This command helps to modify existing network listener
| Options | Type | Description | Default | Mandatory |
|---|---|---|---|---|
enabled |
Boolean |
Enables or disables the network listener. |
true |
No |
dynamic |
Boolean |
When set to true, applies the changes without a restart. Otherwise a restart is required. |
false |
No |
address |
String |
The IP address on which the network listener is going to be listening. |
No |
|
Port |
Integer |
The port on which the network listener is going to be listening. |
Yes |
|
listenerPortRange |
String |
Port range which the network listener can bind to. |
No |
|
threadPool |
String |
The thread pool which will be associated with the network listener. |
No |
|
transport |
String |
The transport layer that is going to be used by the network listener |
No |
|
jkenabled |
Boolean |
If enabled, the network listener will become an Apache mod-jk listener |
false |
No |
target |
String |
The config whose values will be set. |
server-config |
No |
restart-http-listeners
Since Payara Server 5.2020.2
- Usage
-
asadmin> restart-http-listeners <options> - Aim
-
This command restarts all http listeners of the targeted instance(s). Usually used to make network configuration changes take effect without restarting the server.
| Options | Type | Description | Default | Mandatory |
|---|---|---|---|---|
all |
Boolean |
Apply command to all instances |
false |
No |
target |
String |
Name of the target instance, deployment group or cluster |
server |
No |
- Examples
-
Restart all HTTP listeners of all instances:
asadmin> restart-http-listeners --all
Restart all HTTP listeners of a particular instance named FlyingFish:
asadmin> restart-http-listeners FlyingFish
The --target can be omitted as target is the primary parameter.
This command only restarts all HTTP listeners except the admin-listener. IIOP listeners are not affected and may require a server restart to make changes take effect.
|