#3110: Correct config YAML snippets.

docs/source/configuration/agents.rst

@@ -22,7 +22,6 @@ Agents can be scripted (deterministic and stochastic), or controlled by a reinfo
     type: probabilistic-agent
 
     agent_settings:
-                start_settings:
       start_step: 5
       frequency: 4
       variance: 3

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

@@ -19,10 +19,9 @@ example computer
     simulation:
       network:
         nodes:
-                - ref: client_1
+        - hostname: client_1
-                hostname: client_1
           type: computer
-                ip_address: 192.168.0.10
+          ip_address: 192.168.0.10c
           subnet_mask: 255.255.255.0
           default_gateway: 192.168.0.1
           dns_server: 192.168.1.10

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

@@ -21,11 +21,8 @@ example firewall
     simulation:
       network:
         nodes:
-                - ref: firewall
+          - hostname: firewall
-                    hostname: firewall
             type: firewall
-                    start_up_duration: 0
-                    shut_down_duration: 0
             ports:
               external_port: # port 1
                 ip_address: 192.168.20.1
@@ -70,7 +67,7 @@ The ports should be defined with an ip address and subnet mask e.g.
 .. code-block:: yaml
 
     nodes:
-        - ref: firewall
+      - hostname: firewall
       ...
         ports:
           external_port: # port 1
@@ -129,7 +126,7 @@ example:
 .. code-block:: yaml
 
     nodes:
-        - ref: firewall
+      - hostname: firewall
         ...
         acl:
           internal_inbound_acl:
@@ -155,7 +152,7 @@ example:
 .. code-block:: yaml
 
     nodes:
-        - ref: firewall
+      - hostname: firewall
       ...
         acl:
           internal_outbound_acl:
@@ -216,7 +213,7 @@ example:
 .. code-block:: yaml
 
     nodes:
-        - ref: firewall
+      - hostname: firewall
       ...
       acl:
         dmz_outbound_acl:
@@ -254,7 +251,7 @@ example:
 .. code-block:: yaml
 
     nodes:
-        - ref: firewall
+      - hostname: firewall
       ...
       acl:
         external_inbound_acl:
@@ -282,7 +279,7 @@ example:
 .. code-block:: yaml
 
     nodes:
-        - ref: firewall
+      - hotsname: firewall
       ...
         acl:
           external_outbound_acl:

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

@@ -19,8 +19,7 @@ example router
     simulation:
       network:
         nodes:
-                - ref: router_1
+          - hostname: router_1
-                hostname: router_1
             type: router
             num_ports: 5
             ports:
@@ -49,7 +48,7 @@ Example of setting ports for a router with 2 ports:
 .. code-block:: yaml
 
     nodes:
-        - ref: router_1
+        - hostname: router_1
         ...
         ports:
           1:
@@ -81,7 +80,7 @@ e.g.
 .. code-block:: yaml
 
     nodes:
-        - ref: router_1
+        - hostname: router_1
         ...
         acl:
           1:

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

@@ -19,8 +19,7 @@ example server
     simulation:
         network:
             nodes:
-                - ref: server_1
+                - hostname: server_1
-                hostname: server_1
                   type: server
                   ip_address: 192.168.10.10
                   subnet_mask: 255.255.255.0

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

@@ -19,7 +19,6 @@ example switch
     simulation:
       network:
         nodes:
-                - ref: switch_1
           hostname: switch_1
           type: switch
           num_ports: 8

docs/source/how_to_guides/extensible_agents.rst

@@ -48,17 +48,18 @@ Agent generation will fail pydantic checks if incorrect or invalid parameters ar
       team: GREEN
       type: example-agent
 
-        action_space:
-        action_map:
-            0:
-                action: do-nothing
-                options: {}
       agent_settings:
         start_step: 25
         frequency: 20
         variance: 5
         starting_host: "Server_1"
 
+      action_space:
+      action_map:
+        0:
+          action: do-nothing
+          options: {}
+
 
 **discriminators**:
 

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

@@ -78,13 +78,11 @@ Via Configuration
     simulation:
       network:
         nodes:
-                - ref: example_computer
+        - hostname: example_computer
-                hostname: example_computer
         type: computer
         ...
         applications:
-                    - ref: database_client
+        - type: database-client
-                    type: database-client
         options:
           db_server_ip: 192.168.0.1
 

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

@@ -81,13 +81,11 @@ Via Configuration
     simulation:
       network:
         nodes:
-                - ref: example_computer
+        - hostname: example_computer
-                hostname: example_computer
         type: computer
         ...
         applications:
-                    - ref: dos_bot
+        - type: dos-bot
-                    type: dos-bot
         options:
           target_ip_address: 192.168.0.10
           payload: SPOOF DATA

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

@@ -72,13 +72,11 @@ Via Configuration
     simulation:
       network:
         nodes:
-                - ref: example_server
+            - hostname: example_server
-                hostname: example_server
         type: server
         ...
         services:
-                    - ref: dns_client
+        - type: dns-client
-                    type: dns-client
         options:
           dns_server: 192.168.0.10
 

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

@@ -73,13 +73,11 @@ Via Configuration
     simulation:
       network:
         nodes:
-                - ref: example_server
+        - hostname: example_server
-                hostname: example_server
         type: server
         ...
         services:
-                    - ref: ftp_client
+        - type: ftp-client
-                    type: ftp-client
 
 Configuration
 =============

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

@@ -68,13 +68,11 @@ Via Configuration
     simulation:
       network:
         nodes:
-                - ref: example_server
+        - hostname: example_server
-                hostname: example_server
         type: server
         ...
         services:
-                    - ref: ntp_client
+        - type: ntp-client
-                    type: ntp-client
         options:
           ntp_server_ip: 192.168.0.10
 

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

@@ -68,13 +68,11 @@ Via Configuration
     simulation:
       network:
         nodes:
-                - ref: example_server
+        - hostname: example_server
-                hostname: example_server
             type: server
         ...
         services:
-                    - ref: ntp_server
+        - type: ntp-server
-                    type: ntp-server
 
 
 ``Common Attributes``

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

@@ -68,13 +68,11 @@ Via Configuration
     simulation:
       network:
         nodes:
-                - ref: example_server
+        - hostname: example_server
-                hostname: example_server
         type: server
         ...
         services:
-                    - ref: web_server
+        - type: web-server
-                    type: web-server
 
 
 ``Common Attributes``