2.6.17 list-instances

Synopsis

asadmin [asadmin-options] list-instances [--help]
    [--timeoutmsec timeout]
    [--long={false|true} | --nostatus={false|true}]
    [--standaloneonly={false|true} | target]

Storage location

Application Server installation directory/javaee/glassfish/bin

Function

The list-instances subcommand lists server instances in a domain. The list can be filtered by cluster, instance, node, or configuration.

The subcommand displays every server instance in the specified target, regardless of how each instance was created. This subcommand is supported in remote mode only.

Precondition

Domain Administration Server (DAS) is running.

Arguments

--help | -?

Displays the help text for the subcommand.

--timeoutmsec timeout

Specifies the time limit in milliseconds for determining the status of instances. The default is 60,000, which is equivalent to 60 seconds.

Type: Integer

The following values can be specified:

• -2147483648 to 2147483647

Default value: 60000 milliseconds

--long={false|true} | -l={false|true}

Specifies whether detailed information is displayed for each instance that is listed.

The --long option and --nostatus option are mutually exclusive. If both options are specified in the same command, an error occurs.

Type: Boolean

The following values can be specified:

• true

  The following details are displayed for each instance that is listed:

  The name of the instance

  The name of the host where the instance's node resides

  The HTTP port on which the instance listens for administration requests

  The process identifier (PID) of the instance process or -1 if the instance is not running

  The name of the cluster of which the instance is a member, if any

  The state of the instance, which is running or not running

  When an instance is listed, some configuration changes in the domain administration server (DAS) for the instance might not have been applied to the instance itself. In this situation, the commands that are required to apply the changes are listed adjacent to the state of the instance. The maximum number of commands that are listed for an instance is 10.

• false

  Only the name of the instance and an indication of whether the instance is running are displayed (default). The length of time that the instance has been running is not displayed.

Default value: false

--nostatus={false|true}

Specifies whether information about whether instances are running is suppressed.

The --long option and --nostatus option are mutually exclusive. If both options are specified in the same command, an error occurs.

Type: Boolean

The following values can be specified:

• true

  Information about whether instances are running is suppressed. Only the name of each instance is displayed.

• false

  Information about whether instances are running is displayed. This is the default value.

Default value: false

--standaloneonly={false|true}

Specifies whether only standalone instances are listed.

The --standaloneonly option and the target operand and are mutually exclusive. If both the --standaloneonly option and the target operand are specified in the same command, an error occurs.

Type: Boolean

The following values can be specified:

• true

  Only standalone instances are listed.

• false

  All instances in the specified target are listed. This is the default value.

Default value: false

target

Filters the list of server instances by specifying the target for which instances are listed.

The target operand and the --standaloneonly option are mutually exclusive. If both the target operand and the --standaloneonly option are specified in the same command, an error occurs.

Type: String

The following values can be specified:

• domain

  Lists all instances in the domain (default).

• cluster-name

  Lists the instances that are members of the specified cluster.

• instance-name

  Lists only the specified instance.

• node-name

  Lists the instances that reside on the specified node.

• configuration-name

  Lists all instances whose configuration is defined by the specified named configuration.

Default value: domain

asadmin list-instances --long=true

Exit Status

Exit Status	Explanation
0	subcommand executed successfully.
1	error in executing the subcommand.