2.5.11 update-node-ssh

Synopsis

asadmin [asadmin-options] update-node-ssh [--help]
    [--nodehost node-host] [--installdir as-install-parent]
    [--nodedir node-dir] [--sshport ssh-port]
    [--sshuser ssh-user] [--sshkeyfile ssh-keyfile]
    [--force={false|true}] node-name

Storage location

Application Server installation directory/javaee/glassfish/bin

Function

The update-node-ssh subcommand of asadmin updates the configuration data of a node. This subcommand requires secure shell (SSH) to be configured on the machine where the domain administration server (DAS) is running and on the machine where the node resides. You may run this subcommand from any machine that can contact the DAS. This subcommand can update any node, regardless of whether the node is enabled for remote communication. If the node is not enabled for remote communication, the subcommand enables SSH communication for the node and updates any other specified configuration data. If this subcommand is run to enable SSH communication for a node, default values are applied if --sshport, --sshuser or --sshkeyfile is omitted. This subcommand is supported in remote mode only.

Precondition

• SSH is configured on the host where the DAS is running and on the host that the node represents.

• The node that you are updating exists.

• Domain Administration Server (DAS) is running.

Arguments

--help | -?

Displays the help text for the subcommand.

--nodehost node-host

Specifies the name of the host that the node is to represent after the node is updated.

Type: String

The following values can be specified:

• Host name

Default value: N/A

--installdir as-install-parent

Specifies the full path to Application Server installation directory/javaee.

Type: String

The following values can be specified:

• The full path to Application Server installation directory/javaee

Default value: N/A

--nodedir node-dir

Specifies the path to the directory that is to contain server instances that are created on the node. If a relative path is specified, the path is relative to the Application Server installation directory/javaee/glassfish directory, where Application Server installation directory/javaee/glassfish is the base installation directory of Application Server software on the host.

Type: String

The following values can be specified:

• Path to the directory containing the server instances of the node

Default value: N/A

--sshport ssh-port

Specifies the port to use for SSH connections to this node's host.

The default depends on whether this subcommand is run to enable SSH communication for the node:

• If the node is already enabled for communication over SSH, the default is to leave the port unchanged.

• If this subcommand is run to enable SSH communication for the node, the default port is 22. If the --nodehost is set to localhost, the --sshport option is ignored.

Type: Integer

The following values can be specified:

• 1 to 65535

Default value: 22

--sshuser ssh-user

Specifies the user on this node's host that is to run the process for connecting to the host, through SSH.

The default depends on whether this subcommand is run to enable SSH communication for the node:

• If the node is already enabled for communication over SSH, the default is to leave the user unchanged.

• If this subcommand is run to enable SSH communication for the node, the default is the user that is running the DAS process. If the --nodehost option is set to localhost, the --sshuser option is ignored.

Type: String

The following values can be specified:

• User name

Default value: User running the DAS process

--sshkeyfile ssh-keyfile

Specifies the absolute path to the SSH private key file for the user that the --sshuser option specifies. This file is used for authentication to the sshd daemon on the node's host.

If the SSH private key file is protected by a passphrase, the password file must contain the AS_ADMIN_SSHKEYPASSPHRASE entry. The path to the key file must be reachable by the DAS and the key file must be readable by the DAS. The default depends on whether this subcommand is run to enable SSH communication for the node:

• If the node is already enabled for communication over SSH, the default is to leave the key file unchanged.

• If this subcommand is run to enable SSH communication for the node, the default is the key file in the user's .ssh directory. If multiple key files are found, the subcommand uses the following order of id_rsa, id_dsa, identity.

Type: String

The following values can be specified:

• Path to the directory containing SSH private key file for user

Default value: Key file in the user's .ssh directory if subcommand is run to enable SSH communication.

--force={false|true}

Specifies whether the node is updated even if validation of the node's parameters fails. To validate a node's parameters, the DAS must be able to contact the node's host through SSH.

Type: Boolean

The following values can be specified:

• false

  The node is not updated if validation of the node's parameters fails. This is the default value.

• true

  The node is updated even if validation of the node's parameters fails.

Default value: false

node-name

Specifies the name of the node to update.

Type: String

The following values can be specified:

• Node name

Default value: N/A

Exit Status