NgTech-LTD/gns3-server
2
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-08-27 12:30:13 +03:00
Code Issues Packages Projects Releases Wiki Activity
gns3-server/gns3server/schemas/controller/appliances.py
YueGuobin 08e37a4509
docker: inject config files into containers via extra_configs 
Add an `extra_configs` field (list of {target, content}) to the docker
node/template/appliance schemas. For each entry GNS3 writes `content` to a
file in the node working directory and bind-mounts it read-only at `target`
inside the container.

This lets a NOS appliance seed its startup config without rebuilding the
image: XRd points XR_FIRST_BOOT_CONFIG at an injected /firstboot.cfg, FRR at
/etc/frr/frr.conf, etc. The bind is a single-file mount applied at create
time, so it works for both the generic init.sh path and vendor nodes that
skip init.sh (console_type=docker_exec). Entries are only injected when
present, so ordinary nodes are unaffected.

The content can't go through `environment` (it is line-delimited, one var per
line), hence a dedicated field -- the same plumbing shape as extra_volumes.
2026-08-13 23:33:34 +08:00

732 lines
29 KiB
Python
Raw Blame History

#
# Copyright (C) 2026 GNS3 Technologies Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Unified Pydantic model supporting both appliance registry versions using discriminated unions
from enum import Enum
from typing import Annotated, List, Literal, Optional, Union
from uuid import UUID
from pydantic import AnyUrl, BaseModel, Discriminator, EmailStr, Field, Tag
from ..common import ExtraConfig
# ============================================================================
# Shared Enums
# ============================================================================
class Category(str, Enum):
"""Appliance category enum"""
router = 'router'
multilayer_switch = 'multilayer_switch'
switch = 'switch'
firewall = 'firewall'
guest = 'guest'
class Status(str, Enum):
"""Appliance status enum"""
stable = 'stable'
experimental = 'experimental'
broken = 'broken'
class Availability(str, Enum):
"""Image availability enum"""
free = 'free'
with_registration = 'with-registration'
free_to_try = 'free-to-try'
service_contract = 'service-contract'
class Compression(str, Enum):
"""Compression type enum"""
bzip2 = 'bzip2'
gzip = 'gzip'
lzma = 'lzma'
xz = 'xz'
rar = 'rar'
zip = 'zip'
field_7z = '7z'
class DynamipsPlatform(str, Enum):
"""Dynamips platform enum"""
c1700 = 'c1700'
c2600 = 'c2600'
c2691 = 'c2691'
c3725 = 'c3725'
c3745 = 'c3745'
c3600 = 'c3600'
c7200 = 'c7200'
class DynamipsChassis(str, Enum):
"""Dynamips chassis enum"""
chassis_1720 = '1720'
chassis_1721 = '1721'
chassis_1750 = '1750'
chassis_1751 = '1751'
chassis_1760 = '1760'
chassis_2610 = '2610'
chassis_2620 = '2620'
chassis_2610XM = '2610XM'
chassis_2620XM = '2620XM'
chassis_2650XM = '2650XM'
chassis_2621 = '2621'
chassis_2611XM = '2611XM'
chassis_2621XM = '2621XM'
chassis_2651XM = '2651XM'
chassis_3620 = '3620'
chassis_3640 = '3640'
chassis_3660 = '3660'
_ = ''
class DynamipsSlot(str, Enum):
"""Dynamips slot enum"""
C7200_IO_2FE = 'C7200-IO-2FE'
C7200_IO_FE = 'C7200-IO-FE'
C7200_IO_GE_E = 'C7200-IO-GE-E'
NM_16ESW = 'NM-16ESW'
NM_1E = 'NM-1E'
NM_1FE_TX = 'NM-1FE-TX'
NM_4E = 'NM-4E'
NM_4T = 'NM-4T'
PA_2FE_TX = 'PA-2FE-TX'
PA_4E = 'PA-4E'
PA_4T_ = 'PA-4T+'
PA_8E = 'PA-8E'
PA_8T = 'PA-8T'
PA_A1 = 'PA-A1'
PA_FE_TX = 'PA-FE-TX'
PA_GE = 'PA-GE'
PA_POS_OC3 = 'PA-POS-OC3'
C2600_MB_2FE = 'C2600-MB-2FE'
C2600_MB_1E = 'C2600-MB-1E'
C1700_MB_1FE = 'C1700-MB-1FE'
C2600_MB_2E = 'C2600-MB-2E'
C2600_MB_1FE = 'C2600-MB-1FE'
C1700_MB_WIC1 = 'C1700-MB-WIC1'
GT96100_FE = 'GT96100-FE'
Leopard_2FE = 'Leopard-2FE'
_ = ''
class DynamipsWic(str, Enum):
"""Dynamips WIC enum"""
WIC_1ENET = 'WIC-1ENET'
WIC_1T = 'WIC-1T'
WIC_2T = 'WIC-2T'
_ = ''
class DynamipsMidplane(str, Enum):
"""Dynamips midplane enum"""
std = 'std'
vxr = 'vxr'
class DynamipsNpe(str, Enum):
"""Dynamips NPE enum"""
npe_100 = 'npe-100'
npe_150 = 'npe-150'
npe_175 = 'npe-175'
npe_200 = 'npe-200'
npe_225 = 'npe-225'
npe_300 = 'npe-300'
npe_400 = 'npe-400'
npe_g2 = 'npe-g2'
class QemuConsoleType(str, Enum):
"""Qemu console type enum"""
telnet = 'telnet'
ssh = 'ssh'
vnc = 'vnc'
spice = 'spice'
spice_agent = 'spice+agent'
none = 'none'
class QemuAdapterType(str, Enum):
"""Qemu adapter type enum"""
e1000 = 'e1000'
i82550 = 'i82550'
i82551 = 'i82551'
i82557a = 'i82557a'
i82557b = 'i82557b'
i82557c = 'i82557c'
i82558a = 'i82558a'
i82558b = 'i82558b'
i82559a = 'i82559a'
i82559b = 'i82559b'
i82559c = 'i82559c'
i82559er = 'i82559er'
i82562 = 'i82562'
i82801 = 'i82801'
igb = 'igb'
ne2k_pci = 'ne2k_pci'
pcnet = 'pcnet'
rtl8139 = 'rtl8139'
virtio = 'virtio'
virtio_net_pci = 'virtio-net-pci'
vmxnet3 = 'vmxnet3'
class QemuPlatform(str, Enum):
"""Qemu platform enum"""
aarch64 = 'aarch64'
alpha = 'alpha'
arm = 'arm'
cris = 'cris'
i386 = 'i386'
lm32 = 'lm32'
m68k = 'm68k'
microblaze = 'microblaze'
microblazeel = 'microblazeel'
mips = 'mips'
mips64 = 'mips64'
mips64el = 'mips64el'
mipsel = 'mipsel'
moxie = 'moxie'
or32 = 'or32'
ppc = 'ppc'
ppc64 = 'ppc64'
ppcemb = 'ppcemb'
s390x = 's390x'
sh4 = 'sh4'
sh4eb = 'sh4eb'
sparc = 'sparc'
sparc64 = 'sparc64'
tricore = 'tricore'
unicore32 = 'unicore32'
x86_64 = 'x86_64'
xtensa = 'xtensa'
xtensaeb = 'xtensaeb'
class QemuDiskInterface(str, Enum):
"""Disk interface enum"""
ide = 'ide'
sata = 'sata'
nvme = 'nvme'
scsi = 'scsi'
sd = 'sd'
mtd = 'mtd'
floppy = 'floppy'
pflash = 'pflash'
virtio = 'virtio'
none = 'none'
class QemuBootPriority(str, Enum):
"""Boot priority enum"""
c = 'c'
d = 'd'
n = 'n'
cn = 'cn'
cd = 'cd'
dn = 'dn'
dc = 'dc'
nc = 'nc'
nd = 'nd'
class QemuOnClose(str, Enum):
"""Qemu on_close action enum"""
power_off = 'power_off'
shutdown_signal = 'shutdown_signal'
save_vm_state = 'save_vm_state'
class QemuProcessPriority(str, Enum):
"""Qemu process priority enum"""
realtime = 'realtime'
very_high = 'very high'
high = 'high'
normal = 'normal'
low = 'low'
very_low = 'very low'
class DockerConsoleType(str, Enum):
"""Docker console type enum"""
telnet = 'telnet'
ssh = 'ssh'
vnc = 'vnc'
http = 'http'
https = 'https'
none = 'none'
docker_exec = 'docker_exec'
class ChecksumType(str, Enum):
"""Checksum type enum"""
md5 = 'md5'
class TemplateType(str, Enum):
"""Template type enum"""
docker = 'docker'
iou = 'iou'
dynamips = 'dynamips'
qemu = 'qemu'
# ============================================================================
# Version 1-6 Specific Enums
# ============================================================================
class Kvm(str, Enum):
"""KVM requirements enum"""
require = 'require'
allow = 'allow'
disable = 'disable'
# ============================================================================
# Version 1-6 Models
# ============================================================================
class Docker(BaseModel):
"""Docker configuration for v1-6"""
adapters: int = Field(..., title='Number of Ethernet adapters')
image: str = Field(..., title='Docker image in the Docker Hub')
start_command: Optional[str] = Field(None, title='Command executed when the container start. Empty will use the default')
environment: Optional[str] = Field(None, title='One KEY=VAR environment by line')
console_type: Optional[DockerConsoleType] = Field(None, title='Type of console connection for the administration of the appliance')
console_http_port: Optional[int] = Field(None, description='Internal port in the container of the HTTP server')
console_http_path: Optional[str] = Field(None, description='Path of the web interface')
extra_hosts: Optional[str] = Field(None, description='Hosts which will be written to /etc/hosts into container')
extra_volumes: Optional[List[str]] = Field(None, description='Additional directories to make persistent that are not included in the images VOLUME directive')
extra_configs: Optional[List[ExtraConfig]] = Field(None, description='Configuration files injected into the container (bind-mounted read-only)')
class Iou(BaseModel):
"""IOU configuration for v1-6"""
ethernet_adapters: int = Field(..., title='Number of Ethernet adapters')
serial_adapters: int = Field(..., title='Number of serial adapters')
nvram: int = Field(..., title='Host NVRAM')
ram: int = Field(..., title='Host RAM')
startup_config: str = Field(..., title='Config loaded at startup')
class Dynamips(BaseModel):
"""Dynamips configuration for v1-6"""
chassis: Optional[DynamipsChassis] = Field(None, title='Chassis type')
platform: DynamipsPlatform = Field(..., title='Platform type')
ram: Annotated[int, Field(ge=1)] = Field(..., title='Amount of ram')
nvram: Annotated[int, Field(ge=1)] = Field(..., title='Amount of nvram')
startup_config: Optional[str] = Field(None, title='Config loaded at startup')
wic0: Optional[DynamipsWic] = None
wic1: Optional[DynamipsWic] = None
wic2: Optional[DynamipsWic] = None
slot0: Optional[DynamipsSlot] = None
slot1: Optional[DynamipsSlot] = None
slot2: Optional[DynamipsSlot] = None
slot3: Optional[DynamipsSlot] = None
slot4: Optional[DynamipsSlot] = None
slot5: Optional[DynamipsSlot] = None
slot6: Optional[DynamipsSlot] = None
midplane: Optional[DynamipsMidplane] = None
npe: Optional[DynamipsNpe] = None
class Qemu(BaseModel):
"""QEMU configuration for v1-6"""
adapter_type: QemuAdapterType = Field(..., title='Type of network adapter')
adapters: int = Field(..., title='Number of adapters')
ram: int = Field(..., title='RAM allocated to the appliance (MB)')
cpus: Optional[int] = Field(None, title='Number of Virtual CPU')
hda_disk_interface: Optional[QemuDiskInterface] = Field(None, title='Disk interface for the installed hda_disk_image')
hdb_disk_interface: Optional[QemuDiskInterface] = Field(None, title='Disk interface for the installed hdb_disk_image')
hdc_disk_interface: Optional[QemuDiskInterface] = Field(None, title='Disk interface for the installed hdc_disk_image')
hdd_disk_interface: Optional[QemuDiskInterface] = Field(None, title='Disk interface for the installed hdd_disk_image')
arch: QemuPlatform = Field(..., title='Architecture emulated')
console_type: QemuConsoleType = Field(..., title='Type of console connection for the administration of the appliance')
boot_priority: Optional[QemuBootPriority] = Field(None, title='Disk boot priority')
kernel_command_line: Optional[str] = Field(None, title='Command line parameters sent to the kernel')
kvm: Kvm = Field(..., title='KVM requirements')
options: Optional[str] = Field(None, title='Optional additional qemu command line options')
cpu_throttling: Optional[Annotated[float, Field(ge=0.0, le=100.0)]] = Field(None, title='Throttle the CPU')
on_close: Optional[QemuOnClose] = Field(None, title='Action to execute on the VM is closed')
process_priority: Optional[QemuProcessPriority] = Field(None, title='Process priority for QEMU')
class ApplianceVersionImages(BaseModel):
"""Appliance version images configuration for v1-6"""
kernel_image: Optional[str] = Field(None, title='Kernel image')
initrd: Optional[str] = Field(None, title='Initrd disk image')
image: Optional[str] = Field(None, title='OS image')
bios_image: Optional[str] = Field(None, title='Bios image')
hda_disk_image: Optional[str] = Field(None, title='Hda disk image')
hdb_disk_image: Optional[str] = Field(None, title='Hdc disk image')
hdc_disk_image: Optional[str] = Field(None, title='Hdd disk image')
hdd_disk_image: Optional[str] = Field(None, title='Hdd diskimage')
cdrom_image: Optional[str] = Field(None, title='cdrom image')
class ApplianceVersion(BaseModel):
"""Appliance version definition for v1-6"""
name: str = Field(..., title='Name of the version')
idlepc: Optional[str] = Field(None, pattern='^0x[0-9a-f]{8}')
images: Optional[ApplianceVersionImages] = Field(None, title='Images used for this version')
class ApplianceImage(BaseModel):
"""Appliance image definition - compatible with both versions"""
filename: str = Field(..., title='Filename')
version: str = Field(..., title='Version of the file')
md5sum: Optional[str] = Field(None, title='md5sum of the file', pattern='^[a-f0-9]{32}$')
filesize: int = Field(..., title='File size in bytes')
download_url: Optional[Union[AnyUrl, Annotated[str, Field(max_length=0)]]] = Field(
None,
title='Download url where you can download the appliance from a browser'
)
direct_download_url: Optional[Union[AnyUrl, Annotated[str, Field(max_length=0)]]] = Field(
None,
title='Optional. Non authenticated url to the image file where you can download the image.',
)
compression: Optional[Compression] = Field(
None, title='Optional, compression type of direct download url image.'
)
checksum: Optional[str] = Field(None, title='checksum of the image file')
checksum_type: Optional[ChecksumType] = Field(None, title='checksum type of the image file')
compression_target: Optional[str] = Field(
None, title='Optional, file name of the image file inside the compressed file.'
)
# ============================================================================
# Version 8 Models
# ============================================================================
class CustomAdapterItem(BaseModel):
"""Custom adapter configuration (v8)"""
adapter_number: int = Field(..., title='Adapter number')
port_name: Optional[str] = Field(None, title='Custom port name')
adapter_type: Optional[QemuAdapterType] = Field(None, title='Custom adapter type')
mac_address: Optional[str] = Field(
None,
title='Custom MAC address',
pattern=r'^([0-9a-fA-F]{2}[:]){5}([0-9a-fA-F]{2})$',
)
class DockerPropertiesV8(BaseModel):
"""Docker template properties (v8)"""
name: Optional[str] = Field(None, title='Name of the template')
category: Optional[Category] = Field(None, title='Category of the template')
default_name_format: Optional[str] = Field(None, title='Default name format')
usage: Optional[str] = Field(None, title='How to use the template')
symbol: Optional[str] = Field(None, title='Symbol of the template')
image: str = Field(..., title='Docker image')
adapters: Optional[int] = Field(None, title='Number of ethernet adapters')
start_command: Optional[str] = Field(
None, title='Command executed when the container start. Empty will use the default'
)
environment: Optional[str] = Field(None, title='One KEY=VAR environment by line')
console_type: Optional[DockerConsoleType] = Field(
None, title='Type of console'
)
console_http_port: Optional[int] = Field(
None, title='Internal port in the container of the HTTP server'
)
console_http_path: Optional[str] = Field(None, title='Path of the web interface')
console_resolution: Optional[str] = Field(
None,
title='Console resolution for VNC, for example 1024x768',
pattern=r'^[0-9]+x[0-9]+$',
)
extra_hosts: Optional[str] = Field(None, title='Docker extra hosts (added to /etc/hosts)')
extra_volumes: Optional[List[str]] = Field(
None, title='Additional directories to make persistent'
)
extra_configs: Optional[List[ExtraConfig]] = Field(
None, title='Configuration files injected into the container (bind-mounted read-only)'
)
class IouPropertiesV8(BaseModel):
"""IOU template properties (v8)"""
name: Optional[str] = Field(None, title='Name of the template')
category: Optional[Category] = Field(None, title='Category of the template')
default_name_format: Optional[str] = Field(None, title='Default name format')
usage: Optional[str] = Field(None, title='How to use the template')
symbol: Optional[str] = Field(None, title='Symbol of the template')
ethernet_adapters: Optional[int] = Field(None, title='Number of ethernet adapters')
serial_adapters: Optional[int] = Field(None, title='Number of serial adapters')
ram: Optional[int] = Field(None, title='Host RAM')
nvram: Optional[int] = Field(None, title='Host NVRAM')
startup_config: Optional[str] = Field(None, title='Config loaded at startup')
class DynamipsPropertiesV8(BaseModel):
"""Dynamips template properties (v8)"""
name: Optional[str] = Field(None, title='Name of the template')
category: Optional[Category] = Field(None, title='Category of the template')
default_name_format: Optional[str] = Field(None, title='Default name format')
usage: Optional[str] = Field(None, title='How to use the template')
symbol: Optional[str] = Field(None, title='Symbol of the template')
chassis: Optional[DynamipsChassis] = Field(None, title='Chassis type')
platform: Optional[DynamipsPlatform] = Field(None, title='Platform type')
ram: Optional[Annotated[int, Field(ge=1)]] = Field(None, title='Amount of ram')
nvram: Optional[Annotated[int, Field(ge=1)]] = Field(None, title='Amount of nvram')
idlepc: Optional[str] = Field(None, pattern=r'^0x[0-9a-f]{8}')
startup_config: Optional[str] = Field(None, title='Config loaded at startup')
wic0: Optional[str] = Field(None)
wic1: Optional[str] = Field(None)
wic2: Optional[str] = Field(None)
slot0: Optional[str] = Field(None)
slot1: Optional[str] = Field(None)
slot2: Optional[str] = Field(None)
slot3: Optional[str] = Field(None)
slot4: Optional[str] = Field(None)
slot5: Optional[str] = Field(None)
slot6: Optional[str] = Field(None)
midplane: Optional[DynamipsMidplane] = Field(None)
npe: Optional[DynamipsNpe] = Field(None)
class QemuPropertiesV8(BaseModel):
"""Qemu template properties (v8)"""
name: Optional[str] = Field(None, title='Name of the template')
category: Optional[Category] = Field(None, title='Category of the template')
default_name_format: Optional[str] = Field(None, title='Default name format')
usage: Optional[str] = Field(None, title='How to use the template')
symbol: Optional[str] = Field(None, title='Symbol of the template')
adapter_type: Optional[QemuAdapterType] = Field(None, title='Type of network adapter')
adapters: Optional[int] = Field(None, title='Number of adapters')
custom_adapters: Optional[List[CustomAdapterItem]] = Field(None, title='Custom adapters')
first_port_name: Optional[str] = Field(
None, title='Optional name of the first networking port example: eth0'
)
port_name_format: Optional[str] = Field(
None, title='Optional formating of the networking port example: eth{0}'
)
port_segment_size: Optional[int] = Field(
None,
title='Optional port segment size. A port segment is a block of port. For example Ethernet0/0 Ethernet0/1 is the module 0 with a port segment size of 2',
)
linked_clone: Optional[bool] = Field(None, title="False if you don't want to use a single image for all nodes")
ram: Optional[int] = Field(None, title='Ram allocated to the appliance (MB)')
cpus: Optional[int] = Field(None, title='Number of Virtual CPU')
hda_disk_interface: Optional[QemuDiskInterface] = Field(None, title='Disk interface for the installed hda_disk_image')
hdb_disk_interface: Optional[QemuDiskInterface] = Field(None, title='Disk interface for the installed hdb_disk_image')
hdc_disk_interface: Optional[QemuDiskInterface] = Field(None, title='Disk interface for the installed hdc_disk_image')
hdd_disk_interface: Optional[QemuDiskInterface] = Field(None, title='Disk interface for the installed hdd_disk_image')
platform: Optional[QemuPlatform] = Field(None, title='Platform to emulate')
console_type: Optional[QemuConsoleType] = Field(
None, title='Type of console connection for the administration of the appliance'
)
boot_priority: Optional[QemuBootPriority] = Field(
None,
title='Optional define the disk boot priory. Refer to -boot option in qemu manual for more details.',
)
kernel_command_line: Optional[str] = Field(None, title='Command line parameters send to the kernel')
options: Optional[str] = Field(None, title='Optional additional qemu command line options')
cpu_throttling: Optional[Annotated[float, Field(ge=0.0, le=100.0)]] = Field(None, title='Throttle the CPU')
tpm: Optional[bool] = Field(None, title='Enable the Trusted Platform Module (TPM)')
uefi: Optional[bool] = Field(None, title='Enable the UEFI boot mode')
on_close: Optional[QemuOnClose] = Field(None, title='Action to execute on the VM is closed')
process_priority: Optional[QemuProcessPriority] = Field(None, title='Process priority for QEMU')
class TemplateSetting(BaseModel):
"""Emulator settings configuration (v8)"""
name: Optional[str] = Field(None, title='Name of the settings set')
default: Optional[bool] = Field(None, title='Whether these are the default settings')
inherit_default_properties: Optional[bool] = Field(True, title='Whether the default properties should be used')
template_type: TemplateType = Field(..., title='Type of emulator properties')
template_properties: Union[QemuPropertiesV8, DynamipsPropertiesV8, IouPropertiesV8, DockerPropertiesV8] = Field(
...,
title='Properties for the template'
)
class ApplianceVersionV8(BaseModel):
"""Appliance version definition (v8)"""
name: str = Field(..., title='Name of the version')
settings: Optional[str] = Field(None, title='Template settings to use to run the version')
category: Optional[Category] = Field(None, title='Category of the version')
installation_instructions: Optional[str] = Field(None, title='Optional installation instructions for the version')
usage: Optional[str] = Field(None, title='Optional instructions about using the version')
default_username: Optional[str] = Field(None, title='Default username for the version')
default_password: Optional[str] = Field(None, title='Default password for the version')
symbol: Optional[str] = Field(None, title='An optional symbol for the version')
images: Optional[ApplianceVersionImages] = Field(None, title='Images used for this version')
# ============================================================================
# Child Models with Discriminated Union
# ============================================================================
class ApplianceV1_6(BaseModel):
"""GNS3 Appliance model for registry versions 1-6"""
registry_version: Literal[1, 2, 3, 4, 5, 6] = Field(..., title='Version of the registry compatible with this appliance')
appliance_id: UUID = Field(..., title='Appliance ID')
name: str = Field(..., title='Appliance name')
builtin: Optional[bool] = Field(None, title='Whether the appliance is builtin or not')
category: Category = Field(..., title='Category of the appliance')
description: str = Field(..., title='Description of the appliance. Could be a marketing description')
vendor_name: str = Field(..., title='Name of the vendor')
vendor_url: Optional[Union[AnyUrl, Annotated[str, Field(max_length=0)]]] = Field(None, title='Website of the vendor')
documentation_url: Optional[Union[AnyUrl, Annotated[str, Field(max_length=0)]]] = Field(
None,
title='An optional documentation for using the appliance on vendor website'
)
product_name: str = Field(..., title='Product name')
product_url: Optional[Union[AnyUrl, Annotated[str, Field(max_length=0)]]] = Field(None, title='An optional product url on vendor website')
status: Status = Field(..., title='Document if the appliance is working or not')
availability: Optional[Availability] = Field(
None,
title='About image availability: can be downloaded directly; download requires a free registration; paid but a trial version (time or feature limited) is available; not available publicly',
)
maintainer: str = Field(..., title='Maintainer name')
maintainer_email: Optional[Union[EmailStr, Annotated[str, Field(max_length=0)]]] = Field(None, title='Maintainer email')
usage: Optional[str] = Field(None, title='How to use the appliance')
symbol: Optional[str] = Field(None, title='An optional symbol for the appliance')
first_port_name: Optional[str] = Field(None, title='Optional name of the first networking port example: eth0')
port_name_format: Optional[str] = Field(None, title='Optional formating of the networking port example: eth{0}')
port_segment_size: Optional[int] = Field(
None,
title='Optional port segment size. A port segment is a block of port. For example Ethernet0/0 Ethernet0/1 is the module 0 with a port segment size of 2',
)
custom_adapters: Optional[List[CustomAdapterItem]] = Field(
None, title='Optional per-adapter overrides (port name, adapter type, MAC address)'
)
linked_clone: Optional[bool] = Field(None, title="False if you don't want to use a single image for all nodes")
docker: Optional[Docker] = Field(None, title='Docker specific options')
iou: Optional[Iou] = Field(None, title='IOU specific options')
dynamips: Optional[Dynamips] = Field(None, title='Dynamips specific options')
qemu: Optional[Qemu] = Field(None, title='Qemu specific options')
tags: Optional[List[str]] = Field(None, title='User-defined metadata tags for the appliance')
images: Optional[List[ApplianceImage]] = Field(None, title='Images for this appliance')
versions: Optional[List[ApplianceVersion]] = Field(None, title='Versions of the appliance')
class ApplianceV8(BaseModel):
"""GNS3 Appliance model for registry version 8"""
registry_version: Literal[8] = Field(
...,
title='Version of the registry compatible with this appliance (version >=8 introduced breaking changes)',
)
appliance_id: str = Field(
...,
title='Appliance ID',
pattern=r'^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$',
)
name: str = Field(..., title='Appliance name')
builtin: Optional[bool] = Field(None, title='Whether the appliance is builtin or not')
category: Category = Field(..., title='Category of the appliance')
description: str = Field(..., title='Description of the appliance. Could be a marketing description')
vendor_name: str = Field(..., title='Name of the vendor')
vendor_url: AnyUrl = Field(..., title='Website of the vendor')
vendor_logo_url: Optional[AnyUrl] = Field(None, title='Link to the vendor logo (used by the GNS3 marketplace)')
documentation_url: Optional[AnyUrl] = Field(None, title='An optional documentation for using the appliance on vendor website')
product_name: str = Field(..., title='Product name')
product_url: Optional[AnyUrl] = Field(None, title='An optional product url on vendor website')
status: Status = Field(..., title='Document if the appliance is working or not')
availability: Optional[Availability] = Field(
None,
title='About image availability: can be downloaded directly; download requires a free registration; paid but a trial version (time or feature limited) is available; not available publicly',
)
maintainer: str = Field(..., title='Maintainer name')
maintainer_email: EmailStr = Field(..., title='Maintainer email')
installation_instructions: Optional[str] = Field(None, title='Optional installation instructions')
usage: Optional[str] = Field(None, title='How to use the appliance')
default_username: Optional[str] = Field(None, title='Default username for the appliance')
default_password: Optional[str] = Field(None, title='Default password for the appliance')
symbol: Optional[str] = Field(None, title='An optional symbol for the appliance')
tags: Optional[List[str]] = Field(None, title='User-defined metadata tags for the appliance')
settings: List[TemplateSetting] = Field(..., title='Settings for running the appliance')
images: Optional[List[ApplianceImage]] = Field(None, title='Images for this appliance')
versions: Optional[List[ApplianceVersionV8]] = Field(None, title='Versions of the appliance')
# ============================================================================
# Discriminated Union
# ============================================================================
# Define the discriminated union type
ApplianceUnion = Annotated[
Union[
Annotated[ApplianceV1_6, Tag('v1_6')],
Annotated[ApplianceV8, Tag('v8')],
],
Discriminator('registry_version'),
]
"""
Discriminated union type supporting both registry versions 1-6 and 8.
Uses registry_version field to automatically route to correct model.
"""
# For type hints in function signatures
Appliance = ApplianceUnion
# Create a validator wrapper for convenience
from pydantic import TypeAdapter
_appliance_validator = TypeAdapter(ApplianceUnion)
class ApplianceModel:
"""
Wrapper class to provide model_validate() method for the Appliance union type.
This allows seamless usage of schemas.Appliance.model_validate() in existing code.
"""
@staticmethod
def model_validate(data: dict) -> Union[ApplianceV1_6, ApplianceV8]:
"""
Validate appliance data and return appropriate model instance.
Automatically routes to ApplianceV1_6 or ApplianceV8 based on registry_version.
"""
return _appliance_validator.validate_python(data)
Reference in New Issue View Git Blame Copy Permalink