csle_rest_api.resources.emulation_executions package

Submodules

csle_rest_api.resources.emulation_executions.routes module

Routes and sub-resources for the /emulation-executions resource

csle_rest_api.resources.emulation_executions.routes.emulation_execution(execution_id: int)

The /emulation-executions/id resource.

Parameters

execution_id – the id of the execution

Returns

The given execution

csle_rest_api.resources.emulation_executions.routes.emulation_execution_ids() → Tuple[flask.wrappers.Response, int]

Utiltiy method for returning the ids of emulation executions to an HTTP client

Returns

a list of emulation execution ids

csle_rest_api.resources.emulation_executions.routes.emulation_execution_info(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/info resource.

Parameters

execution_id – the id of the execution

Returns

Runtime information about the given execution

csle_rest_api.resources.emulation_executions.routes.emulation_executions() → Tuple[flask.wrappers.Response, int]

The /emulation-executions resource.

Returns

A list of emulation executions or a list of ids of the executions

csle_rest_api.resources.emulation_executions.routes.get_sdn_switches_of_execution(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/switches resource. Gets SDN switches of a given execution of a given emulation.

Parameters

execution_id – the id of the execution

Returns

The sought for switches if they exist

csle_rest_api.resources.emulation_executions.routes.start_stop_client_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/client-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the client manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_client_population(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/client-population resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the client manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_client_producer(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/client-producer resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stops the client producer of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_container(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/container resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stops a container of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_docker_stats_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/docker-stats-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the docker stats manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_docker_stats_monitor(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/docker-stats-monitor resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the docker stats manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_elastic(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/elastic resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the elastic instance of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_elk_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/elk-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the elk manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_elk_stack(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/elk-stack resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the ELK stack of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_filebeat(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/filebeat resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop filebeat of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_heartbeat(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/heartbeat resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop heartbeat of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_host_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/host-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the host managers of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_host_monitor_thread(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/host-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the host managers of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_kafka(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/kafka resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the kafka manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_kafka_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/kafka-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the kafka manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_kibana(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/kibana resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the kibana instance of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_logstash(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/logstash resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the logstash of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_metricbeat(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/metricbeat resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop metricbeat of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_ossec_ids(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/ossec-ids resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the ossec manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_ossec_ids_monitor(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/ossec-ids-monitor resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the ossec-ids-monitor of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_ossec_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/ossec-ids-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the ossec manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_packetbeat(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/packetbeat resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop packetbeat of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_ryu_controller(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/ryu-controller resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the RYU controller of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_ryu_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/ryu-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the ryu manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_ryu_monitor(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/ryu-monitor resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the RYU monitor of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_snort_ids(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/snort-ids resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the snort manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_snort_ids_monitor(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/snort-ids-monitor resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the snort manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_snort_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/snort-ids-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the snort manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_traffic_generator(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/traffic-generator resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the traffic manager of a given execution

csle_rest_api.resources.emulation_executions.routes.start_stop_traffic_manager(execution_id: int) → Tuple[flask.wrappers.Response, int]

The /emulation-executions/id/traffic-manager resource.

Parameters

execution_id – the id of the execution

Returns

Starts or stop the traffic manager of a given execution

Module contents