Kathara API Docs

API Overview

Classes

• IManager.IManager: Interface to be implemented in the virtualization managers
• IExecStream.IExecStream: Interface for handling the commands stream exec
• 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.
• LabFilesystemMixin.LabFilesystemMixin: Abstraction to manage filesystems of 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.
• DockerExecStream.DockerExecStream: Docker-specific class for handling the commands stream exec.
• 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.
• KubernetesSecret.KubernetesSecret: Class responsible for interacting with Kubernetes secrets.
• KubernetesExecStream.KubernetesExecStream: Kubernetes-specific class for handling the commands stream exec.
• 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.

Functions

• decorators.privileged: Decorator function to execute a method with proper privileges. They are then dropped when method is executed.
• terminal_utils.get_terminal_size_tput
• terminal_utils.get_terminal_size_windows
• DockerManager.check_docker_status: Decorator function to check if Docker daemon is running properly.
• strings.formatted_strings
• utils.check_directory_permissions: Check directory permissions across different platforms.
• utils.check_python_version
• utils.check_required_single_not_none_var
• utils.check_single_not_none_var
• utils.chunk_list
• utils.class_for_name
• utils.convert_win_2_linux
• utils.exec_by_platform
• utils.generate_urlsafe_hash
• utils.get_absolute_path
• utils.get_architecture
• utils.get_current_user_home
• utils.get_current_user_info
• utils.get_current_user_name
• utils.get_current_user_uid_gid
• utils.get_executable_path
• utils.get_pool_size
• utils.human_readable_bytes
• utils.import_pywintypes
• utils.is_admin
• utils.is_platform
• utils.is_wsl_platform
• utils.list_chunks
• utils.pack_file_for_tar
• utils.pack_files_for_tar
• utils.parse_cd_mac_address
• utils.parse_docker_engine_version
• utils.pywintypes_import_stub: Stub module of pywintypes for Unix systems (so it won't raise any module not found exception).
• utils.pywintypes_import_win
• utils.re_search_fail
• utils.wait_user_input_linux: Non-blocking input function for Linux and macOS.
• utils.wait_user_input_windows: Return True if an Enter keypress is waiting to be read. Only for Windows.

---

This file was automatically generated via lazydocs.