#2840 Documentation and minor bug fixes found in terminal and session manager.

docs/source/simulation_components/system/services/terminal.rst

@@ -30,6 +30,7 @@ Usage
  - Terminal Clients connect, execute commands and disconnect from remote nodes.
  - Ensures that users are logged in to the component before executing any commands.
  - Service runs on SSH port 22 by default.
+ - Enables Agents to send commands both remotely and locally.
 
 Implementation
 """"""""""""""
@@ -39,9 +40,110 @@ Implementation
  - Extends Service class.
   - A detailed guide on the implementation and functionality of the Terminal class can be found in the "Terminal-Processing" jupyter notebook.
 
+Command Format
+^^^^^^^^^^^^^^
+
+``Terminals`` implement their commands through leveraging the pre-existing :doc:`../../request_system`.
+
+Due to this ``Terminals`` will only accept commands passed within the ``RequestFormat``.
+
+:py:class:`primaite.game.interface.RequestFormat`
+
+For example, ``terminal`` command actions when used in ``yaml`` format are formatted as follows:
+
+.. code-block:: yaml
+    command:
+        - "file_system"
+        - "create"
+        - "file"
+        - "downloads"
+        - "cat.png"
+        - "False"
+
+**This command creates file called ``cat.png`` within the ``downloads`` folder.**
+
+This is then loaded from ``yaml`` into a dictionary containing the terminal command:
+
+.. code-block:: python
+
+    {"command":["file_system", "create", "file", "downloads", "cat.png", "False"]}
+
+Which is then parsed to the ``Terminals`` Request Manager to be executed.
+
+Game Layer Usage (Agents)
+========================
+
+The below code examples demonstrate how to use terminal related actions in yaml files.
+
+yaml
+""""
+
+``NODE_SEND_LOCAL_COMMAND``
+"""""""""""""""""""""""""""
+
+Agents can execute local commands without needing to perform a separate remote login action (``SSH_TO_REMOTE``).
+
+.. code-block:: yaml
+
+    ...
+        ...
+          action: NODE_SEND_LOCAL_COMMAND
+          options:
+            node_id: 0
+            username: admin
+            password: admin
+            command: # Example command - Creates a file called 'cat.png' in the downloads folder.
+              - "file_system"
+              - "create"
+              - "file"
+              - "downloads"
+              - "cat.png"
+              - "False"
+
+
+``SSH_TO_REMOTE``
+"""""""""""""""""
+
+Agents are able to use the terminal to login into remote nodes via ``SSH`` which allows for agents to execute commands on remote hosts.
+
+.. code-block:: yaml
+
+    ...
+        ...
+          action: SSH_TO_REMOTE
+          options:
+            node_id: 0
+            username: admin
+            password: admin
+            remote_ip: 192.168.0.10 # Example Ip Address. (The remote host's IP that will be used by ssh)
+
+
+``NODE_SEND_REMOTE_COMMAND``
+""""""""""""""""""""""""""""
+
+After remotely login into another host, a agent can use the ``NODE_SEND_REMOTE_COMMAND`` to execute commands across the network remotely.
+
+.. code-block:: yaml
+
+    ...
+        ...
+          action: NODE_SEND_REMOTE_COMMAND
+          options:
+            node_id: 0
+            remote_ip: 192.168.0.10
+            command:
+              - "file_system"
+              - "create"
+              - "file"
+              - "downloads"
+              - "cat.png"
+              - "False"
+
+
+
+Simulation Layer Usage
+======================
 
-Usage
-=====
 
 The below code examples demonstrate how to create a terminal, a remote terminal, and how to send a basic application install command to a remote node.