| type=page | |
| status=published | |
| title=ping-node-ssh | |
| next=recover-transactions.html | |
| prev=ping-node-dcom.html | |
| ~~~~~~ | |
| = ping-node-ssh | |
| [[ping-node-ssh-1]][[GSRFM00215]][[ping-node-ssh]] | |
| == ping-node-ssh | |
| Tests if a node that is enabled for communication over SSH is usable | |
| [[sthref1943]] | |
| === Synopsis | |
| [source] | |
| ---- | |
| asadmin [asadmin-options] ping-node-ssh [--help] | |
| [--validate={false|true}] node-name | |
| ---- | |
| [[sthref1944]] | |
| === Description | |
| The `ping-node-ssh` subcommand tests if a node that is enabled for | |
| communication over secure shell (SSH) is usable. 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 command from any machine that can | |
| contact the DAS. | |
| If the node is usable, the subcommand displays a confirmation that the | |
| subcommand could connect to the node through SSH. This confirmation | |
| includes the name of the host that the node represents. | |
| Optionally, the subcommand can also validate the node to determine if | |
| the link:asadmin.html#asadmin-1m[`asadmin`(1M)] utility can run on the | |
| host that the node represents. To validate a node, the subcommand runs | |
| the link:version.html#version-1[`version`(1)] subcommand. If the node is | |
| valid, the subcommand displays the version that the `version` subcommand | |
| returns. | |
| The node that is specified as the operand of this subcommand must be | |
| enabled for communication over SSH. If the node is not enabled for | |
| communication over SSH, an error occurs. To determine whether a node is | |
| enabled for communication over SSH, use the | |
| link:list-nodes.html#list-nodes-1[`list-nodes`(1)] subcommand. | |
| [NOTE] | |
| ==== | |
| To test whether a node that is enabled for communication over the | |
| Distributed Component Object Model (DCOM) remote protocol is usable, use | |
| the link:ping-node-dcom.html#ping-node-dcom-1[`ping-node-dcom`(1)] | |
| subcommand. | |
| ==== | |
| This subcommand is supported in remote mode only. | |
| [[sthref1945]] | |
| === Options | |
| asadmin-options:: | |
| Options for the `asadmin` utility. For information about these | |
| options, see the link:asadmin.html#asadmin-1m[`asadmin`(1M)] help page. | |
| `--help`:: | |
| `-?`:: | |
| Displays the help text for the subcommand. | |
| `--validate`:: | |
| Specifies whether the subcommand validates the node. | |
| Possible values are as follows: | |
| `true`;; | |
| The node is validated. | |
| `false`;; | |
| The node is not validated (default). | |
| [[sthref1946]] | |
| === Operands | |
| node-name:: | |
| The name of the node to test. The node must be enabled for | |
| communication over SSH. Otherwise, an error occurs. | |
| [[sthref1947]] | |
| === Examples | |
| [[GSRFM731]][[sthref1948]] | |
| ==== Example 1 Testing if an SSH-Enabled Node Is Usable | |
| This example tests if the SSH-enabled node `sj03-node` is usable. | |
| [source] | |
| ---- | |
| asadmin> ping-node-ssh sj03-node | |
| Successfully made SSH connection to node sj03-node (sj03.example.com) | |
| Command ping-node-ssh executed successfully. | |
| ---- | |
| [[GSRFM732]][[sthref1949]] | |
| ==== Example 2 Validating an SSH-Enabled Node | |
| This example validates the SSH-enabled node `adc-node`. | |
| [source] | |
| ---- | |
| asadmin> ping-node-ssh --validate=true adc-node | |
| Successfully made SSH connection to node adcnode (adc.example.com) | |
| GlassFish version found at /export/glassfish7: | |
| Using locally retrieved version string from version class. | |
| Version = Eclipse GlassFish 7.0.0 (build 2021-12-10T19:08:14+0100) | |
| Command version executed successfully. | |
| Command ping-node-ssh executed successfully. | |
| ---- | |
| [[sthref1950]] | |
| === Exit Status | |
| 0:: | |
| command executed successfully | |
| 1:: | |
| error in executing the command | |
| [[sthref1951]] | |
| === See Also | |
| link:asadmin.html#asadmin-1m[`asadmin`(1M)] | |
| link:create-node-ssh.html#create-node-ssh-1[`create-node-ssh`(1)], | |
| link:delete-node-ssh.html#delete-node-ssh-1[`delete-node-ssh`(1)], | |
| link:list-nodes.html#list-nodes-1[`list-nodes`(1)], | |
| link:ping-node-dcom.html#ping-node-dcom-1[`ping-node-dcom`(1)], | |
| link:setup-ssh.html#setup-ssh-1[`setup-ssh`(1)], | |
| link:update-node-ssh001.html#update-node-ssh-1[`update-node-ssh`(1)], | |
| link:version.html#version-1[`version`(1)] | |