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

NAME

 list-instances - lists all the instances along with their status

SYNOPSIS

 list-instances --user admin_user [--passwordfile filename] [--host host_name] [--port port_number] [--secure|-s] [--terse=false] [--echo=false] [--interactive=true] [--help] [target]

DESCRIPTION

Use the list-instances to list all the instance in the server. The list-instances command can be run both locally and remotely. To list remote instances, the named administration server must be running on the hostname and port number specified. The user authenticates using the password identified for the administration server.

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

This is the name of the target domain the instances you want listed are associated with.

EXAMPLES

Example 1. Using list-instances in local mode

asadmin> list-instances --user admin --passwordfile passwords.txt instance1
Command list-instances executed successfully

Where: instance1 is listed.

Example 2. Using list-instances in remote mode

asadmin> list-instances --user admin --passwordfile passwords.txt 
--host pigeon --port 4849
remote_instance1 running
Command list-instances executed successfully

Where: remote-instance1 associates with user, passwordfile, host, and port of the remote machine.

EXIT STATUS

0

command executed successfully

1

error in executing the command

SEE ALSO

create-instance(1)