gns3-server 3.0.0__py3-none-any.whl

gns3server/schemas/controller/capabilities.py

@@ -0,0 +1,34 @@
+#
+# Copyright (C) 2020 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/>.
+
+
+from pydantic import BaseModel, Field
+from typing import List
+
+from .nodes import NodeType
+
+
+class Capabilities(BaseModel):
+    """
+    Capabilities properties.
+    """
+
+    version: str = Field(..., description="Compute version number")
+    node_types: List[NodeType] = Field(..., description="Node types supported by the compute")
+    platform: str = Field(..., description="Platform where the compute is running")
+    cpus: int = Field(..., description="Number of CPUs on this compute")
+    memory: int = Field(..., description="Amount of memory on this compute")
+    disk_size: int = Field(..., description="Disk size on this compute")

gns3server/schemas/controller/computes.py

@@ -0,0 +1,168 @@
+#
+# Copyright (C) 2020 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/>.
+
+import uuid
+
+from pydantic import (
+    ConfigDict,
+    BaseModel,
+    Field,
+    SecretStr,
+    field_validator,
+    model_validator
+)
+from typing import List, Optional, Union, Any
+from enum import Enum
+
+from .nodes import NodeType
+from .base import DateTimeModelMixin
+
+
+class Protocol(str, Enum):
+    """
+    Protocol supported to communicate with a compute.
+    """
+
+    http = "http"
+    https = "https"
+
+
+class ComputeBase(BaseModel):
+    """
+    Data to create a compute.
+    """
+
+    protocol: Protocol
+    host: str
+    port: int = Field(..., gt=0, le=65535)
+    user: str = None
+    password: Optional[SecretStr] = None
+    name: Optional[str] = None
+    model_config = ConfigDict(use_enum_values=True)
+
+
+class ComputeCreate(ComputeBase):
+    """
+    Data to create a compute.
+    """
+
+    compute_id: Union[str, uuid.UUID] = None
+    model_config = ConfigDict(json_schema_extra={
+        "example": {
+            "name": "My compute",
+            "host": "127.0.0.1",
+            "port": 3080,
+            "user": "user",
+            "password": "password"
+        }
+    })
+
+    @model_validator(mode='before')
+    @classmethod
+    def set_default_compute_id_and_name(cls, data: Any) -> Any:
+
+        if "compute_id" not in data:
+            data['compute_id'] = uuid.uuid5(
+                uuid.NAMESPACE_URL,
+                f"{data.get('protocol')}://{data.get('host')}:{data.get('port')}"
+            )
+        if "name" not in data:
+            data['name'] = f"{data.get('protocol')}://{data.get('user', '')}@{data.get('host')}:{data.get('port')}"
+        return data
+
+
+class ComputeUpdate(ComputeBase):
+    """
+    Data to update a compute.
+    """
+
+    protocol: Optional[Protocol] = None
+    host: Optional[str] = None
+    port: Optional[int] = Field(None, gt=0, le=65535)
+    user: Optional[str] = None
+    password: Optional[SecretStr] = None
+    model_config = ConfigDict(json_schema_extra={
+        "example": {
+            "host": "10.0.0.1",
+            "port": 8080,
+        }
+    })
+
+
+class Capabilities(BaseModel):
+    """
+    Capabilities supported by a compute.
+    """
+
+    version: str = Field(..., description="Compute version number")
+    node_types: List[NodeType] = Field(..., description="Node types supported by the compute")
+    platform: str = Field(..., description="Platform where the compute is running (Linux, Windows or macOS)")
+    cpus: int = Field(..., description="Number of CPUs on this compute")
+    memory: int = Field(..., description="Amount of memory on this compute")
+    disk_size: int = Field(..., description="Disk size on this compute")
+
+
+class Compute(DateTimeModelMixin, ComputeBase):
+    """
+    Data returned for a compute.
+    """
+
+    compute_id: Union[str, uuid.UUID]
+    name: str
+    connected: Optional[bool] = Field(None, description="Whether the controller is connected to the compute or not")
+    cpu_usage_percent: Optional[float] = Field(None, description="CPU usage of the compute", ge=0, le=100)
+    memory_usage_percent: Optional[float] = Field(None, description="Memory usage of the compute", ge=0, le=100)
+    disk_usage_percent: Optional[float] = Field(None, description="Disk usage of the compute", ge=0, le=100)
+    last_error: Optional[str] = Field(None, description="Last error found on the compute")
+    capabilities: Optional[Capabilities] = None
+    model_config = ConfigDict(from_attributes=True)
+
+
+class ComputeVirtualBoxVM(BaseModel):
+    """
+    VirtualBox VM from compute.
+    """
+
+    vmname: str = Field(..., description="VirtualBox VM name")
+    ram: int = Field(..., description="VirtualBox VM memory")
+
+
+class ComputeVMwareVM(BaseModel):
+    """
+    VMware VM from compute.
+    """
+
+    vmname: str = Field(..., description="VMware VM name")
+    vmx_path: str = Field(..., description="Path to the vmx file")
+
+
+class ComputeDockerImage(BaseModel):
+    """
+    Docker image from compute.
+    """
+
+    image: str = Field(..., description="Docker image name")
+
+
+class AutoIdlePC(BaseModel):
+    """
+    Data for auto Idle-PC request.
+    """
+
+    platform: str = Field(..., description="Cisco platform")
+    image: str = Field(..., description="Image path")
+    ram: int = Field(..., description="Amount of RAM in MB")
+    model_config = ConfigDict(json_schema_extra={"example": {"platform": "c7200", "image": "/path/to/c7200_image.bin", "ram": 256}})

gns3server/schemas/controller/drawings.py

@@ -0,0 +1,34 @@
+#
+# Copyright (C) 2020 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/>.
+
+from pydantic import BaseModel, Field
+from typing import Optional
+from uuid import UUID
+
+
+class Drawing(BaseModel):
+    """
+    Drawing data.
+    """
+
+    drawing_id: Optional[UUID] = None
+    project_id: Optional[UUID] = None
+    x: Optional[int] = None
+    y: Optional[int] = None
+    z: Optional[int] = None
+    locked: Optional[bool] = None
+    rotation: Optional[int] = Field(None, ge=-359, le=360)
+    svg: Optional[str] = None

gns3server/schemas/controller/gns3vm.py

@@ -0,0 +1,56 @@
+#
+# Copyright (C) 2020 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/>.
+
+from pydantic import BaseModel, Field
+from typing import Optional
+from enum import Enum
+
+
+class WhenExit(str, Enum):
+    """
+    What to do with the VM when GNS3 VM exits.
+    """
+
+    stop = "stop"
+    suspend = "suspend"
+    keep = "keep"
+
+
+class Engine(str, Enum):
+    """
+    "The engine to use for the GNS3 VM.
+    """
+
+    vmware = "vmware"
+    virtualbox = "virtualbox"
+    hyperv = "hyper-v"
+    none = "none"
+
+
+class GNS3VM(BaseModel):
+    """
+    GNS3 VM data.
+    """
+
+    enable: Optional[bool] = Field(None, description="Enable/disable the GNS3 VM")
+    vmname: Optional[str] = Field(None, description="GNS3 VM name")
+    when_exit: Optional[WhenExit] = Field(None, description="Action when the GNS3 VM exits")
+    headless: Optional[bool] = Field(None, description="Start the GNS3 VM GUI or not")
+    engine: Optional[Engine] = Field(None, description="The engine to use for the GNS3 VM")
+    allocate_vcpus_ram: Optional[bool] = Field(None, description="Allocate vCPUS and RAM settings")
+    vcpus: Optional[int] = Field(None, description="Number of CPUs to allocate for the GNS3 VM")
+    ram: Optional[int] = Field(None, description="Amount of memory to allocate for the GNS3 VM")
+    port: Optional[int] = Field(None, gt=0, le=65535)

gns3server/schemas/controller/images.py

@@ -0,0 +1,44 @@
+#
+# Copyright (C) 2021 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/>.
+
+from pydantic import ConfigDict, BaseModel, Field
+from enum import Enum
+
+from .base import DateTimeModelMixin
+
+
+class ImageType(str, Enum):
+
+    qemu = "qemu"
+    ios = "ios"
+    iou = "iou"
+
+
+class ImageBase(BaseModel):
+    """
+    Common image properties.
+    """
+
+    filename: str = Field(..., description="Image filename")
+    path: str = Field(..., description="Image path")
+    image_type: ImageType = Field(..., description="Image type")
+    image_size: int = Field(..., description="Image size in bytes")
+    checksum: str = Field(..., description="Checksum value")
+    checksum_algorithm: str = Field(..., description="Checksum algorithm")
+
+
+class Image(DateTimeModelMixin, ImageBase):
+    model_config = ConfigDict(from_attributes=True)

gns3server/schemas/controller/iou_license.py

@@ -0,0 +1,23 @@
+#
+# Copyright (C) 2018 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/>.
+
+from pydantic import BaseModel, Field
+
+
+class IOULicense(BaseModel):
+
+    iourc_content: str = Field(..., description="Content of iourc file")
+    license_check: bool = Field(..., description="Whether the license must be checked or not")

gns3server/schemas/controller/labels.py

@@ -0,0 +1,30 @@
+#
+# Copyright (C) 2021 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/>.
+
+from pydantic import BaseModel, Field
+from typing import Optional, Union
+
+
+class Label(BaseModel):
+    """
+    Label data.
+    """
+
+    text: str
+    style: Optional[Union[str, None]] = Field(None, description="SVG style attribute. Apply default style if null")
+    x: Optional[Union[int, None]] = Field(None, description="Relative X position of the label. Center it if null")
+    y: Optional[int] = Field(None, description="Relative Y position of the label")
+    rotation: Optional[int] = Field(None, ge=-359, le=360, description="Rotation of the label")

gns3server/schemas/controller/links.py

@@ -0,0 +1,94 @@
+#
+# Copyright (C) 2020 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/>.
+
+from pydantic import BaseModel, Field
+from typing import List, Optional
+from enum import Enum
+from uuid import UUID, uuid4
+
+from .labels import Label
+
+
+class LinkNode(BaseModel):
+    """
+    Link node data.
+    """
+
+    node_id: UUID
+    adapter_number: int
+    port_number: int
+    label: Optional[Label] = None
+
+
+class LinkType(str, Enum):
+    """
+    Link type.
+    """
+
+    ethernet = "ethernet"
+    serial = "serial"
+
+
+class LinkStyle(BaseModel):
+
+    color: Optional[str] = None
+    width: Optional[int] = None
+    type: Optional[int] = None
+
+
+class LinkBase(BaseModel):
+    """
+    Link data.
+    """
+
+    nodes: Optional[List[LinkNode]] = Field(None, min_length=0, max_length=2)
+    suspend: Optional[bool] = None
+    link_style: Optional[LinkStyle] = None
+    filters: Optional[dict] = None
+
+
+class LinkCreate(LinkBase):
+
+    link_id: UUID = Field(default_factory=uuid4)
+    nodes: List[LinkNode] = Field(..., min_length=2, max_length=2)
+
+
+class LinkUpdate(LinkBase):
+
+    pass
+
+
+class Link(LinkBase):
+
+    link_id: UUID
+    project_id: Optional[UUID] = None
+    link_type: Optional[LinkType] = None
+    capturing: Optional[bool] = Field(
+        None,
+        description="Read only property. True if a capture running on the link"
+    )
+    capture_file_name: Optional[str] = Field(
+        None,
+        description="Read only property. The name of the capture file if a capture is running"
+    )
+    capture_file_path: Optional[str] = Field(
+        None,
+        description="Read only property. The full path of the capture file if a capture is running"
+    )
+    capture_compute_id: Optional[str] = Field(
+        None,
+        description="Read only property. The compute identifier where a capture is running"
+    )

gns3server/schemas/controller/nodes.py

@@ -0,0 +1,177 @@
+#
+# Copyright (C) 2020 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/>.
+
+from pydantic import BaseModel, Field, model_validator
+from typing import List, Optional, Union, Any
+from enum import Enum
+from uuid import UUID, uuid4
+
+from .labels import Label
+from ..common import ConsoleType, NodeStatus, CustomAdapter
+
+
+class NodeType(str, Enum):
+    """
+    Supported node types.
+    """
+
+    cloud = "cloud"
+    nat = "nat"
+    ethernet_hub = "ethernet_hub"
+    ethernet_switch = "ethernet_switch"
+    frame_relay_switch = "frame_relay_switch"
+    atm_switch = "atm_switch"
+    docker = "docker"
+    dynamips = "dynamips"
+    vpcs = "vpcs"
+    virtualbox = "virtualbox"
+    vmware = "vmware"
+    iou = "iou"
+    qemu = "qemu"
+
+
+class Image(BaseModel):
+    """
+    Image data.
+    """
+
+    filename: str
+    path: str
+    md5sum: Optional[str] = None
+    filesize: Optional[int] = None
+
+
+class LinkType(str, Enum):
+    """
+    Supported link types.
+    """
+
+    ethernet = "ethernet"
+    serial = "serial"
+
+
+class DataLinkType(str, Enum):
+    """
+    Supported data link types.
+    """
+
+    atm = "DLT_ATM_RFC1483"
+    ethernet = "DLT_EN10MB"
+    frame_relay = "DLT_FRELAY"
+    cisco_hdlc = "DLT_C_HDLC"
+    ppp = "DLT_PPP_SERIAL"
+
+
+class NodeCapture(BaseModel):
+    """
+    Node capture data.
+    """
+
+    capture_file_name: str
+    data_link_type: Optional[DataLinkType] = None
+
+
+class NodePort(BaseModel):
+    """
+    Node port data.
+    """
+
+    name: str = Field(..., description="Port name")
+    short_name: str = Field(..., description="Port name")
+    adapter_number: int = Field(..., description="Adapter slot")
+    adapter_type: Optional[str] = Field(None, description="Adapter type")
+    port_number: int = Field(..., description="Port slot")
+    link_type: LinkType = Field(..., description="Type of link")
+    data_link_types: dict = Field(..., description="Available PCAP types for capture")
+    mac_address: Union[str, None] = Field(None, pattern="^([0-9a-fA-F]{2}[:]){5}([0-9a-fA-F]{2})$")
+
+
+class NodeBase(BaseModel):
+    """
+    Node data.
+    """
+
+    compute_id: Union[UUID, str]
+    name: str
+    node_type: NodeType
+
+    node_id: Optional[UUID] = None
+
+    console: Optional[int] = Field(None, gt=0, le=65535, description="Console TCP port")
+
+    console_type: Optional[ConsoleType] = None
+    console_auto_start: Optional[bool] = Field(
+        False, description="Automatically start the console when the node has started"
+    )
+    aux: Optional[int] = Field(None, gt=0, le=65535, description="Auxiliary console TCP port")
+    aux_type: Optional[ConsoleType] = None
+    properties: Optional[dict] = Field(default_factory=dict, description="Properties specific to an emulator")
+
+    label: Optional[Label] = None
+    symbol: Optional[str] = None
+
+    x: Optional[int] = 0
+    y: Optional[int] = 0
+    z: Optional[int] = 1
+    locked: Optional[bool] = Field(False, description="Whether the element locked or not")
+    port_name_format: Optional[str] = Field(
+        None, descript_port_name_formation="Formatting for port name {0} will be replace by port number"
+    )
+    port_segment_size: Optional[int] = Field(None, description="Size of the port segment")
+    first_port_name: Optional[str] = Field(None, description="Name of the first port")
+    custom_adapters: Optional[List[CustomAdapter]] = None
+
+
+class NodeCreate(NodeBase):
+
+    node_id: UUID = Field(default_factory=uuid4)
+
+
+class NodeUpdate(NodeBase):
+    """
+    Data to update a node.
+    """
+
+    compute_id: Optional[Union[UUID, str]] = None
+    name: Optional[str] = None
+    node_type: Optional[NodeType] = None
+
+
+class Node(NodeBase):
+
+    template_id: Optional[UUID] = Field(None,
+                                        description="Template UUID from which the node has been created. Read only")
+    project_id: Optional[UUID] = None
+    node_directory: Optional[str] = Field(None, description="Working directory of the node. Read only")
+    status: Optional[NodeStatus] = Field(None, description="Node status. Read only")
+    command_line: Optional[str] = Field(None, description="Command line use to start the node. Read only")
+    width: Optional[int] = Field(None, description="Width of the node. Read only")
+    height: Optional[int] = Field(None, description="Height of the node. Read only")
+    ports: Optional[List[NodePort]] = Field(None, description="List of node ports. Read only")
+    console_host: Optional[str] = Field(
+        None,
+        description="Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller",
+    )
+
+
+class NodeDuplicate(BaseModel):
+    """
+    Data to duplicate a node.
+    """
+
+    x: int
+    y: int
+    z: Optional[int] = 0