NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 05:51:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

efactor(copilot): adopt Nornir best

Browse Source 
practice for multi-vendor device support

   Refactor Nornir configuration to use host-level connection_options
   instead of dynamic groups, following Nornir's configuration priority
   model (host > group > defaults).

   **Problem:**
   Previous implementation used first device's configuration for all
   devices, causing Cisco devices to use Huawei driver and vice versa.

   **Solution:**
   - Each host now has device-specific connection_options at host level
   - Single generic "network_devices" group for shared settings
   - Host-level config automatically overrides group-level config

   **Changes:**
   - Remove: _get_nornir_groups_config() helper function
   - Remove: _get_nornir_group() helper function
   - Simplify: _initialize_nornir() to use single generic group
   - Update: get_gns3_device_port.py() to return host-level config
   - Reserve: platform field for future NAPALM/scrapli plugin support

   **Benefits:**
   - Cleaner code structure (no dynamic group creation)
   - Follows Nornir best practice ("configuration proximity")
   - Easy to extend with new device types
   - Properly handles mixed-vendor topologies
This commit is contained in:
YueGuobin committed 2026-03-13 09:32:18 +08:00
1 parent 44f802ae4f
commit 364ff93783
4 files changed
+320 -219
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

gns3server/agent/gns3_copilot/tools_v2/config_tools_nornir.py
+27 -87
View File
@@ -104,53 +104,6 @@ def _get_nornir_defaults() -> dict[str, Any]:
return {"data": {"location": "gns3"}}
def _get_nornir_groups_config(
device_type: str = "cisco_ios_telnet", platform: str = "cisco_ios"
) -> dict[str, Any]:
"""
Get Nornir group configuration for network devices.
Args:
device_type: Device type for Netmiko (e.g., 'cisco_ios_telnet', 'huawei_telnet')
platform: Platform type for Nornir (e.g., 'cisco_ios', 'huawei')
Returns:
Dictionary containing Nornir group configuration
"""
return {
"platform": platform,
"hostname": get_gns3_server_host(),
"timeout": 120,
"username": "",
"password": "",
"connection_options": {
"netmiko": {"extras": {"device_type": device_type}}
},
}
def _get_nornir_group(
group_name: str = "network_devices_telnet",
device_type: str = "cisco_ios_telnet",
platform: str = "cisco_ios",
) -> dict[str, Any]:
"""
Get Nornir group configuration for a specific group.
Args:
group_name: Name of the group
device_type: Device type for Netmiko (e.g., 'cisco_ios_telnet', 'huawei_telnet')
platform: Platform type for Nornir (e.g., 'cisco_ios', 'huawei')
Returns:
Dictionary containing group configuration
"""
# _get_nornir_groups_config now returns the group config directly
return _get_nornir_groups_config(
device_type=device_type, platform=platform
)
class ExecuteMultipleDeviceConfigCommands(BaseTool):
"""
A tool to execute configuration commands on multiple devices in a GNS3
@@ -540,51 +493,38 @@ class ExecuteMultipleDeviceConfigCommands(BaseTool):
def _initialize_nornir(
self, hosts_data: dict[str, dict[str, Any]]
) -> Nornir:
"""Initialize Nornir with the provided hosts data."""
"""
Initialize Nornir with the provided hosts data.
Each host now has its own connection_options (device_type), so we only
need a single generic group for shared configuration (hostname, timeout, etc.).
This is the Nornir best practice for multi-vendor environments.
"""
try:
# Extract device_type and platform from hosts_data
# Use the first device's configuration as default
device_type = None
platform = None
if hosts_data:
first_device_data = next(iter(hosts_data.values()), {})
device_type = first_device_data.get(
"device_type", "cisco_ios_telnet"
)
platform = first_device_data.get("platform", "cisco_ios")
logger.info(
"Extracted from tags: device_type=%s, platform=%s",
device_type,
platform,
)
# Get environment config with dynamic device_type and platform
groups_data = _get_nornir_groups_config(
device_type=device_type or "cisco_ios_telnet",
platform=platform or "cisco_ios",
)
defaults = _get_nornir_defaults()
# Dynamically generate group name based on platform and device type
# e.g., "huawei_telnet", "cisco_ios_telnet", "juniper_junos"
actual_platform = platform or "cisco_ios"
if device_type and "_telnet" in device_type:
group_name = f"{actual_platform}_telnet"
else:
group_name = actual_platform
# Log nornir account information
gns3_host = get_gns3_server_host()
# Create a single generic group for shared configuration
# Individual device types are handled at host level via connection_options
groups_data = {
"network_devices": {
"hostname": gns3_host,
"timeout": 120,
"username": "",
"password": "",
}
}
# Log device types being configured
device_types = [
host["connection_options"]["netmiko"]["extras"]["device_type"]
for host in hosts_data.values()
]
logger.info(
"Initializing Nornir: host=%s, platform=%s, device_type=%s, group=%s, timeout=%d",
"Initializing Nornir: host=%s, device_types=%s, hosts=%d",
gns3_host,
groups_data.get("platform"),
device_type,
group_name,
groups_data.get("timeout"),
list(set(device_types)),
len(hosts_data),
)
return InitNornir(
@@ -592,7 +532,7 @@ class ExecuteMultipleDeviceConfigCommands(BaseTool):
"plugin": "DictInventory",
"options": {
"hosts": hosts_data,
"groups": {group_name: groups_data},
"groups": groups_data,
"defaults": defaults,
},
},
gns3server/agent/gns3_copilot/tools_v2/display_tools_nornir.py
+27 -87
View File
@@ -104,53 +104,6 @@ def _get_nornir_defaults() -> dict[str, Any]:
return {"data": {"location": "gns3"}}
def _get_nornir_groups_config(
device_type: str = "cisco_ios_telnet", platform: str = "cisco_ios"
) -> dict[str, Any]:
"""
Get Nornir group configuration for network devices.
Args:
device_type: Device type for Netmiko (e.g., 'cisco_ios_telnet', 'huawei_telnet')
platform: Platform type for Nornir (e.g., 'cisco_ios', 'huawei')
Returns:
Dictionary containing Nornir group configuration
"""
return {
"platform": platform,
"hostname": get_gns3_server_host(),
"timeout": 120,
"username": "",
"password": "",
"connection_options": {
"netmiko": {"extras": {"device_type": device_type}}
},
}
def _get_nornir_group(
group_name: str = "network_devices_telnet",
device_type: str = "cisco_ios_telnet",
platform: str = "cisco_ios",
) -> dict[str, Any]:
"""
Get Nornir group configuration for a specific group.
Args:
group_name: Name of the group
device_type: Device type for Netmiko (e.g., 'cisco_ios_telnet', 'huawei_telnet')
platform: Platform type for Nornir (e.g., 'cisco_ios', 'huawei')
Returns:
Dictionary containing group configuration
"""
# _get_nornir_groups_config now returns the group config directly
return _get_nornir_groups_config(
device_type=device_type, platform=platform
)
class ExecuteMultipleDeviceCommands(BaseTool):
"""
A READ-ONLY diagnostic tool for viewing network device configurations.
@@ -544,51 +497,38 @@ class ExecuteMultipleDeviceCommands(BaseTool):
def _initialize_nornir(
self, hosts_data: dict[str, dict[str, Any]]
) -> Nornir:
"""Initialize Nornir with the provided hosts data."""
"""
Initialize Nornir with the provided hosts data.
Each host now has its own connection_options (device_type), so we only
need a single generic group for shared configuration (hostname, timeout, etc.).
This is the Nornir best practice for multi-vendor environments.
"""
try:
# Extract device_type and platform from hosts_data
# Use the first device's configuration as default
device_type = None
platform = None
if hosts_data:
first_device_data = next(iter(hosts_data.values()), {})
device_type = first_device_data.get(
"device_type", "cisco_ios_telnet"
)
platform = first_device_data.get("platform", "cisco_ios")
logger.info(
"Extracted from tags: device_type=%s, platform=%s",
device_type,
platform,
)
# Get environment config with dynamic device_type and platform
groups_data = _get_nornir_groups_config(
device_type=device_type or "cisco_ios_telnet",
platform=platform or "cisco_ios",
)
defaults = _get_nornir_defaults()
# Dynamically generate group name based on platform and device type
# e.g., "huawei_telnet", "cisco_ios_telnet", "juniper_junos"
actual_platform = platform or "cisco_ios"
if device_type and "_telnet" in device_type:
group_name = f"{actual_platform}_telnet"
else:
group_name = actual_platform
# Log nornir account information
gns3_host = get_gns3_server_host()
# Create a single generic group for shared configuration
# Individual device types are handled at host level via connection_options
groups_data = {
"network_devices": {
"hostname": gns3_host,
"timeout": 120,
"username": "",
"password": "",
}
}
# Log device types being configured
device_types = [
host["connection_options"]["netmiko"]["extras"]["device_type"]
for host in hosts_data.values()
]
logger.info(
"Initializing Nornir: host=%s, platform=%s, device_type=%s, group=%s, timeout=%d",
"Initializing Nornir: host=%s, device_types=%s, hosts=%d",
gns3_host,
groups_data.get("platform"),
device_type,
group_name,
groups_data.get("timeout"),
list(set(device_types)),
len(hosts_data),
)
return InitNornir(
@@ -596,7 +536,7 @@ class ExecuteMultipleDeviceCommands(BaseTool):
"plugin": "DictInventory",
"options": {
"hosts": hosts_data,
"groups": {group_name: groups_data},
"groups": groups_data,
"defaults": defaults,
},
},
gns3server/agent/gns3_copilot/utils/get_gns3_device_port.py
+17 -12
View File
@@ -49,9 +49,13 @@ def get_device_ports_from_topology(
{
"device_name": {
"port": console_port,
"groups": ["platform_telnet"], # Dynamically generated from platform/device_type
"device_type": "huawei_telnet", # Extracted from tags
"platform": "huawei" # Extracted from tags
"platform": "huawei", # Extracted from tags
"groups": ["network_devices"], # For inheriting shared settings
"connection_options": {
"netmiko": {
"extras": {"device_type": "huawei_telnet"} # Extracted from tags
}
}
}
}
Devices that don't exist or missing console_port will not be included
@@ -128,18 +132,19 @@ def get_device_ports_from_topology(
platform,
)
# Add device to hosts_data
# Dynamically generate group name based on platform and device_type
if device_type and "_telnet" in device_type:
group_name = f"{platform}_telnet"
else:
group_name = platform
# Add device to hosts_data with connection_options at host level
# This is the Nornir best practice - each host has its own
# connection configuration (device_type), while sharing common
# settings (hostname, timeout) via group inheritance.
hosts_data[device_name] = {
"port": node_info["console_port"],
"groups": [group_name],
"device_type": device_type,
"platform": platform,
"groups": ["network_devices"], # For inheriting hostname, timeout, etc.
"connection_options": {
"netmiko": {
"extras": {"device_type": device_type}
}
},
}
logger.info("Returning %d device port mappings", len(hosts_data))