Sun Java System Application Server Platform Edition 8.1 2005Q2 Update 2 Reference Manual

## jms-ping(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXAMPLES | EXIT STATUS | SEE ALSO

#### NAME

jms-ping – checks to see if the JMS service is up and running

#### SYNOPSIS

`jms-ping` ––user admin_user [––passwordfile filename] [––host host_name] [––port port_number] [––secure|`–s`] [––terse=false] [––echo=false] [––interactive=true] [––help] [target]

#### DESCRIPTION

The `jms-ping` command checks to see if the JMS service (also known as the JMS provider) is up and running. When you start the Application Server, the JMS service starts by default.

The `jms-ping` command pings only the default JMS host within the JMS service. It throws an exception when it is unable to ping a built-in JMS service.

This command is supported in remote mode only.

#### OPTIONS

`–u` `––user`

  The authorized domain application server administrative username.

`–w` `––password`

  The `––password` option is deprecated. Use `––passwordfile` instead.

`––passwordfile`

  This option replaces the `–– password` option. Using the `––password` option on the command line or through the environment is deprecated. The `––passwordfile` option specifies the name of a file containing the password entries in a specified format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in capital letters. For example, to specify the domain application server password, use an entry with the following format: `AS_ADMIN_PASSWORD`=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, AS_ADMIN_SAVEDMASTERPASSWORD, AS_ADMIN_MQPASSWORD, AS_ADMIN_ALIASPASSWORD, and so on.

`–H` `––host`

  The machine name where the domain application server is running. The default value is localhost.

`–p` `––port`

  The port number of the domain application server listening for administration requests. The default port number for Platform Edition is 4848. The default port number for Enterprise Edition is 4849.

`–s` `––secure`

  If set to true, uses SSL/TLS to communicate with the domain application server.

`–t` `––terse`

  Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

`–e` `––echo`

  Setting to true will echo the command line statement on the standard output. Default is false.

`–I` `––interactive`

  If set to true (default), only the required password options are prompted.

`–h` `––help`

  Displays the help text for the command.

#### OPERANDS

target

  In Enterprise Edition, this operand specifies the target for which the operation is to be performed. Valid values are:

  - `server`, which pings the JMS service for the default server instance `server` and is the default value

  - configuration_name, which pings the JMS service for all clusters using the specified configuration

  - cluster_name, which pings the JMS service for the specified cluster

  - instance_name, which pings the JMS service for a particular server instance

#### EXAMPLES

##### Example 1 Using the jms-ping command

The following command checks to see if the JMS service is running on the server instance `server1`:

    asadmin> jms-ping --user admin
    --passwordfile passwords.txt --host bluestar --port 4848
    server1
    JMS Ping Status=RUNNING
    Command jms-ping executed successfully.

#### EXIT STATUS

0

  command executed successfully

1

  error in executing the command

#### SEE ALSO

create-jmsdest(1), create-jms-resource(1)

J2EE SDK 1.4 Last Revised 31 Jan 2005

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXAMPLES | EXIT STATUS | SEE ALSO

- © 2010, Oracle Corporation and/or its affiliates