csle_cluster.cluster_manager package

Submodules

csle_cluster.cluster_manager.cluster_controller module

class csle_cluster.cluster_manager.cluster_controller.ClusterController

Bases: object

Controller managing API calls to cluster managers

static apply_filebeat_config(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Applies the filebeat config to a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• container_ip – the ip of the container

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static apply_filebeats_config(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to apply the filebeats configuration to a given execution

Parameters

• ip – the ip of the node where to start the filebeats

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static apply_heartbeat_config(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Applies the heartbeat configuration to a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the node to apply the config

Returns

The operation outcome

static apply_heartbeats_config(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to apply the hearbeats config to a given execution

Parameters

• ip – the ip of the node where to start the heartbeats

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static apply_kafka_config(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to apply the Kafka config to a given execution

Parameters

• ip – the ip of the node where to apply the Kafka config

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static apply_metricbeat_config(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Applies the metricbeat configuration to a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the node to apply the config

Returns

The operation outcome

static apply_metricbeats_config(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to apply the metricbeats configuration to a given execution

Parameters

• ip – the ip of the node where to start the metricbeats

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static apply_packetbeat_config(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Applies the packetbeat configuration to a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the node to apply the config

Returns

The operation outcome

static apply_packetbeats_config(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to apply the packetbeats configuration to a given execution

Parameters

• ip – the ip of the node where to start the packetbeats

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static apply_resource_constraints(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to apply resource constraints to containers of a given execution

Parameters

• ip – the ip of the node where to apply the resouce constraints

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static attach_containers_in_execution_to_networks(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to attach the containers of a given execution to networks

Parameters

• ip – the ip of the node where to attach the containers

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The node status

static check_pid(ip: str, port: int, pid: int) → OperationOutcomeDTO

Checks the status of a PID of a specific server

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• pid – the PID to check

Returns

The operation outcome

static clean_all_executions(ip: str, port: int) → OperationOutcomeDTO

Sends a request to clean all executions on a given node

Parameters

• ip – the ip of the node where to stop the executions

• port – the port of the cluster manager

Returns

The operation outcome

static clean_all_executions_of_emulation(ip: str, port: int, emulation: str) → OperationOutcomeDTO

Sends a request to a node to clean all executions of a given emulation

Parameters

• ip – the ip of the node where to clean the executions

• port – the port of the cluster manager

• emulation – the name of the emulation

Returns

The operation outcome

static clean_execution(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to clean a given execution

Parameters

• ip – the ip of the node where to clean the execution

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static configure_ovs(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to configure OVS switches of a given execution

Parameters

• ip – the ip of the node where to configure OVS

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_emulation_networks(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to create the networks of a specific emulation on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_flags(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to create flags of a given execution

Parameters

• ip – the ip of the node where to create the flags

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_kafka_topics(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Creates the kafka topics in a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_kibana_tunnel(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Creates a Kibana tunnel for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_ovs_switches(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the OVS switches of a given execution

Parameters

• ip – the ip of the node where to create the OVS switches

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_ryu_tunnel(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Creates a Ryu tunnel for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_topology(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to create the topology of a given execution

Parameters

• ip – the ip of the node where to create the topology

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_users(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to create users on a given execution

Parameters

• ip – the ip of the node where to create the users

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static create_vulnerabilities(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to create vulnerabilities of a given execution

Parameters

• ip – the ip of the node where to create the vulnerabilities

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_cadvisor_logs(ip: str, port: int) → Dict[str, Any]

Gets the cadvisor logs

Parameters

• ip – the ip of the node to get the cAdvisor logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_client_manager_logs(ip: str, port: int, emulation: str, ip_first_octet: int) → Dict[str, Any]

Gets the logs of the Client manager of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_client_managers_info(ip: str, port: int, emulation: str, ip_first_octet: int) → ClientManagersInfoDTO

Sends a request to get the client managers infos of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

a ClientManagersInfoDTO

static get_cluster_manager_logs(ip: str, port: int) → Dict[str, Any]

Gets the cluster manager logs

Parameters

• ip – the ip of the node where to get the cluster manager logs

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_container_logs(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → Dict[str, Any]

Gets the logs of a specific container of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static get_csle_log_files(ip: str, port: int) → Dict[str, Any]

Gets a list of log files in the CSLE log directory

Parameters

• ip – the ip of the node to get the CSLE logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_docker_logs(ip: str, port: int) → Dict[str, Any]

Gets the Docker logs

Parameters

• ip – the ip of the node to get the Docker logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_docker_stats_manager_info(ip: str, port: int, emulation: str, ip_first_octet: int) → DockerStatsManagersInfoDTO

Sends a request to get the docker stats manager infos of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

a DockerStatsManagersInfoDTO

static get_docker_stats_manager_status(ip: str, port: int) → DockerStatsMonitorStatusDTO

Sends a request to get the docker stats manager status on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The docker stats manager status

static get_docker_statsmanager_logs(ip: str, port: int) → Dict[str, Any]

Gets the docker statsmanager logs

Parameters

• ip – the ip of the node to get the Docker statsmanager logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_elk_logs(ip: str, port: int, emulation: str, ip_first_octet: int) → Dict[str, Any]

Gets the logs of the ELK stack of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_elk_manager_logs(ip: str, port: int, emulation: str, ip_first_octet: int) → Dict[str, Any]

Gets the logs of the ELK stack of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_elk_managers_info(ip: str, port: int, emulation: str, ip_first_octet: int) → ElkManagersInfoDTO

Sends a request to get the elk managers infos of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

an ElkManagersInfoDTO

static get_elk_status(ip: str, port: int, emulation: str, ip_first_octet: int) → ElkStatusDTO

Sends a request to get the status of the ELK stack of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The status of the ELK stack

static get_execution_info(ip: str, port: int, emulation: str, ip_first_octet: int) → ExecutionInfoDTO

Gets the info of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The execution info

static get_execution_time_series_data(ip: str, port: int, emulation: str, ip_first_octet: int, minutes: int) → EmulationMetricsTimeSeries

Sends a request to get time series data of a number of minutes of a given execution

Parameters

• ip – the ip of the node where to start the containers

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• minutes – the number of minutes of data to get in the time series

Returns

The time series data dto

static get_flask_logs(ip: str, port: int) → Dict[str, Any]

Gets the Flask logs

Parameters

• ip – the ip of the node where to get the flask logs

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_grafana_logs(ip: str, port: int) → Dict[str, Any]

Gets the Grafana logs

Parameters

• ip – the ip of the node to get the Grafana logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_host_manager_logs(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → Dict[str, Any]

Gets the logs of a specific host manager of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static get_host_managers_info(ip: str, port: int, emulation: str, ip_first_octet: int) → HostManagersInfoDTO

Gets the host managers info of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The host managers info

static get_host_monitor_threads_statuses(ip: str, port: int, emulation: str, ip_first_octet: int) → HostManagerStatusesDTO

Gets the host monitor thread statuses of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The statuses

static get_kafka_logs(ip: str, port: int, emulation: str, ip_first_octet: int) → Dict[str, Any]

Gets the logs of the Kafka server of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_kafka_manager_logs(ip: str, port: int, emulation: str, ip_first_octet: int) → Dict[str, Any]

Gets the logs of the Kafka manager of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_kafka_managers_info(ip: str, port: int, emulation: str, ip_first_octet: int) → KafkaManagersInfoDTO

Gets the info of kafka managers

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The kafka managers infos

static get_kafka_status(ip: str, port: int, emulation: str, ip_first_octet: int) → KafkaStatusDTO

Sends a request to stop the containers of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The kafka status

static get_log_file(ip: str, port: int, log_file_name: str) → Dict[str, Any]

Gets a specific log file from a node

Parameters

• ip – the ip of the node where to get the log file

• port – the port of the cluster manager

• log_file_name – the name of the log file

Returns

A DTO with the log files

static get_merged_execution_info(execution: EmulationExecution) → EmulationExecutionInfo

Gets the runtime info of a specific execution

Parameters

execution – the execution to get the info for

Returns

the info

static get_nginx_logs(ip: str, port: int) → Dict[str, Any]

Gets the Nginx logs

Parameters

• ip – the ip of the node to get the Nginx logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_node_exporter_logs(ip: str, port: int) → Dict[str, Any]

Gets the node exporter logs

Parameters

• ip – the ip of the node to get the node exporter logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_node_status(ip: str, port: int) → NodeStatusDTO

Gets the status of a cluster node

Parameters

• ip – the ip of the node to get the status

• port – the port of the cluster manager

Returns

The node status

static get_num_active_clients(ip: str, port: int, emulation: str, ip_first_octet: int) → GetNumClientsDTO

Sends a request to get the number of active clients of a given execution

Parameters

• ip – the ip of the node where query for the number of active clients

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_ossec_ids_logs(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → Dict[str, Any]

Gets the logs of a specific OSSEC IDS of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static get_ossec_ids_manager_logs(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → Dict[str, Any]

Gets the logs of a specific OSSEC IDS Manager of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static get_ossec_ids_managers_info(ip: str, port: int, emulation: str, ip_first_octet: int) → OSSECIdsManagersInfoDTO

Gets the info of OSSEC IDS managers

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The managers infos

static get_ossec_ids_monitor_thread_statuses(ip: str, port: int, emulation: str, ip_first_octet: int) → OSSECIdsMonitorThreadStatusesDTO

Gets the OSSEC IDS monitor thread statuses for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The thread statuses

static get_pgadmin_logs(ip: str, port: int) → Dict[str, Any]

Gets the pgAdming logs

Parameters

• ip – the ip of the node to get the pgAdmin logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_postgresql_logs(ip: str, port: int) → Dict[str, Any]

Gets the PostgreSQL logs

Parameters

• ip – the ip of the node to get the PostgreSQL logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_prometheus_logs(ip: str, port: int) → Dict[str, Any]

Gets the Prometheus logs

Parameters

• ip – the ip of the node to get the Prometheus logs from

• port – the port of the cluster manager

Returns

A DTO with the log files

static get_ryu_controller_logs(ip: str, port: int, emulation: str, ip_first_octet: int) → Dict[str, Any]

Gets the logs of the Ryu controller of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_ryu_manager_logs(ip: str, port: int, emulation: str, ip_first_octet: int) → Dict[str, Any]

Gets the logs of the Ryu manager of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static get_ryu_managers_info(ip: str, port: int, emulation: str, ip_first_octet: int) → RyuManagersInfoDTO

Gets the info of Ryu managers

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The ryu manager infos

static get_ryu_status(ip: str, port: int, emulation: str, ip_first_octet: int) → RyuManagerStatusDTO

Gets the Ryu status

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The Ryu status

static get_snort_ids_logs(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → Dict[str, Any]

Gets the logs of a specific Snort IDS of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static get_snort_ids_manager_logs(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → Dict[str, Any]

Gets the logs of a specific Snort IDS of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static get_snort_ids_managers_info(ip: str, port: int, emulation: str, ip_first_octet: int) → SnortIdsManagersInfoDTO

Gets the info of Snort IDS managers

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The Snort IDS managers infos

static get_snort_ids_monitor_thread_statuses(ip: str, port: int, emulation: str, ip_first_octet: int) → SnortIdsMonitorThreadStatusesDTO

Gets the Snort IDS monitor thread statuses for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The thread statuses

static get_traffic_manager_logs(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → Dict[str, Any]

Gets the logs of a specific Traffic manager of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static get_traffic_managers_info(ip: str, port: int, emulation: str, ip_first_octet: int) → TrafficManagersInfoDTO

Sends a request to get the client managers infos of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

a TrafficManagersInfoDTO

static install_libraries(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to install CSLE libraries on the containers of a given execution

Parameters

• ip – the ip of the node where to install the libraries

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static is_cluster_manager_running(ip: str, port: int, timeout_sec: int = 2) → bool

Utility function for checking if the cluster manager gRPC server is running on a given node

Parameters

• ip – ip of the node

• port – port of the gRPC server

• timeout_sec – timeout in seconds

Returns

True if it is running, otherwise False.

static list_all_container_images(ip: str, port: int) → ContainerImagesDTO

Sends a request to list all container images on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The container images

static list_all_docker_networks(ip: str, port: int) → DockerNetworksDTO

Sends a request to list all Docker networks on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The docker networks

static list_all_running_containers(ip: str, port: int) → RunningContainersDTO

Sends a request to list all running containers on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The docker networks

static list_all_running_emulations(ip: str, port: int) → RunningEmulationsDTO

Sends a request to list all running emulations on a given node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The docker networks

static list_all_stopped_containers(ip: str, port: int) → StoppedContainersDTO

Sends a request to list all running containers on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The docker networks

static list_kibana_tunnels(ip: str, port: int) → KibanaTunnelsDTO

Lists the Kibana tunnels of a given server

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The operation outcome

static list_ryu_tunnels(ip: str, port: int) → RyuTunnelsDTO

Lists the Ryu tunnels of a given server

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The operation outcome

static ping_execution(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to ping all containers of a given execution

Parameters

• ip – the ip of the node where to ping the execution

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static remove_all_container_images(ip: str, port: int) → OperationOutcomeDTO

Sends a request to remove all container images on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The operation outcome

static remove_all_docker_networks(ip: str, port: int) → OperationOutcomeDTO

Sends a request to remove all docker networks on a given node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The operation outcome

static remove_all_stopped_containers(ip: str, port: int) → OperationOutcomeDTO

Sends a request to remove all stopped containers on a given node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The operation outcome

static remove_container(ip: str, port: int, container_name: str) → OperationOutcomeDTO

Sends a request to remove a specific container on a specific nodep

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• container_name – the name of the container

Returns

The operation outcome

static remove_container_image(ip: str, port: int, image_name: str) → OperationOutcomeDTO

Sends a request to remove a specific container image on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• image_name – the name of the container

Returns

The operation outcome

static remove_docker_networks(ip: str, port: int, networks: List[str]) → OperationOutcomeDTO

Sends a request to remove a list of docker networks on a given node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• networks – the list of networks to remove

Returns

The operation outcome

static remove_kibana_tunnel(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Removes a Kibana tunnel for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static remove_ryu_tunnel(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Removes a Ryu tunnel for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static run_container(ip: str, port: int, image: str, name: str, memory: int, num_cpus: int, create_network: bool, version: str) → OperationOutcomeDTO

Sends a request to run a container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• image – the docker image

• name – the name of the container

• memory – the memory of the container (in GB)

• num_cpus – the number of CPUs of the container

• version – the version of the container

• create_network – boolean flag inidicating whether a network should be created for the container or not

Returns

The operation outcome

static run_emulation(execution: EmulationExecution, physical_servers: List[str], no_traffic: bool = False, no_clients: bool = False, no_beats: bool = False) → None

Runs a given emulation execution

Parameters

• execution – details about the execution to start

• physical_servers – the list of physical servers the emulation will be run on

• no_traffic – boolean flag indicating whether internal traffic generators should be started or not

• no_clients – boolean flag indicating whether clients should be started or not

• no_beats – boolean flag indicating whether configuration/starting of beats should be skipped or not

Returns

None

static start_all_stopped_containers(ip: str, port: int) → OperationOutcomeDTO

Sends a request to start all stopped containers on a given node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The operation outcome

static start_cadvisor(ip: str, port: int) → ServiceStatusDTO

Starts cAdvisor on a cluster node

Parameters

• ip – the ip of the node to start cAdvisor

• port – the port of the cluster manager

Returns

The status of the service

static start_client_manager(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the client manager of a given execution

Parameters

• ip – the ip of the node where to start the client manager

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_client_population(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the client population of a given execution

Parameters

• ip – the ip of the node where to start the client population

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_container(ip: str, port: int, container_name: str) → OperationOutcomeDTO

Sends a request to start a specific container on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• container_name – the name of the container

Returns

The operation outcome

static start_containers_in_execution(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the containers of a given execution

Parameters

• ip – the ip of the node where to start the containers

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The node status

static start_containers_of_execution(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the containers of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_docker_engine(ip: str, port: int) → ServiceStatusDTO

Stops Docker engine on a cluster node

Parameters

• ip – the ip of the node to stop the docker engine

• port – the port of the cluster manager

Returns

The status of the service

static start_docker_statsmanager(ip: str, port: int) → ServiceStatusDTO

Starts Docker statsmanager on a cluster node

Parameters

• ip – the ip of the node to start the docker statsmanager

• port – the port of the cluster manager

Returns

The status of the service

static start_docker_statsmanager_thread(ip: str, port: int, emulation: str, ip_first_octet: int) → ServiceStatusDTO

Sends a request to start a docker statsmanager thread for a given execution

Parameters

• ip – the ip of the node where to start the statsmanager

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_elastic(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start elastic of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_elk_manager(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the elk manager of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_elk_stack(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the ELK stack of a given execution

Parameters

• ip – the ip of the node where to start the elk stack

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_filebeat(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False) → OperationOutcomeDTO

Sends a request to start filebeat on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

• initial_start – boolean flag indicating whether it is an initial start or not

Returns

The operation outcome

static start_filebeats(ip: str, port: int, emulation: str, ip_first_octet: int, initial_start: bool = False) → OperationOutcomeDTO

Sends a request to start the filebeats of a given execution

Parameters

• ip – the ip of the node where to start the filebeats

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• initial_start – boolean flag whether it is the initial start of the filebeats or not

Returns

The operation outcome

static start_flask(ip: str, port: int) → ServiceStatusDTO

Starts Flask on a cluster node

Parameters

• ip – the ip of the node to start flask

• port – the port of the cluster manager

Returns

The status of the service

static start_grafana(ip: str, port: int) → ServiceStatusDTO

Starts Grafana on a cluster node

Parameters

• ip – the ip of the node to start Grafana

• port – the port of the cluster manager

Returns

The status of the service

static start_heartbeat(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False) → OperationOutcomeDTO

Sends a request to start heartbeat on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

• initial_start – boolean flag indicating whether it is an initial start or not

Returns

The operation outcome

static start_heartbeats(ip: str, port: int, emulation: str, ip_first_octet: int, initial_start: bool = False) → OperationOutcomeDTO

Sends a request to start the heartbeats of a given execution

Parameters

• ip – the ip of the node where to start the heartbeats

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• initial_start – boolean flag whether it is the initial start of the heartbeats or not

Returns

The operation outcome

static start_host_manager(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to start the host manager on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static start_host_managers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the host managers of a given execution

Parameters

• ip – the ip of the node where to start the host managers

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_host_monitor_thread(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to start the host monitor thread on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static start_host_monitor_threads(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the host monitor threads of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_kafka_client_producer(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the kafka client producer of a given execution

Parameters

• ip – the ip of the node where to start the kafka client producer

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_kafka_manager(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Starts the kafka manager in a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_kafka_server(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Starts the kafka server in a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_kibana(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start Kibana of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_logstash(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start Logstash of a given execution

Parameters

• ip – the ip of the node where to stop the traffic generator

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_metricbeat(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False) → OperationOutcomeDTO

Sends a request to start metricbeat on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• initial_start – boolean flag indicating whether it is an initial start or not

• container_ip – the ip of the container

Returns

The operation outcome

static start_metricbeats(ip: str, port: int, emulation: str, ip_first_octet: int, initial_start: bool = False) → OperationOutcomeDTO

Sends a request to start the metricbeats of a given execution

Parameters

• ip – the ip of the node where to start the metricbeats

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• initial_start – boolean flag whether it is the initial start of the metricbeats or not

Returns

The operation outcome

static start_nginx(ip: str, port: int) → ServiceStatusDTO

Starts nginx on a cluster node

Parameters

• ip – the ip of the node to start Nginx

• port – the port of the cluster manager

Returns

The status of the service

static start_node_exporter(ip: str, port: int) → ServiceStatusDTO

Starts Node exporter on a cluster node

Parameters

• ip – the ip of the node to start node exporter

• port – the port of the cluster manager

Returns

The status of the service

static start_ossec_ids(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Starts the OSSEC IDS on a specific host

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static start_ossec_ids_manager(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Starts the OSSEC IDS manager on a specific node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the node to apply the config

Returns

The operation outcome

static start_ossec_ids_managers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Starts the OSSEC IDS managers for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_ossec_ids_monitor_thread(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Starts the OSSEC IDS monitor thread on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the node to apply the config

Returns

The operation outcome

static start_ossec_idses(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the OSSEC IDSes of a given execution

Parameters

• ip – the ip of the node where to start the OSSEC IDS

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_ossec_idses_monitor_threads(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the OSSEC IDSes monitor threads of a given execution

Parameters

• ip – the ip of the node where to start the OSSEC IDS monitor threads

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_packetbeat(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False) → OperationOutcomeDTO

Sends a request to start packetbeat on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

• initial_start – boolean flag indicating whether it is an initial start or not

Returns

The operation outcome

static start_packetbeats(ip: str, port: int, emulation: str, ip_first_octet: int, initial_start: bool = False) → OperationOutcomeDTO

Sends a request to start the packetbeats of a given execution

Parameters

• ip – the ip of the node where to start the packetbeats

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• initial_start – boolean flag whether it is the initial start of the packetbeats or not

Returns

The operation outcome

static start_pgadmin(ip: str, port: int) → ServiceStatusDTO

Starts pgAdmin on a cluster node

Parameters

• ip – the ip of the node to start pgAdmin

• port – the port of the cluster manager

Returns

The status of the service

static start_postgresql(ip: str, port: int) → ServiceStatusDTO

Starts PostgreSQL on a cluster node

Parameters

• ip – the ip of the node to start PostgreSQL

• port – the port of the cluster manager

Returns

The status of the service

static start_prometheus(ip: str, port: int) → ServiceStatusDTO

Starts Prometheus on a cluster node

Parameters

• ip – the ip of the node to start Prometheus

• port – the port of the cluster manager

Returns

The status of the service

static start_ryu(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Starts Ryu

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_ryu_manager(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Starts the Ryu manager for a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_ryu_monitor(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Starts the Ryu monitor for a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_sdn_controller(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the Ryu SDN controller on a given execution

Parameters

• ip – the ip of the node where to start the SDN controller

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_sdn_controller_monitor(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the SDN controller monitor on a given execution

Parameters

• ip – the ip of the node where to start teh SDN controller monitor

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_snort_ids(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Starts the Snort IDS on a specific container in a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

Returns

The operation outcome

static start_snort_ids_manager(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Starts the Snort IDS manager at a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

Returns

The operation outcome

static start_snort_ids_managers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Starts the Snort IDS managers of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_snort_ids_monitor_thread(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Starts the Snort IDS monitor thread on a specific container in a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static start_snort_ids_monitor_threads(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Starts the Snort IDS monitor threads of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_snort_idses(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the Snort IDSes of a given execution

Parameters

• ip – the ip of the node where to start the Snort IDSes

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_snort_idses_monitor_threads(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the Snort IDSes monitor threads of a given execution

Parameters

• ip – the ip of the node where to start the Snort IDS monitor threads

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_spark_server(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Starts the Spark server on a specific container in a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

Returns

The operation outcome

static start_spark_servers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the Spark servers of a given execution

Parameters

• ip – the ip of the node where to start the Snort IDSes

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_traffic_generator(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to start a specific traffic generator

Parameters

• ip – the ip of the node where to start the traffic generator

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container where the traffic generator should be started

Returns

The operation outcome

static start_traffic_generators(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the traffic generators of a given execution

Parameters

• ip – the ip of the node where to start the traffic generators

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static start_traffic_manager(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to start a specific traffic manager

Parameters

• ip – the ip of the node where to stop the traffic manager

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container where the traffic manager should be started

Returns

The operation outcome

static start_traffic_managers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to start the traffic managers of a given execution

Parameters

• ip – the ip of the node where to start the traffic managers

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_all_executions(ip: str, port: int) → OperationOutcomeDTO

Sends a request to stop all executions on a given node

Parameters

• ip – the ip of the node where to stop the executions

• port – the port of the cluster manager

Returns

The operation outcome

static stop_all_executions_of_emulation(ip: str, port: int, emulation: str) → OperationOutcomeDTO

Sends a request to a node to stop all executions of a given emulation

Parameters

• ip – the ip of the node where to stop the executions

• port – the port of the cluster manager

• emulation – the name of the emulation

Returns

The operation outcome

static stop_all_running_containers(ip: str, port: int) → OperationOutcomeDTO

Sends a request to stop all running containers on a given node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

Returns

The operation outcome

static stop_cadvisor(ip: str, port: int) → ServiceStatusDTO

Stops cAdvisor on a cluster node

Parameters

• ip – the ip of the node to stop cAdvisor

• port – the port of the cluster manager

Returns

The status of the service

static stop_client_manager(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the client manager of a given execution

Parameters

• ip – the ip of the node where to start the client manager

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_client_population(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the client population of a given execution

Parameters

• ip – the ip of the node where to stop the client population

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_container(ip: str, port: int, container_name) → OperationOutcomeDTO

Sends a request to stop a specific container on a given node

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• container_name – the name of the container

Returns

The operation outcome

static stop_containers_of_execution(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the containers of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_docker_engine(ip: str, port: int) → ServiceStatusDTO

Stops Docker engine on a cluster node

Parameters

• ip – the ip of the node to stop the docker engine

• port – the port of the cluster manager

Returns

The status of the service

static stop_docker_statsmanager(ip: str, port: int) → ServiceStatusDTO

Stops Docker statsmanager on a cluster node

Parameters

• ip – the ip of the node to stop the statsmanager

• port – the port of the cluster manager

Returns

The status of the service

static stop_docker_statsmanager_thread(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the docker stats manager thread

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_elastic(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop elastic on a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_elk_manager(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the elk manager of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_elk_stack(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the ELK stack of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_execution(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop a given execution

Parameters

• ip – the ip of the node where to stop the execution

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_filebeat(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to stop filebeat on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

Returns

The operation outcome

static stop_filebeats(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the filebeats of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_flask(ip: str, port: int) → ServiceStatusDTO

Stops Flask on a cluster node

Parameters

• ip – the ip of the node to stop flask

• port – the port of the cluster manager

Returns

The status of the service

static stop_grafana(ip: str, port: int) → ServiceStatusDTO

Stops Grafana on a cluster node

Parameters

• ip – the ip of the node to stop Grafana

• port – the port of the cluster manager

Returns

The status of the service

static stop_heartbeat(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops heartbeat on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

Returns

The operation outcome

static stop_heartbeats(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the heartbeats of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_host_manager(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to stop the host manager on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

Returns

The operation outcome

static stop_host_managers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the host managers of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_host_monitor_thread(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to stop the host monitor thread on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static stop_host_monitor_threads(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the host monitor threads of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_kafka_client_producer(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the kafka client producer of a given execution

Parameters

• ip – the ip of the node where to stop the kafka client producer

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_kafka_manager(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the kafka manager of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_kafka_server(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the kafka server in a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_kibana(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop Kibana of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_logstash(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop Logstash of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_metricbeat(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops metricbeat on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static stop_metricbeats(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the metricbeats of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_nginx(ip: str, port: int) → ServiceStatusDTO

Stops nginx on a cluster node

Parameters

• ip – the ip of the node to stop Nginx

• port – the port of the cluster manager

Returns

The status of the service

static stop_node_exporter(ip: str, port: int) → ServiceStatusDTO

Stops Node exporter on a cluster node

Parameters

• ip – the ip of the node to stop node exporter

• port – the port of the cluster manager

Returns

The status of the service

static stop_ossec_ids(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops the OSSEC IDS on a specific host

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• container_ip – the IP of the node to apply the config

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_ossec_ids_manager(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to stop the containers of a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the node to apply the config

Returns

The operation outcome

static stop_ossec_ids_managers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the OSSEC IDS managers of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_ossec_ids_monitor_thread(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops the OSSEC IDS monitor thread on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• container_ip – the IP of the node to apply the config

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_ossec_ids_monitor_threads(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the OSSEC IDS monitor threads for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_ossec_idses(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stop the OSSEC IDSes in a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_packetbeat(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops packetbeat on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static stop_packetbeats(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the packetbeats of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_pgadmin(ip: str, port: int) → ServiceStatusDTO

Stops pgAdmin on a cluster node

Parameters

• ip – the ip of the node to stop pgAdmin

• port – the port of the cluster manager

Returns

The status of the service

static stop_pid(ip: str, port: int, pid: int) → OperationOutcomeDTO

Stops a PID of a specific server

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• pid – the PID to check

Returns

The operation outcome

static stop_postgresql(ip: str, port: int) → ServiceStatusDTO

Stops PostgreSQL on a cluster node

Parameters

• ip – the ip of the node to stop PostgreSQL

• port – the port of the cluster manager

Returns

The status of the service

static stop_prometheus(ip: str, port: int) → ServiceStatusDTO

Stops Prometheus on a cluster node

Parameters

• ip – the ip of the node to stop Prometheus

• port – the port of the cluster manager

Returns

The status of the service

static stop_ryu(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops Ryu

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_ryu_manager(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the Ryu manager for a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_ryu_monitor(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the Ryu monitor for a given execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_snort_ids(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops the Snort IDS on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• container_ip – the ip of the container

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_snort_ids_manager(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops the OSSEC IDS monitor threads for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

Returns

The operation outcome

static stop_snort_ids_managers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the Snort IDS managers of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_snort_ids_monitor_thread(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops the Snort IDS Monitor Thread on a specific container

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the IP of the container

Returns

The operation outcome

static stop_snort_ids_monitor_threads(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the Snort IDS managers of a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_snort_idses(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the Snort IDSes for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_snort_idses_monitor_threads(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Stops the Snort IDSes monitor threads for a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_spark_server(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Stops the Spark server on a specific container in a specific execution

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container

Returns

The operation outcome

static stop_spark_servers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the Spark servers of a given execution

Parameters

• ip – the ip of the node where to start the Snort IDSes

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_traffic_generator(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to stop a specific traffic generator

Parameters

• ip – the ip of the physical node

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container where the traffic generator should be stopped

Returns

The operation outcome

static stop_traffic_generators(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the traffic generators of a given execution

Parameters

• ip – the ip of the node where to stop the traffic generators

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

static stop_traffic_manager(ip: str, port: int, emulation: str, ip_first_octet: int, container_ip: str) → OperationOutcomeDTO

Sends a request to stop a specific traffic manager

Parameters

• ip – the ip of the node where to stop the traffic manager

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

• container_ip – the ip of the container where the traffic manager should be stopped

Returns

The operation outcome

static stop_traffic_managers(ip: str, port: int, emulation: str, ip_first_octet: int) → OperationOutcomeDTO

Sends a request to stop the traffic managers of a given execution

Parameters

• ip – the ip of the node where to stop the traffic managers

• port – the port of the cluster manager

• emulation – the emulation of the execution

• ip_first_octet – the ID of the execution

Returns

The operation outcome

csle_cluster.cluster_manager.cluster_manager module

class csle_cluster.cluster_manager.cluster_manager.ClusterManagerServicer

Bases: ClusterManagerServicer

gRPC server for managing a node in the CSLE management system cluster

applyFileBeatConfig(request: ApplyFileBeatConfigMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the filebeat config on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyFileBeatsConfig(request: ApplyFileBeatConfigsMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the filebeat configurations to a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyHeartBeatConfig(request: ApplyHeartBeatConfigMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the heartbeat config on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyHeartBeatsConfig(request: ApplyHeartBeatConfigsMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the heartbeat configurations to a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyKafkaConfig(request: ApplyKafkaConfigMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the Kafka configuration to an execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyMetricBeatConfig(request: ApplyMetricBeatConfigMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the metricbeat config on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyMetricBeatsConfig(request: ApplyMetricBeatConfigsMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the metricbeat configurations to a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyPacketBeatConfig(request: ApplyPacketBeatConfigMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the packetbeat config on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyPacketBeatsConfig(request: ApplyPacketBeatConfigsMsg, context: ServicerContext) → OperationOutcomeDTO

Applies the packetbeat configurations to a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

applyResourceConstraints(request: ApplyResouceConstraintsMsg, context: ServicerContext) → OperationOutcomeDTO

Applies resource constraints to containers in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

attachContainersInExecutionToNetworks(request: StartContainersInExecutionMsg, context: ServicerContext) → OperationOutcomeDTO

Attaches the containers of a given emulation execution that are configured to be deployed on this host to their corresponding virtual overlay networks

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

checkPid(request: CheckPidMsg, context: ServicerContext) → OperationOutcomeDTO

Checks the status of a PID

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

cleanAllExecutions(request: CleanAllExecutionsMsg, context: ServicerContext) → OperationOutcomeDTO

Cleans all executions

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

cleanAllExecutionsOfEmulation(request: CleanAllExecutionsOfEmulationMsg, context: ServicerContext) → OperationOutcomeDTO

Cleans all executions of a given emulation

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

cleanExecution(request: CleanExecutionMsg, context: ServicerContext) → OperationOutcomeDTO

Cleans a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

configureOvs(request: ConfigureOvsMsg, context: ServicerContext) → OperationOutcomeDTO

Configures OVS switches in an execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createEmulationNetworks(request: CreateEmulationNetworksMsg, context: ServicerContext) → OperationOutcomeDTO

Creates networks for a given emulation execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createFlags(request: CreateFlagsMsg, context: ServicerContext) → OperationOutcomeDTO

Creates flags in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createKafkaTopics(request: CreateKafkaTopicsMsg, context: ServicerContext) → OperationOutcomeDTO

Creates the kafka topics in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createKibanaTunnel(request: CreateKibanaTunnelMsg, context: ServicerContext) → OperationOutcomeDTO

Creates a new Kibana tunnel

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createOvsSwitches(request: CreateOvsSwitchesMsg, context: ServicerContext) → OperationOutcomeDTO

Creates OVS switches in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createRyuTunnel(request: CreateRyuTunnelMsg, context: ServicerContext) → OperationOutcomeDTO

Creates a new Ryu tunnel

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createTopology(request: CreateTopologyMsg, context: ServicerContext) → OperationOutcomeDTO

Configures the topology of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createUsers(request: CreateUsersMsg, context: ServicerContext) → OperationOutcomeDTO

Creates users in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

createVulnerabilities(request: CreateVulnsMsg, context: ServicerContext) → OperationOutcomeDTO

Creates vulnerabilities in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

getCadvisorLogs(request: GetCAdvisorLogsMsg, context: ServicerContext) → LogsDTO

Gets the cAdvisor logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getClientManagerLogsMsg(request: GetClientManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific Client manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getClientManagersInfo(request: GetClientManagersInfoMsg, context: ServicerContext) → ClientManagersInfoDTO

Gets the info of client managers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a ClientManagersInfoDTO

getClusterManagerLogs(request: GetClusterManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of the cluster manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getContainerLogs(request: GetContainerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getCsleLogFiles(request: GetCsleLogFilesMsg, context: ServicerContext) → LogsDTO

Gets the list of file names in the CSLE log directory

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getDockerLogs(request: GetDockerLogsMsg, context: ServicerContext) → LogsDTO

Gets the Docker logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getDockerStatsManagerLogs(request: GetDockerStatsManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the Docker statsmanager logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getDockerStatsManagerStatus(request: GetDockerStatsManagerStatusMsg, context: ServicerContext) → DockerStatsMonitorStatusDTO

Gets the docker stats manager status

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DockerStatsMonitorStatusDTO

getDockerStatsManagersInfo(request: GetDockerStatsManagersInfoMsg, context: ServicerContext) → DockerStatsManagersInfoDTO

Gets the info of docker stats maangers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DockerStatsManagersInfoDTO

getElkLogs(request: GetElkLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific ELK stack

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getElkManagerLogs(request: GetElkManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific ELK manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getElkManagersInfo(request: GetElkManagersInfoMsg, context: ServicerContext) → ElkManagersInfoDTO

Gets the info of elk managers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a ElkManagersInfoDTO

getElkStatus(request: GetElkStackStatusMsg, context: ServicerContext) → ElkStatusDTO

Gets the status of the Elk stack for a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an ElkStatusDTO

getExecutionInfo(request: GetExecutionInfoMsg, context: ServicerContext) → ExecutionInfoDTO

Gets the info of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an ExecutionInfoDTO

getExecutionTimeSeriesData(request: GetExecutionTimeSeriesDataMsg, context: ServicerContext) → EmulationMetricsTimeSeriesDTO

Gets time-series data of an emulation execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getFlaskLogs(request: GetFlaskLogsMsg, context: ServicerContext) → LogsDTO

Gets the Flask logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getGrafanaLogs(request: GetGrafanaLogsMsg, context: ServicerContext) → LogsDTO

Gets the Grafana logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getHostManagerLogs(request: GetHostManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific host manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getHostManagersInfo(request: GetHostManagersInfoMsg, context: ServicerContext) → HostManagersInfoDTO

Gets the info of host managers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a HostManagersInfoDTO

getHostMonitorThreadsStatuses(request: GetHostMonitorThreadsStatusesMsg, context: ServicerContext) → HostManagerStatusesDTO

Gets the host monitor thread statuses of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a HostManagerStatusesDTO

getKafkaLogs(request: GetKafkaLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific Kafka server

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getKafkaManagerLogs(request: GetKafkaManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific Kafka manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getKafkaManagersInfo(request: GetKafkaManagersInfoMsg, context: ServicerContext) → KafkaManagersInfoDTO

Gets the info of kafka managers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a KafkaManagersInfoDTO

getKafkaStatus(request: GetKafkaManagerStatusMsg, context: ServicerContext) → KafkaStatusDTO

Gets the Kafka status in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

getLogFile(request: GetLogFileMsg, context: ServicerContext) → LogsDTO

Gets a specific log file

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getNginxLogs(request: GetNginxLogsMsg, context: ServicerContext) → LogsDTO

Gets the nginx logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getNodeExporterLogs(request: GetNodeExporterLogsMsg, context: ServicerContext) → LogsDTO

Gets the node exporter logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getNodeStatus(request: GetNodeStatusMsg, context: ServicerContext) → NodeStatusDTO

Gets the status of a node in the CSLE cluster & management system

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of the server

getNumActiveClients(request: GetNumActiveClientsMsg, context: ServicerContext) → GetNumClientsDTO

Gets the number of active clients of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a GetNumActiveClientsMsg

getOSSECIDSMonitorThreadStatuses(request: GetOSSECIDSMonitorThreadStatusesMsg, context: ServicerContext) → OSSECIdsMonitorThreadStatusesDTO

Gets the OSSEC IDS monitor thread statuses for a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OSSECIdsMonitorThreadStatusesDTO

getOSSECIdsLogs(request: GetOSSECIdsLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific OSSEC IDS

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getOSSECIdsManagerLogsMsg(request: GetOSSECIdsManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific OSSEC IDS manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getOSSECIdsManagersInfo(request: GetOSSECIDSManagersInfoMsg, context: ServicerContext) → OSSECIdsManagersInfoDTO

Gets the info of OSSEC IDS managers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a OSSECIdsManagersInfoDTO

getPgAdminLogs(request: GetPgAdminLogsMsg, context: ServicerContext) → LogsDTO

Gets the pgAdmin logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getPostrgreSQLLogs(request: GetPostgreSQLLogsMsg, context: ServicerContext) → LogsDTO

Gets the PostgreSQL logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getPrometheusLogs(request: GetPrometheusLogsMsg, context: ServicerContext) → LogsDTO

Gets the Prometheus logs

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with logs

getRyuControllerLogs(request: GetRyuControllerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific Ryu controller

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getRyuManagerLogs(request: GetRyuManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific Ryu manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getRyuManagersInfo(request: GetRyuManagersInfoMsg, context: ServicerContext) → RyuManagersInfoDTO

Gets the info of Ryu managers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a RyuManagersInfoDTO

getRyuStatus(request: GetRyuServiceStatusMsg, context: ServicerContext) → RyuManagerStatusDTO

Gets the Ryu status

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a RyuManagerStatusDTO

getSnortIdsLogs(request: GetSnortIdsLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific Snort IDS

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getSnortIdsManagerLogsMsg(request: GetSnortIdsManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific Snort IDS manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getSnortIdsManagersInfo(request: GetSnortIdsManagersInfoMsg, context: ServicerContext) → SnortIdsManagersInfoDTO

Gets the info of Snort IDS managers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a SnortIdsManagersInfoDTO

getSnortIdsMonitorThreadStatuses(request: GetSnortIdsMonitorThreadStatusesMsg, context: ServicerContext) → SnortIdsMonitorThreadStatusesDTO

Gets the Snort IDS monitor thread statuses for a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an SnortIdsMonitorThreadStatusesDTO

getTrafficManagerLogs(request: GetTrafficManagerLogsMsg, context: ServicerContext) → LogsDTO

Gets the logs of a specific traffic manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a LogsDTO with the logs

getTrafficManagersInfo(request: GetTrafficManagersInfoMsg, context: ServicerContext) → TrafficManagersInfoDTO

Gets the info of traffic managers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a TrafficManagersInfoDTO

installLibraries(request: InstallLibrariesMsg, context: ServicerContext) → OperationOutcomeDTO

Installs CSLE libraries on containers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

listAllContainerImages(request: ListAllContainerImagesMsg, context: ServicerContext) → ContainerImagesDTO

Removes a specific container image

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a ContainerImagesDTO

listAllDockerNetworks(request: ListAllDockerNetworksMsg, context: ServicerContext) → DockerNetworksDTO

Lists all docker networks

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DockerNetworksDTO

listAllRunningContainers(request: ListAllRunningContainersMsg, context: ServicerContext) → RunningContainersDTO

Lists all running containers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a RunningContainersDTO

listAllRunningEmulations(request: ListAllRunningEmulationsMsg, context: ServicerContext) → RunningEmulationsDTO

Lists all running emulations

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a RunningEmulationsDTO

listAllStoppedContainers(request: ListAllStoppedContainersMsg, context: ServicerContext) → StoppedContainersDTO

Lists all stopped containers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a StoppedContainersDTOb

listKibanaTunnels(request: ListKibanaTunnelsMsg, context: ServicerContext) → KibanaTunnelsDTO

Lists the Kibana tunnels

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an KibanaTunnelsDTO

listRyuTunnels(request: ListRyuTunnelsMsg, context: ServicerContext) → RyuTunnelsDTO

Lists the Ryu tunnels

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a RyuTunnelsDTO

pingExecution(request: PingExecutionMsg, context: ServicerContext) → OperationOutcomeDTO

Pings all containers in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

removeAllContainerImages(request: RemoveAllContainerImagesMsg, context: ServicerContext) → OperationOutcomeDTO

Removes all CSLE container images

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

removeAllDockerNetworks(request: RemoveAllDockerNetworksMsg, context: ServicerContext) → OperationOutcomeDTO

Removes all docker networks related to CSLE

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

removeAllStoppedContainers(request: RemoveAllStoppedContainersMsg, context: ServicerContext) → OperationOutcomeDTO

Removes all stopped containers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

removeContainer(request: RemoveContainerMsg, context: ServicerContext) → OperationOutcomeDTO

Removes all specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

removeContainerImage(request: RemoveContainerImageMsg, context: ServicerContext) → OperationOutcomeDTO

Removes a specific container image

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

removeDockerNetworks(request: RemoveDockerNetworksMsg, context: ServicerContext) → OperationOutcomeDTO

Removes a list of docker networks

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

removeKibanaTunnel(request: RemoveKibanaTunnelMsg, context: ServicerContext) → OperationOutcomeDTO

Removes a Kibana tunnel

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

removeRyuTunnel(request: RemoveRyuTunnelMsg, context: ServicerContext) → OperationOutcomeDTO

Removes a Ryu tunnel

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

runContainer(request: RunContainerMsg, context: ServicerContext) → OperationOutcomeDTO

Runs a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startAllStoppedContainers(request: StartAllStoppedContainersMsg, context: ServicerContext) → OperationOutcomeDTO

Starts all stopped containers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startCAdvisor(request: StartCAdvisorMsg, context: ServicerContext) → ServiceStatusDTO

Starts cAdvisor

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of cAdvisor

startClientManager(request: StartClientManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the client manager of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startClientPopulation(request: StartClientPopulationMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the client population of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startContainer(request: StartContainerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startContainersInExecution(request: StartContainersInExecutionMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the containers of a given emulation execution that are configured to be deployed on this host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startContainersOfExecution(request: StartContainersOfExecutionMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the containers of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startDockerEngine(request: StartDockerEngineMsg, context: ServicerContext) → ServiceStatusDTO

Starts Docker Engine

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of the Docker egine

startDockerStatsManager(request: StartDockerStatsManagerMsg, context: ServicerContext) → ServiceStatusDTO

Starts the docker statsmanager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of the docker statsmanager

startDockerStatsManagerThread(request: StartDockerStatsManagerThreadMsg, context: ServicerContext) → ServiceStatusDTO

Starts the docker stats manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startElastic(request: StartElasticServiceMsg, context: ServicerContext) → OperationOutcomeDTO

Starts elastic in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startElkManager(request: StartElkManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts a specific elk manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startElkStack(request: StartElkStackMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the ELK stack in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startFilebeat(request: StartFileBeatMsg, context: ServicerContext) → OperationOutcomeDTO

Starts filebeat on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startFilebeats(request: StartFileBeatsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts filebeats in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startFlask(request: StartFlaskMsg, context: ServicerContext) → ServiceStatusDTO

Starts Flask

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of flask

startGrafana(request: StartGrafanaMsg, context: ServicerContext) → ServiceStatusDTO

Starts grafana

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of grafana

startHeartbeat(request: StartHeartBeatMsg, context: ServicerContext) → OperationOutcomeDTO

Starts heartbeat on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startHeartbeats(request: StartHeartBeatsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts heartbeats in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startHostManager(request: StartHostManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts a specific host manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startHostManagers(request: StartHostManagersMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the host managers of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startHostMonitorThread(request: StartHostMonitorThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Starts a specific host monitor thread

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startHostMonitorThreads(request: StartHostMonitorThreadsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the host monitor threads of a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startKafkaClientProducer(request: StartKafkaClientProducerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Kafka client producer of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startKafkaManager(request: StartKafkaManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the kafka manager in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startKafkaServer(request: StartKafkaServerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the kafka server in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startKibana(request: StartKibanaServiceMsg, context: ServicerContext) → OperationOutcomeDTO

Starts Kibana in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startLogstash(request: StartLogstashServiceMsg, context: ServicerContext) → OperationOutcomeDTO

Starts Logstash in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startMetricbeat(request: StartMetricBeatMsg, context: ServicerContext) → OperationOutcomeDTO

Starts metricbeat on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startMetricbeats(request: StartMetricBeatsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts metricbeats in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startNginx(request: StartNginxMsg, context: ServicerContext) → ServiceStatusDTO

Starts Nginx

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of Nginx

startNodeExporter(request: StartNodeExporterMsg, context: ServicerContext) → ServiceStatusDTO

Starts node exporter

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of node exporter

startOSSECIDS(request: StartOSSECIDSMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the OSSEC IDS on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startOSSECIDSManager(request: StartOSSECIDSManager, context: ServicerContext) → OperationOutcomeDTO

Starts the OSSEC IDS manager on a specific node

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startOSSECIDSManagers(request: StartOSSECIDSManagers, context: ServicerContext) → OperationOutcomeDTO

Starts the OSSEC IDS managers for a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startOSSECIDSMonitorThread(request: StartOSSECIDSMonitorThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the OSSEC IDS monitor thread on a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startOSSECIDSes(request: StartOSSECIDSesMsg, context: ServicerContext) → OperationOutcomeDTO

Starting the OSSEC IDSes in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startOssecIdses(request: StartOSSECIdsesMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the OSSEC IDSes in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startOssecIdsesMonitorThreads(request: StartOSSECIdsesMonitorThreadsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the OSSEC IDSes monitor threads in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startPacketbeat(request: StartPacketBeatMsg, context: ServicerContext) → OperationOutcomeDTO

Starts packetbeat on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startPacketbeats(request: StartPacketBeatsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts packetbetas in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startPgAdmin(request: StartPgAdminMsg, context: ServicerContext) → ServiceStatusDTO

Starts pgAdmin

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of pgAdmin

startPostgreSQL(request: StartPostgreSQLMsg, context: ServicerContext) → ServiceStatusDTO

Starts Postgresql

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of PostgreSQL

startPrometheus(request: StartPrometheusMsg, context: ServicerContext) → ServiceStatusDTO

Starts Prometheus

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of Prometheus

startRyu(request: StartRyuServiceMsg, context: ServicerContext) → OperationOutcomeDTO

Starts Ryu

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startRyuManager(request: StartRyuManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Ryu manager for a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startRyuMonitor(request: StartRyuMonitorThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Ryu monitor thread for a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSdnController(request: StartSdnControllerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Ryu SDN controller of an execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSdnControllerMonitor(request: StartSdnControllerMonitorMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the SDN controller monitor in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIds(request: StartSnortMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Snort IDS on a specific container in a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdsManager(request: StartSnortIdsManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Snort IDS manager at a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdsManagers(request: StartSnortIdsManagersMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Snort IDS managers of a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdsMonitorThread(request: StartSnortIdsMonitorThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Snort IDS monitor thread on a specific container in a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdsMonitorThreads(request: StartSnortIdsMonitorThreadsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Snort IDS monitor threads of a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdses(request: StartSnortIdsesMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Snort IDSes in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdsesMonitorThreads(request: StartSnortIdsesMonitorThreadsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Snort IDSes monitor threads in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSparkServer(request: StartSparkServerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Spark server on a specific container in a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startSparkServers(request: StartSparkServersMsg, context: ServicerContext) → OperationOutcomeDTO

Starts the Spark servers in a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startTrafficGenerator(request: StartTrafficGeneratorMsg, context: ServicerContext) → OperationOutcomeDTO

Starts a specific traffic generator

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startTrafficGenerators(request: StartTrafficGeneratorsMsg, context: ServicerContext) → OperationOutcomeDTO

Starts traffic generators in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startTrafficManager(request: StartTrafficManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Starts a specific traffic manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

startTrafficManagers(request: StartTrafficManagersMsg, context: ServicerContext) → OperationOutcomeDTO

Starts traffic managers in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopAllExecutions(request: StopAllExecutionsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops all executions

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopAllExecutionsOfEmulation(request: StopAllExecutionsOfEmulationMsg, context: ServicerContext) → OperationOutcomeDTO

Stops all executions of a given emulation

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopAllRunningContainers(request: StopAllRunningContainersMsg, context: ServicerContext) → OperationOutcomeDTO

Stops all running CSLE containers

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopCAdvisor(request: StopCAdvisorMsg, context: ServicerContext) → ServiceStatusDTO

Stops cAdvisor

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of cAdvisor

stopClientManager(request: StopClientManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the client manager of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopClientPopulation(request: StopClientPopulationMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the client population of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopContainer(request: StopContainerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopContainersOfExecution(request: StopContainersOfExecutionMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the containers of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopDockerEngine(request: StopDockerEngineMsg, context: ServicerContext) → ServiceStatusDTO

Stops the Docker Engine

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of the Docker Engine

stopDockerStatsManager(request: StopDockerStatsManagerMsg, context: ServicerContext) → ServiceStatusDTO

Stops the docker statsmanaager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of the docker statsmanager

stopDockerStatsManagerThread(request: StopDockerStatsManagerThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the docker stats manager thread

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopElastic(request: StopElasticServiceMsg, context: ServicerContext) → OperationOutcomeDTO

Stops elastic in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopElkManager(request: StopElkManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops a specific elk manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopElkStack(request: StopElkStackMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the elk stack of a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopExecution(request: StopExecutionMsg, context: ServicerContext) → OperationOutcomeDTO

Stops a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopFilebeat(request: StopFileBeatMsg, context: ServicerContext) → OperationOutcomeDTO

Stops filebeat on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopFilebeats(request: StopFilebeatsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops filebeats in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopFlask(request: StopFlaskMsg, context: ServicerContext) → ServiceStatusDTO

Stops Flask

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of flask

stopGrafana(request: StopGrafanaMsg, context: ServicerContext) → ServiceStatusDTO

Stops grafana

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of grafana

stopHeartbeat(request: StopHeartBeatMsg, context: ServicerContext) → OperationOutcomeDTO

Stops heartbeat on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopHeartbeats(request: StopHeartbeatsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops Heartbeats in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopHostManager(request: StopHostManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops a specific host manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopHostManagers(request: StopHostManagersMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the host managers of a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopHostMonitorThread(request: StopHostMonitorThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Stops a specific host monitor thread

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopHostMonitorThreads(request: StopHostMonitorThreadsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the host monitor threads of a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopKafkaClientProducer(request: StopKafkaClientProducerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Kafka client producer of a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopKafkaManager(request: StopKafkaManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the kafka manager in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopKafkaServer(request: StopKafkaServerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the kafka server in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopKibana(request: StopKibanaServiceMsg, context: ServicerContext) → OperationOutcomeDTO

Stops Kibana in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopLogstash(request: StopLogstashServiceMsg, context: ServicerContext) → OperationOutcomeDTO

Stops Logstash in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopMetricbeat(request: StopMetricBeatMsg, context: ServicerContext) → OperationOutcomeDTO

Stops metricbeat on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopMetricbeats(request: StopMetricbeatsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops Metricbeats in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopNginx(request: StopNginxMsg, context: ServicerContext) → ServiceStatusDTO

Stops Nginx

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of Nginx

stopNodeExporter(request: StopNodeExporterMsg, context: ServicerContext) → ServiceStatusDTO

Stops node exporter

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of node exporter

stopOSSECIDS(request: StopOSSECIDSMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the OSSEC IDS on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSManager(request: StopOSSECIDSManager, context: ServicerContext) → OperationOutcomeDTO

Stops the OSSEC IDS manager on a specific node

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSManagers(request: StopOSSECIDSManagers, context: ServicerContext) → OperationOutcomeDTO

Stops the OSSEC IDS managers for a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSMonitorThread(request: StopOSSECIDSMonitorThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the OSSEC IDS monitor thread on a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSMonitorThreads(request: StopOSSECIDSMonitorThreadsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the OSSEC IDS monitor threads for a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSes(request: StopOSSECIDSesMsg, context: ServicerContext) → OperationOutcomeDTO

Stop the OSSEC IDSes in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopPacketbeat(request: StopPacketBeatMsg, context: ServicerContext) → OperationOutcomeDTO

Stops packetbeat on a specific host

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopPacketbeats(request: StopPacketbeatsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops packetbeats in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopPgAdmin(request: StopPgAdminMsg, context: ServicerContext) → ServiceStatusDTO

Stops pgAdmin

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of pgAdmin

stopPid(request: StopPidMsg, context: ServicerContext) → OperationOutcomeDTO

Stops a PID

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopPostgreSQL(request: StopPostgreSQLMsg, context: ServicerContext) → ServiceStatusDTO

Stops Postgresql

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of PostgreSQL

stopPrometheus(request: StopPrometheusMsg, context: ServicerContext) → ServiceStatusDTO

Stops Prometheus

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a DTO with the status of Prometheus

stopRyu(request: StopRyuServiceMsg, context: ServicerContext) → OperationOutcomeDTO

Stops Ryu

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopRyuManager(request: StopRyuManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Ryu manager for a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopRyuMonitor(request: StopRyuMonitorThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Ryu monitor thread for a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIds(request: StopSnortMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Snort IDS on a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsManager(request: StopSnortIdsManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Snort IDS manager at a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsManagers(request: StopSnortIdsManagersMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Snort IDS managers of a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsMonitorThread(request: StopSnortIdsMonitorThreadMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Snort IDS Monitor Thread on a specific container

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsMonitorThreads(request: StopSnortIdsMonitorThreadsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Snort IDS managers of a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdses(request: StopSnortIdsesMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Snort IDSes for a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsesMonitorThreads(request: StopSnortIdsesMonitorThreadsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Snort IDSes monitor threads for a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSparkServer(request: StopSparkServerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Spark server on a specific container in a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopSparkServers(request: StopSparkServersMsg, context: ServicerContext) → OperationOutcomeDTO

Stops the Spark servers in a specific execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopTrafficGenerator(request: StopTrafficGeneratorMsg, context: ServicerContext) → OperationOutcomeDTO

Stops a specific traffic generator

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopTrafficGenerators(request: StopTrafficGeneratorsMsg, context: ServicerContext) → OperationOutcomeDTO

Stops traffic generators in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopTrafficManager(request: StopTrafficManagerMsg, context: ServicerContext) → OperationOutcomeDTO

Stops a specific traffic manager

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

stopTrafficManagers(request: StopTrafficManagersMsg, context: ServicerContext) → OperationOutcomeDTO

Stops traffic managers in a given execution

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

an OperationOutcomeDTO

csle_cluster.cluster_manager.cluster_manager.serve(port: int = 50041, log_dir: str = '/var/log/csle/', max_workers: int = 10, log_file_name: str = 'cluster_manager.log') → None

Starts the gRPC server for managing the cluster node

Parameters

• port – the port that the server will listen to

• log_dir – the directory to write the log file

• log_file_name – the file name of the log

• max_workers – the maximum number of parallel gRPC workers

Returns

None

csle_cluster.cluster_manager.cluster_manager_pb2 module

Generated protocol buffer code.

csle_cluster.cluster_manager.cluster_manager_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

class csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManager

Bases: object

Interface exported by the server

static applyFileBeatConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyFileBeatsConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyHeartBeatConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyHeartBeatsConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyKafkaConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyMetricBeatConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyMetricBeatsConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyPacketBeatConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyPacketBeatsConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static applyResourceConstraints(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static attachContainersInExecutionToNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static checkPid(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static cleanAllExecutions(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static cleanAllExecutionsOfEmulation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static cleanExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static configureOvs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createEmulationNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createFlags(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createKafkaTopics(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createKibanaTunnel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createOvsSwitches(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createRyuTunnel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createTopology(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createUsers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static createVulnerabilities(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getCadvisorLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getClientManagerLogsMsg(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getClientManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getClusterManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getContainerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getCsleLogFiles(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getDockerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getDockerStatsManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getDockerStatsManagerStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getDockerStatsManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getElkLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getElkManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getElkManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getElkStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getExecutionInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getExecutionTimeSeriesData(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getFlaskLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getGrafanaLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getHostManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getHostManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getHostMonitorThreadsStatuses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getKafkaLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getKafkaManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getKafkaManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getKafkaStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getLogFile(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getNginxLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getNodeExporterLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getNodeStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getNumActiveClients(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getOSSECIDSMonitorThreadStatuses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getOSSECIdsLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getOSSECIdsManagerLogsMsg(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getOSSECIdsManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getPgAdminLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getPostrgreSQLLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getPrometheusLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getRyuControllerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getRyuManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getRyuManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getRyuStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getSnortIdsLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getSnortIdsManagerLogsMsg(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getSnortIdsManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getSnortIdsMonitorThreadStatuses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getTrafficManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static getTrafficManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static installLibraries(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static listAllContainerImages(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static listAllDockerNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static listAllRunningContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static listAllRunningEmulations(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static listAllStoppedContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static listKibanaTunnels(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static listRyuTunnels(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static pingExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static removeAllContainerImages(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static removeAllDockerNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static removeAllStoppedContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static removeContainer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static removeContainerImage(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static removeDockerNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static removeKibanaTunnel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static removeRyuTunnel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static runContainer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startAllStoppedContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startCAdvisor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startClientManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startClientPopulation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startContainer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startContainersInExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startContainersOfExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startDockerEngine(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startDockerStatsManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startDockerStatsManagerThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startElastic(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startElkManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startElkStack(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startFilebeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startFilebeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startFlask(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startGrafana(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startHeartbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startHeartbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startHostManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startHostManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startHostMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startHostMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startKafkaClientProducer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startKafkaManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startKafkaServer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startKibana(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startLogstash(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startMetricbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startMetricbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startNginx(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startNodeExporter(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startOSSECIDS(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startOSSECIDSManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startOSSECIDSManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startOSSECIDSMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startOSSECIDSes(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startOssecIdses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startOssecIdsesMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startPacketbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startPacketbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startPgAdmin(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startPostgreSQL(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startPrometheus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startRyu(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startRyuManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startRyuMonitor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSdnController(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSdnControllerMonitor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSnortIds(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSnortIdsManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSnortIdsManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSnortIdsMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSnortIdsMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSnortIdses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSnortIdsesMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSparkServer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startSparkServers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startTrafficGenerator(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startTrafficGenerators(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startTrafficManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startTrafficManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopAllExecutions(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopAllExecutionsOfEmulation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopAllRunningContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopCAdvisor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopClientManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopClientPopulation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopContainer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopContainersOfExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopDockerEngine(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopDockerStatsManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopDockerStatsManagerThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopElastic(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopElkManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopElkStack(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopFilebeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopFilebeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopFlask(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopGrafana(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopHeartbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopHeartbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopHostManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopHostManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopHostMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopHostMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopKafkaClientProducer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopKafkaManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopKafkaServer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopKibana(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopLogstash(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopMetricbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopMetricbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopNginx(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopNodeExporter(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopOSSECIDS(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopOSSECIDSManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopOSSECIDSManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopOSSECIDSMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopOSSECIDSMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopOSSECIDSes(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopPacketbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopPacketbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopPgAdmin(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopPid(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopPostgreSQL(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopPrometheus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopRyu(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopRyuManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopRyuMonitor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSnortIds(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSnortIdsManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSnortIdsManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSnortIdsMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSnortIdsMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSnortIdses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSnortIdsesMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSparkServer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopSparkServers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopTrafficGenerator(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopTrafficGenerators(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopTrafficManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopTrafficManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerServicer

Bases: object

Interface exported by the server

applyFileBeatConfig(request, context)

Missing associated documentation comment in .proto file.

applyFileBeatsConfig(request, context)

Missing associated documentation comment in .proto file.

applyHeartBeatConfig(request, context)

Missing associated documentation comment in .proto file.

applyHeartBeatsConfig(request, context)

Missing associated documentation comment in .proto file.

applyKafkaConfig(request, context)

Missing associated documentation comment in .proto file.

applyMetricBeatConfig(request, context)

Missing associated documentation comment in .proto file.

applyMetricBeatsConfig(request, context)

Missing associated documentation comment in .proto file.

applyPacketBeatConfig(request, context)

Missing associated documentation comment in .proto file.

applyPacketBeatsConfig(request, context)

Missing associated documentation comment in .proto file.

applyResourceConstraints(request, context)

Missing associated documentation comment in .proto file.

attachContainersInExecutionToNetworks(request, context)

Missing associated documentation comment in .proto file.

checkPid(request, context)

Missing associated documentation comment in .proto file.

cleanAllExecutions(request, context)

Missing associated documentation comment in .proto file.

cleanAllExecutionsOfEmulation(request, context)

Missing associated documentation comment in .proto file.

cleanExecution(request, context)

Missing associated documentation comment in .proto file.

configureOvs(request, context)

Missing associated documentation comment in .proto file.

createEmulationNetworks(request, context)

Missing associated documentation comment in .proto file.

createFlags(request, context)

Missing associated documentation comment in .proto file.

createKafkaTopics(request, context)

Missing associated documentation comment in .proto file.

createKibanaTunnel(request, context)

Missing associated documentation comment in .proto file.

createOvsSwitches(request, context)

Missing associated documentation comment in .proto file.

createRyuTunnel(request, context)

Missing associated documentation comment in .proto file.

createTopology(request, context)

Missing associated documentation comment in .proto file.

createUsers(request, context)

Missing associated documentation comment in .proto file.

createVulnerabilities(request, context)

Missing associated documentation comment in .proto file.

getCadvisorLogs(request, context)

Missing associated documentation comment in .proto file.

getClientManagerLogsMsg(request, context)

Missing associated documentation comment in .proto file.

getClientManagersInfo(request, context)

Missing associated documentation comment in .proto file.

getClusterManagerLogs(request, context)

Missing associated documentation comment in .proto file.

getContainerLogs(request, context)

Missing associated documentation comment in .proto file.

getCsleLogFiles(request, context)

Missing associated documentation comment in .proto file.

getDockerLogs(request, context)

Missing associated documentation comment in .proto file.

getDockerStatsManagerLogs(request, context)

Missing associated documentation comment in .proto file.

getDockerStatsManagerStatus(request, context)

Missing associated documentation comment in .proto file.

getDockerStatsManagersInfo(request, context)

Missing associated documentation comment in .proto file.

getElkLogs(request, context)

Missing associated documentation comment in .proto file.

getElkManagerLogs(request, context)

Missing associated documentation comment in .proto file.

getElkManagersInfo(request, context)

Missing associated documentation comment in .proto file.

getElkStatus(request, context)

Missing associated documentation comment in .proto file.

getExecutionInfo(request, context)

Missing associated documentation comment in .proto file.

getExecutionTimeSeriesData(request, context)

Missing associated documentation comment in .proto file.

getFlaskLogs(request, context)

Missing associated documentation comment in .proto file.

getGrafanaLogs(request, context)

Missing associated documentation comment in .proto file.

getHostManagerLogs(request, context)

Missing associated documentation comment in .proto file.

getHostManagersInfo(request, context)

Missing associated documentation comment in .proto file.

getHostMonitorThreadsStatuses(request, context)

Missing associated documentation comment in .proto file.

getKafkaLogs(request, context)

Missing associated documentation comment in .proto file.

getKafkaManagerLogs(request, context)

Missing associated documentation comment in .proto file.

getKafkaManagersInfo(request, context)

Missing associated documentation comment in .proto file.

getKafkaStatus(request, context)

Missing associated documentation comment in .proto file.

getLogFile(request, context)

Missing associated documentation comment in .proto file.

getNginxLogs(request, context)

Missing associated documentation comment in .proto file.

getNodeExporterLogs(request, context)

Missing associated documentation comment in .proto file.

getNodeStatus(request, context)

Missing associated documentation comment in .proto file.

getNumActiveClients(request, context)

Missing associated documentation comment in .proto file.

getOSSECIDSMonitorThreadStatuses(request, context)

Missing associated documentation comment in .proto file.

getOSSECIdsLogs(request, context)

Missing associated documentation comment in .proto file.

getOSSECIdsManagerLogsMsg(request, context)

Missing associated documentation comment in .proto file.

getOSSECIdsManagersInfo(request, context)

Missing associated documentation comment in .proto file.

getPgAdminLogs(request, context)

Missing associated documentation comment in .proto file.

getPostrgreSQLLogs(request, context)

Missing associated documentation comment in .proto file.

getPrometheusLogs(request, context)

Missing associated documentation comment in .proto file.

getRyuControllerLogs(request, context)

Missing associated documentation comment in .proto file.

getRyuManagerLogs(request, context)

Missing associated documentation comment in .proto file.

getRyuManagersInfo(request, context)

Missing associated documentation comment in .proto file.

getRyuStatus(request, context)

Missing associated documentation comment in .proto file.

getSnortIdsLogs(request, context)

Missing associated documentation comment in .proto file.

getSnortIdsManagerLogsMsg(request, context)

Missing associated documentation comment in .proto file.

getSnortIdsManagersInfo(request, context)

Missing associated documentation comment in .proto file.

getSnortIdsMonitorThreadStatuses(request, context)

Missing associated documentation comment in .proto file.

getTrafficManagerLogs(request, context)

Missing associated documentation comment in .proto file.

getTrafficManagersInfo(request, context)

Missing associated documentation comment in .proto file.

installLibraries(request, context)

Missing associated documentation comment in .proto file.

listAllContainerImages(request, context)

Missing associated documentation comment in .proto file.

listAllDockerNetworks(request, context)

Missing associated documentation comment in .proto file.

listAllRunningContainers(request, context)

Missing associated documentation comment in .proto file.

listAllRunningEmulations(request, context)

Missing associated documentation comment in .proto file.

listAllStoppedContainers(request, context)

Missing associated documentation comment in .proto file.

listKibanaTunnels(request, context)

Missing associated documentation comment in .proto file.

listRyuTunnels(request, context)

Missing associated documentation comment in .proto file.

pingExecution(request, context)

Missing associated documentation comment in .proto file.

removeAllContainerImages(request, context)

Missing associated documentation comment in .proto file.

removeAllDockerNetworks(request, context)

Missing associated documentation comment in .proto file.

removeAllStoppedContainers(request, context)

Missing associated documentation comment in .proto file.

removeContainer(request, context)

Missing associated documentation comment in .proto file.

removeContainerImage(request, context)

Missing associated documentation comment in .proto file.

removeDockerNetworks(request, context)

Missing associated documentation comment in .proto file.

removeKibanaTunnel(request, context)

Missing associated documentation comment in .proto file.

removeRyuTunnel(request, context)

Missing associated documentation comment in .proto file.

runContainer(request, context)

Missing associated documentation comment in .proto file.

startAllStoppedContainers(request, context)

Missing associated documentation comment in .proto file.

startCAdvisor(request, context)

Missing associated documentation comment in .proto file.

startClientManager(request, context)

Missing associated documentation comment in .proto file.

startClientPopulation(request, context)

Missing associated documentation comment in .proto file.

startContainer(request, context)

Missing associated documentation comment in .proto file.

startContainersInExecution(request, context)

Missing associated documentation comment in .proto file.

startContainersOfExecution(request, context)

Missing associated documentation comment in .proto file.

startDockerEngine(request, context)

Missing associated documentation comment in .proto file.

startDockerStatsManager(request, context)

Missing associated documentation comment in .proto file.

startDockerStatsManagerThread(request, context)

Missing associated documentation comment in .proto file.

startElastic(request, context)

Missing associated documentation comment in .proto file.

startElkManager(request, context)

Missing associated documentation comment in .proto file.

startElkStack(request, context)

Missing associated documentation comment in .proto file.

startFilebeat(request, context)

Missing associated documentation comment in .proto file.

startFilebeats(request, context)

Missing associated documentation comment in .proto file.

startFlask(request, context)

Missing associated documentation comment in .proto file.

startGrafana(request, context)

Missing associated documentation comment in .proto file.

startHeartbeat(request, context)

Missing associated documentation comment in .proto file.

startHeartbeats(request, context)

Missing associated documentation comment in .proto file.

startHostManager(request, context)

Missing associated documentation comment in .proto file.

startHostManagers(request, context)

Missing associated documentation comment in .proto file.

startHostMonitorThread(request, context)

Missing associated documentation comment in .proto file.

startHostMonitorThreads(request, context)

Missing associated documentation comment in .proto file.

startKafkaClientProducer(request, context)

Missing associated documentation comment in .proto file.

startKafkaManager(request, context)

Missing associated documentation comment in .proto file.

startKafkaServer(request, context)

Missing associated documentation comment in .proto file.

startKibana(request, context)

Missing associated documentation comment in .proto file.

startLogstash(request, context)

Missing associated documentation comment in .proto file.

startMetricbeat(request, context)

Missing associated documentation comment in .proto file.

startMetricbeats(request, context)

Missing associated documentation comment in .proto file.

startNginx(request, context)

Missing associated documentation comment in .proto file.

startNodeExporter(request, context)

Missing associated documentation comment in .proto file.

startOSSECIDS(request, context)

Missing associated documentation comment in .proto file.

startOSSECIDSManager(request, context)

Missing associated documentation comment in .proto file.

startOSSECIDSManagers(request, context)

Missing associated documentation comment in .proto file.

startOSSECIDSMonitorThread(request, context)

Missing associated documentation comment in .proto file.

startOSSECIDSes(request, context)

Missing associated documentation comment in .proto file.

startOssecIdses(request, context)

Missing associated documentation comment in .proto file.

startOssecIdsesMonitorThreads(request, context)

Missing associated documentation comment in .proto file.

startPacketbeat(request, context)

Missing associated documentation comment in .proto file.

startPacketbeats(request, context)

Missing associated documentation comment in .proto file.

startPgAdmin(request, context)

Missing associated documentation comment in .proto file.

startPostgreSQL(request, context)

Missing associated documentation comment in .proto file.

startPrometheus(request, context)

Missing associated documentation comment in .proto file.

startRyu(request, context)

Missing associated documentation comment in .proto file.

startRyuManager(request, context)

Missing associated documentation comment in .proto file.

startRyuMonitor(request, context)

Missing associated documentation comment in .proto file.

startSdnController(request, context)

Missing associated documentation comment in .proto file.

startSdnControllerMonitor(request, context)

Missing associated documentation comment in .proto file.

startSnortIds(request, context)

Missing associated documentation comment in .proto file.

startSnortIdsManager(request, context)

Missing associated documentation comment in .proto file.

startSnortIdsManagers(request, context)

Missing associated documentation comment in .proto file.

startSnortIdsMonitorThread(request, context)

Missing associated documentation comment in .proto file.

startSnortIdsMonitorThreads(request, context)

Missing associated documentation comment in .proto file.

startSnortIdses(request, context)

Missing associated documentation comment in .proto file.

startSnortIdsesMonitorThreads(request, context)

Missing associated documentation comment in .proto file.

startSparkServer(request, context)

Missing associated documentation comment in .proto file.

startSparkServers(request, context)

Missing associated documentation comment in .proto file.

startTrafficGenerator(request, context)

Missing associated documentation comment in .proto file.

startTrafficGenerators(request, context)

Missing associated documentation comment in .proto file.

startTrafficManager(request, context)

Missing associated documentation comment in .proto file.

startTrafficManagers(request, context)

Missing associated documentation comment in .proto file.

stopAllExecutions(request, context)

Missing associated documentation comment in .proto file.

stopAllExecutionsOfEmulation(request, context)

Missing associated documentation comment in .proto file.

stopAllRunningContainers(request, context)

Missing associated documentation comment in .proto file.

stopCAdvisor(request, context)

Missing associated documentation comment in .proto file.

stopClientManager(request, context)

Missing associated documentation comment in .proto file.

stopClientPopulation(request, context)

Missing associated documentation comment in .proto file.

stopContainer(request, context)

Missing associated documentation comment in .proto file.

stopContainersOfExecution(request, context)

Missing associated documentation comment in .proto file.

stopDockerEngine(request, context)

Missing associated documentation comment in .proto file.

stopDockerStatsManager(request, context)

Missing associated documentation comment in .proto file.

stopDockerStatsManagerThread(request, context)

Missing associated documentation comment in .proto file.

stopElastic(request, context)

Missing associated documentation comment in .proto file.

stopElkManager(request, context)

Missing associated documentation comment in .proto file.

stopElkStack(request, context)

Missing associated documentation comment in .proto file.

stopExecution(request, context)

Missing associated documentation comment in .proto file.

stopFilebeat(request, context)

Missing associated documentation comment in .proto file.

stopFilebeats(request, context)

Missing associated documentation comment in .proto file.

stopFlask(request, context)

Missing associated documentation comment in .proto file.

stopGrafana(request, context)

Missing associated documentation comment in .proto file.

stopHeartbeat(request, context)

Missing associated documentation comment in .proto file.

stopHeartbeats(request, context)

Missing associated documentation comment in .proto file.

stopHostManager(request, context)

Missing associated documentation comment in .proto file.

stopHostManagers(request, context)

Missing associated documentation comment in .proto file.

stopHostMonitorThread(request, context)

Missing associated documentation comment in .proto file.

stopHostMonitorThreads(request, context)

Missing associated documentation comment in .proto file.

stopKafkaClientProducer(request, context)

Missing associated documentation comment in .proto file.

stopKafkaManager(request, context)

Missing associated documentation comment in .proto file.

stopKafkaServer(request, context)

Missing associated documentation comment in .proto file.

stopKibana(request, context)

Missing associated documentation comment in .proto file.

stopLogstash(request, context)

Missing associated documentation comment in .proto file.

stopMetricbeat(request, context)

Missing associated documentation comment in .proto file.

stopMetricbeats(request, context)

Missing associated documentation comment in .proto file.

stopNginx(request, context)

Missing associated documentation comment in .proto file.

stopNodeExporter(request, context)

Missing associated documentation comment in .proto file.

stopOSSECIDS(request, context)

Missing associated documentation comment in .proto file.

stopOSSECIDSManager(request, context)

Missing associated documentation comment in .proto file.

stopOSSECIDSManagers(request, context)

Missing associated documentation comment in .proto file.

stopOSSECIDSMonitorThread(request, context)

Missing associated documentation comment in .proto file.

stopOSSECIDSMonitorThreads(request, context)

Missing associated documentation comment in .proto file.

stopOSSECIDSes(request, context)

Missing associated documentation comment in .proto file.

stopPacketbeat(request, context)

Missing associated documentation comment in .proto file.

stopPacketbeats(request, context)

Missing associated documentation comment in .proto file.

stopPgAdmin(request, context)

Missing associated documentation comment in .proto file.

stopPid(request, context)

Missing associated documentation comment in .proto file.

stopPostgreSQL(request, context)

Missing associated documentation comment in .proto file.

stopPrometheus(request, context)

Missing associated documentation comment in .proto file.

stopRyu(request, context)

Missing associated documentation comment in .proto file.

stopRyuManager(request, context)

Missing associated documentation comment in .proto file.

stopRyuMonitor(request, context)

Missing associated documentation comment in .proto file.

stopSnortIds(request, context)

Missing associated documentation comment in .proto file.

stopSnortIdsManager(request, context)

Missing associated documentation comment in .proto file.

stopSnortIdsManagers(request, context)

Missing associated documentation comment in .proto file.

stopSnortIdsMonitorThread(request, context)

Missing associated documentation comment in .proto file.

stopSnortIdsMonitorThreads(request, context)

Missing associated documentation comment in .proto file.

stopSnortIdses(request, context)

Missing associated documentation comment in .proto file.

stopSnortIdsesMonitorThreads(request, context)

Missing associated documentation comment in .proto file.

stopSparkServer(request, context)

Missing associated documentation comment in .proto file.

stopSparkServers(request, context)

Missing associated documentation comment in .proto file.

stopTrafficGenerator(request, context)

Missing associated documentation comment in .proto file.

stopTrafficGenerators(request, context)

Missing associated documentation comment in .proto file.

stopTrafficManager(request, context)

Missing associated documentation comment in .proto file.

stopTrafficManagers(request, context)

Missing associated documentation comment in .proto file.

class csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub(channel)

Bases: object

Interface exported by the server

csle_cluster.cluster_manager.cluster_manager_pb2_grpc.add_ClusterManagerServicer_to_server(servicer, server)

csle_cluster.cluster_manager.cluster_manager_util module

class csle_cluster.cluster_manager.cluster_manager_util.ClusterManagerUtil

Bases: object

Class with utility functions related to the cluster manager

static agg_flow_statistic_dto_to_dict(agg_flow_statistic_dto: AggFlowStatisticDTO) → Dict[str, Any]

Converts a AggFlowStatisticDTO to a dict

Parameters

agg_flow_statistic_dto – the dto to convert

Returns

a dict representation of the DTO

static agg_flow_statistics_dict_to_dict(agg_flow_statistics_dict: AggFlowStatisticDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

agg_flow_statistics_dict – the DTO to convert

Returns

the dict

static avg_flow_statistic_dto_to_dict(avg_flow_statistic_dto: AvgFlowStatisticDTO) → Dict[str, Any]

Converts a AvgFlowStatisticDTO to a dict

Parameters

avg_flow_statistic_dto – the dto to convert

Returns

a dict representation of the DTO

static avg_flow_statistics_dict_to_dict(avg_flow_statistics_dict: AvgFlowStatisticDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

avg_flow_statistics_dict – the DTO to convert

Returns

the dict

static avg_port_statistic_dto_to_dict(avg_port_statistic_dto: AvgPortStatisticDTO) → Dict[str, Any]

Converts a AvgPortStatisticDTO to a dict

Parameters

avg_port_statistic_dto – the dto to convert

Returns

a dict representation of the DTO

static avg_port_statistics_dict_to_dict(avg_port_statistics_dict: AvgPortStatisticDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

avg_port_statistics_dict – the DTO to convert

Returns

the dict

static client_managers_info_dto_to_dict(clients_managers_info_dto: ClientManagersInfoDTO) → Dict[str, Any]

Converts a ClientManagersInfoDTO to a dict

Parameters

clients_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static client_population_metrics_dto_to_dict(client_population_metrics_dto: ClientPopulationMetricsDTO) → Dict[str, Any]

Converts a ClientPopulationMetricsDTO to a dict

Parameters

client_population_metrics_dto – the dto to convert

Returns

a dict representation of the DTO

static container_image_dto_to_dict(container_image_dto: ContainerImageDTO) → Dict[str, Any]

Converts a ContainerImageDTO to a dict

Parameters

container_image_dto – the dto to convert

Returns

a dict representation of the DTO

static container_images_dtos_to_dict(container_images_dtos: ContainerImagesDTO) → Dict[str, Any]

Converts a ContainerImagesDTO to a dict

Parameters

container_images_dtos – the dto to convert

Returns

a dict representation of the DTO

static convert_agg_flow_statistic_dict(agg_flow_statistic_dict: Union[None, Dict[str, List[AggFlowStatistic]]]) → List[AggFlowStatisticDict]

Converts a dict to list of AggFlowStatisticDict

Parameters

agg_flow_statistic_dict – the dict to convert

Returns

the converted objected

static convert_agg_flow_statistic_dict_reverse(agg_flow_statistics_dict: Union[None, List[AggFlowStatisticDict]]) → Dict[str, List[AggFlowStatistic]]

Converts a list of AggFlowStatisticDict to a dict

Parameters

agg_flow_statistics_dict – the list to convert

Returns

the converted DTO

static convert_agg_flow_statistic_dto(agg_flow_statistic: Union[None, AggFlowStatistic]) → AggFlowStatisticDTO

Converts a AggFlowStatistic object to a AggFlowStatisticDTO

Parameters

agg_flow_statistic – the object to convert

Returns

the converted objected

static convert_agg_flow_statistic_dto_reverse(agg_flow_statistic_dto: Union[None, AggFlowStatisticDTO]) → AggFlowStatistic

Converts a AggFlowStatisticDTO to a AggFlowStatistic

Parameters

agg_flow_statistic_dto – the DTO to convert

Returns

the converted DTO

static convert_avg_flow_statistic_dict(avg_flow_statistic_dict: Union[None, Dict[str, List[AvgFlowStatistic]]]) → List[AvgFlowStatisticDict]

Converts a dict to list of AvgFlowStatisticDict

Parameters

avg_flow_statistic_dict – the dict to convert

Returns

the converted objected

static convert_avg_flow_statistic_dict_reverse(avg_flow_statistics_dict: Union[None, List[AvgFlowStatisticDict]]) → Dict[str, List[AvgFlowStatistic]]

Converts a list of AvgFlowStatisticDict to a dict

Parameters

avg_flow_statistics_dict – the list to convert

Returns

the converted DTO

static convert_avg_flow_statistic_dto(avg_flow_statistic: Union[None, AvgFlowStatistic]) → AvgFlowStatisticDTO

Converts a AvgFlowStatistic object to a AvgFlowStatisticDTO

Parameters

avg_flow_statistic – the object to convert

Returns

the converted objected

static convert_avg_flow_statistic_dto_reverse(avg_flow_statistic_dto: Union[None, AvgFlowStatisticDTO]) → AvgFlowStatistic

Converts a AvgFlowStatisticDTO to a AvgFlowStatistic

Parameters

avg_flow_statistic_dto – the DTO to convert

Returns

the converted DTO

static convert_avg_port_statistic_dict(avg_port_statistic_dict: Union[None, Dict[str, List[AvgPortStatistic]]]) → List[AvgPortStatisticDict]

Converts a dict to list of AvgPortStatisticDict

Parameters

avg_port_statistic_dict – the dict to convert

Returns

the converted objected

static convert_avg_port_statistic_dict_reverse(avg_port_statistics_dict: Union[None, List[AvgPortStatisticDict]]) → Dict[str, List[AvgPortStatistic]]

Converts a list of AvgPortStatisticDict to a dict

Parameters

avg_port_statistics_dict – the list to convert

Returns

the converted DTO

static convert_avg_port_statistic_dto(avg_port_statistic: Union[None, AvgPortStatistic]) → AvgPortStatisticDTO

Converts a AvgPortStatistic object to a AvgPortStatisticDTO

Parameters

avg_port_statistic – the object to convert

Returns

the converted objected

static convert_avg_port_statistic_dto_reverse(avg_port_statistic_dto: Union[None, AvgPortStatisticDTO]) → AvgPortStatistic

Converts a AvgPortStatisticDTO to a AvgPortStatistic

Parameters

avg_port_statistic_dto – the DTO to convert

Returns

the converted DTO

static convert_client_dto_to_get_num_clients_dto(clients_dto: ClientsDTO) → GetNumClientsDTO

Converts a clients DTO to a GetNumClientsDTO

Parameters

clients_dto – the clients DTO to convert

Returns

the converted DTO

static convert_client_dto_to_get_num_clients_dto_reverse(clients_dto: Optional[GetNumClientsDTO]) → ClientsDTO

Converts a clients DTO to a GetNumClientsDTO

Parameters

clients_dto – the clients DTO to convert

Returns

the converted DTO

static convert_client_info_dto(client_managers_dto: Union[None, ClientManagersInfo]) → ClientManagersInfoDTO

Converts a ClientManagersInfo into a ClientManagersInfoDTO

Parameters

client_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_client_info_dto_reverse(client_managers_dto: Union[None, ClientManagersInfoDTO]) → ClientManagersInfo

Converts a ClientManagersInfoDTO into a ClientManagersInfo

Parameters

client_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_client_population_metrics_dto(client_population_metrics: ClientPopulationMetrics) → ClientPopulationMetricsDTO

Converts a ClientPopulationMetrics object to a ClientPopulationMetricsDTO

Parameters

client_population_metrics – the object to convert

Returns

the converted objected

static convert_client_population_metrics_dto_reverse(client_population_metrics_dto: Union[None, ClientPopulationMetricsDTO]) → ClientPopulationMetrics

Converts a ClientPopulationMetricsDTO to a ClientPopulationMetrics

Parameters

client_population_metrics_dto – the DTO to convert

Returns

the converted DTO

static convert_docker_info_dto(docker_stats_managers_dto: Union[None, DockerStatsManagersInfo]) → DockerStatsManagersInfoDTO

Converts a DockerStatsManagersInfo into a DockerStatsManagersInfoDTO

Parameters

docker_stats_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_docker_info_dto_reverse(docker_stats_managers_dto: Union[None, DockerStatsManagersInfoDTO]) → DockerStatsManagersInfo

Converts a DockerStatsManagersInfoDTO into a DockerStatsManagersInfo

Parameters

docker_stats_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_docker_stats_dict(docker_stats_d: Optional[Dict[str, List[DockerStats]]]) → List[DockerStatsDict]

Converts a dict to list of DockerStatsDict

Parameters

docker_stats_d – the dict to convert

Returns

the converted objected

static convert_docker_stats_dict_reverse(docker_stats_dict: Optional[List[DockerStatsDict]]) → Dict[str, List[DockerStats]]

Converts a list of DockerStatsDict to a dict

Parameters

docker_stats_dict – the list to convert

Returns

the converted DTO

static convert_docker_stats_dto(docker_stats: Union[None, DockerStats]) → DockerStatsDTO

Converts a DockerStats object to a DockerStatsDTO

Parameters

docker_stats – the object to convert

Returns

the converted objected

static convert_docker_stats_dto_reverse(docker_stats_dto: Union[None, DockerStatsDTO]) → DockerStats

Converts a DockerStatsDTO to a DockerStats

Parameters

docker_stats_dto – the DTO to convert

Returns

the converted DTO

static convert_docker_stats_monitor_dto(monitor_dto: DockerStatsMonitorDTO) → DockerStatsMonitorStatusDTO

Converts a DockerStatsMonitorDTO to a DockerStatsMonitorStatusDTO

Parameters

monitor_dto – the DTO to convert

Returns

the converted DTO

static convert_docker_stats_monitor_dto_reverse(monitor_dto: Optional[DockerStatsMonitorStatusDTO]) → DockerStatsMonitorDTO

Converts a DockerStatsMonitorStatusDTO to a DockerStatsMonitorDTO

Parameters

monitor_dto – the DTO to convert

Returns

the converted DTO

static convert_elk_dto(elk_dto: ElkDTO) → ElkStatusDTO

Converts an ElkDTO to a ElkStatusDTO

Parameters

elk_dto – the DTO to convert

Returns

the converted DTO

static convert_elk_dto_reverse(elk_dto: Optional[ElkStatusDTO]) → ElkDTO

Converts an ElkStatusDTO to an ElkDTO

Parameters

elk_dto – the DTO to convert

Returns

the converted DTO

static convert_elk_info_dto(elk_managers_dto: Union[None, ELKManagersInfo]) → ElkManagersInfoDTO

Converts a ELKManagersInfo into a ElkManagersInfoDTO

Parameters

elk_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_elk_info_dto_reverse(elk_managers_dto: Union[None, ElkManagersInfoDTO]) → ELKManagersInfo

Converts a ELKManagersInfo into a ElkManagersInfoDTO

Parameters

elk_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_emulation_attacker_action_dto(emulation_attacker_action: Union[None, EmulationAttackerAction]) → EmulationAttackerActionDTO

Converts a EmulationAttackerAction object to a EmulationAttackerActionDTO

Parameters

emulation_attacker_action – the object to convert

Returns

the converted objected

static convert_emulation_attacker_action_dto_reverse(emulation_attacker_action_dto: Union[None, EmulationAttackerActionDTO]) → EmulationAttackerAction

Converts a EmulationAttackerActionDTO to an EmulationAttackerAction

Parameters

emulation_attacker_action_dto – the DTO to convert

Returns

the converted DTO

static convert_emulation_defender_action_dto(emulation_defender_action: Union[None, EmulationDefenderAction]) → EmulationDefenderActionDTO

Converts a EmulationDefenderAction object to a EmulationDefenderActionDTO

Parameters

emulation_defender_action – the object to convert

Returns

the converted objected

static convert_emulation_defender_action_dto_reverse(emulation_defender_action_dto: Union[None, EmulationDefenderActionDTO]) → EmulationDefenderAction

Converts a EmulationDefenderActionDTO to an EmulationDefenderAction

Parameters

emulation_defender_action_dto – the DTO to convert

Returns

the converted DTO

static convert_emulation_metrics_time_series_dto(time_series_dto: EmulationMetricsTimeSeries) → EmulationMetricsTimeSeriesDTO

Converts a EmulationMetricsTimeSeries to a EmulationMetricsTimeSeriesDTO

Parameters

time_series_dto – the dict to convert

Returns

the converted objected

static convert_emulation_metrics_time_series_dto_reverse(time_series_dto: Union[None, EmulationMetricsTimeSeriesDTO]) → EmulationMetricsTimeSeries

Converts a EmulationMetricsTimeSeriesDTO to a EmulationMetricsTimeSeries

Parameters

time_series_dto – the DTO to convert

Returns

the converted DTO

static convert_execution_info_dto(execution_info_dto: Union[None, EmulationExecutionInfo]) → ExecutionInfoDTO

Converts a EmulationExecutionInfo into a ExecutionInfoDTO

Parameters

execution_info_dto – the DTO to convert

Returns

the converted DTO

static convert_flow_statistic_dict(flow_statistic_dict: Union[None, Dict[str, List[FlowStatistic]]]) → List[FlowStatisticDict]

Converts a dict to list of FlowStatisticDict

Parameters

flow_statistic_dict – the dict to convert

Returns

the converted objected

static convert_flow_statistic_dict_reverse(flow_statistics_dict: Optional[List[FlowStatisticDict]]) → Dict[str, List[FlowStatistic]]

Converts a list of FlowStatisticDict to a dict

Parameters

flow_statistics_dict – the list to convert

Returns

the converted DTO

static convert_flow_statistic_dto_reverse(flow_statistic_dto: Union[None, FlowStatisticDTO]) → FlowStatistic

Converts a FlowStatisticDTO to a FlowStatistic

Parameters

flow_statistic_dto – the DTO to convert

Returns

the converted DTO

static convert_flow_statistics_dto(flow_statistic: Union[None, FlowStatistic]) → FlowStatisticDTO

Converts a FlowStatistic object to a FlowStatisticDTO

Parameters

flow_statistic – the object to convert

Returns

the converted objected

static convert_host_info_dto(host_managers_dto: Union[None, HostManagersInfo]) → HostManagersInfoDTO

Converts a HostManagersInfo into a HostManagersInfoDTO

Parameters

host_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_host_info_dto_reverse(host_managers_dto: Union[None, HostManagersInfoDTO]) → HostManagersInfo

Converts a HostManagersInfoDTO into a HostManagersInfo

Parameters

host_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_host_metrics_dict(host_metrics_dict: Optional[Dict[str, List[HostMetrics]]]) → List[HostMetricsDict]

Converts a dict to list of HostMetricsDict

Parameters

host_metrics_dict – the dict to convert

Returns

the converted objected

static convert_host_metrics_dict_reverse(host_metrics_dict: Optional[List[HostMetricsDict]]) → Dict[str, List[HostMetrics]]

Converts a list of HostMetricsDict to a dict

Parameters

host_metrics_dict – the list to convert

Returns

the converted DTO

static convert_host_metrics_dto(host_metrics: Union[None, HostMetrics]) → HostMetricsDataDTO

Converts a HostMetrics object to a HostMetricsDataDTO

Parameters

host_metrics – the object to convert

Returns

the converted objected

static convert_host_metrics_dto_reverse(host_metrics_dto: Union[None, HostMetricsDataDTO]) → HostMetrics

Converts a HostMetricsDataDTO to a HostMetrics

Parameters

host_metrics_dto – the DTO to convert

Returns

the converted DTO

static convert_host_status_to_host_manager_status_dto(host_status_dto_and_ip: Tuple[HostStatusDTO, str]) → HostManagerStatusDTO

Converts a HostStatusDTO to a HostManagerStatusDTO

Parameters

host_status_dto – the DTO to convert

Returns

the converted DTO

static convert_host_status_to_host_manager_status_dto_reverse(host_status_dto: Union[None, HostManagerStatusDTO]) → Tuple[HostStatusDTO, str]

Converts a HostManagerStatusDTO to a HostStatusDTO

Parameters

host_status_dto – the DTO to convert

Returns

the converted DTO

static convert_kafka_dto_to_kafka_status_dto(kafka_dto: Union[None, KafkaDTO]) → KafkaStatusDTO

Converts a KafkaDTO to a KafkaStatusDTO

Parameters

kafka_dto – the DTO to convert

Returns

the converted DTO

static convert_kafka_dto_to_kafka_status_dto_reverse(kafka_dto: Union[None, KafkaStatusDTO]) → KafkaDTO

Converts a KafkaStatusDTO to a KafkaDTO

Parameters

kafka_dto – the DTO to convert

Returns

the converted DTO

static convert_kafka_info_dto(kafka_managers_info_dto: Union[None, KafkaManagersInfo]) → KafkaManagersInfoDTO

Converts a KafkaManagersInfo into a KafkaManagersInfoDTO

Parameters

kafka_managers_info_dto – the DTO to convert

Returns

the converted DTO

static convert_kafka_info_dto_reverse(kafka_managers_info_dto: Union[None, KafkaManagersInfoDTO]) → KafkaManagersInfo

Converts a KafkaManagersInfoDTO into a KafkaManagersInfo

Parameters

kafka_managers_info_dto – the DTO to convert

Returns

the converted DTO

static convert_ossec_ids_alert_counters_dict(ossec_ids_alert_counters_dict: Optional[Dict[str, List[OSSECIdsAlertCounters]]]) → List[OSSECIdsAlertCountersDict]

Converts a dict to list of OSSECIdsAlertCountersDict

Parameters

ossec_ids_alert_counters_dict – the dict to convert

Returns

the converted objected

static convert_ossec_ids_alert_counters_dict_reverse(ossec_ids_alert_counters_dict: Optional[List[OSSECIdsAlertCountersDict]]) → Dict[str, List[OSSECIdsAlertCounters]]

Converts a list of OSSECIdsAlertCountersDict to a dict

Parameters

ossec_ids_alert_counters_dict – the list to convert

Returns

the converted DTO

static convert_ossec_ids_alert_counters_dto(ossec_ids_alert_counters: Union[None, OSSECIdsAlertCounters]) → OSSECIdsAlertCountersDTO

Converts a OSSECIdsAlertCounters object to a OSSECIdsAlertCountersDTO

Parameters

ossec_ids_alert_counters – the object to convert

Returns

the converted objected

static convert_ossec_ids_alert_counters_dto_reverse(ossec_ids_alert_counters_dto: Union[None, OSSECIdsAlertCountersDTO]) → OSSECIdsAlertCounters

Converts a OSSECIdsAlertCountersDTO to a OSSECIdsAlertCounters

Parameters

ossec_ids_alert_counters_dto – the DTO to convert

Returns

the converted DTO

static convert_ossec_ids_monitor_dto_to_ossec_ids_status_dto(ossec_dto: Union[None, OSSECIdsMonitorDTO]) → OSSECIdsStatusDTO

Converts a OSSECIdsMonitorDTO to a OSSECIdsStatusDTO

Parameters

ossec_dto – the DTO to convert

Returns

the converted DTO

static convert_ossec_ids_monitor_dto_to_ossec_ids_status_dto_reverse(ossec_dto: Union[None, OSSECIdsStatusDTO]) → OSSECIdsMonitorDTO

Converts a OSSECIdsStatusDTO to a OSSECIdsMonitorDTO

Parameters

ossec_dto – the DTO to convert

Returns

the converted DTO

static convert_ossec_info_dto(ossec_ids_managers_info_dto: Optional[OSSECIDSManagersInfo]) → OSSECIdsManagersInfoDTO

Converts a OSSECIDSManagersInfo into a OSSECIdsManagersInfoDTO

Parameters

ossec_ids_managers_info_dto – the DTO to convert

Returns

the converted DTO

static convert_ossec_info_dto_reverse(ossec_ids_managers_info_dto: Union[None, OSSECIdsManagersInfoDTO]) → OSSECIDSManagersInfo

Converts a OSSECIdsManagersInfoDTO into a OSSECIDSManagersInfo

Parameters

ossec_ids_managers_info_dto – the DTO to convert

Returns

the converted DTO

static convert_port_statistic_dict(port_statistic_dict: Union[None, Dict[str, List[PortStatistic]]]) → List[PortStatisticDict]

Converts a dict to list of PortStatisticDict

Parameters

port_statistic_dict – the dict to convert

Returns

the converted object

static convert_port_statistic_dict_reverse(port_statistics_dict: Union[None, List[PortStatisticDict]]) → Dict[str, List[PortStatistic]]

Converts a list of PortStatisticDict to a dict

Parameters

port_statistics_dict – the list to convert

Returns

the converted DTO

static convert_port_statistic_dto_reverse(port_statistic_dto: Union[None, PortStatisticDTO]) → PortStatistic

Converts a PortStatisticDTO to a PortStatistic

Parameters

port_statistic_dto – the DTO to convert

Returns

the converted DTO

static convert_port_statistics_dto(port_statistic: Union[None, PortStatistic]) → PortStatisticDTO

Converts a PortStatistic object to a PortStatisticDTO

Parameters

port_statistic – the object to convert

Returns

the converted objected

static convert_ryu_dto_to_ryu_status_dto(ryu_dto: Union[None, RyuDTO]) → RyuManagerStatusDTO

Converts a RyuDTO to a RyuManagerStatusDTO

Parameters

ryu_dto – the DTO to convert

Returns

the converted DTO

static convert_ryu_dto_to_ryu_status_dto_reverse(ryu_dto: Union[None, RyuManagerStatusDTO]) → RyuDTO

Converts a RyuManagerStatusDTO to a RyuDTO

Parameters

ryu_dto – the DTO to convert

Returns

the converted DTO

static convert_ryu_info_dto(ryu_managers_info_dto: Union[None, RyuManagersInfo]) → RyuManagersInfoDTO

Converts a RyuManagersInfo into a RyuManagersInfoDTO

Parameters

ryu_managers_info_dto – the DTO to convert

Returns

the converted DTO

static convert_ryu_info_dto_reverse(ryu_managers_info_dto: Union[None, RyuManagersInfoDTO]) → RyuManagersInfo

Converts a RyuManagersInfoDTO into a RyuManagersInfo

Parameters

ryu_managers_info_dto – the DTO to convert

Returns

the converted DTO

static convert_snort_ids_alert_counters_dict(snort_ids_alert_counters_d: Optional[Dict[str, List[SnortIdsAlertCounters]]]) → List[SnortIdsAlertCountersDict]

Converts a dict to list of SnortIdsAlertCountersDict

Parameters

snort_ids_alert_counters_d – the dict to convert

Returns

the converted objected

static convert_snort_ids_alert_counters_dict_reverse(snort_ids_alerts_counters_dict: Optional[List[SnortIdsAlertCountersDict]]) → Dict[str, List[SnortIdsAlertCounters]]

Converts a list of SnortIdsIpAlertCountersDict to a dict

Parameters

snort_ids_alerts_counters_dict – the list to convert

Returns

the converted DTO

static convert_snort_ids_alert_counters_dto(snort_ids_alert_counters: Union[None, SnortIdsAlertCounters]) → SnortIdsAlertCountersDTO

Converts a SnortIdsAlertCounters object to a SnortIdsAlertCountersDTO

Parameters

snort_ids_alert_counters – the object to convert

Returns

the converted objected

static convert_snort_ids_alert_counters_dto_reverse(snort_ids_alert_counters_dto: Union[None, SnortIdsAlertCountersDTO]) → SnortIdsAlertCounters

Converts a SnortIdsAlertCountersDTO to a SnortIdsAlertCounters

Parameters

snort_ids_alert_counters_dto – the DTO to convert

Returns

the converted DTO

static convert_snort_ids_ip_alert_counters_dict(snort_ids_ip_alert_counters_d: Optional[Dict[str, List[SnortIdsIPAlertCounters]]]) → List[SnortIdsIpAlertCountersDict]

Converts a dict to list of SnortIdsIpAlertCountersDict

Parameters

snort_ids_ip_alert_counters_d – the dict to convert

Returns

the converted objected

static convert_snort_ids_ip_alert_counters_dict_reverse(snort_ids_ip_alerts_counters_dict: Optional[List[SnortIdsIpAlertCountersDict]]) → Dict[str, List[SnortIdsIPAlertCounters]]

Converts a list of SnortIdsIpAlertCountersDict to a dict

Parameters

snort_ids_ip_alerts_counters_dict – the list to convert

Returns

the converted DTO

static convert_snort_ids_ip_alert_counters_dto(snort_ids_ip_alert_counters: Union[None, SnortIdsIPAlertCounters]) → SnortIdsIpAlertCountersDTO

Converts a SnortIdsIPAlertCounters object to a SnortIdsIpAlertCountersDTO

Parameters

snort_ids_ip_alert_counters – the object to convert

Returns

the converted objected

static convert_snort_ids_ip_alert_counters_dto_reverse(snort_ids_ip_alert_counters_dto: Union[None, SnortIdsIpAlertCountersDTO]) → SnortIdsIPAlertCounters

Converts a SnortIdsIpAlertCountersDTO to a SnortIdsIPAlertCounters

Parameters

snort_ids_ip_alert_counters_dto – the DTO to convert

Returns

the converted DTO

static convert_snort_ids_monitor_dto_to_snort_ids_status_dto(snort_dto: Optional[SnortIdsMonitorDTO]) → SnortIdsStatusDTO

Converts a SnortIdsMonitorDTO to a SnortIdsStatusDTO

Parameters

snort_dto – the DTO to convert

Returns

the converted DTO

static convert_snort_ids_monitor_dto_to_snort_ids_status_dto_reverse(snort_dto: Optional[SnortIdsStatusDTO]) → SnortIdsMonitorDTO

Converts a SnortIdsStatusDTO to a SnortIdsMonitorDTO

Parameters

snort_dto – the DTO to convert

Returns

the converted DTO

static convert_snort_ids_rule_counters_dict(snort_ids_rule_counters_d: Union[None, Dict[str, List[SnortIdsRuleCounters]]]) → List[SnortIdsRuleCountersDict]

Converts a dict to list of SnortIdsRuleCountersDict

Parameters

snort_ids_rule_counters_d – the dict to convert

Returns

the converted objected

static convert_snort_ids_rule_counters_dict_reverse(snort_ids_rule_counters_dict: Union[None, List[SnortIdsRuleCountersDict]]) → Dict[str, List[SnortIdsRuleCounters]]

Converts a list of SnortIdsRuleCountersDict to a dict

Parameters

snort_ids_rule_counters_dict – the list to convert

Returns

the converted DTO

static convert_snort_ids_rule_counters_dto(snort_ids_rule_counters: Optional[SnortIdsRuleCounters]) → SnortIdsRuleCountersDTO

Converts a SnortIdsRuleCounters object to a SnortIdsRuleCountersDTO

Parameters

snort_ids_rule_counters – the object to convert

Returns

the converted objected

static convert_snort_ids_rule_counters_dto_reverse(snort_ids_rule_counters_dto: Union[None, SnortIdsRuleCountersDTO]) → SnortIdsRuleCounters

Converts a SnortIdsRuleCountersDTO to a SnortIdsRuleCounters

Parameters

snort_ids_rule_counters_dto – the DTO to convert

Returns

the converted DTO

static convert_snort_info_dto(snort_ids_managers_info_dto: Union[None, SnortIdsManagersInfo]) → SnortIdsManagersInfoDTO

Converts a SnortIdsManagersInfo into a SnortIdsManagersInfoDTO

Parameters

snort_ids_managers_info_dto – the DTO to convert

Returns

the converted DTO

static convert_snort_info_dto_reverse(snort_ids_managers_info_dto: Union[None, SnortIdsManagersInfoDTO]) → SnortIdsManagersInfo

Converts a SnortIdsManagersInfo into a SnortIdsManagersInfoDTO

Parameters

snort_ids_managers_info_dto – the DTO to convert

Returns

the converted DTO

static convert_traffic_dto_to_traffic_manager_info_dto(traffic_dto: TrafficDTO) → TrafficManagerInfoDTO

Converts a TrafficDTO to a TrafficManagerInfoDTO

Parameters

traffic_dto – the DTO to convert

Returns

the converted DTO

static convert_traffic_dto_to_traffic_manager_info_dto_reverse(traffic_dto: Optional[TrafficManagerInfoDTO]) → TrafficDTO

Converts a TrafficManagerInfoDTO to a TrafficDTO

Parameters

traffic_dto – the DTO to convert

Returns

the converted DTO

static convert_traffic_info_dto(traffic_managers_dto: Union[None, TrafficManagersInfo]) → TrafficManagersInfoDTO

Converts a TrafficManagersInfo into a TrafficManagerInfoDTO

Parameters

traffic_managers_dto – the DTO to convert

Returns

the converted DTO

static convert_traffic_info_dto_reverse(traffic_managers_dto: Union[None, TrafficManagersInfoDTO]) → TrafficManagersInfo

Converts a TrafficManagerInfoDTO into a TrafficManagersInfo

Parameters

traffic_managers_dto – the DTO to convert

Returns

the converted DTO

static create_kibana_tunnel(execution: EmulationExecution, logger: Logger) → int

Utility method for creating a Kibana tunnel.

Parameters

• execution – the execution to create the tunnel for

• logger – the logger to use for logging

Returns

the port of the tunnel

static create_kibana_tunnels_dto_from_dict(dict: Dict[str, Any]) → KibanaTunnelsDTO

Utility function for creating a kibana tunnels DTO from a dict with Kibana tunnels

Parameters

dict – the dict with the tunnels

Returns

the DTO

static create_ryu_tunnel(execution: EmulationExecution, logger: Logger) → int

Utility function for creating a Ryu tunnel

Parameters

• execution – the execution to create the tunnel for

• logger – the logger to use for logging

Returns

the port of the tunnel

static create_ryu_tunnels_dto_from_dict(dict: Dict[str, Any]) → RyuTunnelsDTO

Utility function for creating a ryu tunnels DTO from a dict with Ryu tunnels

Parameters

dict – the dict with the tunnels

Returns

the DTO

static docker_container_dto_to_dict(docker_container_dto_to_dict: DockerContainerDTO) → Dict[str, Any]

Converts a DockerContainerDTO to a dict

Parameters

docker_container_dto_to_dict – the dto to convert

Returns

a dict representation of the DTO

static docker_networks_dto_to_dict(docker_networks_dto: DockerNetworksDTO) → Dict[str, Any]

Converts a DockerNetworksDTO to a dict

Parameters

docker_networks_dto – the dto to convert

Returns

a dict representation of the DTO

static docker_stats_dict_to_dict(docker_stats_dict: DockerStatsDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

docker_stats_dict – the DTO to convert

Returns

the dict

static docker_stats_dto_to_dict(docker_stats_dto: DockerStatsDTO) → Dict[str, Any]

Converts a DockerStatsDTO to a dict

Parameters

docker_stats_dto – the dto to convert

Returns

a dict representation of the DTO

static docker_stats_managers_info_dto_to_dict(docker_stats_managers_info_dto: DockerStatsManagersInfoDTO) → Dict[str, Any]

Converts a DockerStatsManagersInfoDTO to a dict

Parameters

docker_stats_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static docker_stats_monitor_status_dto_to_dict(docker_stats_managers_info_dto: DockerStatsMonitorStatusDTO) → Dict[str, Any]

Converts a DockerStatsMonitorStatusDTO to a dict

Parameters

docker_stats_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static elk_managers_info_dto_to_dict(elk_managers_info_dto: ElkManagersInfoDTO) → Dict[str, Any]

Converts a ElkManagersInfoDTO to a dict

Parameters

elk_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static elk_status_dto_to_dict(elk_status_dto: ElkStatusDTO) → Dict[str, Any]

Converts a ElkStatusDTO to a dict

Parameters

elk_status_dto – the dto to convert

Returns

a dict representation of the DTO

static emulation_attacker_action_dto_to_dict(emulation_attacker_action_dto: EmulationAttackerActionDTO) → Dict[str, Any]

Converts a EmulationAttackerActionDTO to a dict

Parameters

emulation_attacker_action_dto – the dto to convert

Returns

a dict representation of the DTO

static emulation_defender_action_dto_to_dict(emulation_defender_action_dto: EmulationDefenderActionDTO) → Dict[str, Any]

Converts a EmulationDefenderActionDTO to a dict

Parameters

emulation_defender_action_dto – the dto to convert

Returns

a dict representation of the DTO

static emulation_metrics_time_series_dto_to_dict(time_series_dto: EmulationMetricsTimeSeriesDTO) → Dict[str, Any]

Converts a EmulationMetricsTimeSeriesDTO to a dict

Parameters

time_series_dto – the dto to convert

Returns

a dict representation of the DTO

static flow_statistic_dto_to_dict(flow_statistic_dto: FlowStatisticDTO) → Dict[str, Any]

Converts a FlowStatisticDTO to a dict

Parameters

flow_statistic_dto – the dto to convert

Returns

a dict representation of the DTO

static flow_statistics_dict_to_dict(flow_statistics_dict: FlowStatisticDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

flow_statistics_dict – the DTO to convert

Returns

the dict

static get_active_ips(emulation_env_config: EmulationEnvConfig) → List[str]

Gets the locally active ips for a given emulation

Parameters

emulation_env_config – the emulation configuration

Returns

the list of Ips

static get_container_config(execution: EmulationExecution, ip: str) → Optional[NodeContainerConfig]

Utility method for checking if a given IP matches som container IP in a given execution and then returns the corresponding configuration

Parameters

• execution – the execution to check

• ip – the ip to check

Returns

the IP if it matches, otherwise None

static get_empty_agg_flow_statistic_dict() → List[AggFlowStatisticDict]

Gets an empty list of AggFlowStatisticDict :return: an empty list of AggFlowStatisticDict

static get_empty_agg_flow_statistic_dto() → AggFlowStatisticDTO

Gets an empty AggFlowStatisticDTO

Returns

an empty AggFlowStatisticDTO

static get_empty_avg_flow_statistic_dict() → List[AvgFlowStatisticDict]

Gets an empty list of AvgFlowStatisticDict

Returns

an empty list of AvgFlowStatisticDict

static get_empty_avg_flow_statistic_dto() → AvgFlowStatisticDTO

Gets an empty AvgFlowStatisticDTO

Returns

an empty AvgFlowStatisticDTO

static get_empty_avg_port_statistic_dict() → List[AvgPortStatisticDict]

Gets an empty list of AvgPortStatisticDict

Returns

an empty list of AvgPortStatisticDict

static get_empty_avg_port_statistic_dto() → AvgPortStatisticDTO

Gets an empty AvgPortStatisticDTO

Returns

an empty AvgPortStatisticDTO

static get_empty_client_managers_info_dto() → ClientManagersInfoDTO

Gets an empty ClientManagersInfoDTO

Returns

an empty ClientManagersInfoDTO

static get_empty_client_population_metrics_dto() → ClientPopulationMetricsDTO

Gets an empty ClientPopulationMetricsDTO

Returns

an empty ClientPopulationMetricsDTO

static get_empty_docker_managers_info_dto() → DockerStatsManagersInfoDTO

Gets an empty DockerStatsManagersInfoDTO

Returns

an empty DockerStatsManagersInfoDTO

static get_empty_docker_stats_dict() → List[DockerStatsDict]

Gets an empty list of DockerStatsDict

Returns

an empty list of DockerStatsDict

static get_empty_docker_stats_dto() → DockerStatsDTO

Returns

an empty ClientPopulationMetricsDTO

static get_empty_docker_stats_monitor_status_dto() → DockerStatsMonitorStatusDTO

Gets an empty DockerStatsMonitorStatusDTO

Returns

an empty DockerStatsMonitorStatusDTO

static get_empty_elk_managers_info_dto() → ElkManagersInfoDTO

Gets an empty ElkManagersInfoDTO

Returns

an empty ElkManagersInfoDTO

static get_empty_elk_status_dto() → ElkStatusDTO

Gets an empty ElkStatusDTO

Returns

an empty ElkStatusDTO

static get_empty_emulation_attacker_action_dto() → EmulationAttackerActionDTO

Gets an empty EmulationAttackerActionDTO

Returns

an empty EmulationAttackerActionDTO

static get_empty_emulation_defender_action_dto() → EmulationDefenderActionDTO

Gets an empty EmulationDefenderActionDTO

Returns

an empty EmulationDefenderActionDTO

static get_empty_emulation_metrics_time_series_dto() → EmulationMetricsTimeSeriesDTO

Gets an empty emulation metric series dto

Returns

an empty EmulationMetricsTimeSeriesDTO

static get_empty_execution_info_dto() → ExecutionInfoDTO

Gets an empty ExecutionInfoDTO

Returns

an empty ExecutionInfoDTO

static get_empty_flow_statistic_dict() → List[FlowStatisticDict]

Gets an empty list of FlowStatisticDict

Returns

an empty list of FlowStatisticDict

static get_empty_flow_statistic_dto() → FlowStatisticDTO

Gets an empty FlowStatisticDTO

Returns

an empty FlowStatisticDTO

static get_empty_get_num_clients_dto() → GetNumClientsDTO

Gets an empty GetNumClientsDTO

Returns

an empty GetNumClientsDTO

static get_empty_host_manager_status_dto() → HostManagerStatusDTO

Gets an empty HostManagerStatusDTO

Returns

an empty HostManagerStatusDTO

static get_empty_host_managers_info_dto() → HostManagersInfoDTO

Gets an empty HostManagersInfoDTO

Returns

an empty HostManagersInfoDTO

static get_empty_host_metrics_dict() → List[HostMetricsDict]

Gets an empty list of HostMetricsDict

Returns

an empty HostMetricsDict

static get_empty_host_metrics_dto() → HostMetricsDataDTO

Gets an empty HostMetricsDataDTO

Returns

an empty HostMetricsDataDTO

static get_empty_kafka_dto() → KafkaStatusDTO

Gets an empty KafkaStatusDTO

Returns

an empty KafkaStatusDTO

static get_empty_kafka_managers_info_dto() → KafkaManagersInfoDTO

Gets an empty KafkaManagersInfoDTO

Returns

an empty KafkaManagersInfoDTO

static get_empty_kibana_tunnel_dto() → KibanaTunnelDTO

Gets an empty KibanaTunnelDTO

Returns

an empty KibanaTunnelDTO

static get_empty_kibana_tunnels_dto() → KibanaTunnelsDTO

Gets an empty KibanaTunnelsDTO

Returns

an empty KibanaTunnelsDTO

static get_empty_num_clients_dto() → GetNumClientsDTO

Gets an empty GetNumClientsDTO

Returns

an empty GetNumClientsDTO

static get_empty_ossec_ids_alert_counters_dict() → List[OSSECIdsAlertCountersDict]

Gets an empty list of OSSECIdsAlertCountersDict :return: an empty OSSECIdsAlertCountersDict

static get_empty_ossec_ids_alert_counters_dto() → OSSECIdsAlertCountersDTO

Gets an empty OSSECIdsAlertCountersDTO

Returns

an empty OSSECIdsAlertCountersDTO

static get_empty_ossec_ids_monitor_dto() → OSSECIdsStatusDTO

Gets an empty OSSECIdsMonitorDTO

Returns

an empty OSSECIdsMonitorDTO

static get_empty_ossec_ids_status_dto() → OSSECIdsStatusDTO

Gets an empty OSSECIdsStatusDTO

Returns

an empty OSSECIdsStatusDTO

static get_empty_ossec_managers_info_dto() → OSSECIdsManagersInfoDTO

Gets an empty OSSECIdsManagersInfoDTO

Returns

an empty OSSECIdsManagersInfoDTO

static get_empty_port_statistic_dict() → List[PortStatisticDict]

Gets an list of PortStatisticDict

Returns

an empty list of PortStatisticDict

static get_empty_port_statistic_dto() → PortStatisticDTO

Gets an empty PortStatisticDTO

Returns

an empty PortStatisticDTO

static get_empty_ryu_manager_status_dto() → RyuManagerStatusDTO

Gets an empty RyuManagerStatusDTO

Returns

an empty RyuManagerStatusDTO

static get_empty_ryu_managers_info_dto() → RyuManagersInfoDTO

Gets an empty RyuManagersInfoDTO

Returns

an empty RyuManagersInfoDTO

static get_empty_ryu_tunnel_dto() → RyuTunnelDTO

Gets an empty RyuTunnelDTO

Returns

an empty RyuTunnelDTO

static get_empty_ryu_tunnels_dto() → RyuTunnelsDTO

Returns

an empty RyuTunnelsDTO

static get_empty_snort_ids_alert_counters_dict() → List[SnortIdsAlertCountersDict]

Gets an empty list of SnortIdsAlertCountersDict

Returns

an empty list of SnortIdsAlertCountersDict

static get_empty_snort_ids_alert_counters_dto() → SnortIdsAlertCountersDTO

Gets an empty SnortIdsAlertCountersDTO

Returns

an empty SnortIdsAlertCountersDTO

static get_empty_snort_ids_ip_alert_counters_dict() → List[SnortIdsIpAlertCountersDict]

Gets an empty list of SnortIdsIpAlertCountersDict

Returns

an empty list of SnortIdsIpAlertCountersDict

static get_empty_snort_ids_ip_alert_counters_dto() → SnortIdsIpAlertCountersDTO

Gets an empty SnortIdsAlertCountersDTO

Returns

an empty SnortIdsAlertCountersDTO

static get_empty_snort_ids_rule_counters_dict() → List[SnortIdsRuleCountersDict]

Gets an empty list of SnortIdsRuleCountersDict

Returns

an empty list of SnortIdsRuleCountersDict

static get_empty_snort_ids_rule_counters_dto() → SnortIdsRuleCountersDTO

Gets an empty SnortIdsAlertCountersDTO

Returns

an empty SnortIdsAlertCountersDTO

static get_empty_snort_ids_status_dto() → SnortIdsStatusDTO

Gets an empty SnortIdsStatusDTO

Returns

an empty SnortIdsStatusDTO

static get_empty_snort_managers_info_dto() → SnortIdsManagersInfoDTO

Gets an empty SnortIdsManagersInfoDTO

Returns

an empty SnortIdsManagersInfoDTO

static get_empty_traffic_manager_info_dto() → TrafficManagerInfoDTO

Gets an empty TrafficManagersInfoDTO

Returns

an empty TrafficManagersInfoDTO

static get_empty_traffic_managers_info_dto() → TrafficManagersInfoDTO

Gets an empty TrafficManagersInfoDTO

Returns

an empty TrafficManagersInfoDTO

static get_logs(execution: EmulationExecution, ip: str, path: str) → LogsDTO

Utility method for getting the logs of a specific container in a specific execution and with a specific path

Parameters

• execution – the execution

• ip – the IP of the container

Returns

the parsed logs

static get_num_clients_dto_to_dict(get_num_clients_dto: GetNumClientsDTO) → Dict[str, Any]

Converts a GetNumClientsDTO to a dict

Parameters

get_num_clients_dto – the dto to convert

Returns

a dict representation of the DTO

static host_manager_status_dto_to_dict(host_manager_status_dto: HostManagerStatusDTO) → Dict[str, Any]

Converts a HostManagerStatusDTO to a dict

Parameters

host_manager_status_dto – the dto to convert

Returns

a dict representation of the DTO

static host_managers_info_dto_to_dict(host_managers_info_dto: HostManagersInfoDTO) → Dict[str, Any]

Converts a HostManagersInfoDTO to a dict

Parameters

host_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static host_metrics_dict_to_dict(host_metrics_dict: HostMetricsDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

host_metrics_dict – the DTO to convert

Returns

the dict

static host_metrics_dto_to_dict(host_metrics_dto: HostMetricsDataDTO) → Dict[str, Any]

Converts a HostMetricsDataDTO to a dict

Parameters

host_metrics_dto – the dto to convert

Returns

a dict representation of the DTO

static kafka_managers_info_dto_to_dict(kafka_managers_info_dto: KafkaManagersInfoDTO) → Dict[str, Any]

Converts a KafkaManagersInfoDTO to a dict

Parameters

kafka_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static kafka_status_dto_to_dict(kafka_status_dto: KafkaStatusDTO) → Dict[str, Any]

Converts a KafkaStatusDTO to a dict

Parameters

kafka_status_dto – the dto to convert

Returns

a dict representation of the DTO

static kibana_tunnel_dto_to_dict(kibana_tunnel_dto: KibanaTunnelDTO) → Dict[str, Any]

Converts a KibanaTunnelDTO to a dict

Parameters

kibana_tunnel_dto – the dto to convert

Returns

a dict representation of the DTO

static kibana_tunnels_dto_to_dict(kibana_tunnels_dto: KibanaTunnelsDTO) → Dict[str, Any]

Converts a KibanaTunnelsDTO to a dict

Parameters

kibana_tunnels_dto – the dto to convert

Returns

a dict representation of the DTO

static logs_dto_to_dict(logs_dto: LogsDTO) → Dict[str, Any]

Converts a LogsDTO to a dict

Parameters

logs_dto – the dto to convert

Returns

a dict representation of the DTO

static merge_execution_infos(execution_infos: List[ExecutionInfoDTO]) → EmulationExecutionInfo

Function that merges a list of execution infos into one

Parameters

execution_infos – the list of execution infos to merge

Returns

the merged info

static node_status_dto_to_dict(node_status_dto: NodeStatusDTO) → Dict[str, Any]

Converts a NodeStatusDTO to a dict

Parameters

node_status_dto – the dto to convert

Returns

a dict representation of the DTO

static ossec_ids_alert_counters_dict_to_dict(ossec_ids_alert_counters_dict: OSSECIdsAlertCountersDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

ossec_ids_alert_counters_dict – the DTO to convert

Returns

the dict

static ossec_ids_alert_counters_dto_to_dict(ossec_ids_alert_counters_dto: OSSECIdsAlertCountersDTO) → Dict[str, Any]

Converts a OSSECIdsAlertCountersDTO to a dict

Parameters

ossec_ids_alert_counters_dto – the dto to convert

Returns

a dict representation of the DTO

static ossec_ids_monitor_thread_statuses_dto_to_dict(ossec_ids_monitor_thread_statuses_dto: OSSECIdsMonitorThreadStatusesDTO) → Dict[str, Any]

Converts a OSSECIdsMonitorThreadStatusesDTO to a dict

Parameters

ossec_ids_monitor_thread_statuses_dto – the dto to convert

Returns

a dict representation of the DTO

static ossec_ids_status_dto_to_dict(ossec_ids_status_dto: OSSECIdsStatusDTO) → Dict[str, Any]

Converts a OSSECIdsStatusDTO to a dict

Parameters

ossec_ids_status_dto – the dto to convert

Returns

a dict representation of the DTO

static ossec_managers_info_dto_to_dict(ossec_managers_info_dto: OSSECIdsManagersInfoDTO) → Dict[str, Any]

Converts a OSSECIdsManagersInfoDTO to a dict

Parameters

ossec_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static port_statistic_dto_to_dict(port_statistic_dto: PortStatisticDTO) → Dict[str, Any]

Converts a PortStatisticDTO to a dict

Parameters

port_statistic_dto – the dto to convert

Returns

a dict representation of the DTO

static port_statistics_dict_to_dict(port_statistics_dict: PortStatisticDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

port_statistics_dict – the DTO to convert

Returns

the dict

static remove_kibana_tunnel(execution: EmulationExecution) → None

Utility function for removing the kibana tunnel of a given execution

Parameters

execution – the execution to remove the tunnel for

Returns

None

static remove_ryu_tunnel(execution: EmulationExecution) → None

Utility function for removing a Ryu tunnel for a given execution

Parameters

execution – the execution to remove the tunnel for

Returns

None

static running_containers_dto_to_dict(running_containers_dto_to_dict: RunningContainersDTO) → Dict[str, List[Dict[str, Any]]]

Converts a RunningContainersDTO to a dict

Parameters

running_containers_dto_to_dict – the dto to convert

Returns

a dict representation of the DTO

static running_emulations_dto_to_dict(running_emulations_dto: RunningEmulationsDTO) → Dict[str, Any]

Converts a RunningEmulationsDTO to a dict

Parameters

running_emulations_dto – the dto to convert

Returns

a dict representation of the DTO

static ryu_manager_status_dto_to_dict(ryu_manager_status_dto_to_dict: RyuManagerStatusDTO) → Dict[str, Any]

Converts a RyuManagerStatusDTO to a dict

Parameters

ryu_manager_status_dto_to_dict – the dto to convert

Returns

a dict representation of the DTO

static ryu_managers_info_dto_to_dict(ryu_managers_info_dto: RyuManagersInfoDTO) → Dict[str, Any]

Converts a RyuManagersInfoDTO to a dict

Parameters

ryu_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static ryu_tunnel_dto_to_dict(ryu_tunnel_dto: RyuTunnelDTO) → Dict[str, Any]

Converts a RyuTunnelDTO to a dict

Parameters

ryu_tunnel_dto – the dto to convert

Returns

a dict representation of the DTO

static ryu_tunnels_dto_to_dict(ryu_tunnels_dto: RyuTunnelsDTO) → Dict[str, Any]

Converts a RyuTunnelsDTO to a dict

Parameters

ryu_tunnels_dto – the dto to convert

Returns

a dict representation of the DTO

static service_status_dto_to_dict(node_status_dto: ServiceStatusDTO) → Dict[str, Any]

Converts a ServiceStatusDTO to a dict

Parameters

node_status_dto – the dto to convert

Returns

a dict representation of the DTO

static snort_ids_alert_counters_dict_to_dict(snort_ids_alert_counters_dict: SnortIdsAlertCountersDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

snort_ids_alert_counters_dict – the DTO to convert

Returns

the dict

static snort_ids_alert_counters_dto_to_dict(snort_ids_alert_counters_dto: SnortIdsAlertCountersDTO) → Dict[str, Any]

Converts a SnortIdsAlertCountersDTO to a dict

Parameters

snort_ids_alert_counters_dto – the dto to convert

Returns

a dict representation of the DTO

static snort_ids_ip_alert_counters_dict_to_dict(snort_ids_ip_alert_counters_dict: SnortIdsIpAlertCountersDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

snort_ids_ip_alert_counters_dict – the DTO to convert

Returns

the dict

static snort_ids_ip_alert_counters_dto_to_dict(snort_ids_alert_counters_dto: SnortIdsIpAlertCountersDTO) → Dict[str, Any]

Converts a SnortIdsAlertCountersDTO to a dict

Parameters

snort_ids_alert_counters_dto – the dto to convert

Returns

a dict representation of the DTO

static snort_ids_monitor_thread_statuses_dto_to_dict(snort_ids_monitor_thread_statuses_dto: SnortIdsMonitorThreadStatusesDTO) → Dict[str, Any]

Converts a SnortIdsMonitorThreadStatusesDTO to a dict

Parameters

snort_ids_monitor_thread_statuses_dto – the dto to convert

Returns

a dict representation of the DTO

static snort_ids_rule_counters_dict_to_dict(snort_ids_rule_counters_dict: SnortIdsRuleCountersDict) → Dict[str, Any]

Converts a DTO to a dict

Parameters

snort_ids_rule_counters_dict – the DTO to convert

Returns

the dict

static snort_ids_rule_counters_dto_to_dict(snort_ids_rule_counters_dto: SnortIdsRuleCountersDTO) → Dict[str, Any]

Converts a SnortIdsRuleCountersDTO to a dict

Parameters

snort_ids_rule_counters_dto – the dto to convert

Returns

a dict representation of the DTO

static snort_ids_status_dto_to_dict(snort_ids_status_dto: SnortIdsStatusDTO) → Dict[str, Any]

Converts a SnortIdsStatusDTO to a dict

Parameters

snort_ids_status_dto – the dto to convert

Returns

a dict representation of the DTO

static snort_managers_info_dto_to_dict(snort_managers_info_dto: SnortIdsManagersInfoDTO) → Dict[str, Any]

Converts a SnortIdsManagersInfoDTO to a dict

Parameters

snort_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

static stopped_containers_dto_to_dict(stopped_containers_dto_to_dict: StoppedContainersDTO) → Dict[str, Any]

Converts a StoppedContainersDTO to a dict

Parameters

stopped_containers_dto_to_dict – the dto to convert

Returns

a dict representation of the DTO

static tail(f, window=1) → str

Returns the last window lines of file f as a list of bytes.

Parameters

• f – the file object

• window – the window size

Returns

the parsed lines

static traffic_manager_info_dto_to_dict(traffic_manager_info_dto: TrafficManagerInfoDTO) → Dict[str, Any]

Converts a TrafficManagerInfoDTO to a dict

Parameters

traffic_manager_info_dto – the dto to convert

Returns

a dict representation of the DTO

static traffic_managers_info_dto_to_dict(traffic_managers_info_dto: TrafficManagersInfoDTO) → Dict[str, Any]

Converts a TrafficManagersInfoDTO to a dict

Parameters

traffic_managers_info_dto – the dto to convert

Returns

a dict representation of the DTO

csle_cluster.cluster_manager.query_cluster_manager module

csle_cluster.cluster_manager.query_cluster_manager.apply_filebeat_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Applies the filebeat config to a specific node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.apply_filebeats_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Applies the filebeat configurations of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.apply_heartbeat_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Applies the heartbeat configuration to a specific node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the node to apply the config

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.apply_heartbeats_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Applies the heartbeat configurations of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.apply_kafka_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Applies the kafka config to a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.apply_metricbeat_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Applies the metricbeat configuration to a specific node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the node to apply the config

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.apply_metricbeats_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Applies the metricbeat configurations of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.apply_packetbeat_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Applies the packetbeat configuration to a specific node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.apply_packetbeats_config(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Applies the packetbeat configurations of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.apply_resource_constraints(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Applies resource constraints to a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.attach_containers_in_execution_to_networks(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Attaches containers of a given emulation execution that are configured to be deployed on the host to networks

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.check_pid(stub: ClusterManagerStub, pid: int, timeout=30000) → OperationOutcomeDTO

Checks the status of a PID

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• pid – the pid to check

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.clean_all_executions(stub: ClusterManagerStub, timeout=30000) → OperationOutcomeDTO

Cleans all executions

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.clean_all_executions_of_emulation(stub: ClusterManagerStub, emulation: str, timeout=30000) → OperationOutcomeDTO

Cleans all executions of a given emulation

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.clean_execution(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Cleans an emulation execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.configure_ovs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Configure OVS switches in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.create_emulation_networks(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates Docker networks for a given emulation

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.create_flags(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates flags in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.create_kafka_topics(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates the kafka topics in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.create_kibana_tunnel(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates a Kibana tunnel for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.create_ovs_switches(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates OVS switches of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.create_ryu_tunnel(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates a Ryu tunnel for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.create_topology(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates the topology of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.create_users(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates users in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.create_vulnerabilities(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Creates vulnerabilities in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.get_cadvisor_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches cAdvisor logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_client_manager_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → LogsDTO

Gets the logs of the Client manager of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_client_managers_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → ClientManagersInfoDTO

Gets the info of client managers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

a ClientManagersInfoDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.get_cluster_manager_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches the logs of the cluster manager on a given physical node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_container_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → LogsDTO

Gets the logs of a specific container of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_csle_log_files(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches CSLE log file names from the CSLE log directory from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_docker_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches Docker logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_docker_stats_manager_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → DockerStatsManagersInfoDTO

Gets the docker stats manager info

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

a DockerStatsManagersInfoDTO with the infos

csle_cluster.cluster_manager.query_cluster_manager.get_docker_stats_manager_status(stub: ClusterManagerStub, port: int, timeout=30000) → DockerStatsMonitorStatusDTO

Stops the docker stats manager thread for a specific emulation execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• port – the port that the docker statsmanage is listening to

Returns

a DockerStatsMonitorStatusDTO with the docker stats managers statuses

csle_cluster.cluster_manager.query_cluster_manager.get_docker_statsmanager_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches docker statsmanager logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_elk_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → LogsDTO

Gets the logs of the ELK stack of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_elk_manager_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → LogsDTO

Gets the logs of the ELK manager of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_elk_managers_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → ElkManagersInfoDTO

Gets the Elk managers info

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

a ElkManagersInfoDTO with the infos

csle_cluster.cluster_manager.query_cluster_manager.get_elk_status(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → ElkStatusDTO

Gets the status of the Elk stack

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an ElkStatusDTO with the status

csle_cluster.cluster_manager.query_cluster_manager.get_execution_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → ExecutionInfoDTO

Gets the info of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the execution info

csle_cluster.cluster_manager.query_cluster_manager.get_execution_time_series_data(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, minutes: int, timeout=30000) → EmulationMetricsTimeSeriesDTO

Fetches the logs of the cluster manager on a given physical node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• minutes – the number of minutes to get the data for

Returns

a DTO with the time series data

csle_cluster.cluster_manager.query_cluster_manager.get_flask_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches flask logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_grafana_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches grafana logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_host_manager_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → LogsDTO

Gets the logs of a specific host manager of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_host_managers_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → HostManagersInfoDTO

Gets the host managers info of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the host managers info

csle_cluster.cluster_manager.query_cluster_manager.get_host_monitor_threads_statuses(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → HostManagerStatusesDTO

Gets the host monitor thread statuses of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the monitor thread statuses

csle_cluster.cluster_manager.query_cluster_manager.get_kafka_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → LogsDTO

Gets the logs of the Kafka server of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_kafka_manager_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → LogsDTO

Gets the logs of the Kafka manager of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_kafka_managers_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → KafkaManagersInfoDTO

Gets the info of kafka managers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.get_kafka_status(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → KafkaStatusDTO

Gets the Kafka status in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the kafka status

csle_cluster.cluster_manager.query_cluster_manager.get_log_file(stub: ClusterManagerStub, log_file_name: str, timeout=60) → LogsDTO

Fetches a given log file from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• log_file_name – the name of the log file

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_nginx_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches Nginx logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_node_exporter_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches node exporter logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_node_status(stub: ClusterManagerStub, timeout=60) → NodeStatusDTO

Queries the cluster manager for the status of the node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a NodeStatusDTO describing the status of the node

csle_cluster.cluster_manager.query_cluster_manager.get_num_active_clients(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → GetNumClientsDTO

Gets the number of active clients of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.get_ossec_ids_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → LogsDTO

Gets the logs of a specific OSSEC IDS of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_ossec_ids_manager_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → LogsDTO

Gets the logs of a specific OSSEC IDS Manager of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_ossec_ids_managers_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OSSECIdsManagersInfoDTO

Gets the info of OSSEC IDS managers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the info

csle_cluster.cluster_manager.query_cluster_manager.get_ossec_ids_monitor_thread_statuses(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OSSECIdsMonitorThreadStatusesDTO

Gets the OSSEC IDS monitor thread statuses for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the statuses

csle_cluster.cluster_manager.query_cluster_manager.get_pgadmin_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches pgAdmin logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_postgresql_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches PostgreSQL logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_prometheus_logs(stub: ClusterManagerStub, timeout=60) → LogsDTO

Fetches node exporter logs from the cluster manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a LogsDTO with the logs

csle_cluster.cluster_manager.query_cluster_manager.get_ryu_controller_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → LogsDTO

Gets the logs of the Ryu controller of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_ryu_manager_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → LogsDTO

Gets the logs of the Ryu manager of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_ryu_managers_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → RyuManagersInfoDTO

Gets the info of Ryu managers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the infos

csle_cluster.cluster_manager.query_cluster_manager.get_ryu_status(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → RyuManagerStatusDTO

Gets the Ryu status

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the status

csle_cluster.cluster_manager.query_cluster_manager.get_snort_ids_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → LogsDTO

Gets the logs of a specific Snort IDS of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_snort_ids_manager_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → LogsDTO

Gets the logs of a specific Snort IDS of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_snort_ids_managers_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → SnortIdsManagersInfoDTO

Gets the info of Snort IDS managers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the infos

csle_cluster.cluster_manager.query_cluster_manager.get_snort_ids_monitor_thread_statuses(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → SnortIdsMonitorThreadStatusesDTO

Gets the Snort IDS monitor thread statuses for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the statuses

csle_cluster.cluster_manager.query_cluster_manager.get_traffic_manager_logs(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → LogsDTO

Gets the logs of a specific Traffic manager of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the logs

csle_cluster.cluster_manager.query_cluster_manager.get_traffic_managers_info(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → TrafficManagersInfoDTO

Gets the info of traffic managers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

a TrafficManagersInfoDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.install_libraries(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Installs CSLE libraries on containers in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.list_all_container_images(stub: ClusterManagerStub, timeout=30000) → ContainerImagesDTO

Lists all container images

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ContainerImagesDTO with the container images

csle_cluster.cluster_manager.query_cluster_manager.list_all_docker_networks(stub: ClusterManagerStub, timeout=30000) → DockerNetworksDTO

Lists all Docker networks

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a DockerNetworksDTO wth the docker networks

csle_cluster.cluster_manager.query_cluster_manager.list_all_running_containers(stub: ClusterManagerStub, timeout=30000) → RunningContainersDTO

Lists all running containers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a RunningContainersDTO wth the running containers

csle_cluster.cluster_manager.query_cluster_manager.list_all_running_emulations(stub: ClusterManagerStub, timeout=30000) → RunningEmulationsDTO

Lists all running emulations

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a RunningEmulationsDTO with the running emulations

csle_cluster.cluster_manager.query_cluster_manager.list_all_stopped_containers(stub: ClusterManagerStub, timeout=30000) → StoppedContainersDTO

Lists all stopped containers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a StoppedContainersDTO wth the stopped containers

csle_cluster.cluster_manager.query_cluster_manager.list_kibana_tunnels(stub: ClusterManagerStub, timeout=30000) → KibanaTunnelsDTO

Lists the Kibana tunnels of a specific server

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.list_ryu_tunnels(stub: ClusterManagerStub, timeout=30000) → RyuTunnelsDTO

Lists the Ryu tunnels of a specific server

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.ping_execution(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Pings all containers in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.remove_all_container_images(stub: ClusterManagerStub, timeout=30000) → OperationOutcomeDTO

Removes all container images

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.remove_all_docker_networks(stub: ClusterManagerStub, timeout=30000) → OperationOutcomeDTO

Remove all docker networks

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.remove_all_stopped_containers(stub: ClusterManagerStub, timeout=30000) → OperationOutcomeDTO

Removes all stopped containers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.remove_container(stub: ClusterManagerStub, container_name: str, timeout=30000) → OperationOutcomeDTO

Removes a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_name – the name of the container

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.remove_container_image(stub: ClusterManagerStub, image_name: str, timeout=30000) → OperationOutcomeDTO

Removes a specific container image

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• image_name – the name of the container imge

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.remove_docker_networks(stub: ClusterManagerStub, networks: List[str], timeout=30000) → OperationOutcomeDTO

Removes a list of docker networks

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• networks – the list of docker networks to remove

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.remove_kibana_tunnel(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Removes a Kibana tunnel for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.remove_ryu_tunnel(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Removes a Ryu tunnel for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.run_container(stub: ClusterManagerStub, image: str, name: str, memory: int, num_cpus: int, create_network: bool, version: str, timeout=30000) → OperationOutcomeDTO

Runs a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• name – the name of the container

• image – the image of the container

• memory – the memory (GB) of the container

• num_cpus – the number of CPUs of the container

• create_network – whether to create a network for the container or not

• version – the version of the container

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_all_stopped_containers(stub: ClusterManagerStub, timeout=30000) → OperationOutcomeDTO

Starts all stopped containers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_cadvisor(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the cAdvisor service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the cAdvisor service

csle_cluster.cluster_manager.query_cluster_manager.start_client_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the client manager of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_client_population(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the client population of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_container(stub: ClusterManagerStub, container_name: str, timeout=30000) → OperationOutcomeDTO

Starts a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_name – the name of the container imge

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_containers_in_execution(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts containers of a given emulation execution that are configured to be deployed on the host

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_containers_of_execution(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the containers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_docker_engine(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the docker engine service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the docker engine service

csle_cluster.cluster_manager.query_cluster_manager.start_docker_statsmanager(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the docker statsmanager service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the docker statsmanager service

csle_cluster.cluster_manager.query_cluster_manager.start_docker_statsmanager_thread(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → ServiceStatusDTO

Starts a docker stats manager thread for a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_elastic(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts elastic

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_elk_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the elk manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_elk_stack(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the ELK stack of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_filebeat(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False, timeout=30000) → OperationOutcomeDTO

Stops filebeat on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container

• initial_start – boolean flag indicating whether it is an initial start or not

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_filebeats(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, initial_start: bool = False, timeout=30000) → OperationOutcomeDTO

Starts filebeats of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• initial_start – boolean flag whether it is the initial start of the filebeats or not

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_flask(stub: ClusterManagerStub, timeout=300) → ServiceStatusDTO

Requests the cluster manager to start the flask service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the flask service

csle_cluster.cluster_manager.query_cluster_manager.start_grafana(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the Grafana service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the Grafana service

csle_cluster.cluster_manager.query_cluster_manager.start_heartbeat(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False, timeout=30000) → OperationOutcomeDTO

Starts heartbeat on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the container

• initial_start – boolean flag indicating whether it is an initial start or not

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_heartbeats(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, initial_start: bool = False, timeout=30000) → OperationOutcomeDTO

Starts heartbeats of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• initial_start – boolean flag whether it is the initial start of the heartbeats or not

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_host_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts the host manager of a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container to start the host manager

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_host_managers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Host managers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_host_monitor_thread(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts a specific host monitor thread

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_host_monitor_threads(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the host monitor threads of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_kafka_client_producer(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Kafka client producer of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_kafka_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the kafka manager in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_kafka_server(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the kafka server in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_kibana(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts Kibana

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_logstash(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts Logstash

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_metricbeat(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False, timeout=30000) → OperationOutcomeDTO

Starts metricbeat on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• initial_start – boolean flag indicating whether it is an initial start or not

• container_ip – the ip of the container

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_metricbeats(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, initial_start: bool = False, timeout=30000) → OperationOutcomeDTO

Starts metricbeats of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• initial_start – boolean flag whether it is the initial start of the metricbeats or not

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_nginx(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the nginx service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the nginx service

csle_cluster.cluster_manager.query_cluster_manager.start_node_exporter(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the node exporter service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the node exporter service

csle_cluster.cluster_manager.query_cluster_manager.start_ossec_ids(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts the OSSEC IDS on a specific host

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the node to apply the config

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_ossec_ids_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts the OSSEC IDS manager on a specific node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the node to apply the config

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_ossec_ids_managers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the OSSEC IDS managers for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_ossec_ids_monitor_thread(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts the OSSEC IDS monitor thread on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the node to apply the config

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_ossec_idses(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the OSSEC IDSes of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_ossec_idses_monitor_threads(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the OSSEC IDSes monitor threads of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_packetbeat(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False, timeout=30000) → OperationOutcomeDTO

Starts packetbeat on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container

• initial_start – boolean flag indicating whether it is an initial start or not

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_packetbeats(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, initial_start: bool = False, timeout=30000) → OperationOutcomeDTO

Starts packetbeats of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• initial_start – boolean flag whether it is the initial start of the packetbeats or not

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_pgadmin(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the pgAdmin service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the pgAdmin service

csle_cluster.cluster_manager.query_cluster_manager.start_postgresql(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the PostgreSQL service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the PostgreSQL service

csle_cluster.cluster_manager.query_cluster_manager.start_prometheus(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to start the Prometheus service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the Prometheus service

csle_cluster.cluster_manager.query_cluster_manager.start_ryu(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts Ryu

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_ryu_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Ryu manager for a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_ryu_monitor(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Ryu monitor for a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_sdn_controller(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the RYU SDN controller in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_sdn_controller_monitor(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the SDN controller monitor in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_snort_ids(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts the Snort IDS on a specific container in a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the ip of the container

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_snort_ids_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts the Snort IDS manager at a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_snort_ids_managers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Snort IDS managers of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_snort_ids_monitor_thread(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts the Snort IDS monitor thread on a specific container in a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_snort_ids_monitor_threads(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Snort IDS monitor threads of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_snort_idses(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Snort IDSes of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_snort_idses_monitor_threads(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Snort IDSes monitor threads of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_spark_server(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts the Spark server on a specific container in a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the ip of the container

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.start_spark_servers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Spark servers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_traffic_generator(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts a specific traffic generator

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container to start the traffic generator

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_traffic_generators(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts traffic generators of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_traffic_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Starts a specific traffic manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container to start the traffic manager

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.start_traffic_managers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts traffic managers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_all_executions(stub: ClusterManagerStub, timeout=30000) → OperationOutcomeDTO

Stops all executions

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_all_executions_of_emulation(stub: ClusterManagerStub, emulation: str, timeout=30000) → OperationOutcomeDTO

Stops all executions of a given emulation

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_all_running_containers(stub: ClusterManagerStub, timeout=30000) → OperationOutcomeDTO

Stops all running containers

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_cadvisor(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the cAdvisor service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the cAdvisor service

csle_cluster.cluster_manager.query_cluster_manager.stop_client_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the client manager of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_client_population(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the client population of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_container(stub: ClusterManagerStub, container_name: str, timeout=30000) → OperationOutcomeDTO

Stops a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_name – the name of the container

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_containers_of_execution(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the containers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_docker_engine(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the docker engine service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the docker engine service

csle_cluster.cluster_manager.query_cluster_manager.stop_docker_statsmanager(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the docker statsmanager service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the docker statsmanager service

csle_cluster.cluster_manager.query_cluster_manager.stop_docker_statsmanager_thread(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the docker stats manager thread for a specific emulation execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_elastic(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops elastic

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_elk_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stop elk manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_elk_stack(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the ELK stack

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_execution(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops an emulation execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_filebeat(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops filebeat on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_filebeats(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops all filebeats of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_flask(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the flask service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the flask service

csle_cluster.cluster_manager.query_cluster_manager.stop_grafana(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the Grafana service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the Grafana service

csle_cluster.cluster_manager.query_cluster_manager.stop_heartbeat(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops heartbeat on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_heartbeats(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops all heartbeats of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_host_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops a specific host manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_host_managers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops all host managers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_host_monitor_thread(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops a specific host monitor thread

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_host_monitor_threads(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the host monitor threads of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_kafka_client_producer(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the Kafka client producer of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_kafka_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the kafka manager in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_kafka_server(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the kafka server in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_kibana(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops Kibana

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_logstash(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops Logstash

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_metricbeat(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops metricbeat on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the container

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_metricbeats(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops all metricbeats of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_nginx(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the nginx service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the nginx service

csle_cluster.cluster_manager.query_cluster_manager.stop_node_exporter(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the node exporter service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the node exporter service

csle_cluster.cluster_manager.query_cluster_manager.stop_ossec_ids(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops the OSSEC IDS on a specific host

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the node to apply the config

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_ossec_ids_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops the OSSEC IDS manager on a specific node

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the node to apply the config

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_ossec_ids_managers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the OSSEC IDS managers of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_ossec_ids_monitor_thread(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops the OSSEC IDS monitor thread on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the IP of the node to apply the config

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_ossec_ids_monitor_threads(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the OSSEC IDS monitor threads for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_ossec_idses(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stop the OSSEC IDSes in a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_packetbeat(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops packetbeat on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the IP of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_packetbeats(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops all packetbeats of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_pgadmin(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the pgAdmin service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the pgAdmin service

csle_cluster.cluster_manager.query_cluster_manager.stop_pid(stub: ClusterManagerStub, pid: int, timeout=30000) → OperationOutcomeDTO

Stops a PID

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• pid – the pid to check

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_postgresql(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the PostgreSQL service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the PostgreSQL service

csle_cluster.cluster_manager.query_cluster_manager.stop_prometheus(stub: ClusterManagerStub, timeout=60) → ServiceStatusDTO

Requests the cluster manager to stop the Prometheus service

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a ServiceStatusDTO describing the status of the Prometheus service

csle_cluster.cluster_manager.query_cluster_manager.stop_ryu(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops Ryu

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_ryu_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the Ryu manager for a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_ryu_monitor(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Starts the Ryu monitor for a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_snort_ids(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops the Snort IDS on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the ip of the container

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_snort_ids_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops the Snort IDS manager at a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• container_ip – the ip of the container

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_snort_ids_managers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the Snort IDS managers of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_snort_ids_monitor_thread(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops the Snort IDS Monitor Thread on a specific container

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the ip of the container

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_snort_ids_monitor_threads(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the Snort IDS managers of a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_snort_idses(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the Snort IDSes for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_snort_idses_monitor_threads(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the Snort IDSes monitor threads for a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_spark_server(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops the Spark server on a specific container in a specific execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• container_ip – the ip of the container

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

the operation outcome

csle_cluster.cluster_manager.query_cluster_manager.stop_spark_servers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops the Spark servers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_traffic_generator(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops a specific traffic generator

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container to stop the traffic generator

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_traffic_generators(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops traffic generators of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_traffic_manager(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) → OperationOutcomeDTO

Stops a specific traffic manager

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

• container_ip – the ip of the container to stop the traffic manager

Returns

an OperationOutcomeDTO with the outcome of the operation

csle_cluster.cluster_manager.query_cluster_manager.stop_traffic_managers(stub: ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) → OperationOutcomeDTO

Stops traffic managers of a given execution

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

• emulation – the name of the emulation

• ip_first_octet – the first octet of the subnet of the execution

Returns

an OperationOutcomeDTO with the outcome of the operation

Module contents