.. _step-SSHCommand:


SSHCommand
==========

SSHes into provided system, and executes a command.

.. versionadded:: 1.0.0

* **Friendly name:** ``Run a command through an SSH tunnel``
* **Step class:** ``base_steps_syncpack.steps.SSHCommand.SSHCommand``
* **Step version:** ``1.0.3``
* **Required parameters:** ``ip``, ``username``, ``cmd``

Parameters
----------

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``ip``
     - string
     - yes
     - --
     - The ip address of the IS manager node
   * - ``username``
     - string
     - yes
     - ``isadmin``
     - Username for manager node
   * - ``password``
     - string
     - no
     - ``isadmin``
     - password for manager node or paraphrase to decrypt SSH key
   * - ``ssh_key``
     - string (long)
     - no
     - --
     - Remote SSH Key content as one liner string using the newline char '\\n' as separator Example: ``SSHKey``
   * - ``use_ssh_key``
     - boolean
     - no
     - ``False``
     - Use SSH Key provided to authenticate to the remote system
   * - ``cmd``
     - string (multi-line)
     - yes
     - --
     - The SSH command to execute

Every step also accepts the platform parameters common to all steps --
see :ref:`platform-parameters`.

Dependencies
------------

* **Inherits from:** ``SSHCommand`` -> ``BaseStep`` -> ``Serializable``
* **SyncPack modules:** ``base_steps_syncpack.util.ssh_connection_utils``
* **External packages:** ``ipaascommon``, ``ipaascore``

.. include:: /_step_notes/SSHCommand.rst

API
---

.. autoclass:: base_steps_syncpack.steps.SSHCommand.SSHCommand
   :members:
   :show-inheritance: