list-jms-resources :: Payara Enterprise Documentation

Lists the JMS resources.

Synopsis

asadmin [asadmin-options] list-jms-resources [--help]
[--restype type]
[target]

Description

The list-jms-resources subcommand lists the existing Java Message Service (JMS) resources (destination and connection factory resources).

This subcommand is supported in remote mode only. Remote asadmin subcommands require a running domain administration server (DAS).

Options

asadmin-options: Options for the asadmin utility. For information about these options, see the asadmin help page.
--help
-?: Displays the help text for the subcommand.
--restype: The JMS resource type can be jakarta.jms.Topic, jakarta.jms.Queue, jakarta.jms.ConnectionFactory, jakarta.jms.TopicConnectionFactory, or jakarta.jms.QueueConnectionFactory.

Operands

target

Restricts the listing to resources for a specified target. Valid values are as follows:

server: Lists the resources for the default server instance. This is the default value.
domain: Lists the resources for the domain.
cluster-name: Lists the resources for every server instance in the specified cluster.
instance-name: Lists the resources for the specified server instance.

Examples

Example 1 Listing all JMS resources

The following subcommand lists all JMS resources.

asadmin> list-jms-resources
jms/Queue
jms/ConnectionFactory
jms/DurableConnectionFactory
jms/Topic
Command list-jms-resources executed successfully.

Example 2 Listing JMS resources of a specified type

The following subcommand lists all jakarta.jms.ConnectionFactory resources.

asadmin> list-jms-resources --restype jakarta.jms.ConnectionFactory
jms/ConnectionFactory
jms/DurableConnectionFactory
Command list-jms-resources executed successfully.

Exit Status

0: subcommand executed successfully
1: error in executing the subcommand

See Also

Payara Platform