Payara Platform

delete-node-ssh

Deletes a node that is enabled for communication over SSH.

Synopsis

asadmin [asadmin-options] delete-node-ssh [--help]
[--uninstall={false|true}] [--force={false|true}]
node-name

Description

The delete-node-ssh subcommand deletes a node that is enabled for communication over secure shell (SSH) from the domain. This subcommand does not require SSH to be configured.

This subcommand can delete only a node that is enabled for communication over SSH. The subcommand for deleting other types of nodes depends on the type of the node:

A node that is enabled for communication over the Distributed Component Object Model (DCOM) remote protocol must be deleted by using the delete-node-dcom subcommand.
A node that is not enabled for remote communication must be deleted by using the delete-node-config subcommand.

To determine whether a node is enabled for communication over SSH, use the list-nodes subcommand.

No Payara Server instances must reside on the node that is being deleted. Otherwise, the subcommand fails. Before running this subcommand, delete any instances that reside on the node by using, for example, the delete-instance subcommand or the delete-local-instance subcommand.

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.

--uninstall

Specifies whether the Payara Server software is uninstalled from host that the node represents.
Possible values are as follows:

false: The Payara Server software is not uninstalled from the host (default).
true: The Payara Server software is uninstalled from the host. By default, if any node except the predefined node localhost- domain resides on any host from which Payara Server software is being uninstalled, the subcommand fails. To uninstall the Payara Server software from a host on which user-defined nodes reside, set the --force option to true. If the --force option is true, the subcommand removes the entire content of the parent of the base installation directory.

--force

If --uninstall is true, specifies whether the subcommand uninstalls the Payara Server software from a host even if a user-defined node resides on the host. Possible values are as follows:

false: If a user-defined node resides on a host, the software is not uninstalled and the subcommand fails (default).
If the --force option is false, the subcommand removes only the Payara Server software files. Other content if the parent of the base installation directory, such as configuration files, are not removed.
true: The subcommand uninstalls the Payara Server software from the host even if a user-defined node resides on the host.
If the --force option is true, the subcommand removes the entire content of the parent of the base installation directory.

Operands

node-name: The name of the node to delete. The node must be enabled for communication over SSH. Otherwise, an error occurs.

Examples

Example 1 Deleting a Node That Is Enabled for Communication Over SSH

This example deletes the node eg1, which is enabled for communication over SSH.

asadmin> delete-node-ssh eg1
Command delete-node-ssh executed successfully.

Exit Status

0: command executed successfully
1: error in executing the command

See Also