Payara Server asadmin command reference, Part 1

There is asadmin command reference supported by Payara Server. Part 1 shows commands that are compatible with GlassFish 4.x. Part 2 will show commands of Payara Server extensions.

In regard to the details of each commands, See GlassFish 4 reference manual or asadmin help ${command_name}.

I. Local command

You can execute local command without DAS is running.

1. Manage domains

1.1. Start and stop domains

start-domain
stop-domain
restart-domain
list-domains

1.2. Create and delete domains

create-domain (support for --autoname since 5.193)
delete-domain
verify-domain-xml

1.3. Backup and restore domains

backup-domain
restore-domain
list-backups

2. Manage local instances

2.1. Start and stop local instances

start-local-instance
stop-local-instance
restart-local-instance

2.2. Create and delete local instances

create-local-instance (support for --autoname since 5.193)
delete-local-instance
import-sync-bundle

3. Install and uninstall nodes

3.1. SSH

install-node
install-node-ssh
uninstall-node
uninstall-node-ssh

Tips: install-node and uninstall-node are equivalent to install-node-ssh and uninstall-node-ssh.

3.2. DCOM

install-node-dcom
uninstall-node-dcom

4. Manage clusters

setup-ssh
setup-local-dcom
validate-multicast

5. Start and stop the database

start-database
stop-database

6. Command line interface (asadmin itself)

6.1. asadmin help

help
version
list-commands

6.2. asadmin features

login
multimode
export
unset

6.3. Utilities

monitor
osgi-shell

7. Manage the server

change-admin-password
change-master-password
create-service

II. Remote command

You can execute a remote command during DAS is running.

1. Deploy

1.1. Applications

deploy
deploydir
redeploy
undeploy
enable
disable
list-applications
list-sub-components
show-component-status
create-application-ref
delete-application-ref
list-application-refs
set-web-context-param
unset-web-context-param
list-web-context-param
set-web-env-entry
unset-web-env-entry
list-web-env-entry
list-components

1.2. Libraries

add-library
remove-library
list-libraries

2. Server

2.1. Web

create-http
delete-http
create-ssl
delete-ssl
create-http-listener
delete-http-listener
list-http-listeners
get-http-listener
create-http-redirect
delete-http-redirect
create-network-listener
delete-network-listener
list-network-listeners
create-threadpool
delete-threadpool
list-threadpools
create-transport
delete-transport
list-transports
create-protocol
create-protocol-filter
create-protocol-finder
delete-protocol
delete-protocol-filter
delete-protocol-finder
list-protocols
list-protocol-filters
list-protocol-finders
create-virtual-server
delete-virtual-server
list-virtual-servers

2.2. EJB

list-timers
migrate-timers
get-client-stubs
create-iiop-listener
delete-iiop-listener
list-iiop-listeners

2.3. JDBC

create-jdbc-resource
delete-jdbc-resource
list-jdbc-resources
create-jdbc-connection-pool
delete-jdbc-connection-pool
list-jdbc-connection-pools
ping-connection-pool
flush-connection-pool

2.4. JTA

rollback-transaction
recover-transactions
freeze-transaction-service
unfreeze-transaction-service

2.5. JMS

create-jms-host
delete-jms-host
list-jms-hosts
jms-ping
create-jmsdest
delete-jmsdest
list-jmsdest
flush-jmsdest
create-jms-resource
list-jms-resources
delete-jms-resource
configure-jms-cluster
change-master-broker

2.6. JCA

add-resources
create-connector-connection-pool
delete-connector-connection-pool
list-connector-connection-pools
create-connector-resource
delete-connector-resource
list-connector-resources
create-connector-security-map
delete-connector-security-map
update-connector-security-map
list-connector-security-maps
create-connector-work-security-map
delete-connector-work-security-map
update-connector-work-security-map
list-connector-work-security-maps
create-admin-object
delete-admin-object
list-admin-objects
create-resource-adapter-config
delete-resource-adapter-config
list-resource-adapter-configs
create-resource-ref
delete-resource-ref
update-resource-ref
list-resource-refs

2.7. JBatch

set-batch-runtime-configuration
list-batch-job-executions
list-batch-job-steps
list-batch-jobs
list-batch-runtime-configuration

2.8. Managed executor services

create-context-service
delete-context-service
list-context-services
create-managed-executor-service
delete-managed-executor-service
list-managed-executor-services
create-managed-scheduled-executor-service
delete-managed-scheduled-executor-service
list-managed-scheduled-executor-services
create-managed-thread-factory
delete-managed-thread-factory
list-managed-thread-factories

2.9. JavaMail

create-javamail-resource
delete-javamail-resource
list-javamail-resources

2.10. Lifecycle modules

create-lifecycle-module
delete-lifecycle-module
list-lifecycle-modules

2.11. JNDI resources

create-jndi-resource
delete-jndi-resource
list-jndi-resources
list-jndi-entries
create-custom-resource
delete-custom-resource
list-custom-resources

3. Security

3.1. Administration

enable-secure-admin
disable-secure-admin
enable-secure-admin-principal
disable-secure-admin-principal
list-secure-admin-principals
enable-secure-admin-internal-user
disable-secure-admin-internal-user
list-secure-admin-internal-users
configure-ldap-for-admin
create-password-alias
delete-password-alias
update-password-alias
list-password-aliases
list-supported-cipher-suites

3.2. JAAS

create-auth-realm
delete-auth-realm
list-auth-realms
create-file-user
update-file-user
delete-file-user
list-file-users
list-file-groups

3.3. JACC

create-jacc-provider
delete-jacc-provider
list-jacc-providers

3.4. SOAP

create-message-security-provider
delete-message-security-provider
list-message-security-providers

3.5. Audit module

create-audit-module
delete-audit-module
list-audit-modules

4. Configuration

4.1. Configuration

copy-config
delete-config
list-configs
create-module-config
delete-module-config
get-active-module-config

4.2. System properties

create-system-properties
delete-system-property
list-system-properties

4.3. JVM options

create-jvm-options
delete-jvm-options
list-jvm-options

5. Monitoring

create-profiler
delete-profiler
enable-monitoring
disable-monitoring
get
set
list
generate-jvm-report
uptime

6. Logging

list-loggers
set-log-levels
list-log-levels
delete-log-levels
set-log-attributes
list-log-attributes
set-log-file-format
rotate-log
collect-log-files

7. High availability

7.1. Nodes

create-node-config
create-node-ssh
create-node-dcom
delete-node-config
delete-node-ssh
delete-node-dcom
update-node-config
update-node-ssh
update-node-dcom
list-nodes-config
list-nodes-ssh
list-nodes-dcom
list-nodes
ping-node-ssh
ping-node-dcom
validate-dcom

7.2. Instances

create-instance
delete-instance
list-instances
start-instance
stop-instance
restart-instance

7.3. Clusters

create-cluster
delete-cluster
start-cluster
stop-cluster
list-clusters
get-health
list-persistence-types
export-sync-bundle

7.4. HTTP load balancer

create-http-lb
create-http-lb-config
create-http-lb-ref
delete-http-lb
delete-http-lb-config
delete-http-lb-ref
list-http-lbs
list-http-lb-configs
apply-http-lb-changes
configure-lb-weight
enable-http-lb-application
enable-http-lb-server
disable-http-lb-application
disable-http-lb-server
export-http-lb-config
create-http-health-checker
delete-http-health-checker

8. Modular system

osgi
list-modules
list-containers

9. Command line interface (asadmin itself)

configure-managed-jobs
list-jobs
attach

Add Comment

Comments

0 comments

Please sign in to leave a comment.

Was this article helpful?
0 out of 0 found this helpful