add yaml include feature

docs/config.yaml.example

@@ -5,64 +5,29 @@
 # Copy this file to a location of your choice and modify for your environment.
 #
 # Usage: ipng-router-backup --config /path/to/your/config.yaml
+#
+# YAML !include Support:
+# You can split large configurations into multiple files using !include directives.
+# Examples:
+#   !include device-types.yaml
+#   !include devices/production.yaml
+#   !include "devices/lab environment.yaml"  # Use quotes for paths with spaces
 
-# Device Types Section
-# Define reusable command sets for different types of network equipment
-types:
-  # Nokia SR Linux devices
-  srlinux:
-    commands:
-      - show version                    # System version and build info
-      - show platform linecard         # Line card information
-      - show platform fan-tray         # Fan status and health
-      - show platform power-supply     # Power supply status
-      - info flat from running         # Full running configuration
+# Include device types from separate file
+!include device-types.yaml
 
-  # Arista EOS devices  
-  eos:
-    commands:
-      - show version                    # System version information
-      - show inventory                  # Hardware inventory
-      - show env power                  # Power supply status
-      - show running-config             # Complete running configuration
-
-  # Centec switches
-  centec:
-    commands:
-      - show version | exc uptime       # Version info without uptime line
-      - show boot images                # Boot image information
-      - show transceiver                # SFP/transceiver status
-      - show running-config             # Running configuration
-
-  # Cisco IOS/IOS-XE devices
-  cisco-ios:
-    commands:
-      - show version                    # IOS version and hardware info
-      - show inventory                  # Hardware inventory details
-      - show running-config             # Complete configuration
-      - show ip interface brief         # Interface IP summary
-      - show cdp neighbors              # CDP neighbor information
-
-  # Juniper devices
-  junos:
-    commands:
-      - show version                    # Software and hardware version
-      - show chassis hardware           # Chassis hardware details
-      - show configuration | display set # Configuration in set format
-      - show interfaces terse           # Interface status summary
-
-# Devices Section  
+# Devices Section
 # Define individual network devices to backup
 devices:
   # Core switches (SR Linux)
   asw100:
     user: admin                         # SSH username
     type: srlinux                       # Reference to type above
-    
+
   asw120:
     user: netops                        # Different user per device if needed
     type: srlinux
-    
+
   asw121:
     user: admin
     type: srlinux
@@ -71,16 +36,16 @@ devices:
   csw150:
     user: admin
     type: centec
-    
+
   csw151:
-    user: admin  
+    user: admin
     type: centec
 
   # Edge routers (Arista EOS)
   edge-01:
     user: automation
     type: eos
-    
+
   edge-02:
     user: automation
     type: eos
@@ -100,7 +65,7 @@ devices:
     type: cisco-ios
 
 # Configuration Tips:
-# 
+#
 # 1. Authentication Priority (automatic):
 #    - SSH Agent (if SSH_AUTH_SOCK environment variable is set)
 #    - SSH Key file (--key-file flag or default locations)
@@ -109,10 +74,10 @@ devices:
 # 2. Running the backup:
 #    # Backup all devices
 #    ipng-router-backup --config /etc/ipng-router-backup/config.yaml
-#    
-#    # Backup specific devices only  
+#
+#    # Backup specific devices only
 #    ipng-router-backup --config config.yaml --host asw100 --host edge-01
-#    
+#
 #    # Custom output directory
 #    ipng-router-backup --config config.yaml --output-dir /backup/$(date +%Y%m%d)
 #
@@ -130,4 +95,4 @@ devices:
 # 5. Error handling:
 #    - If a device is unreachable, the tool continues with other devices
 #    - Check tool output for connection or authentication failures
-#    - Use --host flag to test individual devices
+#    - Use --host flag to test individual devices