list-nodes-ssh

lists all Payara Server nodes that support communication over SSH in a domain.

Synopsis

asadmin [asadmin-options] list-nodes-ssh [--help]
[--long={false|true}]

Description

The list-nodes-ssh subcommand lists all Payara Server nodes that support communication over secure shell (SSH) in a domain.

To list all nodes in a domain regardless of the type of the node, run the list-nodes subcommand.

By default, the subcommand displays the following information for each node that is listed:

  • The name of the node

  • The type of the node, which is SSH

  • The name of the host that the node represents

The --long option of the subcommand specifies whether the nodes are listed in long format. In long format, the following additional information about each node is displayed:

  • The path to the parent of the base installation directory of Payara Server on the host that the node represents

  • A comma-separated list of the names of the Payara Server instances that reside on the node

If the --terse option of the asadmin utility is true and the --long option of the subcommand is false, the subcommand lists only the name of each node.

This subcommand is supported in remote mode only.

Options

asadmin-options

Options for the asadmin utility. For information about these options, see the asadmin help page.

--help
-?

Displays the help text for the subcommand.

--long
-l

Specifies whether the nodes are listed in long format.
Possible values are as follows:

true

The nodes are listed in long format.

false

The nodes are listed in short format (default).

Examples

Example 1 Listing Payara Server Nodes

This example displays the name, type, and host for all Payara Server nodes that support communication over SSH in a domain.

asadmin> list-nodes-ssh
sj02  SSH  sj02.example.com
sj01  SSH  sj01.example.com
Command list-nodes-ssh executed successfully.

Example 2 Listing Only the Names of Payara Server Nodes

This example uses the --terse option of the asadmin utility to list only the names of the Payara Server nodes that support communication over SSH in a domain.

asadmin> list-nodes-ssh --terse=true
sj02
sj01

Example 3 Listing Payara Server Nodes in Long Format

This example lists the Payara Server nodes that support communication over SSH in a domain in long format.

asadmin> list-nodes-ssh --long=true
NODE NAME   TYPE   NODE HOST          INSTALL DIRECTORY    REFERENCED BY
sj02        SSH    sj02.example.com   /export/payara6   pmd-i-sj02, yml-i-sj02
sj01        SSH    sj01.example.com   /export/payara6   pmd-i-sj01, yml-i-sj01
Command list-nodes-ssh executed successfully.

Exit Status

0

command executed successfully

1

error in executing the command

See Also