|
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-resourcesCreates 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.
asadminDescribes how the asadmin utility works.
attachAttaches 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-jobsConfigures 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-configAdds the default configuration of a module to domain.xml.
create-serviceConfigures 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-propertiesCreates or updates system properties. Supported in remote mode only. For procedural information in this guide, see To Create System Properties.
delete-module-configRemoves the configuration of a module from domain.xml.
delete-system-propertyDeletes 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.
getGets 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-configDisplays the current active configuration of a module.
listLists 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-commandsLists 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-containersLists application containers and the status of each container. Supported in remote mode only. For procedural information in this guide, see To List Containers.
list-jobsLists 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-modulesLists 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-propertiesLists 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-timersList the timers owned by a specific server instance. Supported in remote mode only. For procedural information in this guide, see To List Timers.
multimodeProvides 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.
osgiDelegates 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-shellProvides 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.
setSets the values of one or more configurable attributes. For procedural information in this guide, see Configuring Monitoring.
setup-local-dcomSets 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-statusLists the status of existing components. Supported in remote mode only. For procedural information in this guide, see To Show Component Status.
start-databaseStarts 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-databaseStops a process of the Apache Derby DB database server. For procedural information in this guide, see To Stop the Database.
versionDisplays 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-jobsLists batch jobs and job details. For procedural information in this guide, see To List Batch Jobs.
list-batch-job-executionsLists batch job executions and execution details. For procedural information in this guide, see To List Batch Job Executions.
list-batch-job-stepsLists steps for a specific batch job execution. For procedural information in this guide, see To List Batch Job Steps.
list-batch-runtime-configurationDisplays the configuration of the batch runtime. For procedural information in this guide, see To List the Batch Runtime Configuration.
set-batch-runtime-configurationConfigures the batch runtime. For procedural information in this guide, see To Configure the Batch Runtime.
create-context-serviceCreates a context service resource. For procedural information in this guide, see To Create a Context Service.
create-managed-executor-serviceCreates a managed executor service resource. For procedural information in this guide, see To Create a Managed Executor Service.
create-managed-scheduled-executor-serviceCreates a managed scheduled executor service resource. For procedural information in this guide, see To Create a Managed Scheduled Executor Service.
create-managed-thread-factoryCreates a managed thread factory resource. For procedural information in this guide, see To Create a Managed Thread Factory.
list-context-servicesLists context service resources. For procedural information in this guide, see To List Context Services.
list-managed-executor-servicesLists managed executor service resources. For procedural information in this guide, see To List Managed Executor Services.
list-managed-scheduled-executor-servicesLists managed scheduled executor service resources. For procedural information in this guide, see To List Managed Scheduled Executor Services.
list-managed-thread-factoriesLists managed thread factory resources. For procedural information in this guide, see To List Managed Thread Factories.
delete-context-serviceRemoves a context service resource. For procedural information in this guide, see To Delete a Context Service.
delete-managed-executor-serviceRemoves a managed executor service resource. For procedural information in this guide, see To Delete a Managed Executor Service.
delete-managed-scheduled-executor-serviceRemoves a managed scheduled executor service resource. For procedural information in this guide, see To Delete a Managed Scheduled Executor Service.
delete-managed-thread-factoryRemoves a managed thread factory resource. For procedural information in this guide, see To Delete a Managed Thread Factory.
create-admin-objectCreates an administered object. For procedural information in this guide, see To Create an Administered Object.
create-connector-connection-poolAdds 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-resourceCreates a connector resource. For procedural information in this guide, see To Create a Connector Resource.
create-connector-security-mapCreates a connector security map for the specified connector connection pool. For procedural information, see To Create a Connector Security Map.
create-connector-work-security-mapCreates 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-resourceCreates a new JDBC resource. Supported in remote mode only. For procedural information in this guide, see To Create a JDBC Resource.
create-jdbc-connection-poolRegisters 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-configCreates 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-objectDeletes an administered object. For procedural information in this guide, see To Delete an Administered Object.
delete-connector-connection-poolRemoves 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-resourceDeletes connector resource. For procedural information in this guide, see To Delete a Connector Resource.
delete-connector-security-mapDeletes 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-mapDeletes 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-poolDeletes 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-resourceDeletes 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-configDeletes 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-poolReintializes all connections established in the specified connection. For procedural information in this guide, see To Reset (Flush) a Connection Pool.
list-admin-objectsLists administered objects. For procedural information in this guide, see To List Administered Objects.
list-connector-connection-poolsLists the connector connection pools that have been created. For procedural information in this guide, see To List Connector Connection Pools.
list-connector-resourcesCreates connector resources. For procedural information in this guide, see To List Connector Resources.
list-connector-security-mapsLists 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-mapsLists 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-poolsLists the existing JDBC connection pools. Supported in remote mode only. For procedural information in this guide, see To List JDBC Connection Pools.
list-jdbc-resourcesLists the existing JDBC resources. Supported in remote mode only. For procedural information in this guide, see To List JDBC Resources.
list-resource-adapter-configsLists 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-poolTests 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-mapModifies 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-mapModifies 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-domainDescribes how to back up a domain. Supported in local mode only. For procedural information in this guide, see To Back Up a Domain.
create-domainCreates 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-domainDeletes 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-backupsLists the existing domain backups. Supported in local mode only. For procedural information in this guide, see To List Domain Backups.
list-domainsLists 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.
loginAllows you to log in to a domain. For procedural information in this guide, see To Log In to a Domain.
restart-domainRestarts 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-domainRecovers and domain from a backup file. Supported in local mode only. For procedural information in this guide, see To Restore a Domain.
start-domainStarts 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-domainStops 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.
uptimeDisplays 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-httpCreates 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-listenerCreates a new HTTP listener socket. Supported in remote mode only. For procedural information in this guide, see To Create an Internet Connection.
create-network-listenerCreates a new HTTP listener socket. Supported in remote mode only. For procedural information in this guide, see To Create an Internet Connection.
create-protocolCreates a protocol for a listener. Supported in remote mode only. For procedural information in this guide, see To Create a Protocol.
create-transportCreates a transport for a listener. Supported in remote mode only. For procedural information in this guide, see To Create a Transport.
create-virtual-serverCreates the specified virtual server element. Supported in remote mode only. For procedural information in this guide, see To Create a Virtual Server.
create-sslCreates 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-httpDeletes an existing HTTP configuration. Supported in remote mode only. For procedural information in this guide, see To Delete an HTTP Configuration.
delete-http-listenerDeletes the specified HTTP listener. Supported in remote mode only. For procedural information in this guide, see To Delete an HTTP Network Listener.
delete-network-listenerDeletes the specified HTTP listener. Supported in remote mode only. For procedural information in this guide, see To Delete an HTTP Network Listener.
delete-protocolDeletes and existing HTTP protocol. Supported in remote mode only. For procedural information in this guide, see To Delete a Protocol.
delete-sslDeletes 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-transportDeletes and existing HTTP transport. Supported in remote mode only. For procedural information in this guide, see To Delete a Transport.
delete-virtual-serverDeletes the specified virtual server element. Supported in remote mode only. For procedural information in this guide, see To Delete a Virtual Server.
list-http-listenersLists the existing HTTP listeners. Supported in remote mode only. For procedural information in this guide, see To List HTTP Network Listeners.
list-network-listenersLists the existing HTTP listeners. Supported in remote mode only. For procedural information in this guide, see To List HTTP Network Listeners.
list-protocolsLists the existing HTTP protocols. Supported in remote mode only. For procedural information in this guide, see To List Protocols.
list-transportsLists the existing HTTP transports. Supported in remote mode only. For procedural information in this guide, see To List Transports.
list-virtual-serversLists the existing virtual servers. Supported in remote mode only. For procedural information in this guide, see To List Virtual Servers.
create-javamail-resourceCreates a JavaMail session resource. Supported in remote mode only. For procedural information in this guide, see To Create a JavaMail Resource.
delete-javamail-resourceDeletes a JavaMail session resource. Supported in remote mode only. For procedural information in this guide, see To Delete a JavaMail Resource.
list-javamail-resourcesCreates JavaMail session resources. Supported in remote mode only. For procedural information in this guide, see To List JavaMail Resources.
create-jmsdestCreates 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-hostCreates 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-resourceCreates 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-jmsdestRemoves the specified JMS destination. Supported in remote mode only. For procedural information in this guide, see To Delete a JMS Physical Destination.
delete-jms-hostDeletes 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-resourceDeletes 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-jmsdestPurges 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-pingChecks 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-jmsdestLists the JMS physical destinations. Supported in remote mode only. For procedural information in this guide, see To List JMS Physical Destinations.
list-jms-hostsLists the existing JMS hosts. Supported in remote mode only. For procedural information in this guide, see To List JMS Hosts.
list-jms-resourcesLists 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-resourceCreates a custom JNDI resource. Supported in remote mode only. For procedural information in this guide, see To Create a Custom JNDI Resource.
create-jndi-resourceCreates an external JNDI resource. Supported in remote mode only. For procedural information in this guide, see To Register an External JNDI Resource.
delete-custom-resourceDeletes a custom JNDI resource. Supported in remote mode only. For procedural information in this guide, see To Delete a Custom JNDI Resource.
delete-jndi-resourceDeletes an external JNDI resource. Supported in remote mode only. For procedural information in this guide, see To Delete an External JNDI Resource.
list-custom-resourcesLists the existing custom JNDI resources. Supported in remote mode only. For procedural information in this guide, see To List Custom JNDI Resources.
list-jndi-entriesLists 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-resourcesLists the existing external JNDI resources. Supported in remote mode only. For procedural information in this guide, see To List External JNDI Resources.
create-jvm-optionsCreates 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-profilerCreates a profiler element. Supported in remote mode only. For procedural information in this guide, see To Create a Profiler.
delete-jvm-optionsDeletes 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-profilerDeletes the specified profiler element. Supported in remote mode only. For procedural information in this guide, see To Delete a Profiler.
generate-jvm-reportGenerates 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-optionsLists 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-moduleCreates 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-modulesLists life cycle modules. Supported in remote mode only. For procedural information in this guide, see To List Life Cycle Modules.
delete-lifecycle-moduleDeletes 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-filesCollects 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-monitoringDisables the monitoring service. Supported in remote mode only. For procedural information in this guide, see To Disable Monitoring.
enable-monitoringEnables the monitoring service. Supported in remote mode only. For procedural information in this guide, see To Enable Monitoring.
list-log-attributesLists log file attributes. Supported in remote mode only. For procedural information in this guide, see Configuring the Logging Service.
list-log-levelsLists the existing loggers. Supported in remote mode only. For procedural information in this guide, see To List Log Levels.
list-loggersLists 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.
monitorDisplays 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-logRotates 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-attributesSets log file attributes. Supported in remote mode only. For procedural information in this guide, see Configuring the Logging Service.
set-log-file-formatSets the formatter used to format log records in log files. For procedural information in this guide, see Setting the Log File Format.
set-log-levelsSets the log level for a module. Supported in remote mode only. For procedural information in this guide, see Setting Log Levels.
create-iiop-listenerCreates an IIOP listener. Supported in remote mode only. For procedural information in this guide, see To Create an IIOP Listener.
delete-iiop-listenerDeletes an IIOP listener. Supported in remote mode only. For procedural information in this guide, see To Delete an IIOP Listener.
list-iiop-listenersLists the existing IIOP listeners. Supported in remote mode only. For procedural information in this guide, see To List IIOP Listeners.
create-threadpoolCreates a new thread pool. Supported in remote mode only. For procedural information in this guide, see To Create a Thread Pool.
delete-threadpoolDeletes the specified thread pool. Supported in remote mode only. For procedural information in this guide, see To Delete a Thread Pool.
list-threadpoolsLists the existing thread pools. Supported in remote mode only. For procedural information in this guide, see To List Thread Pools.
freeze-transaction-serviceFreezes 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-transactionsManually recovers pending transactions. Supported in remote mode only. For procedural information, see To Manually Recover Transactions.
rollback-transactionRolls back the named transaction. Supported in remote mode only. For procedural information, see To Roll Back a Transaction.
unfreeze-transaction-serviceResumes 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 |
Copyright © 2019, Oracle and/or its affiliates. All rights reserved.
DRAFT