Subcommands for the asadmin Utility DRAFT |
Previous | Contents |
asadmin
UtilityThis appendix lists the asadmin
subcommands that are included with
this release of the GlassFish Server Open Source Edition 5.0 software.
For information and instructions on using the asadmin
application
deployment subcommands, see the GlassFish Server Open Source
Edition Application Deployment Guide.
Online help for the asadmin
subcommands can be invoked on the command
line, for example, asadmin create-domain
help
. The
GlassFish Server Open Source Edition Reference Manual also
provides a collection of these help pages.
Note
|
The common options used with remote subcommands are described in the
o |
add-resources
Creates the resources named in the specified XML file. Supported in remote mode only. For procedural information in this guide, see To Add Resources From an XML File.
asadmin
Describes how the asadmin
utility works.
attach
Attaches to subcommands that were started using the asadmin --detach
option or that contain progress information. For procedural
information in this guide, see
To Run asadmin
Subcommands
in --detach
Mode.
configure-managed-jobs
Configures how long information about subcommands (jobs) that were
started using the asadmin --detach
option or that contain progress
information is kept. For procedural information in this guide, see
To Run asadmin
Subcommands
in --detach
Mode.
create-module-config
Adds the default configuration of a module to domain.xml
.
create-service
Configures the starting of a domain administration server (DAS) on an unattended boot. On Oracle Solaris 10, this subcommand uses the Service Management Facility (SMF). For procedural information in this guide, see To Configure a DAS or an Instance for Automatic Restart on Oracle Solaris.
create-system-properties
Creates or updates system properties. Supported in remote mode only. For procedural information in this guide, see To Create System Properties.
delete-module-config
Removes the configuration of a module from domain.xml
.
delete-system-property
Deletes system properties of a domain or configuration, or server instance. Supported in remote mode only. For procedural information in this guide, see To Delete a System Property.
get
Gets an attribute of an element in the domain.xml
file. With the
-m
option, gets the names and values of the monitorable or
configurable attributes. For procedural information in this guide, see
Guidelines for Using the list
and get
Subcommands for Monitoring.
get-active-module-config
Displays the current active configuration of a module.
list
Lists the configurable element. On Oracle Solaris, quotes are needed
when running subcommands with *
as the option value or operand. For
procedural information in this guide, see
Guidelines for Using the list
and get
Subcommands for Monitoring.
list-commands
Lists all the asadmin
subcommands, local subcommands first, then
remote subcommands. You can specify that only remote subcommands or
only local subcommands be displayed. Supported in remote mode only.
For procedural information in this guide, see
To List Subcommands.
list-containers
Lists application containers and the status of each container. Supported in remote mode only. For procedural information in this guide, see To List Containers.
list-jobs
Lists information about subcommands that were started using the
asadmin --detach
option or that contain progress information. For
procedural information in this guide, see
To Run asadmin
Subcommands
in --detach
Mode.
list-modules
Lists modules that are accessible to the GlassFish Server subsystem. The status of each module is included. Supported in remote mode only. For procedural information in this guide, see To List Modules.
list-system-properties
Lists the system properties of a domain or configuration. Supported in remote mode only. For procedural information in this guide, see To List System Properties.
list-timers
List the timers owned by a specific server instance. Supported in remote mode only. For procedural information in this guide, see To List Timers.
multimode
Provides an asadmin>
prompt for running multiple subcommands while
preserving options and environment settings. Supported in local mode
only. For procedural information, see
Using the asadmin
Utility.
osgi
Delegates the command line to the Apache Felix Gogo remote shell for the execution of OSGi shell commands. For procedural information in this guide, see To Run Apache Felix Gogo Remote Shell Commands.
osgi-shell
Provides interactive access to the Apache Felix Gogo remote shell for the execution of OSGi shell commands. For procedural information in this guide, see To Run Apache Felix Gogo Remote Shell Commands.
set
Sets the values of one or more configurable attributes. For procedural information in this guide, see Configuring Monitoring.
setup-local-dcom
Sets up the Distributed Component Object Model (DCOM) remote protocol on the host where the subcommand is run. The DCOM remote protocol is available only on Windows systems.
show-component-status
Lists the status of existing components. Supported in remote mode only. For procedural information in this guide, see To Show Component Status.
start-database
Starts the Apache Derby database server. Use this subcommand only for working with applications deployed to the GlassFish Server. For procedural information in this guide, see To Start the Database.
stop-database
Stops a process of the Apache Derby DB database server. For procedural information in this guide, see To Stop the Database.
version
Displays the version information for the option specified in archive or folder format. Supported in remote mode only. For procedural information in this guide, see To Display the GlassFish Server Version.
list-batch-jobs
Lists batch jobs and job details. For procedural information in this guide, see To List Batch Jobs.
list-batch-job-executions
Lists batch job executions and execution details. For procedural information in this guide, see To List Batch Job Executions.
list-batch-job-steps
Lists steps for a specific batch job execution. For procedural information in this guide, see To List Batch Job Steps.
list-batch-runtime-configuration
Displays the configuration of the batch runtime. For procedural information in this guide, see To List the Batch Runtime Configuration.
set-batch-runtime-configuration
Configures the batch runtime. For procedural information in this guide, see To Configure the Batch Runtime.
create-context-service
Creates a context service resource. For procedural information in this guide, see To Create a Context Service.
create-managed-executor-service
Creates a managed executor service resource. For procedural information in this guide, see To Create a Managed Executor Service.
create-managed-scheduled-executor-service
Creates a managed scheduled executor service resource. For procedural information in this guide, see To Create a Managed Scheduled Executor Service.
create-managed-thread-factory
Creates a managed thread factory resource. For procedural information in this guide, see To Create a Managed Thread Factory.
list-context-services
Lists context service resources. For procedural information in this guide, see To List Context Services.
list-managed-executor-services
Lists managed executor service resources. For procedural information in this guide, see To List Managed Executor Services.
list-managed-scheduled-executor-services
Lists managed scheduled executor service resources. For procedural information in this guide, see To List Managed Scheduled Executor Services.
list-managed-thread-factories
Lists managed thread factory resources. For procedural information in this guide, see To List Managed Thread Factories.
delete-context-service
Removes a context service resource. For procedural information in this guide, see To Delete a Context Service.
delete-managed-executor-service
Removes a managed executor service resource. For procedural information in this guide, see To Delete a Managed Executor Service.
delete-managed-scheduled-executor-service
Removes a managed scheduled executor service resource. For procedural information in this guide, see To Delete a Managed Scheduled Executor Service.
delete-managed-thread-factory
Removes a managed thread factory resource. For procedural information in this guide, see To Delete a Managed Thread Factory.
create-admin-object
Creates an administered object. For procedural information in this guide, see To Create an Administered Object.
create-connector-connection-pool
Adds a new connector connection pool with the specified connection pool name. For procedural information in this guide, see To Create a Connector Connection Pool.
create-connector-resource
Creates a connector resource. For procedural information in this guide, see To Create a Connector Resource.
create-connector-security-map
Creates a connector security map for the specified connector connection pool. For procedural information, see To Create a Connector Security Map.
create-connector-work-security-map
Creates a connector work security map for the specified resource adapter. Supported in remote mode only. For procedural information in this guide, see To Create a Connector Work Security Map.
create-jdbc-resource
Creates a new JDBC resource. Supported in remote mode only. For procedural information in this guide, see To Create a JDBC Resource.
create-jdbc-connection-pool
Registers a new JDBC connection pool with the specified JDBC connection pool name. Supported in remote mode only. For procedural information in this guide, see To Create a JDBC Connection Pool.
create-resource-adapter-config
Creates configuration information for the connector module. Supported in remote mode only. For procedural information in this guide, see To Create Configuration Information for a Resource Adapter.
delete-admin-object
Deletes an administered object. For procedural information in this guide, see To Delete an Administered Object.
delete-connector-connection-pool
Removes the connector connection pool specified using the
connector_connection_pool_name
operand. For procedural information
in this guide, see To Delete a Connector
Connection Pool.
delete-connector-resource
Deletes connector resource. For procedural information in this guide, see To Delete a Connector Resource.
delete-connector-security-map
Deletes a specified connector security map. Supported in remote mode only. For procedural information in this guide, see To Delete a Connector Security Map.
delete-connector-work-security-map
Deletes a specified connector work security map. Supported in remote mode only. For procedural information in this guide, see To Delete a Connector Work Security Map.
delete-jdbc-connection-pool
Deletes the specified JDBC connection pool. Supported in remote mode only. For procedural information in this guide, see To Delete a JDBC Connection Pool.
delete-jdbc-resource
Deletes a JDBC resource. The specified JNDI name identifies the resource to be deleted. Supported in remote mode only. For procedural information in this guide, see To Delete a JDBC Resource.
delete-resource-adapter-config
Deletes configuration information for the connector module. Supported in remote mode only. For procedural information in this guide, see To Delete a Resource Adapter Configuration.
flush-connection-pool
Reintializes all connections established in the specified connection. For procedural information in this guide, see To Reset (Flush) a Connection Pool.
list-admin-objects
Lists administered objects. For procedural information in this guide, see To List Administered Objects.
list-connector-connection-pools
Lists the connector connection pools that have been created. For procedural information in this guide, see To List Connector Connection Pools.
list-connector-resources
Creates connector resources. For procedural information in this guide, see To List Connector Resources.
list-connector-security-maps
Lists the connector security maps belonging to a specified connector connection pool. For procedural information in this guide, see To List Connector Security Maps.
list-connector-work-security-maps
Lists the existing connector work security maps for a resource adapter. Supported in remote mode only. For procedural information in this guide, see To List Connector Work Security Maps.
list-jdbc-connection-pools
Lists the existing JDBC connection pools. Supported in remote mode only. For procedural information in this guide, see To List JDBC Connection Pools.
list-jdbc-resources
Lists the existing JDBC resources. Supported in remote mode only. For procedural information in this guide, see To List JDBC Resources.
list-resource-adapter-configs
Lists configuration information for the connector modules. Supported in remote mode only. For procedural information in this guide, see To List Resource Adapter Configurations.
ping-connection-pool
Tests if a JDBC connection pool is usable. Supported in remote mode only. For procedural information in this guide, see To Contact (Ping) a Connection Pool.
update-connector-security-map
Modifies a security map for the specified connector connection pool. For procedural information in this guide, see To Update a Connector Security Map.
update-connector-work-security-map
Modifies a work security map that belongs to a specific resource adapter (connector module). For procedure information in this guide, see To Update a Connector Work Security Map.
backup-domain
Describes how to back up a domain. Supported in local mode only. For procedural information in this guide, see To Back Up a Domain.
create-domain
Creates the configuration of a domain. A domain can exist independent
of other domains. Any user who has access to the asadmin
utility on
a given host can create a domain and store its configuration in a
location of choice. For procedural information in this guide, see
To Create a Domain.
delete-domain
Deletes the specified domain. The domain must be stopped before it can be deleted. For procedural information in this guide, see To Delete a Domain.
list-backups
Lists the existing domain backups. Supported in local mode only. For procedural information in this guide, see To List Domain Backups.
list-domains
Lists the existing domains and their statuses. If the domain directory is not specified, the domains in the domain-root-dir, the default for which is as-install`/domains`, are displayed. For procedural information in this guide, see To List Domains.
login
Allows you to log in to a domain. For procedural information in this guide, see To Log In to a Domain.
restart-domain
Restarts the Domain Administration Server (DAS) of the specified domain. Supported in remote mode only. For procedural information in this guide, see To Restart a Domain.
restore-domain
Recovers and domain from a backup file. Supported in local mode only. For procedural information in this guide, see To Restore a Domain.
start-domain
Starts a domain. If the domain directory is not specified, the default
domain1
in the default domain-root-dir directory is started. If
there are two or more domains, the domain_name operand must be
specified. For procedural information in this guide, see
To Start a Domain.
stop-domain
Stops the domain administration server (DAS) of the specified domain. Supported in remote mode only. For procedural information in this guide, see To Stop a Domain.
uptime
Displays the length of time that the domain administration server (DAS) has been running since the last restart. Supported in remote mode only. For procedural information in this guide, see To Display Domain Uptime.
create-http
Creates a set of HTTP parameters for a protocol, which in turn configures one or more network listeners. Supported in remote mode only. For procedural information in this guide, see To Create an HTTP Configuration.
create-http-listener
Creates a new HTTP listener socket. Supported in remote mode only. For procedural information in this guide, see To Create an Internet Connection.
create-network-listener
Creates a new HTTP listener socket. Supported in remote mode only. For procedural information in this guide, see To Create an Internet Connection.
create-protocol
Creates a protocol for a listener. Supported in remote mode only. For procedural information in this guide, see To Create a Protocol.
create-transport
Creates a transport for a listener. Supported in remote mode only. For procedural information in this guide, see To Create a Transport.
create-virtual-server
Creates the specified virtual server element. Supported in remote mode only. For procedural information in this guide, see To Create a Virtual Server.
create-ssl
Creates and configures the SSL element in the selected HTTP listener to enable secure communication on that listener/service. Supported in remote mode only. For procedural information in this guide, see To Configure an HTTP Listener for SSL.
delete-http
Deletes an existing HTTP configuration. Supported in remote mode only. For procedural information in this guide, see To Delete an HTTP Configuration.
delete-http-listener
Deletes the specified HTTP listener. Supported in remote mode only. For procedural information in this guide, see To Delete an HTTP Network Listener.
delete-network-listener
Deletes the specified HTTP listener. Supported in remote mode only. For procedural information in this guide, see To Delete an HTTP Network Listener.
delete-protocol
Deletes and existing HTTP protocol. Supported in remote mode only. For procedural information in this guide, see To Delete a Protocol.
delete-ssl
Deletes the SSL element in the selected HTTP listener. Supported in remote mode only. For procedural information in this guide, see To Delete SSL From an HTTP Listener.
delete-transport
Deletes and existing HTTP transport. Supported in remote mode only. For procedural information in this guide, see To Delete a Transport.
delete-virtual-server
Deletes the specified virtual server element. Supported in remote mode only. For procedural information in this guide, see To Delete a Virtual Server.
list-http-listeners
Lists the existing HTTP listeners. Supported in remote mode only. For procedural information in this guide, see To List HTTP Network Listeners.
list-network-listeners
Lists the existing HTTP listeners. Supported in remote mode only. For procedural information in this guide, see To List HTTP Network Listeners.
list-protocols
Lists the existing HTTP protocols. Supported in remote mode only. For procedural information in this guide, see To List Protocols.
list-transports
Lists the existing HTTP transports. Supported in remote mode only. For procedural information in this guide, see To List Transports.
list-virtual-servers
Lists the existing virtual servers. Supported in remote mode only. For procedural information in this guide, see To List Virtual Servers.
create-javamail-resource
Creates a JavaMail session resource. Supported in remote mode only. For procedural information in this guide, see To Create a JavaMail Resource.
delete-javamail-resource
Deletes a JavaMail session resource. Supported in remote mode only. For procedural information in this guide, see To Delete a JavaMail Resource.
list-javamail-resources
Creates JavaMail session resources. Supported in remote mode only. For procedural information in this guide, see To List JavaMail Resources.
create-jmsdest
Creates a JMS physical destination. Along with the physical
destination, you use the create-jms-resource
subcommand to create a
JMS destination resource that has a Name
property that specifies the
physical destination. Supported in remote mode only. For procedural
information in this guide, see To Create a JMS
Physical Destination.
create-jms-host
Creates a JMS host within the JMS service. Supported in remote mode only. For procedural information in this guide, see To Create a JMS Host.
create-jms-resource
Creates a JMS connection factory resource or JMS destination resource. Supported in remote mode only. Supported in remote mode only. For procedural information in this guide, see To Create a Connection Factory or Destination Resource.
delete-jmsdest
Removes the specified JMS destination. Supported in remote mode only. For procedural information in this guide, see To Delete a JMS Physical Destination.
delete-jms-host
Deletes a JMS host within the JMS service. Supported in remote mode only. For procedural information in this guide, see To Delete a JMS Host.
delete-jms-resource
Deletes a JMS connection factory resource or JMS destination resource. Supported in remote mode only. For procedural information in this guide, see To Delete a Connection Factory or Destination Resource.
flush-jmsdest
Purges the messages from a physical destination in the specified JMS Service configuration of the specified target. Supported in remote mode only. For procedural information in this guide, see To Purge Messages From a Physical Destination.
jms-ping
Checks if the JMS service (also known as the JMS provider) is up and running. Supported in remote mode only. For procedural information in this guide, see Troubleshooting the JMS Service.
list-jmsdest
Lists the JMS physical destinations. Supported in remote mode only. For procedural information in this guide, see To List JMS Physical Destinations.
list-jms-hosts
Lists the existing JMS hosts. Supported in remote mode only. For procedural information in this guide, see To List JMS Hosts.
list-jms-resources
Lists the existing JMS connection factory or destination resources. Supported in remote mode only. For procedural information in this guide, see To List JMS Resources.
create-custom-resource
Creates a custom JNDI resource. Supported in remote mode only. For procedural information in this guide, see To Create a Custom JNDI Resource.
create-jndi-resource
Creates an external JNDI resource. Supported in remote mode only. For procedural information in this guide, see To Register an External JNDI Resource.
delete-custom-resource
Deletes a custom JNDI resource. Supported in remote mode only. For procedural information in this guide, see To Delete a Custom JNDI Resource.
delete-jndi-resource
Deletes an external JNDI resource. Supported in remote mode only. For procedural information in this guide, see To Delete an External JNDI Resource.
list-custom-resources
Lists the existing custom JNDI resources. Supported in remote mode only. For procedural information in this guide, see To List Custom JNDI Resources.
list-jndi-entries
Lists the entries in the JNDI tree. Supported in remote mode only. For procedural information in this guide, see To List External JNDI Entries,
list-jndi-resources
Lists the existing external JNDI resources. Supported in remote mode only. For procedural information in this guide, see To List External JNDI Resources.
create-jvm-options
Creates a JVM option in the Java configuration or profiler elements of
the domain.xml
file. Supported in remote mode only. For procedural
information in this guide, see To Create JVM
Options.
create-profiler
Creates a profiler element. Supported in remote mode only. For procedural information in this guide, see To Create a Profiler.
delete-jvm-options
Deletes the specified JVM option from the Java configuration or
profiler elements of the domain.xml
file. Supported in remote mode
only. For procedural information in this guide, see
To Delete JVM Options.
delete-profiler
Deletes the specified profiler element. Supported in remote mode only. For procedural information in this guide, see To Delete a Profiler.
generate-jvm-report
Generates a report showing the threads, classes, and memory for the virtual machine that runs GlassFish Server. For procedural information in this guide, see To Generate a JVM Report.
list-jvm-options
Lists the command-line options that are passed to the Java application launcher when GlassFish Server is started. Supported in remote mode only. For procedural information in this guide, see To List JVM Options.
create-lifecycle-module
Creates a new life cycle module. Supported in remote mode only. For procedural information in this guide, see To Create a Life Cycle Module.
list-lifecycle-modules
Lists life cycle modules. Supported in remote mode only. For procedural information in this guide, see To List Life Cycle Modules.
delete-lifecycle-module
Deletes an existing life cycle module. Supported in remote mode only. For procedural information in this guide, see To Delete a Life Cycle Module.
collect-log-files
Collects all available log files and creates a ZIP archive. Supported in remote mode only. For procedural information in this guide, see To Collect Log Files into a ZIP Archive.
disable-monitoring
Disables the monitoring service. Supported in remote mode only. For procedural information in this guide, see To Disable Monitoring.
enable-monitoring
Enables the monitoring service. Supported in remote mode only. For procedural information in this guide, see To Enable Monitoring.
list-log-attributes
Lists log file attributes. Supported in remote mode only. For procedural information in this guide, see Configuring the Logging Service.
list-log-levels
Lists the existing loggers. Supported in remote mode only. For procedural information in this guide, see To List Log Levels.
list-loggers
Lists all public loggers in your distribution of GlassFish Server Open Source Edition. Internal loggers are not listed. For procedural information in this guide, see To List Loggers.
monitor
Displays monitoring information for the common GlassFish Server resources. Supported in remote mode only. For procedural information in this guide, see To View Common Monitoring Data.
rotate-log
Rotates the server.log
file and stores the old data in a
time-stamped file. Supported in remote mode only. For procedural
information in this guide, see To Rotate Log
Files Manually.
set-log-attributes
Sets log file attributes. Supported in remote mode only. For procedural information in this guide, see Configuring the Logging Service.
set-log-file-format
Sets the formatter used to format log records in log files. For procedural information in this guide, see Setting the Log File Format.
set-log-levels
Sets the log level for a module. Supported in remote mode only. For procedural information in this guide, see Setting Log Levels.
create-iiop-listener
Creates an IIOP listener. Supported in remote mode only. For procedural information in this guide, see To Create an IIOP Listener.
delete-iiop-listener
Deletes an IIOP listener. Supported in remote mode only. For procedural information in this guide, see To Delete an IIOP Listener.
list-iiop-listeners
Lists the existing IIOP listeners. Supported in remote mode only. For procedural information in this guide, see To List IIOP Listeners.
create-threadpool
Creates a new thread pool. Supported in remote mode only. For procedural information in this guide, see To Create a Thread Pool.
delete-threadpool
Deletes the specified thread pool. Supported in remote mode only. For procedural information in this guide, see To Delete a Thread Pool.
list-threadpools
Lists the existing thread pools. Supported in remote mode only. For procedural information in this guide, see To List Thread Pools.
freeze-transaction-service
Freezes the transaction subsystem during which time all the in-flight transactions are suspended. Supported in remote mode only. For procedural information, see To Stop the Transaction Service.
recover-transactions
Manually recovers pending transactions. Supported in remote mode only. For procedural information, see To Manually Recover Transactions.
rollback-transaction
Rolls back the named transaction. Supported in remote mode only. For procedural information, see To Roll Back a Transaction.
unfreeze-transaction-service
Resumes all the suspended in-flight transactions. Invoke this subcommand on an already frozen transaction. Supported in remote mode only. For procedural information, see To Restart the Transaction Service.
Previous | Contents |
DRAFT