56 lines
1.4 KiB
ReStructuredText
56 lines
1.4 KiB
ReStructuredText
.. only:: comment
|
|
|
|
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
|
|
|
|
.. _common_node_attributes:
|
|
|
|
``ref``
|
|
-------
|
|
|
|
Human readable name used as reference for the |NODE|. Not used in code.
|
|
|
|
``hostname``
|
|
------------
|
|
|
|
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``.
|