oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#2257: apply PR suggestions

Browse Source
This commit is contained in:
Czar Echavez
2024-02-28 15:08:00 +00:00
parent f2d7a2fc16
commit 6d43c61058
11 changed files with 81 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/simulation_components/system/applications/data_manipulation_bot.rst
View File

@@ -99,7 +99,7 @@ If not using the data manipulation bot manually, it needs to be used with a data
type: UC2RedObservation
options:
nodes:
- node_ref: client_1
- node_name: client_1
observations:
- logon_status
- operating_status
@@ -116,7 +116,7 @@ If not using the data manipulation bot manually, it needs to be used with a data
- type: NODE_APPLICATION_EXECUTE
options:
nodes:
- node_ref: client_1
- node_name: client_1
applications:
- application_ref: data_manipulation_bot
max_folders_per_node: 1

4
docs/source/simulation_components/system/list_of_applications.rst
View File

@@ -1,3 +1,7 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
.. toctree::
:maxdepth: 1
:glob:

4
docs/source/simulation_components/system/list_of_services.rst
View File

@@ -1,3 +1,7 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
.. toctree::
:maxdepth: 1
:glob:

2
docs/source/simulation_components/system/services/database_service.rst
View File

@@ -12,7 +12,7 @@ The ``DatabaseService`` provides a SQL database server simulation by extending t
Key capabilities
================
- Creates a database file in the ``Node`` 's ``FileSystem`` upon creation.
- Creates a database file in the ``FileSystem`` of the ``Node`` (which the ``DatabaseService`` is installed on) upon creation.
- Handles connecting clients by maintaining a dictionary of connections mapped to session IDs.
- Authenticates connections using a configurable password.
- Simulates ``SELECT``, ``DELETE`` and ``INSERT`` SQL queries.

3
docs/source/simulation_components/system/services/ftp_client.rst
View File

@@ -20,6 +20,7 @@ Key features
- RETR: retrieves a file from the FTP server
- QUIT: disconnect from server
- Leverages the Service base class for install/uninstall, status tracking, etc.
- :ref:`FTPClient` and ``FTPServer`` utilise port 21 (FTP) throughout all file transfer / request
Usage
=====
@@ -52,7 +53,7 @@ Python
hostname="server",
ip_address="192.168.2.2",
subnet_mask="255.255.255.0",
default_gateway="192.168.1.1Ó",
default_gateway="192.168.1.10",
start_up_duration=0,
)
server.power_on()

3
docs/source/simulation_components/system/services/ftp_server.rst
View File

@@ -17,12 +17,13 @@ Key capabilities
- STOR: stores a file from client to server
- RETR: retrieves a file from the FTP server
- Leverages the Service base class for install/uninstall, status tracking, etc.
- :ref:`FTPClient` and ``FTPServer`` utilise port 21 (FTP) throughout all file transfer / request
Usage
=====
- Install on a Node via the ``SoftwareManager`` to start the FTP server service.
- Service runs on FTP (command) port 21 by default. (TODO: look at in depth implementation of FTP PORT command)
- Service runs on FTP (command) port 21 by default
Implementation
==============