gns3-server/gns3server/api/routes/controller/appliances.py

#
# 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/>.

"""
API routes for appliances.
"""

from fastapi import APIRouter
from typing import Optional, List

router = APIRouter()


@router.get("")
async def get_appliances(update: Optional[bool] = False, symbol_theme: Optional[str] = "Classic") -> List[dict]:
    """
    Return all appliances known by the controller.
    """

    from gns3server.controller import Controller

    controller = Controller.instance()
    if update:
        await controller.appliance_manager.download_appliances()
    controller.appliance_manager.load_appliances(symbol_theme=symbol_theme)
    return [c.asdict() for c in controller.appliance_manager.appliances.values()]