help(1)

NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO

NAME

help– displays the asadmin utility commands

SYNOPSIS

help [command_name]
command_name [––help | –?]

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 | -? or asadmin help command_name

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

add-resources

registers the resource in the specified XML file

backup-domain

performs a backup on the domain

change-admin-password

changes the administrator password

change-master-password

changes the master password

configure-webservice-management

sets the monitoring or maxhistory or attributes of a deployed webservice

create-admin-object

adds the administered object with the specified JNDI name

create-audit-module

creates an audit module for the optional plugin module

create-auth-realm

adds the named authorized realm

create-connector-connection-pool

adds a a new connector 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 named connector connection pool

create-custom-resource

registers the custom resource

create-domain

creates a domain with the specified name

create-file-user

creates a new file user

create-http-listener

adds a new HTTP listener socket

create-iiop-listener

adds the IIOP listener

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-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-management-rule

creates a new management rule

create-mbean

creates and registers a custom MBean

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-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-service

configures the starting of a DAS or node agent on an unattended boot

create-ssl

creates the SSL element in the HTTP listener or IIOP listener

create-threadpool

creates the thread pool

create-transformation-rule

creates transformation rule for a deployed web service

create-virtual-server

adds the named virtual server

delete-admin-object

removes the administered object with the specified JNDI name

delete-audit-module

deletes the audit-module for the optional plugin module

delete-auth-realm

removes the named authorized realm

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-listener

removes the HTTP listener

delete-iiop-listener

removes the IIOP listener

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-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-management-rule

deletes a specified management rule

delete-mbean

deletes a custom MBean

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-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-ssl

deletes the ssl element from the HTTP listener or IIOP listener

delete-threadpool

deletes the thread pool

delete-transformation-rule

deletes the transformation rule of a given web service

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 specified directory, located in the domain application server

disable

stops the specified, deployed component

display-error-distribution

displays distribution of errors from instance server.log at module level

display-error-statistics

displays a summary list of severities and warnings

display-log-records

displays all the error messages for a given module at a given timestamp

enable

runs the specified, deployed component

export

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

flush-jmsdest

purges the messages in a JMS destination

freeze-transaction-service

immobilizes the named transaction service

generate-diagnostic-report

generates reports that can help diagnose application server malfunctioning

generate-jvm-report

shows the threads, classes and memory for a given target instance

get-client-stubs

gets the stubs of the client

get

gets the values of the monitorable or configurable attributes

help

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

jms-ping

checks to see if the JMS provider is running

list-admin-objects

lists all the administered objects

list-audit-modules

lists the audit modules

list-auth-realms

lists the authorized realms

list-backups

lists all backups

list-components

lists deployed components

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-listeners

gets the HTTP listeners

list-iiop-listeners

gets the IIOP listeners

list-javamail-resources

gets all the Javamail resources

list-jdbc-connection-pools

registers the JDBC connection pool

list-jdbc-resources

lists all the JDBC resources

list-jms-resources

lists the JMS resources

list-jmsdest

gets all the named destinations

list-jndi-entries

gets all the named destinations ,browses and queries the JNDI tree

list-jndi-resources

gets all the JNDI resources

list-lifecycle-modules

gets the lifecycle modules

list-management-rules

lists the management rules created using the create-management-rule command

list-mbeans

lists the custom mbeans for a given target server instance

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-password-aliases

lists all password aliases

list-persistence-resources

gets all the persistence resources

list-registry-locations

returns list of configured web service registry access points

list-resource-adapter-configs

lists the resource adapters configured in an instance

list-sub-components

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

list-threadpools

lists the thread pools

list-timers

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

list-transformation-rules

lists all the transformation rules of a given webservice

list-virtual-servers

gets the virtual servers

list

lists the configurable elements and provides the fully qualified dotted names of the management components that have read-only or modifiable attributes

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

publish-to-registry

publishes all the web service artifacts to registries

recover-transactions

manually recovers pending transactions

restore-domain

restores files from backup

rollback-transaction

rolls back the named transaction

set

sets the values of attributes. Set command can be used to modify default properties of a resource.

show-component-status

displays the status of the deployed component

start-appserv

starts the domains in the specified domains directory

start-callflow-monitoring

provides the complete callflow/path of a request

start-database

starts the bundled Java DB database

start-domain

starts the given domain

stop-appserv

stops the domains in the specified domains directory

stop-callflow-monitoring

disables collection of callflow information of a request

stop-database

stops the bundled Java DB database

stop-domain

stops the given domain

undeploy

removes a component in the domain application server

unfreeze-transaction-service

mobilizes the named transaction service

unpublish-from-registry

unpublishes the web service artifacts from the registries

unset

removes one or more variables from the multimode environment

update-connector-security-map

creates or modifies a security map for the specified connector connection pool

update-file-user

updates a current file user as specified

update-password-alias

updates a password alias

verify-domain-xml

verifies the content of the domain.xml

version

displays the version information

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)

NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO