16 Command Line Reference

-secure

Use secure connection to broker with ssladmin connection service

-u userName

User name for authentication

If this option is omitted, the Command utility will prompt for it interactively.

-passfile path

Location of password file

See Password Files for more information.

-D

Set connection-related system property that affects how imqcmd creates a connection to the broker. Not used to set broker configuration properties.

Usually overrides connection factory attributes for imqcmd client runtime. For example, the option in the following command changes the default value of imqSSLIsTrusted:

imqcmd list svc -secure -DimqSSLIsTrusted=true

-rtm timeoutInterval

Initial timeout interval, in seconds

This is the initial length of time that the Command utility will wait for a reply from the broker before retrying a request. Each subsequent retry will use a timeout interval that is a multiple of this initial interval.

Default value: 10.

-rtr numRetries

Number of retries to attempt after a broker request times out

Default value: 5.

-javahome path

Location of alternative Java runtime

Default behavior: Use runtime installed on system or bundled with Message Queue.

-f

Perform action without user confirmation

-s

Silent mode (no output displayed)

-v

Display version information^{Foot 1 ,Foot 2} 

-h

Display usage help^{Footref 1,Footref 2}

-H

Display expanded usage help, including attribute list and examples^{Footref 1,Footref 2}

shutdown bkr [-b hostName:portNumber]
 [-time nSeconds]
 [-nofailover]

Shut down broker

The -time option specifies the interval, in seconds, to wait before shutting down the broker. (The broker will not block, but will return immediately from the delayed shutdown request.) During the shutdown interval, the broker will not accept any new jms connections; admin connections will be accepted, and existing jms connections will continue to operate. A broker belonging to an enhanced cluster will not attempt to take over for any other broker during the shutdown interval.

The -nofailover option indicates that no other broker is to take over the persistent data of the one being shut down. ^Foot 1 

restart bkr [-b hostName:portNumber]

Restart broker

Shuts down the broker and then restarts it using the same options specified when it was originally started.

pause bkr [-b hostName:portNumber]

Pause broker

See Pausing and Resuming a Broker for more information.

quiesce bkr [-b hostName:portNumber]

Quiesce broker

The broker will stop accepting new connections; existing connections will continue to operate.

unquiesce bkr [-b hostName:portNumber]

Unquiesce broker

The broker will resume accepting new connections, returning to normal operation.

resume bkr [-b hostName:portNumber]

Resume broker

takeover bkr 
 -n brokerID
 [-f]

Initiate broker takeover ^Footref 1

Before taking over a broker, you should first shut it down manually using the shutdown bkr subcommand with the -nofailover option. If the specified broker appears to be still running, takeover bkr will display a confirmation message (Do you want to take over for this broker?). The -f option suppresses this message and initiates the takeover unconditionally.

Note: The takeover bkr subcommand is intended only for use in failed-takeover situations. You should use it only as a last resort, and not as a general way of forcibly taking over a running broker.

update bkr [-b hostName:portNumber]
 -o property1=value1
 [-o property2=value2]...

Set broker properties

See Broker Properties Reference for information on broker properties.

query bkr
 -b hostName:portNumber

List broker property values

For brokers belonging to a cluster, also lists cluster properties such as broker list, master broker (for conventional clusters), and cluster identifier (for enhanced clusters).

list bkr

List brokers in cluster

metrics bkr [-b hostName:portNumber]
 [-m metricType]
 [-int interval]
 [-msp numSamples]

Display broker metrics

The -m option specifies the type of metrics to display:

• ttl: Messages and packets flowing into and out of the broker

• rts: Rate of flow of messages and packets into and out of the broker per second

• cxn: Connections, virtual memory heap, and threads

Default value: ttl.

The -int option specifies the interval, in seconds, at which to display metrics. Default value: 5.

The -msp option specifies the number of samples to display. Default value: Unlimited (infinite).

reload cls

Reload cluster configuration^Footref 1

Forces all persistent information to be brought up to date.

changemaster cls
 -o imq.cluster.masterbroker=newMaster

Change the master broker in a conventional cluster with master broker.

This command must be run on the current master broker.

The value newMaster has the form hostName:portNumber, where hostName and portNumber are is its Port Mapper host name and port number, respectively.

Literal IP addresses as host names: You can use a literal IPv4 or IPv6 address as a host name. If you use a literal IPv6 address, its format must conform to RFC2732, Format for Literal IPv6 Addresses in URL's.

pause svc -n serviceName
 [-bhostName:portNumber]

Pause connection service

The admin connection service cannot be paused.

resume svc -n serviceName
 [-b hostName:portNumber]

Resume connection service

update svc -n serviceName
 [-b hostName:portNumber]
 -o property1=value1
 [-o property2=value2]...

Set connection service properties

See Connection Properties for information on connection service properties.

list svc
 [-b hostName:portNumber]

List connection services available on broker

query svc -n serviceName
 [-bhostName:portNumber]

List connection service property values

metrics svc -n serviceName
 [-bhostName:portNumber]
 [-mmetricType]
 [-intinterval]
 [-mspnumSamples]

Display connection service metrics

The -m option specifies the type of metrics to display:

• ttl: Messages and packets flowing into and out of the broker by way of the specified connection service

• rts: Rate of flow of messages and packets into and out of the broker per second by way of the specified connection service

• cxn: Connections, virtual memory heap, and threads

Default value: ttl.

The -int option specifies the interval, in seconds, at which to display metrics. Default value: 5.

The -msp option specifies the number of samples to display. Default value: Unlimited (infinite).

list cxn [-svn serviceName]
 [-b hostName:portNumber]

List connections on broker

Lists all connections on the broker to the specified connection service. If no connection service is specified, all connections are listed.

query cxn -n connectionID
 [-b hostName:portNumber]

Display connection information

destroy cxn -n connectionID
 [-b hostName:portNumber]

Destroy connection

create dst -t destType -n destName
 [-o property=value]...

Create physical destination^Foot 1 

The destination name destName may contain only alphanumeric characters (no spaces) and must begin with an alphabetic character or the underscore (_) or dollar sign ($) character. It may not begin with the characters mq.

destroy dst -t destType -n destName

Destroy physical destination^Footref 1

This operation cannot be applied to a system-created destination, such as a dead message queue.

pause dst [-t destType -n destName]
 [-pst pauseType]

Pause message delivery for physical destination

Pauses message delivery for the physical destination specified by the -t and -n options. If these options are not specified, all destinations are paused.

The -pst option specifies the type of message delivery to be paused:

• PRODUCERS: Pause delivery from message producers

• CONSUMERS: Pause delivery to message consumers

• ALL: Pause all message delivery

Default value: ALL

resume dst [-t destType -n destName]

Resume message delivery for physical destination

Resumes message delivery for the physical destination specified by the -t and -n options. If these options are not specified, all destinations are resumed.

purge dst -t destType -n destName

Purge all messages from physical destination

compact dst [-t destType -n destName]

Compact physical destination

Compacts the file-based persistent data store for the physical destination specified by the -t and -n options. If these options are not specified, all destinations are compacted.

A destination must be paused before it can be compacted.

update dst -t destType -n destName
 -o property1=value1
 [-o property2=value2]...

Set physical destination properties

See Physical Destination Property Reference for information on physical destination properties.

list dst [-tdestType]
 [-tmp]

List physical destinations

Lists all physical destinations of the type specified by the -t option. If no destination type is specified, both queue and topic destinations are listed. If the -tmp option is specified, temporary destinations are listed as well.

query dst -t destType -n destName

List physical destination property values

metrics dst -t destType -n destName
 [-m metricType]
 [-int interval]
 [-msp numSamples]

Display physical destination metrics

The -m option specifies the type of metrics to display:

• ttl: Messages and packets flowing into and out of the destination and residing in memory

• rts: Rate of flow of messages and packets into and out of the destination per second, along with other rate information

• con: Metrics related to message consumers

• dsk: Disk usage

Default value: ttl.

The -int option specifies the interval, in seconds, at which to display metrics. Default value: 5.

The -msp option specifies the number of samples to display. Default value: Unlimited (infinite).

destroy dur -n subscriberName -c clientID

Destroy durable subscription^Foot 1 

purge dur -n subscriberName -c clientID

Purge all messages for durable subscription

list dur [-d topicName]

List durable subscriptions for the specified topic. If -d option is omitted then the command lists all durable subscriptions for all topics.

commit txn -n transactionID

Commit transaction

rollback txn -n transactionID

Roll back transaction

list txn

List transactions being tracked by broker

query txn -n transactionID

Display transaction information

list jmx

List JMX service URLs of JMX connectors