Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Reference Manual

## help(1)

NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO

#### NAME

help– displays the asadmin utility commands

#### SYNOPSIS

`help` [or ––help | `-h |` `-?`]

#### DESCRIPTION

The help command displays a list of all the `asadmin` utility commands. Specify the command to display the usage information for that command. To display the manpage of each command, use the syntax: `asadmin` command_name ––help | `-h |` `-?`or `asadmin help` command_name

The following is a list of all the `asadmin` utility commands:

add-resources

  registers the resource in the XML file specified

backup-domain

  performs a backup on the domain

change-master-password

  changes the master password

clear-ha-store

  deletes tables in the HA database

configure-ha-cluster

  configures an existing cluster to be High Availability

configure-ha-persistence

  enables configuration of parameters related to session persistence

copy-config

  copies an existing configuration to create a new configuration

create-admin-object

  adds the administered object with the specified JNDI name

create-application-ref

  creates a reference to an application

create-audit-module

  creates an audit module for the optional plugin module

create-auth-realm

  adds the new authorized realm

create-cluster

  creates a cluster

create-connector-connection-pool

  adds a connection pool with the specified connection pool name

create-connector-resource

  registers the resource with the specified JNDI name

create-connector-security-map

  creates or modifies a security map for the namedconnector connection pool

create-custom-resource

  registers the custom resource

create-domain

  creates a domain with the given name

create-file-user

  creates a new file user

create-ha-store

  creates tables in HA database that are used by HA cluster

create-http-health-checker

  creates a health-checker for a specified load balancer configuration

create-http-lb-config

  creates a configuration for the load balancer

create-http-lb-ref

  add an existing cluster or server instance to an existing load balancer configuration

create-http-listener

  adds a new HTTP listener socket

create-iiop-listener

  adds the IIOP listener

create-instance

  creates an instance with the given name

create-javamail-resource

  registers the Javamail resource

create-jdbc-connection-pool

  registers the JDBC connection pool

create-jdbc-resource

  registers the JDBC resource

create-jms-host

  creates a JMS host

create-jms-resource

  registers the JMS resource

create-jmsdest

  adds the named destination

create-jndi-resource

  registers the JNDI resource

create-jvm-options

  creates the JVM options from the Java configuration or profiler elements

create-lifecycle-module

  adds a lifecycle module

create-message-security-provider

  enables administrators to create the message-security-config and provider-config sub-elements for the security service in `domain.xml`

create-node-agent

  creates a node agent and its associated directory structure

create-node-agent-config

  adds a new unbound node agent to a domain

create-password-alias

  creates a password alias

create-persistence-resource

  registers the persistence resource

create-profiler

  creates the profiler element

create-resource-adapter-config

  creates the resource adapter Java bean

create-resource-ref

  creates a reference to a resource

create-ssl

  creates the SSL element in the HTTP listener or IIOP listener

create-system-properties

  adds or updates one or more system properties of the domain, configuration, cluster, or server instance

create-threadpool

  creates the thread pool

create-virtual-server

  adds the named virtual server

delete-admin-object

  removes the administered object with the specified JNDI name

delete-application-ref

  removes a reference to an application

delete-audit-module

  deletes the audit-module for the optional plugin module

delete-auth-realm

  removes the named authorized realm

delete-cluster

  deletes a cluster

delete-config

  deletes an existing configuration

delete-connector-connection-pool

  removes the specified connection pool

delete-connector-resource

  removes the named resource connector

delete-connector-security-map

  deletes the named security map

delete-custom-resource

  removes the custom resource

delete-domain

  deletes the given domain

delete-file-user

  removes the named file user

delete-http-health-checker

  deletes a health-checker for a specified load balancer configuration

delete-http-lb-config

  deletes a load balancer configuration

delete-http-lb-ref

  deletes the cluster or server instance from a load balancer configuration

delete-iiop-listener

  removes the IIOP listener

delete-instance

  deletes the instance that is not running

delete-javamail-resource

  removes the Javamail resource

delete-jdbc-connection-pool

  removes the JDBC connection pool

delete-jdbc-resource

  removes the JDBC resource

delete-jms-host

  removes a JMS host

delete-jms-resource

  removes the JMS resource

delete-jmsdest

  destroys the named destination

delete-jndi-resource

  removes the JNDI resource

delete-jvm-options

  deletes the JVM options from the Java configuration or profiler elements

delete-lifecycle-module

  removes the lifecycle module

delete-message-security-provider

  enables administrators to delete a provider-config sub-element for the given message layer (message-security-config element of `domain.xml`)

delete-node-agent

  deletes the node agent and its associated directory structure

delete-node-agent-config

  removes a node agent from a domain

delete-password-alias

  deletes a password alias

delete-persistence-resource

  removes the persistence resource

delete-profiler

  deletes the profiler element

delete-resource-adapter-config

  deletes the resource adapter Java bean

delete-resource-ref

  removes a reference to a resource

delete-ssl

  deletes the ssl element from the HTTP listener or IIOP listener

delete-system-property

  removes one or more system properties of the domain, configuration, cluster, or server instance

delete-threadpool

  deletes the thread pool

delete-virtual-server

  deletes the virtual server with the named virtual server ID

deploy

  deploys the specified component

deploydir

  deploys the component that is in the directory located on domain application server

disable

  stops the component

disable-http-lb-application

  disables an application managed by a load balancer

disable-http-lb-server

  disables a sever or cluster managed by a load balancer

enable

  runs the component

enable-http-lb-application

  enables a previously-disabled application managed by a load balancer

enable-http-lb-server

  enables a previously disabled sever or cluster managed by a load balancer

export

  marks a variable name for automatic export to the environment of subsequent commands in multimode

export-http-lb-config

  exports the load balancer configuration to a file that can be used by the load balancer

freeze-transaction-service

  immobilizes the named transaction service

get

  gets the values of the monitorable or configurable attributes

get-client-stubs

  gets the stubs of the client

help

  displays a list of all the commands available in the Command-line interface

jms-ping

  checks to see if the JMS provider is up and running

list

  lists the configurable elements

list-admin-objects

  gets all the administered objects

list-application-refs

  lists all application references in a cluster or unclustered server instance

list-audit-modules

  lists the audit modules

list-auth-realms

  lists the authorized realms

list-backups

  lists all backups and restores

list-clusters

  lists the existing clusters

list-configs

  lists all existing configurations

list-connector-connection-pools

  gets all the connection pools

list-connector-resources

  gets all the connector resources

list-connector-security-maps

  lists the security maps for the connector connection pool

list-custom-resources

  gets all the custom resources

list-domains

  lists the domains in the given domains directory

list-file-groups

  lists the file groups

list-file-users

  lists the file users

list-http-lb-configs

  lists load balancer configurations

list-http-listeners

  gets the HTTP listeners

list-iiop-listeners

  gets the IIOP listeners

list-instances

  lists all the instances in the server

list-javamail-resources

  gets all the Javamail resources

list-jdbc-connection-pools

  registers the JDBC connection pool

list-jdbc-resources

  gets all the JDBC resources

list-jms-hosts

  lists the existing JMS hosts

list-jms-resources

  gets all the JMS resources

list-jmsdest

  gets all the named destinations

list-jndi-entries

  gets all the named destinationsbrowses and queries the JNDI tree

list-jndi-resources

  gets all the JNDI resources

list-lifecycle-modules

  gets the lifecycle modules

list-message-security-providers

  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

  lists the node agents along with their status

list-password-aliases

  lists all password aliases

list-persistence-resources

  gets all the persistence resources

list-resource-adapter-configs

  lists the resource adapters configured in an instance

list-resource-refs

  lists the existing resource references

list-sub-components

  lists EJBs or Servlets in a deployed module or in a module of a deployed application

list-system-properties

  lists the system properties of the domain, configuration, cluster, or server instance

list-threadpools

  lists the thread pools

list-timers

  lists all of the timers owned by server instance(s)

list-virtual-servers

  gets the virtual servers

migrate-timers

  moves a timer when a server instance stops

multimode

  allows you to execute multiple commands while returning environment settings and remaining in the `asadmin` utility

ping-connection-pool

  tests if a connection pool is usable

recover-transactions

  manually recovers pending transactions

rollback-transaction

  rollsback the named transaction

remove-ha-cluster

  returns an HA cluster to non-HA status

restore-domain

  restores files from backup

set

  sets the values of attributes

show-component-status

  displays the status of the deployed component

start-cluster

  starts a cluster

start-domain

  starts the given domain

start-instance

  starts a server instance

start-node-agent

  starts a node agent

stop-cluster

  stops a cluster

stop-domain

  stops the given domain

stop-instance

  stops a server instance

stop-node-agent

  stops a node agent

undeploy

  removes a component in the domain application server

unfreeze-transaction-service

  mobilizes the named transaction service

unset

  removes one or more variables from the multimode environment

update-file-user

  updates a current file user as specified

update-password-alias

  updates a password alias

update-connector-security-map

  updates the security map for the specified connector connection pool

verify-domain-xml

  verifies the content of the `domain.xml`

version

  displays the version information

The following commands are deprecated:

1. display-license

2. install-license

3. restart-instance

4. shutdown

5. create-acl

6. delete-acl

7. list-acls

8. start-appserv

9. stop-appserv

#### EXAMPLES

##### Example 1 Using help

    asadmin> help
    asadmin> create-domain --help

Where: `create-domain` is the command you wish to view the usage for.

#### SEE ALSO

asadmin(1)

J2EE SDK 1.4 Last Revised 31 Jan 2005

NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO

- © 2010, Oracle Corporation and/or its affiliates