Kathara API Docs

API Overview

Classes

EventDispatcher.EventDispatcher: Class implementing an event dispatcher for custom events.
IManager.IManager: Interface to be implemented in the virtualization managers
ILinkStats.ILinkStats: Interface for handling the statistics of deployed collision domains
IMachineStats.IMachineStats: Interface for handling the statistics of deployed devices
FilesystemMixin.FilesystemMixin: Abstraction to manage filesystems of devices and network scenarios.
Kathara.Kathara: Facade class for interacting with Kathara. It is a proxy for the selected Manager.
DockerImage.DockerImage: Class responsible for interacting with Docker Images.
DockerLink.DockerLink: The class responsible for deploying Kathara collision domains as Docker networks and interact with them.
DockerMachine.DockerMachine: The class responsible for deploying Kathara devices as Docker container and interact with them.
DockerManager.DockerManager: The class responsible to interact between Kathara and the Docker APIs.
DockerPlugin.DockerPlugin: Class responsible for interacting with Docker Plugins.
DockerLinkStats.DockerLinkStats: The class responsible to handle Docker Networks statistics.
DockerMachineStats.DockerMachineStats: The class responsible to handle Docker Machine statistics.
KubernetesConfig.KubernetesConfig: Class responsible for loading Kubernetes configurations.
KubernetesConfigMap.KubernetesConfigMap: Class responsible for interacting with Kubernetes ConfigMap.
KubernetesLink.KubernetesLink: The class responsible for deploying Kathara collision domains as Kubernetes networks and interact with them.
KubernetesMachine.KubernetesMachine: Class responsible for managing Kathara devices representation in Kubernetes.
KubernetesManager.KubernetesManager: Class responsible for interacting with Kubernetes API.
KubernetesNamespace.KubernetesNamespace: Class responsible for interacting with Kubernetes namespaces.
KubernetesLinkStats.KubernetesLinkStats: The class responsible to handle Kubernetes Networks statistics.
KubernetesMachineStats.KubernetesMachineStats: The class responsible to handle Kubernetes Machine statistics.
ExternalLink.ExternalLink: A Kathara external collision domain. It is used to create a collision domain attached to a host interface.
Interface.Interface: Interface object associated to a Machine network interface.
Lab.Lab: A Kathara network scenario, containing information about devices and collision domains.
Link.Link: A Kathara collision domain.
Machine.Machine: A Kathara device.
Networking.Networking: Class responsible for managing ExternalLink objects attaching Kathara collision domain to host interfaces.
DepParser.DepParser: Class responsible for parsing the lab.dep file.
ExtParser.ExtParser: Class responsible for parsing lab.ext file.
FolderParser.FolderParser: Class responsible for parsing the folder in the network scenario directory.
LabParser.LabParser: Class responsible for parsing the lab.conf file.
OptionParser.OptionParser: Class responsible for parsing the network scenario options from CLI.
Setting.Setting: Class responsible for interacting with Kathara Settings.
types.SharedCollisionDomainsOption: Enum representing options for shared collision domains option.