.. _auto_ssh_verify_connection:

*VERIFIES SSH CONNECTION TO A SPECIFIED HOSTNAME*
=================================================

Verifies that an SSH connection can be established to a specified remote host for a given user. Use this worker to validate SSH connectivity and confirm that a user account exists and is reachable before submitting jobs or running remote workflows.

When to use
-----------

Tagged: ``connectivity``, ``hpc``, ``remote``, ``ssh``, ``validation``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Hostname
     - hostname
     - text
     - —
     - ✓
     - Fully qualified domain name or IP address of the remote host to test the SSH connection against (e.g. 'hpc-cluster.company.com').
   * - User Name
     - username
     - text
     - —
     - ✓
     - SSH username to authenticate with on the remote host; must correspond to a valid account on the target system.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - User Exists
     - user_exists
     - text
     - Boolean-like text flag ('true'/'false' or '1'/'0') indicating whether the SSH connection succeeded and the specified user account was found on the remote host.

Disciplines
-----------

- platform.hpc_config
- platform.integration
- platform.job_submission

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>ssh_verify_connection</code>. Schema hash: <code>6aec8523f73a</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>