Download this book in PDF (2568 KB)

Application Server 9.1 Section 1: Administration Commands

•   A
  • add-resources(1) – creates the resources specified in an XML file
  • apply-http-lb-changes(1) – applies load balancer configuration changes to the load balancer
  • asadmin(1) – wrapper utility for performing administrative tasks for the Sun Java System Application Server on Ubuntu Linux
•   B
  • backup-domain(1) – performs a backup on the domain
•   C
  • change-admin-password(1) – changes the administrator password
  • change-master-password(1) – changes the master password
  • clear-ha-store(1) – deletes tables in HADB
  • configure-ha-cluster(1) – configures an existing cluster to be highly available
  • configure-ha-persistence(1) – enables configuration of parameters related to session persistence
  • configure-lb-weight(1) – sets load balancing weights for clustered instances
  • configure-webservice-management(1) – sets the monitoring or maxhistorysize attributes of a deployed web service
  • copy-config(1) – copies an existing configuration to create a new configuration
  • create-admin-object(1) – adds the administered object with the specified JNDI name
  • create-application-ref(1) – creates a reference to an application
  • create-audit-module(1) – adds an audit-module
  • create-auth-realm(1) – adds the named authentication realm
  • create-cluster(1) – creates a cluster
  • create-connector-connection-pool(1) – adds a connection pool with the specified connection pool name
  • create-connector-resource(1) – registers the connector resource with the specified JNDI name
  • create-connector-security-map(1) – creates a security map for the specified connector connection pool
  • create-custom-resource(1) – creates a custom resouce
  • create-domain(1) – creates a domain with the given name
  • create-file-user(1) – creates a new file user
  • create-ha-store(1) – creates tables in the HADB that are used by HA the cluster
  • create-http-health-checker(1) – creates a health-checker for a specified load balancer configuration
  • create-http-lb(1) – creates a load balancer
  • create-http-lb-config(1) – creates a configuration for the load balancer
  • create-http-lb-ref(1) – adds an existing cluster or server instance to an existing load balancer configuration or load balancer
  • create-http-listener(1) – adds a new HTTP listener socket
  • create-iiop-listener(1) – adds an IIOP listener
  • create-instance(1) – creates an instance
  • create-javamail-resource(1) – creates a JavaMail session resource
  • create-jbi-application-configuration(1) – creates an application configuration for the specified component
  • create-jbi-application-variable(1) – creates the application variables for the specified component
  • create-jdbc-connection-pool(1) – registers the JDBC connection pool
  • create-jdbc-resource(1) – creates a JDBC resource with the specified JNDI name
  • create-jmsdest(1) – creates a JMS physical destination
  • create-jms-host(1) – creates a JMS host
  • create-jms-resource(1) – creates a JMS resource
  • create-jndi-resource(1) – registers a JNDI resource
  • create-jvm-options(1) – creates JVM options in the Java configuration or profiler element of the domain.xml file.
  • create-lifecycle-module(1) – adds a lifecycle module
  • create-management-rule(1) – creates a new management rule
  • create-mbean(1) – creates and registers a custom MBean
  • create-message-security-provider(1) – enables administrators to create the message-security-config and provider-config sub-elements for the security service in domain.xml
  • create-node-agent(1) – creates a node agent
  • create-node-agent-config(1) – adds a new unbound node agent to a domain
  • create-password-alias(1) – creates a password alias
  • create-persistence-resource(1) – registers a persistence resource
  • create-profiler(1) – creates the profiler element
  • create-resource-adapter-config(1) – creates the configuration information in domain.xml for the connector module
  • create-resource-ref(1) – creates a reference to a resource
  • create-service(1) – configures the starting of a DAS or node agent on an unattended boot.
  • create-ssl(1) – creates and configures the SSL element in the selected HTTP listener, IIOP listener, or IIOP service
  • create-system-properties(1) – adds or updates one or more system properties of the domain, configuration, cluster, or server instance
  • create-threadpool(1) – adds a threadpool
  • create-transformation-rule(1) – creates transformation rule for a deployed web service
  • create-virtual-server(1) – creates the named virtual server
•   D
  • delete-admin-object(1) – removes the administered object with the specified JNDI name.
  • delete-application-ref(1) – removes a reference to an application
  • delete-audit-module(1) – removes the named audit-module
  • delete-auth-realm(1) – removes the named authentication realm
  • delete-cluster(1) – deletes a cluster
  • delete-config(1) – deletes an existing configuration
  • delete-connector-connection-pool(1) – removes the specified connector connection pool
  • delete-connector-resource(1) – removes the connector resource with the specified JNDI name
  • delete-connector-security-map(1) – deletes a security map for the specified connector connection pool
  • delete-custom-resource(1) – removes a custom resource
  • delete-domain(1) – deletes the given domain
  • delete-file-user(1) – removes the named file user
  • delete-http-health-checker(1) – deletes the health-checker for a specified load balancer configuration
  • delete-http-lb(1) – deletes a load balancer
  • delete-http-lb-config(1) – deletes a load balancer configuration
  • delete-http-lb-ref(1) – deletes the cluster or server instance from a load balancer
  • delete-http-listener(1) – removes an HTTP listener
  • delete-iiop-listener(1) – removes an IIOP listener
  • delete-instance(1) – deletes the instance that is not running
  • delete-javamail-resource(1) – removes a JavaMail session resource
  • delete-jbi-application-configuration(1) – deletes the application configuration for the given component
  • delete-jbi-application-variable(1) – deletes the application variables for the given component
  • delete-jdbc-connection-pool(1) – removes the specified JDBC connection pool
  • delete-jdbc-resource(1) – removes a JDBC resource with the specified JNDI name
  • delete-jmsdest(1) – removes a JMS destination
  • delete-jms-host(1) – removes a JMS host
  • delete-jms-resource(1) – removes a JMS resource
  • delete-jndi-resource(1) – removes the JNDI resource with the specified JNDI name
  • delete-jvm-options(1) – removes JVM options from the Java configuration or profiler elements of the domain.xml file
  • delete-lifecycle-module(1) – removes the lifecycle module
  • delete-management-rule(1) – removes a specified management rule
  • delete-mbean(1) – deletes a custom MBean.
  • delete-message-security-provider(1) – enables administrators to delete a provider-config sub-element for the given message layer (message-security-config element of domain.xml)
  • delete-node-agent(1) – deletes the node agent and its associated directory structure
  • delete-node-agent-config(1) – removes a node agent from a domain
  • delete-password-alias(1) – deletes a password alias
  • delete-persistence-resource(1) – removes a persistence resource
  • delete-profiler(1) – removes the specified profiler element
  • delete-resource-adapter-config(1) – deletes the resource adapter configuration
  • delete-resource-ref(1) – removes a reference to a resource
  • delete-ssl(1) – deletes the SSL element in the selected HTTP listener, IIOP listener, or IIOP service
  • delete-system-property(1) – removes one system property of the domain, configuration, cluster, or server instance, at a time
  • delete-threadpool(1) – removes the named threadpool
  • delete-transformation-rule(1) – deletes the transformation rule of a given web service
  • delete-virtual-server(1) – removes a virtual server
  • deploy(1) – deploys the specified component
  • deploydir(1) – deploys an exploded format of application archive
  • deploy-jbi-service-assembly(1) – deploys a service assembly into the JBI environment
  • disable(1) – disables the component
  • disable-http-lb-application(1) – disables an application managed by a load balancer
  • disable-http-lb-server(1) – disables a sever or cluster managed by a load balancer
  • display-error-distribution(1) – displays distribution of errors from instance server.log at module level
  • display-error-statistics(1) – displays a summary of list of severities and warnings
  • display-license(1) – displays the license information
  • display-log-records(1) – displays all the error messages for a given module at a given timestamp
•   E
  • enable(1) – enables the component
  • enable-http-lb-application(1) – enables a previously-disabled application managed by a load balancer
  • enable-http-lb-server(1) – enables a previously disabled sever or cluster managed by a load balancer
  • export(1) – marks a variable name for automatic export to the environment of subsequent commands in multimode
  • export-http-lb-config(1) – exports the load balancer configuration or load balancer to a file
  • export-jbi-application-environment(1) – generates template files and places them in the specified configuration directory
•   F
  • flush-jmsdest(1) – purges messages in a JMS destination.
  • freeze-transaction-service(1) – freezes the transaction subsystem
•   G
  • generate-diagnostic-report(1) – generates reports that can help diagnose application server malfunctioning
  • generate-jvm-report(1) – shows the threads, classes and memory for a given target instance.
  • get(1) – gets the values of the monitorable or configurable attributes
  • get-client-stubs(1) – retreives the client stub JAR.
  • get-health(1) – provides information on the cluster health
•   H
  • help(1) – displays the asadmin utility commands
•   I
  • install-jbi-component(1) – installs a service engine or binding component into the JBI environment
  • install-jbi-shared-library(1) – installs a shared library into the JBI environment
  • install-license(1) – installs the license file
•   J
  • jms-ping(1) – checks if the JMS service is up and running
•   K
•   L
  • list(1) – lists the configurable elements
  • list-acls(1) – gets the access control lists
  • list-admin-objects(1) – gets all the administered objects
  • list-application-refs(1) – lists the existing application references
  • list-audit-modules(1) – gets all audit modules and displays them
  • list-auth-realms(1) – lists the authentication realms
  • list-backups(1) – lists all backups
  • list-clusters(1) – lists the existing clusters
  • list-components(1) – lists deployed components
  • list-configs(1) – lists all existing configurations
  • list-connector-connection-pools(1) – gets connector connection pools that have been created
  • list-connector-resources(1) – gets all connector resources
  • list-connector-security-maps(1) – lists the security maps belonging to the specified connector connection pool
  • list-custom-resources(1) – gets all custom resources
  • list-domains(1) – lists the domains in the specified domain directory
  • list-file-groups(1) – lists file groups
  • list-file-users(1) – lists the file users
  • list-http-lb-configs(1) – lists load balancer configurations
  • list-http-lbs(1) – lists load balancers
  • list-http-listeners(1) – lists the existing HTTP listeners
  • list-iiop-listeners(1) – lists the existing IIOP listeners
  • list-instances(1) – lists all the server instances while indicating if they are running or not.
  • list-javamail-resources(1) – lists the existing JavaMail session resources
  • list-jbi-application-configurations(1) – lists the application configurations for the specified component
  • list-jbi-application-variables(1) – lists the application variables for the given component
  • list-jbi-binding-components(1) – lists the binding components installed on the specified target
  • list-jbi-service-assemblies(1) – lists the service assemblies installed into the JBI environment
  • list-jbi-service-engines(1) – lists the service engines installed on the specified target
  • list-jbi-shared-libraries(1) – lists the JBI shared libraries that are installed into the JBI environment
  • list-jdbc-connection-pools(1) – lists all JDBC connection pools
  • list-jdbc-resources(1) – gets all JDBC resources
  • list-jmsdest(1) – lists the existing JMS physical destinations
  • list-jms-hosts(1) – lists the existing JMS hosts
  • list-jms-resources(1) – lists the JMS resources
  • list-jndi-entries(1) – browses and queries the JNDI tree
  • list-jndi-resources(1) – lists all existing JNDI resources
  • list-lifecycle-modules(1) – lists the lifecycle modules
  • list-management-rules(1) – lists the available management rules
  • list-mbeans(1) – lists the custom mbeans for a given target server instance.
  • list-message-security-providers(1) – enables administrators to list all security message providers (provider-config sub-elements) for the given message layer (message-security-config element of domain.xml)
  • list-node-agents(1) – lists the node agents along with their status
  • list-password-aliases(1) – lists all password aliases
  • list-persistence-resources(1) – gets all the persistence resources
  • list-registry-locations(1) – returns list of configured web service registry access points.
  • list-resource-adapter-configs(1) – lists the names of the resource—adapter—configs created.
  • list-resource-refs(1) – lists the existing resource references
  • list-sub-components(1) – lists EJBs or Servlets in deployed module or module of deployed application
  • list-system-properties(1) – lists the system properties of the domain, configuration, cluster, or server instance
  • list-threadpools(1) – lists all the threadpools
  • list-timers(1) – lists all of the timers owned by server instance(s)
  • list-transformation-rules(1) – lists all the transformation rules of a given webservice. If the webservice name option is omitted, then all the transformation rules will be listed.
  • list-virtual-servers(1) – lists the existing virtual servers
  • login(1) – lets you log in to a domain
•   M
  • migrate-timers(1) – moves a timer when a server instance stops
  • monitor(1) – displays monitoring data for commonly-used Application Server components
  • multimode(1) – allows you to execute multiple commands while preserving environment settings and remaining in the asadmin utility
•   N
•   O
•   P
  • ping-connection-pool(1) – tests if a connection pool is usable
  • publish-to-registry(1) – publishes all the web service artifacts to registries.
•   Q
•   R
  • recover-transactions(1) – manually recovers pending transactions
  • remove-ha-cluster(1) – returns an HA cluster to non-HA status
  • restore-domain(1) – restores files from backup
  • rollback-transaction(1) – rolls back the named transaction
•   S
  • set(1) – sets the values of attributes
  • set-jbi-component-configuration(1) – sets the component configuration values for the given component
  • set-jbi-component-logger(1) – sets the log levels for the specified JBI component
  • set-jbi-runtime-configuration(1) – sets the JBI runtime configuration levels
  • set-jbi-runtime-logger(1) – sets the log levels for a logger in the JBI runtime environment
  • show-component-status(1) – displays the status of the deployed component
  • show-jbi-application-configuration(1) – shows the information for the specific application configuration
  • show-jbi-binding-component(1) – shows detailed information about the specified binding component
  • show-jbi-runtime-configuration(1) – shows the runtime configuration
  • show-jbi-runtime-loggers(1) – shows the runtime loggers
  • show-jbi-service-assembly(1) – shows detailed information about a specified service assembly
  • show-jbi-service-engine(1) – shows detailed information about the specified service engine
  • show-jbi-shared-library(1) – shows detailed information about a specified shared library
  • show-jbi-statistics(1) – shows the JBI statistics filtered using the specified option values
  • shutdown(1) – brings down the administration server
  • shut-down-jbi-component(1) – shuts down a service engine or a binding component on the specified target
  • shut-down-jbi-service-assembly(1) – shuts down a JBI service assembly on the specified target
  • start-appserv(1) – starts the domains in the specified domains directory
  • start-callflow-monitoring(1) – provides the complete call flow/path of a request.
  • start-cluster(1) – starts a cluster
  • start-database(1) – starts the Java DB
  • start-domain(1) – starts a domain
  • start-instance(1) – starts a server instance
  • start-jbi-component(1) – starts a service engine or a binding component on the specified target
  • start-jbi-service-assembly(1) – starts a service assembly on the specified target
  • start-node-agent(1) – starts a node agent
  • stop-appserv(1) – stops the domains in the specified domains directory
  • stop-callflow-monitoring(1) – Disables collection of call flow information of a request.
  • stop-cluster(1) – stops a cluster
  • stop-database(1) – stops Java DB
  • stop-domain(1) – Stops the Domain Administration Server of the specified domain
  • stop-instance(1) – stops a server instance
  • stop-jbi-component(1) – stops a service engine or a binding component on the specified target
  • stop-jbi-service-assembly(1) – stops a service assembly on the specified target
  • stop-node-agent(1) – stops a node agent
•   T
•   U
  • undeploy(1) – removes a deployed component
  • undeploy-jbi-service-assembly(1) – undeploys a service assembly on the specified target
  • unfreeze-transaction-service(1) – resumes all suspended transactions
  • uninstall-jbi-component(1) – uninstalls a service engine or binding component on the specified target
  • uninstall-jbi-shared-library(1) – uninstalls a shared library on the specified target
  • unpublish-from-registry(1) – unpublishes the web service artifacts from the registries
  • unset(1) – removes one or more variables from the multimode environment
  • update-connector-security-map(1) – creates or modifies a security map for the specified connector connection pool
  • update-file-user(1) – updates a current file user as specified
  • update-jbi-application-configuration(1) – updates the application configuration for the specified component
  • update-jbi-application-variable(1) – updates the application variables for the specified component
  • update-password-alias(1) – updates a password alias
  • upgrade-jbi-component(1) – upgrades a service engine or binding component
•   V
  • verify-domain-xml(1) – verifies the content of the domain.xml file
  • verify-jbi-application-environment(1) – verifies that all configurations needed by an application can be resolved during deployment
  • version(1) – displays the version information
•   W
•   X
•   Y
•   Z