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

#2257: fix text and make examples in node configs more specific

Browse Source
This commit is contained in:
Czar Echavez
2024-02-26 09:47:12 +00:00
parent e964b8a3ea
commit 634f634097
6 changed files with 80 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/configuration/simulation/nodes/common/common_network_node_attributes.rst
View File

@@ -23,7 +23,7 @@ e.g.
``address`` ``address``
""""""""""" """""""""""
The target IP address for the route. If the packet destination IP address matches this, the router will route the packet according to the ``next_hop_ip_address``. The target IP address for the route. If the packet destination IP address matches this, the |NODE| will route the packet according to the ``next_hop_ip_address``.
This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``. This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``.

26
docs/source/configuration/simulation/nodes/computer.rst
View File

@@ -16,18 +16,20 @@ example computer
.. code-block:: yaml .. code-block:: yaml
nodes: simulation:
- ref: client_1 network:
hostname: client_1 nodes:
type: computer - ref: client_1
ip_address: 192.168.0.10 hostname: client_1
subnet_mask: 255.255.255.0 type: computer
default_gateway: 192.168.0.1 ip_address: 192.168.0.10
dns_server: 192.168.1.10 subnet_mask: 255.255.255.0
applications: default_gateway: 192.168.0.1
... dns_server: 192.168.1.10
services: applications:
... ...
services:
...
.. include:: common/common_node_attributes.rst .. include:: common/common_node_attributes.rst

64
docs/source/configuration/simulation/nodes/firewall.rst
View File

@@ -18,37 +18,39 @@ example firewall
.. code-block:: yaml .. code-block:: yaml
nodes: simulation:
- ref: firewall network:
hostname: firewall nodes:
type: firewall - ref: firewall
start_up_duration: 0 hostname: firewall
shut_down_duration: 0 type: firewall
ports: start_up_duration: 0
external_port: # port 1 shut_down_duration: 0
ip_address: 192.168.20.1 ports:
subnet_mask: 255.255.255.0 external_port: # port 1
internal_port: # port 2 ip_address: 192.168.20.1
ip_address: 192.168.1.2 subnet_mask: 255.255.255.0
subnet_mask: 255.255.255.0 internal_port: # port 2
dmz_port: # port 3 ip_address: 192.168.1.2
ip_address: 192.168.10.1 subnet_mask: 255.255.255.0
subnet_mask: 255.255.255.0 dmz_port: # port 3
acl: ip_address: 192.168.10.1
internal_inbound_acl: subnet_mask: 255.255.255.0
... acl:
internal_outbound_acl: internal_inbound_acl:
... ...
dmz_inbound_acl: internal_outbound_acl:
... ...
dmz_outbound_acl: dmz_inbound_acl:
... ...
external_inbound_acl: dmz_outbound_acl:
... ...
external_outbound_acl: external_inbound_acl:
... ...
routes: external_outbound_acl:
... ...
routes:
...
.. include:: common/common_node_attributes.rst .. include:: common/common_node_attributes.rst

20
docs/source/configuration/simulation/nodes/router.rst
View File

@@ -16,15 +16,17 @@ example router
.. code-block:: yaml .. code-block:: yaml
nodes: simulation:
- ref: router_1 network:
hostname: router_1 nodes:
type: router - ref: router_1
num_ports: 5 hostname: router_1
ports: type: router
... num_ports: 5
acl: ports:
... ...
acl:
...
.. include:: common/common_node_attributes.rst .. include:: common/common_node_attributes.rst

26
docs/source/configuration/simulation/nodes/server.rst
View File

@@ -16,18 +16,20 @@ example server
.. code-block:: yaml .. code-block:: yaml
nodes: simulation:
- ref: server_1 network:
hostname: server_1 nodes:
type: server - ref: server_1
ip_address: 192.168.10.10 hostname: server_1
subnet_mask: 255.255.255.0 type: server
default_gateway: 192.168.10.1 ip_address: 192.168.10.10
dns_server: 192.168.1.10 subnet_mask: 255.255.255.0
applications: default_gateway: 192.168.10.1
... dns_server: 192.168.1.10
services: applications:
... ...
services:
...
.. include:: common/common_node_attributes.rst .. include:: common/common_node_attributes.rst

12
docs/source/configuration/simulation/nodes/switch.rst
View File

@@ -16,11 +16,13 @@ example switch
.. code-block:: yaml .. code-block:: yaml
nodes: simulation:
- ref: switch_1 network:
hostname: switch_1 nodes:
type: switch - ref: switch_1
num_ports: 8 hostname: switch_1
type: switch
num_ports: 8
.. include:: common/common_node_attributes.rst .. include:: common/common_node_attributes.rst