csle_cluster.cluster_manager package

Submodules

csle_cluster.cluster_manager.cluster_controller module

class csle_cluster.cluster_manager.cluster_controller.ClusterController[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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][source]

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][source]

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) cluster_manager_pb2.ClientManagersInfoDTO[source]

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][source]

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][source]

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][source]

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][source]

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) cluster_manager_pb2.DockerStatsManagersInfoDTO[source]

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) cluster_manager_pb2.DockerStatsMonitorStatusDTO[source]

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][source]

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][source]

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][source]

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) cluster_manager_pb2.ElkManagersInfoDTO[source]

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) cluster_manager_pb2.ElkStatusDTO[source]

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) cluster_manager_pb2.ExecutionInfoDTO[source]

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) csle_common.dao.emulation_config.emulation_metrics_time_series.EmulationMetricsTimeSeries[source]

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][source]

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][source]

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][source]

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) cluster_manager_pb2.HostManagersInfoDTO[source]

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) cluster_manager_pb2.HostManagerStatusesDTO[source]

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][source]

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][source]

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) cluster_manager_pb2.KafkaManagersInfoDTO[source]

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) cluster_manager_pb2.KafkaStatusDTO[source]

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][source]

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: csle_common.dao.emulation_config.emulation_execution.EmulationExecution) csle_common.dao.emulation_config.emulation_execution_info.EmulationExecutionInfo[source]

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][source]

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][source]

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) cluster_manager_pb2.NodeStatusDTO[source]

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) cluster_manager_pb2.GetNumClientsDTO[source]

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][source]

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][source]

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) cluster_manager_pb2.OSSECIdsManagersInfoDTO[source]

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) cluster_manager_pb2.OSSECIdsMonitorThreadStatusesDTO[source]

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][source]

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][source]

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][source]

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][source]

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][source]

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) cluster_manager_pb2.RyuManagersInfoDTO[source]

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) cluster_manager_pb2.RyuManagerStatusDTO[source]

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][source]

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][source]

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) cluster_manager_pb2.SnortIdsManagersInfoDTO[source]

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) cluster_manager_pb2.SnortIdsMonitorThreadStatusesDTO[source]

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][source]

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) cluster_manager_pb2.TrafficManagersInfoDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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[source]

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) cluster_manager_pb2.ContainerImagesDTO[source]

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) cluster_manager_pb2.DockerNetworksDTO[source]

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) cluster_manager_pb2.RunningContainersDTO[source]

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) cluster_manager_pb2.RunningEmulationsDTO[source]

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) cluster_manager_pb2.StoppedContainersDTO[source]

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) cluster_manager_pb2.KibanaTunnelsDTO[source]

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) cluster_manager_pb2.RyuTunnelsDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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]) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_common.dao.emulation_config.emulation_execution.EmulationExecution, physical_servers: List[str], no_traffic: bool = False, no_clients: bool = False, no_beats: bool = False) None[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.ServiceStatusDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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) cluster_manager_pb2.OperationOutcomeDTO[source]

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[source]

Bases: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerServicer

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

applyFileBeatConfig(request: cluster_manager_pb2.ApplyFileBeatConfigMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the filebeat config on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyFileBeatsConfig(request: cluster_manager_pb2.ApplyFileBeatConfigsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the filebeat configurations to a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyHeartBeatConfig(request: cluster_manager_pb2.ApplyHeartBeatConfigMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the heartbeat config on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyHeartBeatsConfig(request: cluster_manager_pb2.ApplyHeartBeatConfigsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the heartbeat configurations to a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyKafkaConfig(request: cluster_manager_pb2.ApplyKafkaConfigMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the Kafka configuration to an execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyMetricBeatConfig(request: cluster_manager_pb2.ApplyMetricBeatConfigMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the metricbeat config on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyMetricBeatsConfig(request: cluster_manager_pb2.ApplyMetricBeatConfigsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the metricbeat configurations to a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyPacketBeatConfig(request: cluster_manager_pb2.ApplyPacketBeatConfigMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the packetbeat config on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyPacketBeatsConfig(request: cluster_manager_pb2.ApplyPacketBeatConfigsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies the packetbeat configurations to a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

applyResourceConstraints(request: cluster_manager_pb2.ApplyResouceConstraintsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Applies resource constraints to containers in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

attachContainersInExecutionToNetworks(request: cluster_manager_pb2.StartContainersInExecutionMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

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: cluster_manager_pb2.CheckPidMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Checks the status of a PID

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

cleanAllExecutions(request: cluster_manager_pb2.CleanAllExecutionsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Cleans all executions

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

cleanAllExecutionsOfEmulation(request: cluster_manager_pb2.CleanAllExecutionsOfEmulationMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Cleans all executions of a given emulation

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

cleanExecution(request: cluster_manager_pb2.CleanExecutionMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Cleans a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

configureOvs(request: cluster_manager_pb2.ConfigureOvsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Configures OVS switches in an execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createEmulationNetworks(request: cluster_manager_pb2.CreateEmulationNetworksMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Creates networks for a given emulation execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createFlags(request: cluster_manager_pb2.CreateFlagsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Creates flags in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createKafkaTopics(request: cluster_manager_pb2.CreateKafkaTopicsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Creates the kafka topics in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createKibanaTunnel(request: cluster_manager_pb2.CreateKibanaTunnelMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Creates a new Kibana tunnel

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createOvsSwitches(request: cluster_manager_pb2.CreateOvsSwitchesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Creates OVS switches in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createRyuTunnel(request: cluster_manager_pb2.CreateRyuTunnelMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Creates a new Ryu tunnel

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createTopology(request: cluster_manager_pb2.CreateTopologyMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Configures the topology of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createUsers(request: cluster_manager_pb2.CreateUsersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Creates users in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

createVulnerabilities(request: cluster_manager_pb2.CreateVulnsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Creates vulnerabilities in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

getCadvisorLogs(request: cluster_manager_pb2.GetCAdvisorLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the cAdvisor logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getClientManagerLogsMsg(request: cluster_manager_pb2.GetClientManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetClientManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.ClientManagersInfoDTO[source]

Gets the info of client managers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a ClientManagersInfoDTO

getClusterManagerLogs(request: cluster_manager_pb2.GetClusterManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the logs of the cluster manager

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getContainerLogs(request: cluster_manager_pb2.GetContainerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the logs of a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a LogsDTO with the logs

getCsleLogFiles(request: cluster_manager_pb2.GetCsleLogFilesMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetDockerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the Docker logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getDockerStatsManagerLogs(request: cluster_manager_pb2.GetDockerStatsManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the Docker statsmanager logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getDockerStatsManagerStatus(request: cluster_manager_pb2.GetDockerStatsManagerStatusMsg, context: grpc.ServicerContext) cluster_manager_pb2.DockerStatsMonitorStatusDTO[source]

Gets the docker stats manager status

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DockerStatsMonitorStatusDTO

getDockerStatsManagersInfo(request: cluster_manager_pb2.GetDockerStatsManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.DockerStatsManagersInfoDTO[source]

Gets the info of docker stats maangers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DockerStatsManagersInfoDTO

getElkLogs(request: cluster_manager_pb2.GetElkLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetElkManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetElkManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.ElkManagersInfoDTO[source]

Gets the info of elk managers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a ElkManagersInfoDTO

getElkStatus(request: cluster_manager_pb2.GetElkStackStatusMsg, context: grpc.ServicerContext) cluster_manager_pb2.ElkStatusDTO[source]

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: cluster_manager_pb2.GetExecutionInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.ExecutionInfoDTO[source]

Gets the info of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an ExecutionInfoDTO

getExecutionTimeSeriesData(request: cluster_manager_pb2.GetExecutionTimeSeriesDataMsg, context: grpc.ServicerContext) cluster_manager_pb2.EmulationMetricsTimeSeriesDTO[source]

Gets time-series data of an emulation execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getFlaskLogs(request: cluster_manager_pb2.GetFlaskLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the Flask logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getGrafanaLogs(request: cluster_manager_pb2.GetGrafanaLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the Grafana logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getHostManagerLogs(request: cluster_manager_pb2.GetHostManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetHostManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.HostManagersInfoDTO[source]

Gets the info of host managers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a HostManagersInfoDTO

getHostMonitorThreadsStatuses(request: cluster_manager_pb2.GetHostMonitorThreadsStatusesMsg, context: grpc.ServicerContext) cluster_manager_pb2.HostManagerStatusesDTO[source]

Gets the host monitor thread statuses of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a HostManagerStatusesDTO

getKafkaLogs(request: cluster_manager_pb2.GetKafkaLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetKafkaManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetKafkaManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.KafkaManagersInfoDTO[source]

Gets the info of kafka managers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a KafkaManagersInfoDTO

getKafkaStatus(request: cluster_manager_pb2.GetKafkaManagerStatusMsg, context: grpc.ServicerContext) cluster_manager_pb2.KafkaStatusDTO[source]

Gets the Kafka status in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

getLogFile(request: cluster_manager_pb2.GetLogFileMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets a specific log file

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getNginxLogs(request: cluster_manager_pb2.GetNginxLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the nginx logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getNodeExporterLogs(request: cluster_manager_pb2.GetNodeExporterLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the node exporter logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getNodeStatus(request: cluster_manager_pb2.GetNodeStatusMsg, context: grpc.ServicerContext) cluster_manager_pb2.NodeStatusDTO[source]

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: cluster_manager_pb2.GetNumActiveClientsMsg, context: grpc.ServicerContext) cluster_manager_pb2.GetNumClientsDTO[source]

Gets the number of active clients of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a GetNumActiveClientsMsg

getOSSECIDSMonitorThreadStatuses(request: cluster_manager_pb2.GetOSSECIDSMonitorThreadStatusesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OSSECIdsMonitorThreadStatusesDTO[source]

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: cluster_manager_pb2.GetOSSECIdsLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetOSSECIdsManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetOSSECIDSManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.OSSECIdsManagersInfoDTO[source]

Gets the info of OSSEC IDS managers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a OSSECIdsManagersInfoDTO

getPgAdminLogs(request: cluster_manager_pb2.GetPgAdminLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the pgAdmin logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getPostrgreSQLLogs(request: cluster_manager_pb2.GetPostgreSQLLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the PostgreSQL logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getPrometheusLogs(request: cluster_manager_pb2.GetPrometheusLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

Gets the Prometheus logs

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with logs

getRyuControllerLogs(request: cluster_manager_pb2.GetRyuControllerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetRyuManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetRyuManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.RyuManagersInfoDTO[source]

Gets the info of Ryu managers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a RyuManagersInfoDTO

getRyuStatus(request: cluster_manager_pb2.GetRyuServiceStatusMsg, context: grpc.ServicerContext) cluster_manager_pb2.RyuManagerStatusDTO[source]

Gets the Ryu status

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a RyuManagerStatusDTO

getSnortIdsLogs(request: cluster_manager_pb2.GetSnortIdsLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetSnortIdsManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetSnortIdsManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.SnortIdsManagersInfoDTO[source]

Gets the info of Snort IDS managers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a SnortIdsManagersInfoDTO

getSnortIdsMonitorThreadStatuses(request: cluster_manager_pb2.GetSnortIdsMonitorThreadStatusesMsg, context: grpc.ServicerContext) cluster_manager_pb2.SnortIdsMonitorThreadStatusesDTO[source]

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: cluster_manager_pb2.GetTrafficManagerLogsMsg, context: grpc.ServicerContext) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetTrafficManagersInfoMsg, context: grpc.ServicerContext) cluster_manager_pb2.TrafficManagersInfoDTO[source]

Gets the info of traffic managers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a TrafficManagersInfoDTO

installLibraries(request: cluster_manager_pb2.InstallLibrariesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Installs CSLE libraries on containers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

listAllContainerImages(request: cluster_manager_pb2.ListAllContainerImagesMsg, context: grpc.ServicerContext) cluster_manager_pb2.ContainerImagesDTO[source]

Removes a specific container image

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a ContainerImagesDTO

listAllDockerNetworks(request: cluster_manager_pb2.ListAllDockerNetworksMsg, context: grpc.ServicerContext) cluster_manager_pb2.DockerNetworksDTO[source]

Lists all docker networks

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DockerNetworksDTO

listAllRunningContainers(request: cluster_manager_pb2.ListAllRunningContainersMsg, context: grpc.ServicerContext) cluster_manager_pb2.RunningContainersDTO[source]

Lists all running containers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a RunningContainersDTO

listAllRunningEmulations(request: cluster_manager_pb2.ListAllRunningEmulationsMsg, context: grpc.ServicerContext) cluster_manager_pb2.RunningEmulationsDTO[source]

Lists all running emulations

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a RunningEmulationsDTO

listAllStoppedContainers(request: cluster_manager_pb2.ListAllStoppedContainersMsg, context: grpc.ServicerContext) cluster_manager_pb2.StoppedContainersDTO[source]

Lists all stopped containers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a StoppedContainersDTOb

listKibanaTunnels(request: cluster_manager_pb2.ListKibanaTunnelsMsg, context: grpc.ServicerContext) cluster_manager_pb2.KibanaTunnelsDTO[source]

Lists the Kibana tunnels

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an KibanaTunnelsDTO

listRyuTunnels(request: cluster_manager_pb2.ListRyuTunnelsMsg, context: grpc.ServicerContext) cluster_manager_pb2.RyuTunnelsDTO[source]

Lists the Ryu tunnels

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a RyuTunnelsDTO

pingExecution(request: cluster_manager_pb2.PingExecutionMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Pings all containers in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

removeAllContainerImages(request: cluster_manager_pb2.RemoveAllContainerImagesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Removes all CSLE container images

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

removeAllDockerNetworks(request: cluster_manager_pb2.RemoveAllDockerNetworksMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Removes all docker networks related to CSLE

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

removeAllStoppedContainers(request: cluster_manager_pb2.RemoveAllStoppedContainersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Removes all stopped containers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

removeContainer(request: cluster_manager_pb2.RemoveContainerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Removes all specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

removeContainerImage(request: cluster_manager_pb2.RemoveContainerImageMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Removes a specific container image

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

removeDockerNetworks(request: cluster_manager_pb2.RemoveDockerNetworksMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Removes a list of docker networks

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

removeKibanaTunnel(request: cluster_manager_pb2.RemoveKibanaTunnelMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Removes a Kibana tunnel

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

removeRyuTunnel(request: cluster_manager_pb2.RemoveRyuTunnelMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Removes a Ryu tunnel

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

runContainer(request: cluster_manager_pb2.RunContainerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Runs a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startAllStoppedContainers(request: cluster_manager_pb2.StartAllStoppedContainersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts all stopped containers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startCAdvisor(request: cluster_manager_pb2.StartCAdvisorMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts cAdvisor

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of cAdvisor

startClientManager(request: cluster_manager_pb2.StartClientManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the client manager of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startClientPopulation(request: cluster_manager_pb2.StartClientPopulationMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the client population of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startContainer(request: cluster_manager_pb2.StartContainerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startContainersInExecution(request: cluster_manager_pb2.StartContainersInExecutionMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

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: cluster_manager_pb2.StartContainersOfExecutionMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the containers of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startDockerEngine(request: cluster_manager_pb2.StartDockerEngineMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts Docker Engine

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of the Docker egine

startDockerStatsManager(request: cluster_manager_pb2.StartDockerStatsManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

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: cluster_manager_pb2.StartDockerStatsManagerThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts the docker stats manager

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startElastic(request: cluster_manager_pb2.StartElasticServiceMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts elastic in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startElkManager(request: cluster_manager_pb2.StartElkManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts a specific elk manager

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startElkStack(request: cluster_manager_pb2.StartElkStackMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the ELK stack in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startFilebeat(request: cluster_manager_pb2.StartFileBeatMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts filebeat on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startFilebeats(request: cluster_manager_pb2.StartFileBeatsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts filebeats in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startFlask(request: cluster_manager_pb2.StartFlaskMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts Flask

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of flask

startGrafana(request: cluster_manager_pb2.StartGrafanaMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts grafana

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of grafana

startHeartbeat(request: cluster_manager_pb2.StartHeartBeatMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts heartbeat on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startHeartbeats(request: cluster_manager_pb2.StartHeartBeatsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts heartbeats in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startHostManager(request: cluster_manager_pb2.StartHostManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts a specific host manager

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startHostManagers(request: cluster_manager_pb2.StartHostManagersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the host managers of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startHostMonitorThread(request: cluster_manager_pb2.StartHostMonitorThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts a specific host monitor thread

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startHostMonitorThreads(request: cluster_manager_pb2.StartHostMonitorThreadsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the host monitor threads of a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startKafkaClientProducer(request: cluster_manager_pb2.StartKafkaClientProducerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Kafka client producer of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startKafkaManager(request: cluster_manager_pb2.StartKafkaManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the kafka manager in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startKafkaServer(request: cluster_manager_pb2.StartKafkaServerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the kafka server in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startKibana(request: cluster_manager_pb2.StartKibanaServiceMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts Kibana in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startLogstash(request: cluster_manager_pb2.StartLogstashServiceMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts Logstash in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startMetricbeat(request: cluster_manager_pb2.StartMetricBeatMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts metricbeat on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startMetricbeats(request: cluster_manager_pb2.StartMetricBeatsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts metricbeats in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startNginx(request: cluster_manager_pb2.StartNginxMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts Nginx

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of Nginx

startNodeExporter(request: cluster_manager_pb2.StartNodeExporterMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts node exporter

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of node exporter

startOSSECIDS(request: cluster_manager_pb2.StartOSSECIDSMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the OSSEC IDS on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startOSSECIDSManager(request: cluster_manager_pb2.StartOSSECIDSManager, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the OSSEC IDS manager on a specific node

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startOSSECIDSManagers(request: cluster_manager_pb2.StartOSSECIDSManagers, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the OSSEC IDS managers for a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startOSSECIDSMonitorThread(request: cluster_manager_pb2.StartOSSECIDSMonitorThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the OSSEC IDS monitor thread on a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startOSSECIDSes(request: cluster_manager_pb2.StartOSSECIDSesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starting the OSSEC IDSes in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startOssecIdses(request: cluster_manager_pb2.StartOSSECIdsesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the OSSEC IDSes in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startOssecIdsesMonitorThreads(request: cluster_manager_pb2.StartOSSECIdsesMonitorThreadsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the OSSEC IDSes monitor threads in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startPacketbeat(request: cluster_manager_pb2.StartPacketBeatMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts packetbeat on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startPacketbeats(request: cluster_manager_pb2.StartPacketBeatsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts packetbetas in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startPgAdmin(request: cluster_manager_pb2.StartPgAdminMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts pgAdmin

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of pgAdmin

startPostgreSQL(request: cluster_manager_pb2.StartPostgreSQLMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts Postgresql

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of PostgreSQL

startPrometheus(request: cluster_manager_pb2.StartPrometheusMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Starts Prometheus

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of Prometheus

startRyu(request: cluster_manager_pb2.StartRyuServiceMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts Ryu

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startRyuManager(request: cluster_manager_pb2.StartRyuManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Ryu manager for a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startRyuMonitor(request: cluster_manager_pb2.StartRyuMonitorThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Ryu monitor thread for a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startSdnController(request: cluster_manager_pb2.StartSdnControllerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Ryu SDN controller of an execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startSdnControllerMonitor(request: cluster_manager_pb2.StartSdnControllerMonitorMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the SDN controller monitor in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIds(request: cluster_manager_pb2.StartSnortMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

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: cluster_manager_pb2.StartSnortIdsManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Snort IDS manager at a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdsManagers(request: cluster_manager_pb2.StartSnortIdsManagersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Snort IDS managers of a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdsMonitorThread(request: cluster_manager_pb2.StartSnortIdsMonitorThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

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: cluster_manager_pb2.StartSnortIdsMonitorThreadsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Snort IDS monitor threads of a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdses(request: cluster_manager_pb2.StartSnortIdsesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Snort IDSes in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startSnortIdsesMonitorThreads(request: cluster_manager_pb2.StartSnortIdsesMonitorThreadsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Snort IDSes monitor threads in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startSparkServer(request: cluster_manager_pb2.StartSparkServerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

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: cluster_manager_pb2.StartSparkServersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts the Spark servers in a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startTrafficGenerator(request: cluster_manager_pb2.StartTrafficGeneratorMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts a specific traffic generator

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startTrafficGenerators(request: cluster_manager_pb2.StartTrafficGeneratorsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts traffic generators in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startTrafficManager(request: cluster_manager_pb2.StartTrafficManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts a specific traffic manager

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

startTrafficManagers(request: cluster_manager_pb2.StartTrafficManagersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Starts traffic managers in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopAllExecutions(request: cluster_manager_pb2.StopAllExecutionsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops all executions

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopAllExecutionsOfEmulation(request: cluster_manager_pb2.StopAllExecutionsOfEmulationMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops all executions of a given emulation

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopAllRunningContainers(request: cluster_manager_pb2.StopAllRunningContainersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops all running CSLE containers

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopCAdvisor(request: cluster_manager_pb2.StopCAdvisorMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Stops cAdvisor

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of cAdvisor

stopClientManager(request: cluster_manager_pb2.StopClientManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the client manager of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopClientPopulation(request: cluster_manager_pb2.StopClientPopulationMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the client population of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopContainer(request: cluster_manager_pb2.StopContainerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopContainersOfExecution(request: cluster_manager_pb2.StopContainersOfExecutionMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the containers of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopDockerEngine(request: cluster_manager_pb2.StopDockerEngineMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

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: cluster_manager_pb2.StopDockerStatsManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

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: cluster_manager_pb2.StopDockerStatsManagerThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the docker stats manager thread

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopElastic(request: cluster_manager_pb2.StopElasticServiceMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops elastic in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopElkManager(request: cluster_manager_pb2.StopElkManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops a specific elk manager

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopElkStack(request: cluster_manager_pb2.StopElkStackMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the elk stack of a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopExecution(request: cluster_manager_pb2.StopExecutionMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopFilebeat(request: cluster_manager_pb2.StopFileBeatMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops filebeat on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopFilebeats(request: cluster_manager_pb2.StopFilebeatsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops filebeats in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopFlask(request: cluster_manager_pb2.StopFlaskMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Stops Flask

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of flask

stopGrafana(request: cluster_manager_pb2.StopGrafanaMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Stops grafana

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of grafana

stopHeartbeat(request: cluster_manager_pb2.StopHeartBeatMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops heartbeat on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopHeartbeats(request: cluster_manager_pb2.StopHeartbeatsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops Heartbeats in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopHostManager(request: cluster_manager_pb2.StopHostManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops a specific host manager

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopHostManagers(request: cluster_manager_pb2.StopHostManagersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the host managers of a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopHostMonitorThread(request: cluster_manager_pb2.StopHostMonitorThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops a specific host monitor thread

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopHostMonitorThreads(request: cluster_manager_pb2.StopHostMonitorThreadsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the host monitor threads of a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopKafkaClientProducer(request: cluster_manager_pb2.StopKafkaClientProducerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Kafka client producer of a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopKafkaManager(request: cluster_manager_pb2.StopKafkaManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the kafka manager in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopKafkaServer(request: cluster_manager_pb2.StopKafkaServerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the kafka server in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopKibana(request: cluster_manager_pb2.StopKibanaServiceMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops Kibana in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopLogstash(request: cluster_manager_pb2.StopLogstashServiceMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops Logstash in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopMetricbeat(request: cluster_manager_pb2.StopMetricBeatMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops metricbeat on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopMetricbeats(request: cluster_manager_pb2.StopMetricbeatsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops Metricbeats in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopNginx(request: cluster_manager_pb2.StopNginxMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Stops Nginx

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of Nginx

stopNodeExporter(request: cluster_manager_pb2.StopNodeExporterMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Stops node exporter

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of node exporter

stopOSSECIDS(request: cluster_manager_pb2.StopOSSECIDSMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the OSSEC IDS on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSManager(request: cluster_manager_pb2.StopOSSECIDSManager, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the OSSEC IDS manager on a specific node

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSManagers(request: cluster_manager_pb2.StopOSSECIDSManagers, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the OSSEC IDS managers for a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSMonitorThread(request: cluster_manager_pb2.StopOSSECIDSMonitorThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the OSSEC IDS monitor thread on a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSMonitorThreads(request: cluster_manager_pb2.StopOSSECIDSMonitorThreadsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the OSSEC IDS monitor threads for a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopOSSECIDSes(request: cluster_manager_pb2.StopOSSECIDSesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stop the OSSEC IDSes in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopPacketbeat(request: cluster_manager_pb2.StopPacketBeatMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops packetbeat on a specific host

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopPacketbeats(request: cluster_manager_pb2.StopPacketbeatsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops packetbeats in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopPgAdmin(request: cluster_manager_pb2.StopPgAdminMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Stops pgAdmin

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of pgAdmin

stopPid(request: cluster_manager_pb2.StopPidMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops a PID

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopPostgreSQL(request: cluster_manager_pb2.StopPostgreSQLMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Stops Postgresql

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of PostgreSQL

stopPrometheus(request: cluster_manager_pb2.StopPrometheusMsg, context: grpc.ServicerContext) cluster_manager_pb2.ServiceStatusDTO[source]

Stops Prometheus

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

a DTO with the status of Prometheus

stopRyu(request: cluster_manager_pb2.StopRyuServiceMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops Ryu

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopRyuManager(request: cluster_manager_pb2.StopRyuManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Ryu manager for a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopRyuMonitor(request: cluster_manager_pb2.StopRyuMonitorThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Ryu monitor thread for a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIds(request: cluster_manager_pb2.StopSnortMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Snort IDS on a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsManager(request: cluster_manager_pb2.StopSnortIdsManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Snort IDS manager at a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsManagers(request: cluster_manager_pb2.StopSnortIdsManagersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Snort IDS managers of a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsMonitorThread(request: cluster_manager_pb2.StopSnortIdsMonitorThreadMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Snort IDS Monitor Thread on a specific container

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsMonitorThreads(request: cluster_manager_pb2.StopSnortIdsMonitorThreadsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Snort IDS managers of a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdses(request: cluster_manager_pb2.StopSnortIdsesMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Snort IDSes for a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopSnortIdsesMonitorThreads(request: cluster_manager_pb2.StopSnortIdsesMonitorThreadsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Snort IDSes monitor threads for a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopSparkServer(request: cluster_manager_pb2.StopSparkServerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

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: cluster_manager_pb2.StopSparkServersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops the Spark servers in a specific execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopTrafficGenerator(request: cluster_manager_pb2.StopTrafficGeneratorMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops a specific traffic generator

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopTrafficGenerators(request: cluster_manager_pb2.StopTrafficGeneratorsMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops traffic generators in a given execution

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopTrafficManager(request: cluster_manager_pb2.StopTrafficManagerMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

Stops a specific traffic manager

Parameters
  • request – the gRPC request

  • context – the gRPC context

Returns

an OperationOutcomeDTO

stopTrafficManagers(request: cluster_manager_pb2.StopTrafficManagersMsg, context: grpc.ServicerContext) cluster_manager_pb2.OperationOutcomeDTO[source]

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[source]

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[source]

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)[source]
static applyFileBeatsConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static applyHeartBeatConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static applyHeartBeatsConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static applyKafkaConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static applyMetricBeatConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static applyMetricBeatsConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static applyPacketBeatConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static applyPacketBeatsConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static applyResourceConstraints(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static attachContainersInExecutionToNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static checkPid(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static cleanAllExecutions(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static cleanAllExecutionsOfEmulation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static cleanExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static configureOvs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createEmulationNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createFlags(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createKafkaTopics(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createKibanaTunnel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createOvsSwitches(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createRyuTunnel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createTopology(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createUsers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static createVulnerabilities(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getCadvisorLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getClientManagerLogsMsg(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getClientManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getClusterManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getContainerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getCsleLogFiles(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getDockerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getDockerStatsManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getDockerStatsManagerStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getDockerStatsManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getElkLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getElkManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getElkManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getElkStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getExecutionInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getExecutionTimeSeriesData(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getFlaskLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getGrafanaLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getHostManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getHostManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getHostMonitorThreadsStatuses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getKafkaLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getKafkaManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getKafkaManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getKafkaStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getLogFile(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getNginxLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getNodeExporterLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getNodeStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getNumActiveClients(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getOSSECIDSMonitorThreadStatuses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getOSSECIdsLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getOSSECIdsManagerLogsMsg(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getOSSECIdsManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getPgAdminLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getPostrgreSQLLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getPrometheusLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getRyuControllerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getRyuManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getRyuManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getRyuStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getSnortIdsLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getSnortIdsManagerLogsMsg(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getSnortIdsManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getSnortIdsMonitorThreadStatuses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getTrafficManagerLogs(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static getTrafficManagersInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static installLibraries(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static listAllContainerImages(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static listAllDockerNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static listAllRunningContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static listAllRunningEmulations(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static listAllStoppedContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static listKibanaTunnels(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static listRyuTunnels(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static pingExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static removeAllContainerImages(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static removeAllDockerNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static removeAllStoppedContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static removeContainer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static removeContainerImage(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static removeDockerNetworks(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static removeKibanaTunnel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static removeRyuTunnel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static runContainer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startAllStoppedContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startCAdvisor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startClientManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startClientPopulation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startContainer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startContainersInExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startContainersOfExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startDockerEngine(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startDockerStatsManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startDockerStatsManagerThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startElastic(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startElkManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startElkStack(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startFilebeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startFilebeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startFlask(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startGrafana(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startHeartbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startHeartbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startHostManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startHostManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startHostMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startHostMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startKafkaClientProducer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startKafkaManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startKafkaServer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startKibana(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startLogstash(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startMetricbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startMetricbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startNginx(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startNodeExporter(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startOSSECIDS(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startOSSECIDSManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startOSSECIDSManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startOSSECIDSMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startOSSECIDSes(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startOssecIdses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startOssecIdsesMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startPacketbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startPacketbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startPgAdmin(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startPostgreSQL(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startPrometheus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startRyu(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startRyuManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startRyuMonitor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSdnController(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSdnControllerMonitor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSnortIds(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSnortIdsManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSnortIdsManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSnortIdsMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSnortIdsMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSnortIdses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSnortIdsesMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSparkServer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startSparkServers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startTrafficGenerator(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startTrafficGenerators(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startTrafficManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static startTrafficManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopAllExecutions(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopAllExecutionsOfEmulation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopAllRunningContainers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopCAdvisor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopClientManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopClientPopulation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopContainer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopContainersOfExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopDockerEngine(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopDockerStatsManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopDockerStatsManagerThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopElastic(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopElkManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopElkStack(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopExecution(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopFilebeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopFilebeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopFlask(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopGrafana(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopHeartbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopHeartbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopHostManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopHostManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopHostMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopHostMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopKafkaClientProducer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopKafkaManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopKafkaServer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopKibana(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopLogstash(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopMetricbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopMetricbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopNginx(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopNodeExporter(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopOSSECIDS(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopOSSECIDSManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopOSSECIDSManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopOSSECIDSMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopOSSECIDSMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopOSSECIDSes(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopPacketbeat(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopPacketbeats(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopPgAdmin(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopPid(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopPostgreSQL(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopPrometheus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopRyu(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopRyuManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopRyuMonitor(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSnortIds(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSnortIdsManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSnortIdsManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSnortIdsMonitorThread(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSnortIdsMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSnortIdses(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSnortIdsesMonitorThreads(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSparkServer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopSparkServers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopTrafficGenerator(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopTrafficGenerators(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopTrafficManager(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
static stopTrafficManagers(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]
class csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerServicer[source]

Bases: object

Interface exported by the server

applyFileBeatConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyFileBeatsConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyHeartBeatConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyHeartBeatsConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyKafkaConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyMetricBeatConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyMetricBeatsConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyPacketBeatConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyPacketBeatsConfig(request, context)[source]

Missing associated documentation comment in .proto file.

applyResourceConstraints(request, context)[source]

Missing associated documentation comment in .proto file.

attachContainersInExecutionToNetworks(request, context)[source]

Missing associated documentation comment in .proto file.

checkPid(request, context)[source]

Missing associated documentation comment in .proto file.

cleanAllExecutions(request, context)[source]

Missing associated documentation comment in .proto file.

cleanAllExecutionsOfEmulation(request, context)[source]

Missing associated documentation comment in .proto file.

cleanExecution(request, context)[source]

Missing associated documentation comment in .proto file.

configureOvs(request, context)[source]

Missing associated documentation comment in .proto file.

createEmulationNetworks(request, context)[source]

Missing associated documentation comment in .proto file.

createFlags(request, context)[source]

Missing associated documentation comment in .proto file.

createKafkaTopics(request, context)[source]

Missing associated documentation comment in .proto file.

createKibanaTunnel(request, context)[source]

Missing associated documentation comment in .proto file.

createOvsSwitches(request, context)[source]

Missing associated documentation comment in .proto file.

createRyuTunnel(request, context)[source]

Missing associated documentation comment in .proto file.

createTopology(request, context)[source]

Missing associated documentation comment in .proto file.

createUsers(request, context)[source]

Missing associated documentation comment in .proto file.

createVulnerabilities(request, context)[source]

Missing associated documentation comment in .proto file.

getCadvisorLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getClientManagerLogsMsg(request, context)[source]

Missing associated documentation comment in .proto file.

getClientManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getClusterManagerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getContainerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getCsleLogFiles(request, context)[source]

Missing associated documentation comment in .proto file.

getDockerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getDockerStatsManagerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getDockerStatsManagerStatus(request, context)[source]

Missing associated documentation comment in .proto file.

getDockerStatsManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getElkLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getElkManagerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getElkManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getElkStatus(request, context)[source]

Missing associated documentation comment in .proto file.

getExecutionInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getExecutionTimeSeriesData(request, context)[source]

Missing associated documentation comment in .proto file.

getFlaskLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getGrafanaLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getHostManagerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getHostManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getHostMonitorThreadsStatuses(request, context)[source]

Missing associated documentation comment in .proto file.

getKafkaLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getKafkaManagerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getKafkaManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getKafkaStatus(request, context)[source]

Missing associated documentation comment in .proto file.

getLogFile(request, context)[source]

Missing associated documentation comment in .proto file.

getNginxLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getNodeExporterLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getNodeStatus(request, context)[source]

Missing associated documentation comment in .proto file.

getNumActiveClients(request, context)[source]

Missing associated documentation comment in .proto file.

getOSSECIDSMonitorThreadStatuses(request, context)[source]

Missing associated documentation comment in .proto file.

getOSSECIdsLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getOSSECIdsManagerLogsMsg(request, context)[source]

Missing associated documentation comment in .proto file.

getOSSECIdsManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getPgAdminLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getPostrgreSQLLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getPrometheusLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getRyuControllerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getRyuManagerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getRyuManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getRyuStatus(request, context)[source]

Missing associated documentation comment in .proto file.

getSnortIdsLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getSnortIdsManagerLogsMsg(request, context)[source]

Missing associated documentation comment in .proto file.

getSnortIdsManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

getSnortIdsMonitorThreadStatuses(request, context)[source]

Missing associated documentation comment in .proto file.

getTrafficManagerLogs(request, context)[source]

Missing associated documentation comment in .proto file.

getTrafficManagersInfo(request, context)[source]

Missing associated documentation comment in .proto file.

installLibraries(request, context)[source]

Missing associated documentation comment in .proto file.

listAllContainerImages(request, context)[source]

Missing associated documentation comment in .proto file.

listAllDockerNetworks(request, context)[source]

Missing associated documentation comment in .proto file.

listAllRunningContainers(request, context)[source]

Missing associated documentation comment in .proto file.

listAllRunningEmulations(request, context)[source]

Missing associated documentation comment in .proto file.

listAllStoppedContainers(request, context)[source]

Missing associated documentation comment in .proto file.

listKibanaTunnels(request, context)[source]

Missing associated documentation comment in .proto file.

listRyuTunnels(request, context)[source]

Missing associated documentation comment in .proto file.

pingExecution(request, context)[source]

Missing associated documentation comment in .proto file.

removeAllContainerImages(request, context)[source]

Missing associated documentation comment in .proto file.

removeAllDockerNetworks(request, context)[source]

Missing associated documentation comment in .proto file.

removeAllStoppedContainers(request, context)[source]

Missing associated documentation comment in .proto file.

removeContainer(request, context)[source]

Missing associated documentation comment in .proto file.

removeContainerImage(request, context)[source]

Missing associated documentation comment in .proto file.

removeDockerNetworks(request, context)[source]

Missing associated documentation comment in .proto file.

removeKibanaTunnel(request, context)[source]

Missing associated documentation comment in .proto file.

removeRyuTunnel(request, context)[source]

Missing associated documentation comment in .proto file.

runContainer(request, context)[source]

Missing associated documentation comment in .proto file.

startAllStoppedContainers(request, context)[source]

Missing associated documentation comment in .proto file.

startCAdvisor(request, context)[source]

Missing associated documentation comment in .proto file.

startClientManager(request, context)[source]

Missing associated documentation comment in .proto file.

startClientPopulation(request, context)[source]

Missing associated documentation comment in .proto file.

startContainer(request, context)[source]

Missing associated documentation comment in .proto file.

startContainersInExecution(request, context)[source]

Missing associated documentation comment in .proto file.

startContainersOfExecution(request, context)[source]

Missing associated documentation comment in .proto file.

startDockerEngine(request, context)[source]

Missing associated documentation comment in .proto file.

startDockerStatsManager(request, context)[source]

Missing associated documentation comment in .proto file.

startDockerStatsManagerThread(request, context)[source]

Missing associated documentation comment in .proto file.

startElastic(request, context)[source]

Missing associated documentation comment in .proto file.

startElkManager(request, context)[source]

Missing associated documentation comment in .proto file.

startElkStack(request, context)[source]

Missing associated documentation comment in .proto file.

startFilebeat(request, context)[source]

Missing associated documentation comment in .proto file.

startFilebeats(request, context)[source]

Missing associated documentation comment in .proto file.

startFlask(request, context)[source]

Missing associated documentation comment in .proto file.

startGrafana(request, context)[source]

Missing associated documentation comment in .proto file.

startHeartbeat(request, context)[source]

Missing associated documentation comment in .proto file.

startHeartbeats(request, context)[source]

Missing associated documentation comment in .proto file.

startHostManager(request, context)[source]

Missing associated documentation comment in .proto file.

startHostManagers(request, context)[source]

Missing associated documentation comment in .proto file.

startHostMonitorThread(request, context)[source]

Missing associated documentation comment in .proto file.

startHostMonitorThreads(request, context)[source]

Missing associated documentation comment in .proto file.

startKafkaClientProducer(request, context)[source]

Missing associated documentation comment in .proto file.

startKafkaManager(request, context)[source]

Missing associated documentation comment in .proto file.

startKafkaServer(request, context)[source]

Missing associated documentation comment in .proto file.

startKibana(request, context)[source]

Missing associated documentation comment in .proto file.

startLogstash(request, context)[source]

Missing associated documentation comment in .proto file.

startMetricbeat(request, context)[source]

Missing associated documentation comment in .proto file.

startMetricbeats(request, context)[source]

Missing associated documentation comment in .proto file.

startNginx(request, context)[source]

Missing associated documentation comment in .proto file.

startNodeExporter(request, context)[source]

Missing associated documentation comment in .proto file.

startOSSECIDS(request, context)[source]

Missing associated documentation comment in .proto file.

startOSSECIDSManager(request, context)[source]

Missing associated documentation comment in .proto file.

startOSSECIDSManagers(request, context)[source]

Missing associated documentation comment in .proto file.

startOSSECIDSMonitorThread(request, context)[source]

Missing associated documentation comment in .proto file.

startOSSECIDSes(request, context)[source]

Missing associated documentation comment in .proto file.

startOssecIdses(request, context)[source]

Missing associated documentation comment in .proto file.

startOssecIdsesMonitorThreads(request, context)[source]

Missing associated documentation comment in .proto file.

startPacketbeat(request, context)[source]

Missing associated documentation comment in .proto file.

startPacketbeats(request, context)[source]

Missing associated documentation comment in .proto file.

startPgAdmin(request, context)[source]

Missing associated documentation comment in .proto file.

startPostgreSQL(request, context)[source]

Missing associated documentation comment in .proto file.

startPrometheus(request, context)[source]

Missing associated documentation comment in .proto file.

startRyu(request, context)[source]

Missing associated documentation comment in .proto file.

startRyuManager(request, context)[source]

Missing associated documentation comment in .proto file.

startRyuMonitor(request, context)[source]

Missing associated documentation comment in .proto file.

startSdnController(request, context)[source]

Missing associated documentation comment in .proto file.

startSdnControllerMonitor(request, context)[source]

Missing associated documentation comment in .proto file.

startSnortIds(request, context)[source]

Missing associated documentation comment in .proto file.

startSnortIdsManager(request, context)[source]

Missing associated documentation comment in .proto file.

startSnortIdsManagers(request, context)[source]

Missing associated documentation comment in .proto file.

startSnortIdsMonitorThread(request, context)[source]

Missing associated documentation comment in .proto file.

startSnortIdsMonitorThreads(request, context)[source]

Missing associated documentation comment in .proto file.

startSnortIdses(request, context)[source]

Missing associated documentation comment in .proto file.

startSnortIdsesMonitorThreads(request, context)[source]

Missing associated documentation comment in .proto file.

startSparkServer(request, context)[source]

Missing associated documentation comment in .proto file.

startSparkServers(request, context)[source]

Missing associated documentation comment in .proto file.

startTrafficGenerator(request, context)[source]

Missing associated documentation comment in .proto file.

startTrafficGenerators(request, context)[source]

Missing associated documentation comment in .proto file.

startTrafficManager(request, context)[source]

Missing associated documentation comment in .proto file.

startTrafficManagers(request, context)[source]

Missing associated documentation comment in .proto file.

stopAllExecutions(request, context)[source]

Missing associated documentation comment in .proto file.

stopAllExecutionsOfEmulation(request, context)[source]

Missing associated documentation comment in .proto file.

stopAllRunningContainers(request, context)[source]

Missing associated documentation comment in .proto file.

stopCAdvisor(request, context)[source]

Missing associated documentation comment in .proto file.

stopClientManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopClientPopulation(request, context)[source]

Missing associated documentation comment in .proto file.

stopContainer(request, context)[source]

Missing associated documentation comment in .proto file.

stopContainersOfExecution(request, context)[source]

Missing associated documentation comment in .proto file.

stopDockerEngine(request, context)[source]

Missing associated documentation comment in .proto file.

stopDockerStatsManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopDockerStatsManagerThread(request, context)[source]

Missing associated documentation comment in .proto file.

stopElastic(request, context)[source]

Missing associated documentation comment in .proto file.

stopElkManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopElkStack(request, context)[source]

Missing associated documentation comment in .proto file.

stopExecution(request, context)[source]

Missing associated documentation comment in .proto file.

stopFilebeat(request, context)[source]

Missing associated documentation comment in .proto file.

stopFilebeats(request, context)[source]

Missing associated documentation comment in .proto file.

stopFlask(request, context)[source]

Missing associated documentation comment in .proto file.

stopGrafana(request, context)[source]

Missing associated documentation comment in .proto file.

stopHeartbeat(request, context)[source]

Missing associated documentation comment in .proto file.

stopHeartbeats(request, context)[source]

Missing associated documentation comment in .proto file.

stopHostManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopHostManagers(request, context)[source]

Missing associated documentation comment in .proto file.

stopHostMonitorThread(request, context)[source]

Missing associated documentation comment in .proto file.

stopHostMonitorThreads(request, context)[source]

Missing associated documentation comment in .proto file.

stopKafkaClientProducer(request, context)[source]

Missing associated documentation comment in .proto file.

stopKafkaManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopKafkaServer(request, context)[source]

Missing associated documentation comment in .proto file.

stopKibana(request, context)[source]

Missing associated documentation comment in .proto file.

stopLogstash(request, context)[source]

Missing associated documentation comment in .proto file.

stopMetricbeat(request, context)[source]

Missing associated documentation comment in .proto file.

stopMetricbeats(request, context)[source]

Missing associated documentation comment in .proto file.

stopNginx(request, context)[source]

Missing associated documentation comment in .proto file.

stopNodeExporter(request, context)[source]

Missing associated documentation comment in .proto file.

stopOSSECIDS(request, context)[source]

Missing associated documentation comment in .proto file.

stopOSSECIDSManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopOSSECIDSManagers(request, context)[source]

Missing associated documentation comment in .proto file.

stopOSSECIDSMonitorThread(request, context)[source]

Missing associated documentation comment in .proto file.

stopOSSECIDSMonitorThreads(request, context)[source]

Missing associated documentation comment in .proto file.

stopOSSECIDSes(request, context)[source]

Missing associated documentation comment in .proto file.

stopPacketbeat(request, context)[source]

Missing associated documentation comment in .proto file.

stopPacketbeats(request, context)[source]

Missing associated documentation comment in .proto file.

stopPgAdmin(request, context)[source]

Missing associated documentation comment in .proto file.

stopPid(request, context)[source]

Missing associated documentation comment in .proto file.

stopPostgreSQL(request, context)[source]

Missing associated documentation comment in .proto file.

stopPrometheus(request, context)[source]

Missing associated documentation comment in .proto file.

stopRyu(request, context)[source]

Missing associated documentation comment in .proto file.

stopRyuManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopRyuMonitor(request, context)[source]

Missing associated documentation comment in .proto file.

stopSnortIds(request, context)[source]

Missing associated documentation comment in .proto file.

stopSnortIdsManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopSnortIdsManagers(request, context)[source]

Missing associated documentation comment in .proto file.

stopSnortIdsMonitorThread(request, context)[source]

Missing associated documentation comment in .proto file.

stopSnortIdsMonitorThreads(request, context)[source]

Missing associated documentation comment in .proto file.

stopSnortIdses(request, context)[source]

Missing associated documentation comment in .proto file.

stopSnortIdsesMonitorThreads(request, context)[source]

Missing associated documentation comment in .proto file.

stopSparkServer(request, context)[source]

Missing associated documentation comment in .proto file.

stopSparkServers(request, context)[source]

Missing associated documentation comment in .proto file.

stopTrafficGenerator(request, context)[source]

Missing associated documentation comment in .proto file.

stopTrafficGenerators(request, context)[source]

Missing associated documentation comment in .proto file.

stopTrafficManager(request, context)[source]

Missing associated documentation comment in .proto file.

stopTrafficManagers(request, context)[source]

Missing associated documentation comment in .proto file.

class csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub(channel)[source]

Bases: object

Interface exported by the server

csle_cluster.cluster_manager.cluster_manager_pb2_grpc.add_ClusterManagerServicer_to_server(servicer, server)[source]

csle_cluster.cluster_manager.cluster_manager_util module

class csle_cluster.cluster_manager.cluster_manager_util.ClusterManagerUtil[source]

Bases: object

Class with utility functions related to the cluster manager

static agg_flow_statistic_dto_to_dict(agg_flow_statistic_dto: cluster_manager_pb2.AggFlowStatisticDTO) Dict[str, Any][source]

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: cluster_manager_pb2.AggFlowStatisticDict) Dict[str, Any][source]

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: cluster_manager_pb2.AvgFlowStatisticDTO) Dict[str, Any][source]

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: cluster_manager_pb2.AvgFlowStatisticDict) Dict[str, Any][source]

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: cluster_manager_pb2.AvgPortStatisticDTO) Dict[str, Any][source]

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: cluster_manager_pb2.AvgPortStatisticDict) Dict[str, Any][source]

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: cluster_manager_pb2.ClientManagersInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.ClientPopulationMetricsDTO) Dict[str, Any][source]

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: cluster_manager_pb2.ContainerImageDTO) Dict[str, Any][source]

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: cluster_manager_pb2.ContainerImagesDTO) Dict[str, Any][source]

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[csle_ryu.dao.agg_flow_statistic.AggFlowStatistic]]]) List[cluster_manager_pb2.AggFlowStatisticDict][source]

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[cluster_manager_pb2.AggFlowStatisticDict]]) Dict[str, List[csle_ryu.dao.agg_flow_statistic.AggFlowStatistic]][source]

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, csle_ryu.dao.agg_flow_statistic.AggFlowStatistic]) cluster_manager_pb2.AggFlowStatisticDTO[source]

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, cluster_manager_pb2.AggFlowStatisticDTO]) csle_ryu.dao.agg_flow_statistic.AggFlowStatistic[source]

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[csle_ryu.dao.avg_flow_statistic.AvgFlowStatistic]]]) List[cluster_manager_pb2.AvgFlowStatisticDict][source]

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[cluster_manager_pb2.AvgFlowStatisticDict]]) Dict[str, List[csle_ryu.dao.avg_flow_statistic.AvgFlowStatistic]][source]

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, csle_ryu.dao.avg_flow_statistic.AvgFlowStatistic]) cluster_manager_pb2.AvgFlowStatisticDTO[source]

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, cluster_manager_pb2.AvgFlowStatisticDTO]) csle_ryu.dao.avg_flow_statistic.AvgFlowStatistic[source]

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[csle_ryu.dao.avg_port_statistic.AvgPortStatistic]]]) List[cluster_manager_pb2.AvgPortStatisticDict][source]

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[cluster_manager_pb2.AvgPortStatisticDict]]) Dict[str, List[csle_ryu.dao.avg_port_statistic.AvgPortStatistic]][source]

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, csle_ryu.dao.avg_port_statistic.AvgPortStatistic]) cluster_manager_pb2.AvgPortStatisticDTO[source]

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, cluster_manager_pb2.AvgPortStatisticDTO]) csle_ryu.dao.avg_port_statistic.AvgPortStatistic[source]

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: client_manager_pb2.ClientsDTO) cluster_manager_pb2.GetNumClientsDTO[source]

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[cluster_manager_pb2.GetNumClientsDTO]) client_manager_pb2.ClientsDTO[source]

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, csle_common.dao.emulation_config.client_managers_info.ClientManagersInfo]) cluster_manager_pb2.ClientManagersInfoDTO[source]

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, cluster_manager_pb2.ClientManagersInfoDTO]) csle_common.dao.emulation_config.client_managers_info.ClientManagersInfo[source]

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: csle_collector.client_manager.client_population_metrics.ClientPopulationMetrics) cluster_manager_pb2.ClientPopulationMetricsDTO[source]

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, cluster_manager_pb2.ClientPopulationMetricsDTO]) csle_collector.client_manager.client_population_metrics.ClientPopulationMetrics[source]

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, csle_common.dao.emulation_config.docker_stats_managers_info.DockerStatsManagersInfo]) cluster_manager_pb2.DockerStatsManagersInfoDTO[source]

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, cluster_manager_pb2.DockerStatsManagersInfoDTO]) csle_common.dao.emulation_config.docker_stats_managers_info.DockerStatsManagersInfo[source]

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[csle_collector.docker_stats_manager.dao.docker_stats.DockerStats]]]) List[cluster_manager_pb2.DockerStatsDict][source]

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[cluster_manager_pb2.DockerStatsDict]]) Dict[str, List[csle_collector.docker_stats_manager.dao.docker_stats.DockerStats]][source]

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, csle_collector.docker_stats_manager.dao.docker_stats.DockerStats]) cluster_manager_pb2.DockerStatsDTO[source]

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, cluster_manager_pb2.DockerStatsDTO]) csle_collector.docker_stats_manager.dao.docker_stats.DockerStats[source]

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: docker_stats_manager_pb2.DockerStatsMonitorDTO) cluster_manager_pb2.DockerStatsMonitorStatusDTO[source]

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[cluster_manager_pb2.DockerStatsMonitorStatusDTO]) docker_stats_manager_pb2.DockerStatsMonitorDTO[source]

Converts a DockerStatsMonitorStatusDTO to a DockerStatsMonitorDTO

Parameters

monitor_dto – the DTO to convert

Returns

the converted DTO

static convert_elk_dto(elk_dto: elk_manager_pb2.ElkDTO) cluster_manager_pb2.ElkStatusDTO[source]

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[cluster_manager_pb2.ElkStatusDTO]) elk_manager_pb2.ElkDTO[source]

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, csle_common.dao.emulation_config.elk_managers_info.ELKManagersInfo]) cluster_manager_pb2.ElkManagersInfoDTO[source]

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, cluster_manager_pb2.ElkManagersInfoDTO]) csle_common.dao.emulation_config.elk_managers_info.ELKManagersInfo[source]

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, csle_common.dao.emulation_action.attacker.emulation_attacker_action.EmulationAttackerAction]) cluster_manager_pb2.EmulationAttackerActionDTO[source]

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, cluster_manager_pb2.EmulationAttackerActionDTO]) csle_common.dao.emulation_action.attacker.emulation_attacker_action.EmulationAttackerAction[source]

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, csle_common.dao.emulation_action.defender.emulation_defender_action.EmulationDefenderAction]) cluster_manager_pb2.EmulationDefenderActionDTO[source]

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, cluster_manager_pb2.EmulationDefenderActionDTO]) csle_common.dao.emulation_action.defender.emulation_defender_action.EmulationDefenderAction[source]

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: csle_common.dao.emulation_config.emulation_metrics_time_series.EmulationMetricsTimeSeries) cluster_manager_pb2.EmulationMetricsTimeSeriesDTO[source]

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, cluster_manager_pb2.EmulationMetricsTimeSeriesDTO]) csle_common.dao.emulation_config.emulation_metrics_time_series.EmulationMetricsTimeSeries[source]

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, csle_common.dao.emulation_config.emulation_execution_info.EmulationExecutionInfo]) cluster_manager_pb2.ExecutionInfoDTO[source]

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[csle_ryu.dao.flow_statistic.FlowStatistic]]]) List[cluster_manager_pb2.FlowStatisticDict][source]

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[cluster_manager_pb2.FlowStatisticDict]]) Dict[str, List[csle_ryu.dao.flow_statistic.FlowStatistic]][source]

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, cluster_manager_pb2.FlowStatisticDTO]) csle_ryu.dao.flow_statistic.FlowStatistic[source]

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, csle_ryu.dao.flow_statistic.FlowStatistic]) cluster_manager_pb2.FlowStatisticDTO[source]

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, csle_common.dao.emulation_config.host_managers_info.HostManagersInfo]) cluster_manager_pb2.HostManagersInfoDTO[source]

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, cluster_manager_pb2.HostManagersInfoDTO]) csle_common.dao.emulation_config.host_managers_info.HostManagersInfo[source]

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[csle_collector.host_manager.dao.host_metrics.HostMetrics]]]) List[cluster_manager_pb2.HostMetricsDict][source]

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[cluster_manager_pb2.HostMetricsDict]]) Dict[str, List[csle_collector.host_manager.dao.host_metrics.HostMetrics]][source]

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, csle_collector.host_manager.dao.host_metrics.HostMetrics]) cluster_manager_pb2.HostMetricsDataDTO[source]

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, cluster_manager_pb2.HostMetricsDataDTO]) csle_collector.host_manager.dao.host_metrics.HostMetrics[source]

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[host_manager_pb2.HostStatusDTO, str]) cluster_manager_pb2.HostManagerStatusDTO[source]

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, cluster_manager_pb2.HostManagerStatusDTO]) Tuple[host_manager_pb2.HostStatusDTO, str][source]

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, kafka_manager_pb2.KafkaDTO]) cluster_manager_pb2.KafkaStatusDTO[source]

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, cluster_manager_pb2.KafkaStatusDTO]) kafka_manager_pb2.KafkaDTO[source]

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, csle_common.dao.emulation_config.kafka_managers_info.KafkaManagersInfo]) cluster_manager_pb2.KafkaManagersInfoDTO[source]

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, cluster_manager_pb2.KafkaManagersInfoDTO]) csle_common.dao.emulation_config.kafka_managers_info.KafkaManagersInfo[source]

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[csle_collector.ossec_ids_manager.dao.ossec_ids_alert_counters.OSSECIdsAlertCounters]]]) List[cluster_manager_pb2.OSSECIdsAlertCountersDict][source]

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[cluster_manager_pb2.OSSECIdsAlertCountersDict]]) Dict[str, List[csle_collector.ossec_ids_manager.dao.ossec_ids_alert_counters.OSSECIdsAlertCounters]][source]

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, csle_collector.ossec_ids_manager.dao.ossec_ids_alert_counters.OSSECIdsAlertCounters]) cluster_manager_pb2.OSSECIdsAlertCountersDTO[source]

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, cluster_manager_pb2.OSSECIdsAlertCountersDTO]) csle_collector.ossec_ids_manager.dao.ossec_ids_alert_counters.OSSECIdsAlertCounters[source]

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, ossec_ids_manager_pb2.OSSECIdsMonitorDTO]) cluster_manager_pb2.OSSECIdsStatusDTO[source]

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, cluster_manager_pb2.OSSECIdsStatusDTO]) ossec_ids_manager_pb2.OSSECIdsMonitorDTO[source]

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[csle_common.dao.emulation_config.ossec_managers_info.OSSECIDSManagersInfo]) cluster_manager_pb2.OSSECIdsManagersInfoDTO[source]

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, cluster_manager_pb2.OSSECIdsManagersInfoDTO]) csle_common.dao.emulation_config.ossec_managers_info.OSSECIDSManagersInfo[source]

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[csle_ryu.dao.port_statistic.PortStatistic]]]) List[cluster_manager_pb2.PortStatisticDict][source]

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[cluster_manager_pb2.PortStatisticDict]]) Dict[str, List[csle_ryu.dao.port_statistic.PortStatistic]][source]

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, cluster_manager_pb2.PortStatisticDTO]) csle_ryu.dao.port_statistic.PortStatistic[source]

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, csle_ryu.dao.port_statistic.PortStatistic]) cluster_manager_pb2.PortStatisticDTO[source]

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, ryu_manager_pb2.RyuDTO]) cluster_manager_pb2.RyuManagerStatusDTO[source]

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, cluster_manager_pb2.RyuManagerStatusDTO]) ryu_manager_pb2.RyuDTO[source]

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, csle_common.dao.emulation_config.ryu_managers_info.RyuManagersInfo]) cluster_manager_pb2.RyuManagersInfoDTO[source]

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, cluster_manager_pb2.RyuManagersInfoDTO]) csle_common.dao.emulation_config.ryu_managers_info.RyuManagersInfo[source]

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[csle_collector.snort_ids_manager.dao.snort_ids_alert_counters.SnortIdsAlertCounters]]]) List[cluster_manager_pb2.SnortIdsAlertCountersDict][source]

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[cluster_manager_pb2.SnortIdsAlertCountersDict]]) Dict[str, List[csle_collector.snort_ids_manager.dao.snort_ids_alert_counters.SnortIdsAlertCounters]][source]

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, csle_collector.snort_ids_manager.dao.snort_ids_alert_counters.SnortIdsAlertCounters]) cluster_manager_pb2.SnortIdsAlertCountersDTO[source]

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, cluster_manager_pb2.SnortIdsAlertCountersDTO]) csle_collector.snort_ids_manager.dao.snort_ids_alert_counters.SnortIdsAlertCounters[source]

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[csle_collector.snort_ids_manager.dao.snort_ids_ip_alert_counters.SnortIdsIPAlertCounters]]]) List[cluster_manager_pb2.SnortIdsIpAlertCountersDict][source]

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[cluster_manager_pb2.SnortIdsIpAlertCountersDict]]) Dict[str, List[csle_collector.snort_ids_manager.dao.snort_ids_ip_alert_counters.SnortIdsIPAlertCounters]][source]

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, csle_collector.snort_ids_manager.dao.snort_ids_ip_alert_counters.SnortIdsIPAlertCounters]) cluster_manager_pb2.SnortIdsIpAlertCountersDTO[source]

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, cluster_manager_pb2.SnortIdsIpAlertCountersDTO]) csle_collector.snort_ids_manager.dao.snort_ids_ip_alert_counters.SnortIdsIPAlertCounters[source]

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[snort_ids_manager_pb2.SnortIdsMonitorDTO]) cluster_manager_pb2.SnortIdsStatusDTO[source]

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[cluster_manager_pb2.SnortIdsStatusDTO]) snort_ids_manager_pb2.SnortIdsMonitorDTO[source]

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[csle_collector.snort_ids_manager.dao.snort_ids_rule_counters.SnortIdsRuleCounters]]]) List[cluster_manager_pb2.SnortIdsRuleCountersDict][source]

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[cluster_manager_pb2.SnortIdsRuleCountersDict]]) Dict[str, List[csle_collector.snort_ids_manager.dao.snort_ids_rule_counters.SnortIdsRuleCounters]][source]

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[csle_collector.snort_ids_manager.dao.snort_ids_rule_counters.SnortIdsRuleCounters]) cluster_manager_pb2.SnortIdsRuleCountersDTO[source]

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, cluster_manager_pb2.SnortIdsRuleCountersDTO]) csle_collector.snort_ids_manager.dao.snort_ids_rule_counters.SnortIdsRuleCounters[source]

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, csle_common.dao.emulation_config.snort_managers_info.SnortIdsManagersInfo]) cluster_manager_pb2.SnortIdsManagersInfoDTO[source]

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, cluster_manager_pb2.SnortIdsManagersInfoDTO]) csle_common.dao.emulation_config.snort_managers_info.SnortIdsManagersInfo[source]

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: traffic_manager_pb2.TrafficDTO) cluster_manager_pb2.TrafficManagerInfoDTO[source]

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[cluster_manager_pb2.TrafficManagerInfoDTO]) traffic_manager_pb2.TrafficDTO[source]

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, csle_common.dao.emulation_config.traffic_managers_info.TrafficManagersInfo]) cluster_manager_pb2.TrafficManagersInfoDTO[source]

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, cluster_manager_pb2.TrafficManagersInfoDTO]) csle_common.dao.emulation_config.traffic_managers_info.TrafficManagersInfo[source]

Converts a TrafficManagerInfoDTO into a TrafficManagersInfo

Parameters

traffic_managers_dto – the DTO to convert

Returns

the converted DTO

static create_kibana_tunnel(execution: csle_common.dao.emulation_config.emulation_execution.EmulationExecution, logger: logging.Logger) int[source]

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]) cluster_manager_pb2.KibanaTunnelsDTO[source]

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: csle_common.dao.emulation_config.emulation_execution.EmulationExecution, logger: logging.Logger) int[source]

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]) cluster_manager_pb2.RyuTunnelsDTO[source]

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: cluster_manager_pb2.DockerContainerDTO) Dict[str, Any][source]

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: cluster_manager_pb2.DockerNetworksDTO) Dict[str, Any][source]

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: cluster_manager_pb2.DockerStatsDict) Dict[str, Any][source]

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: cluster_manager_pb2.DockerStatsDTO) Dict[str, Any][source]

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: cluster_manager_pb2.DockerStatsManagersInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.DockerStatsMonitorStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.ElkManagersInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.ElkStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.EmulationAttackerActionDTO) Dict[str, Any][source]

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: cluster_manager_pb2.EmulationDefenderActionDTO) Dict[str, Any][source]

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: cluster_manager_pb2.EmulationMetricsTimeSeriesDTO) Dict[str, Any][source]

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: cluster_manager_pb2.FlowStatisticDTO) Dict[str, Any][source]

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: cluster_manager_pb2.FlowStatisticDict) Dict[str, Any][source]

Converts a DTO to a dict

Parameters

flow_statistics_dict – the DTO to convert

Returns

the dict

static get_active_ips(emulation_env_config: csle_common.dao.emulation_config.emulation_env_config.EmulationEnvConfig) List[str][source]

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: csle_common.dao.emulation_config.emulation_execution.EmulationExecution, ip: str) Optional[csle_common.dao.emulation_config.node_container_config.NodeContainerConfig][source]

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[cluster_manager_pb2.AggFlowStatisticDict][source]

Gets an empty list of AggFlowStatisticDict :return: an empty list of AggFlowStatisticDict

static get_empty_agg_flow_statistic_dto() cluster_manager_pb2.AggFlowStatisticDTO[source]

Gets an empty AggFlowStatisticDTO

Returns

an empty AggFlowStatisticDTO

static get_empty_avg_flow_statistic_dict() List[cluster_manager_pb2.AvgFlowStatisticDict][source]

Gets an empty list of AvgFlowStatisticDict

Returns

an empty list of AvgFlowStatisticDict

static get_empty_avg_flow_statistic_dto() cluster_manager_pb2.AvgFlowStatisticDTO[source]

Gets an empty AvgFlowStatisticDTO

Returns

an empty AvgFlowStatisticDTO

static get_empty_avg_port_statistic_dict() List[cluster_manager_pb2.AvgPortStatisticDict][source]

Gets an empty list of AvgPortStatisticDict

Returns

an empty list of AvgPortStatisticDict

static get_empty_avg_port_statistic_dto() cluster_manager_pb2.AvgPortStatisticDTO[source]

Gets an empty AvgPortStatisticDTO

Returns

an empty AvgPortStatisticDTO

static get_empty_client_managers_info_dto() cluster_manager_pb2.ClientManagersInfoDTO[source]

Gets an empty ClientManagersInfoDTO

Returns

an empty ClientManagersInfoDTO

static get_empty_client_population_metrics_dto() cluster_manager_pb2.ClientPopulationMetricsDTO[source]

Gets an empty ClientPopulationMetricsDTO

Returns

an empty ClientPopulationMetricsDTO

static get_empty_docker_managers_info_dto() cluster_manager_pb2.DockerStatsManagersInfoDTO[source]

Gets an empty DockerStatsManagersInfoDTO

Returns

an empty DockerStatsManagersInfoDTO

static get_empty_docker_stats_dict() List[cluster_manager_pb2.DockerStatsDict][source]

Gets an empty list of DockerStatsDict

Returns

an empty list of DockerStatsDict

static get_empty_docker_stats_dto() cluster_manager_pb2.DockerStatsDTO[source]
Returns

an empty ClientPopulationMetricsDTO

static get_empty_docker_stats_monitor_status_dto() cluster_manager_pb2.DockerStatsMonitorStatusDTO[source]

Gets an empty DockerStatsMonitorStatusDTO

Returns

an empty DockerStatsMonitorStatusDTO

static get_empty_elk_managers_info_dto() cluster_manager_pb2.ElkManagersInfoDTO[source]

Gets an empty ElkManagersInfoDTO

Returns

an empty ElkManagersInfoDTO

static get_empty_elk_status_dto() cluster_manager_pb2.ElkStatusDTO[source]

Gets an empty ElkStatusDTO

Returns

an empty ElkStatusDTO

static get_empty_emulation_attacker_action_dto() cluster_manager_pb2.EmulationAttackerActionDTO[source]

Gets an empty EmulationAttackerActionDTO

Returns

an empty EmulationAttackerActionDTO

static get_empty_emulation_defender_action_dto() cluster_manager_pb2.EmulationDefenderActionDTO[source]

Gets an empty EmulationDefenderActionDTO

Returns

an empty EmulationDefenderActionDTO

static get_empty_emulation_metrics_time_series_dto() cluster_manager_pb2.EmulationMetricsTimeSeriesDTO[source]

Gets an empty emulation metric series dto

Returns

an empty EmulationMetricsTimeSeriesDTO

static get_empty_execution_info_dto() cluster_manager_pb2.ExecutionInfoDTO[source]

Gets an empty ExecutionInfoDTO

Returns

an empty ExecutionInfoDTO

static get_empty_flow_statistic_dict() List[cluster_manager_pb2.FlowStatisticDict][source]

Gets an empty list of FlowStatisticDict

Returns

an empty list of FlowStatisticDict

static get_empty_flow_statistic_dto() cluster_manager_pb2.FlowStatisticDTO[source]

Gets an empty FlowStatisticDTO

Returns

an empty FlowStatisticDTO

static get_empty_get_num_clients_dto() cluster_manager_pb2.GetNumClientsDTO[source]

Gets an empty GetNumClientsDTO

Returns

an empty GetNumClientsDTO

static get_empty_host_manager_status_dto() cluster_manager_pb2.HostManagerStatusDTO[source]

Gets an empty HostManagerStatusDTO

Returns

an empty HostManagerStatusDTO

static get_empty_host_managers_info_dto() cluster_manager_pb2.HostManagersInfoDTO[source]

Gets an empty HostManagersInfoDTO

Returns

an empty HostManagersInfoDTO

static get_empty_host_metrics_dict() List[cluster_manager_pb2.HostMetricsDict][source]

Gets an empty list of HostMetricsDict

Returns

an empty HostMetricsDict

static get_empty_host_metrics_dto() cluster_manager_pb2.HostMetricsDataDTO[source]

Gets an empty HostMetricsDataDTO

Returns

an empty HostMetricsDataDTO

static get_empty_kafka_dto() cluster_manager_pb2.KafkaStatusDTO[source]

Gets an empty KafkaStatusDTO

Returns

an empty KafkaStatusDTO

static get_empty_kafka_managers_info_dto() cluster_manager_pb2.KafkaManagersInfoDTO[source]

Gets an empty KafkaManagersInfoDTO

Returns

an empty KafkaManagersInfoDTO

static get_empty_kibana_tunnel_dto() cluster_manager_pb2.KibanaTunnelDTO[source]

Gets an empty KibanaTunnelDTO

Returns

an empty KibanaTunnelDTO

static get_empty_kibana_tunnels_dto() cluster_manager_pb2.KibanaTunnelsDTO[source]

Gets an empty KibanaTunnelsDTO

Returns

an empty KibanaTunnelsDTO

static get_empty_num_clients_dto() cluster_manager_pb2.GetNumClientsDTO[source]

Gets an empty GetNumClientsDTO

Returns

an empty GetNumClientsDTO

static get_empty_ossec_ids_alert_counters_dict() List[cluster_manager_pb2.OSSECIdsAlertCountersDict][source]

Gets an empty list of OSSECIdsAlertCountersDict :return: an empty OSSECIdsAlertCountersDict

static get_empty_ossec_ids_alert_counters_dto() cluster_manager_pb2.OSSECIdsAlertCountersDTO[source]

Gets an empty OSSECIdsAlertCountersDTO

Returns

an empty OSSECIdsAlertCountersDTO

static get_empty_ossec_ids_monitor_dto() cluster_manager_pb2.OSSECIdsStatusDTO[source]

Gets an empty OSSECIdsMonitorDTO

Returns

an empty OSSECIdsMonitorDTO

static get_empty_ossec_ids_status_dto() cluster_manager_pb2.OSSECIdsStatusDTO[source]

Gets an empty OSSECIdsStatusDTO

Returns

an empty OSSECIdsStatusDTO

static get_empty_ossec_managers_info_dto() cluster_manager_pb2.OSSECIdsManagersInfoDTO[source]

Gets an empty OSSECIdsManagersInfoDTO

Returns

an empty OSSECIdsManagersInfoDTO

static get_empty_port_statistic_dict() List[cluster_manager_pb2.PortStatisticDict][source]

Gets an list of PortStatisticDict

Returns

an empty list of PortStatisticDict

static get_empty_port_statistic_dto() cluster_manager_pb2.PortStatisticDTO[source]

Gets an empty PortStatisticDTO

Returns

an empty PortStatisticDTO

static get_empty_ryu_manager_status_dto() cluster_manager_pb2.RyuManagerStatusDTO[source]

Gets an empty RyuManagerStatusDTO

Returns

an empty RyuManagerStatusDTO

static get_empty_ryu_managers_info_dto() cluster_manager_pb2.RyuManagersInfoDTO[source]

Gets an empty RyuManagersInfoDTO

Returns

an empty RyuManagersInfoDTO

static get_empty_ryu_tunnel_dto() cluster_manager_pb2.RyuTunnelDTO[source]

Gets an empty RyuTunnelDTO

Returns

an empty RyuTunnelDTO

static get_empty_ryu_tunnels_dto() cluster_manager_pb2.RyuTunnelsDTO[source]
Returns

an empty RyuTunnelsDTO

static get_empty_snort_ids_alert_counters_dict() List[cluster_manager_pb2.SnortIdsAlertCountersDict][source]

Gets an empty list of SnortIdsAlertCountersDict

Returns

an empty list of SnortIdsAlertCountersDict

static get_empty_snort_ids_alert_counters_dto() cluster_manager_pb2.SnortIdsAlertCountersDTO[source]

Gets an empty SnortIdsAlertCountersDTO

Returns

an empty SnortIdsAlertCountersDTO

static get_empty_snort_ids_ip_alert_counters_dict() List[cluster_manager_pb2.SnortIdsIpAlertCountersDict][source]

Gets an empty list of SnortIdsIpAlertCountersDict

Returns

an empty list of SnortIdsIpAlertCountersDict

static get_empty_snort_ids_ip_alert_counters_dto() cluster_manager_pb2.SnortIdsIpAlertCountersDTO[source]

Gets an empty SnortIdsAlertCountersDTO

Returns

an empty SnortIdsAlertCountersDTO

static get_empty_snort_ids_rule_counters_dict() List[cluster_manager_pb2.SnortIdsRuleCountersDict][source]

Gets an empty list of SnortIdsRuleCountersDict

Returns

an empty list of SnortIdsRuleCountersDict

static get_empty_snort_ids_rule_counters_dto() cluster_manager_pb2.SnortIdsRuleCountersDTO[source]

Gets an empty SnortIdsAlertCountersDTO

Returns

an empty SnortIdsAlertCountersDTO

static get_empty_snort_ids_status_dto() cluster_manager_pb2.SnortIdsStatusDTO[source]

Gets an empty SnortIdsStatusDTO

Returns

an empty SnortIdsStatusDTO

static get_empty_snort_managers_info_dto() cluster_manager_pb2.SnortIdsManagersInfoDTO[source]

Gets an empty SnortIdsManagersInfoDTO

Returns

an empty SnortIdsManagersInfoDTO

static get_empty_traffic_manager_info_dto() cluster_manager_pb2.TrafficManagerInfoDTO[source]

Gets an empty TrafficManagersInfoDTO

Returns

an empty TrafficManagersInfoDTO

static get_empty_traffic_managers_info_dto() cluster_manager_pb2.TrafficManagersInfoDTO[source]

Gets an empty TrafficManagersInfoDTO

Returns

an empty TrafficManagersInfoDTO

static get_logs(execution: csle_common.dao.emulation_config.emulation_execution.EmulationExecution, ip: str, path: str) cluster_manager_pb2.LogsDTO[source]

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: cluster_manager_pb2.GetNumClientsDTO) Dict[str, Any][source]

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: cluster_manager_pb2.HostManagerStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.HostManagersInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.HostMetricsDict) Dict[str, Any][source]

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: cluster_manager_pb2.HostMetricsDataDTO) Dict[str, Any][source]

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: cluster_manager_pb2.KafkaManagersInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.KafkaStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.KibanaTunnelDTO) Dict[str, Any][source]

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: cluster_manager_pb2.KibanaTunnelsDTO) Dict[str, Any][source]

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: cluster_manager_pb2.LogsDTO) Dict[str, Any][source]

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[cluster_manager_pb2.ExecutionInfoDTO]) csle_common.dao.emulation_config.emulation_execution_info.EmulationExecutionInfo[source]

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: cluster_manager_pb2.NodeStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.OSSECIdsAlertCountersDict) Dict[str, Any][source]

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: cluster_manager_pb2.OSSECIdsAlertCountersDTO) Dict[str, Any][source]

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: cluster_manager_pb2.OSSECIdsMonitorThreadStatusesDTO) Dict[str, Any][source]

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: cluster_manager_pb2.OSSECIdsStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.OSSECIdsManagersInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.PortStatisticDTO) Dict[str, Any][source]

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: cluster_manager_pb2.PortStatisticDict) Dict[str, Any][source]

Converts a DTO to a dict

Parameters

port_statistics_dict – the DTO to convert

Returns

the dict

static remove_kibana_tunnel(execution: csle_common.dao.emulation_config.emulation_execution.EmulationExecution) None[source]

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: csle_common.dao.emulation_config.emulation_execution.EmulationExecution) None[source]

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: cluster_manager_pb2.RunningContainersDTO) Dict[str, List[Dict[str, Any]]][source]

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: cluster_manager_pb2.RunningEmulationsDTO) Dict[str, Any][source]

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: cluster_manager_pb2.RyuManagerStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.RyuManagersInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.RyuTunnelDTO) Dict[str, Any][source]

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: cluster_manager_pb2.RyuTunnelsDTO) Dict[str, Any][source]

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: cluster_manager_pb2.ServiceStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsAlertCountersDict) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsAlertCountersDTO) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsIpAlertCountersDict) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsIpAlertCountersDTO) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsMonitorThreadStatusesDTO) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsRuleCountersDict) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsRuleCountersDTO) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsStatusDTO) Dict[str, Any][source]

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: cluster_manager_pb2.SnortIdsManagersInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.StoppedContainersDTO) Dict[str, Any][source]

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[source]

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: cluster_manager_pb2.TrafficManagerInfoDTO) Dict[str, Any][source]

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: cluster_manager_pb2.TrafficManagersInfoDTO) Dict[str, Any][source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, pid: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.ClientManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.DockerStatsManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, port: int, timeout=30000) cluster_manager_pb2.DockerStatsMonitorStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.ElkManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.ElkStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.ExecutionInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, minutes: int, timeout=30000) cluster_manager_pb2.EmulationMetricsTimeSeriesDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.HostManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.HostManagerStatusesDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.KafkaManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.KafkaStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, log_file_name: str, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.NodeStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.GetNumClientsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OSSECIdsManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OSSECIdsMonitorThreadStatusesDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.RyuManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.RyuManagerStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.SnortIdsManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.SnortIdsMonitorThreadStatusesDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.LogsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.TrafficManagersInfoDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.ContainerImagesDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.DockerNetworksDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.RunningContainersDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.RunningEmulationsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.StoppedContainersDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.KibanaTunnelsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.RyuTunnelsDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, container_name: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, image_name: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, networks: List[str], timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, image: str, name: str, memory: int, num_cpus: int, create_network: bool, version: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, container_name: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, initial_start: bool = False, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=300) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, initial_start: bool = False, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, initial_start: bool = False, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, initial_start: bool = False, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, initial_start: bool = False, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, container_name: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, pid: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, timeout=60) cluster_manager_pb2.ServiceStatusDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, container_ip: str, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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: csle_cluster.cluster_manager.cluster_manager_pb2_grpc.ClusterManagerStub, emulation: str, ip_first_octet: int, timeout=30000) cluster_manager_pb2.OperationOutcomeDTO[source]

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