#2257: added common node attributes page + ability to set node operating state via config + tests

docs/source/configuration/simulation/nodes/common/common.rst

@@ -0,0 +1,35 @@
+.. only:: comment
+
+    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+
+.. _Node Attributes:
+
+Common Attributes
+#################
+
+Node Attributes
+===============
+
+Attributes that are shared by all nodes.
+
+.. include:: common_node_attributes.rst
+
+.. _Network Node Attributes:
+
+Network Node Attributes
+=======================
+
+Attributes that are shared by nodes that inherit from :py:mod:`primaite.simulator.network.hardware.nodes.network.network_node.NetworkNode`
+
+.. include:: common_host_node_attributes.rst
+
+.. _Host Node Attributes:
+
+Host Node Attributes
+====================
+
+Attributes that are shared by nodes that inherit from :py:mod:`primaite.simulator.network.hardware.nodes.host.host_node.HostNode`
+
+.. include:: common_host_node_attributes.rst
+
+.. |NODE| replace:: node

docs/source/configuration/simulation/nodes/common/common_host_node_attributes.rst

@@ -2,6 +2,8 @@
 
     © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
 
+.. _common_host_node_attributes:
+
 ``ip_address``
 --------------
 
@@ -19,13 +21,6 @@ The subnet mask for the |NODE| to use.
 
 The IP address that the |NODE| will use as the default gateway. Typically, this is the IP address of the closest router that the |NODE| is connected to.
 
-``dns_server``
---------------
-
-Optional. Default value is ``None``
-
-The IP address of the node which holds an instance of the :ref:`DNSServer`. Some applications may use a domain name e.g. the :ref:`WebBrowser`
-
 .. include:: ../software/applications.rst
 
 .. include:: ../software/services.rst

docs/source/configuration/simulation/nodes/common/common_network_node_attributes.rst

@@ -2,6 +2,8 @@
 
     © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
 
+.. _common_network_node_attributes:
+
 ``routes``
 ----------
 

docs/source/configuration/simulation/nodes/common/common_node_attributes.rst

@@ -2,6 +2,8 @@
 
     © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
 
+.. _common_node_attributes:
+
 ``ref``
 -------
 
@@ -11,3 +13,43 @@ Human readable name used as reference for the |NODE|. Not used in code.
 ------------
 
 The hostname of the |NODE|. This will be used to reference the |NODE|.
+
+``operating_state``
+-------------------
+
+The initial operating state of the node.
+
+Optional. Default value is ``ON``.
+
+Options available are:
+
+- ``ON``
+- ``OFF``
+- ``BOOTING``
+- ``SHUTTING_DOWN``
+
+Note that YAML may assume non quoted ``ON`` and ``OFF`` as ``True`` and ``False`` respectively. To prevent this, use ``"ON"`` or ``"OFF"``
+
+See :py:mod:`primaite.simulator.network.hardware.node_operating_state.NodeOperatingState`
+
+
+``dns_server``
+--------------
+
+Optional. Default value is ``None``.
+
+The IP address of the node which holds an instance of the :ref:`DNSServer`. Some applications may use a domain name e.g. the :ref:`WebBrowser`
+
+``start_up_duration``
+---------------------
+
+Optional. Default value is ``3``.
+
+The number of time steps required to occur in order for the node to cycle from ``OFF`` to ``BOOTING_UP`` and then finally ``ON``.
+
+``shut_down_duration``
+----------------------
+
+Optional. Default value is ``3``.
+
+The number of time steps required to occur in order for the node to cycle from ``ON`` to ``SHUTTING_DOWN`` and then finally ``OFF``.

docs/source/simulation_components/network/base_hardware.rst

@@ -12,34 +12,22 @@ complex, specialized hardware components inherit from and build upon.
 
 The key elements defined in ``base.py`` are:
 
-NetworkInterface
-================
+``NetworkInterface``
+====================
 
 - Abstract base class for network interfaces like NICs. Defines common attributes like MAC address, speed, MTU.
 - Requires subclasses to implement ``enable()``, ``disable()``, ``send_frame()`` and ``receive_frame()``.
 - Provides basic state description and request handling capabilities.
 
-Node
-====
+``Node``
+========
 The Node class stands as a central component in ``base.py``, acting as the superclass for all network nodes within a
 PrimAITE simulation.
 
-
-
 Node Attributes
 ---------------
 
-
-- **hostname**: The network hostname of the node.
-- **operating_state**: Indicates the current hardware state of the node.
-- **network_interfaces**: Maps interface names to NetworkInterface objects on the node.
-- **network_interface**:  Maps port IDs to ``NetworkInterface`` objects on the node.
-- **dns_server**: Specifies DNS servers for domain name resolution.
-- **start_up_duration**: The time it takes for the node to become fully operational after being powered on.
-- **shut_down_duration**: The time required for the node to properly shut down.
-- **sys_log**: A system log for recording events related to the node.
-- **session_manager**: Manages user sessions within the node.
-- **software_manager**: Controls the installation and management of software and services on the node.
+See :ref:`Node Attributes`
 
 .. _Node Start up and Shut down:
 

docs/source/simulation_components/system/applications/data_manipulation_bot.rst

@@ -79,7 +79,7 @@ Python
     data_manipulation_bot.configure(server_ip_address=IPv4Address("192.168.1.14"), payload="DELETE")
     data_manipulation_bot.run()
 
-This would connect to the database service at 192.168.1.14, authenticate, and execute the SQL statement to drop the 'users' table.
+This would connect to the database service at 192.168.1.14, authenticate, and execute the SQL statement to delete database contents.
 
 Example with ``DataManipulationAgent``
 """"""""""""""""""""""""""""""""""""""

docs/source/simulation_components/system/applications/database_client.rst

@@ -24,12 +24,6 @@ Usage
 - Retrieve results in a dictionary.
 - Disconnect when finished.
 
-To create database backups:
-
-- Configure the backup server on the :ref:`DatabaseService` by providing the Backup server ``IPv4Address`` with ``configure_backup``
-- Create a backup using ``backup_database``. This fails if the backup server is not configured.
-- Restore a backup using ``restore_backup``. By default, this uses the database created via ``backup_database``.
-
 Implementation
 ==============
 

docs/source/simulation_components/system/list_of_system_applications.rst

@@ -13,4 +13,4 @@ The list of applications that are considered system software are:
 
 - ``WebBrowser``
 
-More info :py:mod:`primaite.simulator.network.hardware.nodes.host.host_node.SYSTEM_SOFTWARE`
+More info :py:mod:`primaite.simulator.network.hardware.nodes.host.host_node.HostNode.SYSTEM_SOFTWARE`

docs/source/simulation_components/system/list_of_system_services.rst

@@ -15,4 +15,4 @@ The list of services that are considered system software are:
 - ``FTPClient``
 - ``NTPClient``
 
-More info :py:mod:`primaite.simulator.network.hardware.nodes.host.host_node.SYSTEM_SOFTWARE`
+More info :py:mod:`primaite.simulator.network.hardware.nodes.host.host_node.HostNode.SYSTEM_SOFTWARE`

docs/source/simulation_components/system/software.rst

@@ -10,7 +10,7 @@ Software
 Base Software
 -------------
 
-All software which inherits ``IOSoftware`` installed on a node will not work unless the node has been turned on.
+Software which inherits ``IOSoftware`` installed on a node will not work unless the node has been turned on.
 
 See :ref:`Node Start up and Shut down`