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

NAME

 list-clusters - lists the existing clusters

SYNOPSIS

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

DESCRIPTION

The list-clusters command lists the existing clusters.

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 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

Specifies the target for which the clusters are to be listed. Valid values are:

• domain, which lists all clusters in the domain and is the default value

• cluster_name, which lists the named cluster

• instance_name, which lists the cluster associated with the clustered server instance. Unlike many of the other uses of instance_name, this is one situation where an unclustered instance cannot be specified.

• node_agent_name, which lists all clusters associated with the named node agent. For example, if agent1 manages server1 and server2, which are part of cluster1 and cluster2, then cluster1 and cluster2 will be listed.

EXAMPLES

Example 1. Using the list-clusters command

The following command lists all clusters in the current domain.

asadmin> list-clusters --user admin1 
--passwordfile passwords.txt 
MyCluster not running
Command list-clusters executed successfully.

EXIT STATUS

0

command executed successfully

1

error in executing the command

SEE ALSO

create-cluster(1), delete-cluster(1), start-cluster(1), stop-cluster(1)