list-instances

Syntax

tadm list-instances common_options [--all] ( --config=name | --node=name )

Description

Use this command to list all instances.

  • If you specify the configuration name, the command lists all nodes on which the configuration is deployed.

  • If you specify the node, the command lists all configurations deployed on that node.

Note:

If a node is service-enabled, then list-instances will list service-name of the service corresponding to the instance of that node. Note that for service-name to appear, you must run list-instances with the --all option.

Options

For information about common_options, run the help command.

--node|-n

Specify the host name of the node for which you want to list the configurations.

--all|-l

If you specify this option, the command displays instance status and if the instance has service for each instance in the configuration.

--config|-c

Specify the name of the configuration for which you want to list the nodes.

Example

tadm list-instances --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt 
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-instance, delete-instance, start-instance, stop-instance, restart-instance, reconfig-instance, list-nodes, remove-node