Get current user's range information. Args: user_id: Optional user ID (admin only) Returns: Range information

Get range configuration. Args: user_id: Optional user ID (admin only) Returns: Range configuration

Update range configuration. Args: config: Range configuration object user_id: Optional user ID (admin only) Returns: Updated configuration

Deploy a range from configuration with optional filters for resuming. IMPORTANT: For deploying predefined scenarios (redteam-lab-lite, etc.), use deploy_scenario() or smart_deploy() instead. This too...

Get available Ansible tags for the current range. Use this to see what tags are available for resuming/partial deployments. Tags allow you to run specific parts of a deployment without re-running eve...

Abort a range deployment. Stops an active deployment. Use this before deleting a range that is currently deploying. After aborting, you can resume the deployment using deploy_range() with specific ta...

Create a snapshot of a host. Args: vm_name: Name of the VM to snapshot name: Name of the snapshot description: Optional snapshot description user_id: Optional user ID (admin only) Re...

List all snapshots for the range. Args: user_id: Optional user ID (admin only) Returns: List of snapshots

Rollback to a snapshot. Args: vm_name: Name of the VM snapshot_name: Name of the snapshot to rollback to user_id: Optional user ID (admin only) Returns: Rollback result

Remove a snapshot. Args: vm_name: Name of the VM snapshot_name: Name of the snapshot to remove user_id: Optional user ID (admin only) Returns: Removal result

Power on all VMs in the range. Args: user_id: Optional user ID (admin only) Returns: Power on result

Power off all VMs in the range. Args: user_id: Optional user ID (admin only) Returns: Power off result

List available templates. Args: user_id: Optional user ID (admin only) Returns: List of available templates

List all hosts in range. Args: user_id: Optional user ID (admin only) Returns: List of hosts

List all networks in a range. Args: user_id: Optional user ID (admin only) Returns: List of networks

Start testing state for the range. Args: user_id: Optional user ID (admin only) Returns: Testing start result

Stop testing state for the range. Args: user_id: Optional user ID (admin only) Returns: Testing stop result

Check health of Ludus MCP server and Ludus API connectivity. Uses the ludus CLI if available for more reliable connectivity testing. Returns: Health status including: - Server status (health...

List all available scenarios. Returns: Dictionary of scenario keys and descriptions

Deploy a scenario with optional SIEM integration and customization. IMPORTANT: This tool generates a FRESH configuration for each call. Each deployment builds a new scenario from scratch - no state i...

Get scenario configuration. Args: scenario_key: Scenario identifier siem_type: SIEM type to include Returns: Scenario configuration

Get scenario configuration as YAML. Args: scenario_key: Scenario identifier siem_type: SIEM type to include Returns: YAML configuration string

Preview a scenario before deployment with detailed information. IMPORTANT: Generates a FRESH configuration preview for the specified scenario. Use this BEFORE deploy_scenario to verify what will be d...

Get one-line deployment status with emoji indicators. Args: user_id: Optional user ID (admin only) Returns: Formatted status string

Get current deployment status with detailed information. Args: user_id: Optional user ID (admin only) Returns: Detailed deployment status

Get deployment logs for the range. Args: user_id: Optional user ID (admin only) Returns: Deployment logs

Smart deployment with validation, optional snapshot, and auto-monitoring. RECOMMENDED: This is the preferred method for deploying scenarios as it includes validation, error checking, and monitoring g...

Monitor deployment progress with periodic updates. Args: user_id: Optional user ID (admin only) check_interval: Seconds between checks max_checks: Maximum number of checks Returns: M...

Get deployment timeline with progress tracking. Args: user_id: Optional user ID (admin only) Returns: Timeline with steps and progress

Validate range configuration before deployment. Args: config: Range configuration to validate Returns: Validation result with errors and warnings

Handle Active Directory Web Services (ADWS) recovery for stuck deployments. ADWS errors are common during Active Directory deployments. This tool: 1. Checks if deployment is stuck on ADWS errors 2. W...

List all users in the Ludus system. Returns: List of all users with their information

Get information about a specific user. Args: user_id: User ID to retrieve Returns: User information

Add a new user to the Ludus system. Args: username: Username for the new user password: Password for the new user is_admin: Whether the user should have admin privileges proxmox_usern...

Remove a user from the Ludus system. Args: user_id: User ID to remove Returns: Removal result

Get API key for a user. Args: user_id: User ID to get API key for Returns: User's API key information

Get SIEM information for the range. Args: user_id: Optional user ID (admin only) Returns: SIEM configuration and status

Get SIEM alerts for the range. Args: user_id: Optional user ID (admin only) severity: Filter by severity level (low, medium, high, critical) limit: Maximum number of alerts to return Ret...

Get SIEM agents for the range. Args: user_id: Optional user ID (admin only) Returns: List of SIEM agents

Get detection summary from SIEM. Args: user_id: Optional user ID (admin only) Returns: Detection summary with statistics

Get Wazuh SIEM information for the range. Args: user_id: Optional user ID (admin only) Returns: Wazuh configuration and status

Get range access configuration. Args: user_id: Optional user ID (admin only) Returns: Range access configuration

Grant access to range for another user. Args: target_user_id: User ID to grant access to permissions: List of permissions to grant (read, write, admin) user_id: Optional user ID (admin on...

Revoke range access from a user. Args: target_user_id: User ID to revoke access from user_id: Optional user ID (admin only) Returns: Revoke result

Clear all range access permissions. Args: user_id: Optional user ID (admin only) Returns: Clear result

Get range access logs. Args: user_id: Optional user ID (admin only) limit: Maximum number of log entries to return Returns: List of access log entries

Run security audit on the range. Args: user_id: Optional user ID (admin only) Returns: Security audit report

Check compliance against security framework. Args: framework: Security framework to check against (nist, pci, iso27001) user_id: Optional user ID (admin only) Returns: Compliance check r...

Rotate credentials for the range. Args: user_id: Optional user ID (admin only) Returns: Credential rotation result

Get vulnerability scan results for the range. Args: user_id: Optional user ID (admin only) Returns: Vulnerability scan results

Add a new template to the system. Args: name: Template name url: Template URL or image source description: Optional template description user_id: Optional user ID (admin only) Return...

Build a template. Args: template_id: Template ID to build force: Force rebuild even if template exists user_id: Optional user ID (admin only) Returns: Build initiation result

Delete a template. Args: template_id: Template ID to delete user_id: Optional user ID (admin only) Returns: Deletion result

Get template build status. Args: template_id: Template ID user_id: Optional user ID (admin only) Returns: Template build status

Get template build logs. Args: template_id: Template ID user_id: Optional user ID (admin only) Returns: Template build logs

Abort a template build. Args: template_id: Template ID user_id: Optional user ID (admin only) Returns: Abort result

Apply a template to a VM. Args: vm_name: Name of the VM to apply template to template_id: Template ID to apply user_id: Optional user ID (admin only) Returns: Template application re...

Create a custom template from scratch. Args: name: Name for the custom template os_type: OS type (linux, windows) os_version: OS version (e.g., "22.04", "2022") packages: List of pack...

Create a container-based template. Args: name: Name for the container template base_os: Base OS (e.g., "ubuntu-22.04", "debian-12") containers: List of container configurations descri...

List common container base images. Returns: Dictionary of common container configurations

Get configuration for a common container. Args: container_name: Container name Returns: Container configuration

Compare two templates and show differences. Args: template_id1: First template ID template_id2: Second template ID user_id: Optional user ID (admin only) Returns: Template difference...

Validate a template configuration. Args: template_config: Template configuration to validate user_id: Optional user ID (admin only) Returns: Validation result with errors and warnings

Get template dependencies. Args: template_id: Template ID user_id: Optional user ID (admin only) Returns: List of template dependencies

Optimize a template for better performance. Args: template_id: Template ID to optimize user_id: Optional user ID (admin only) Returns: Optimization result

Get comprehensive metrics for the range. Args: user_id: Optional user ID (admin only) Returns: Range metrics (CPU, memory, disk, network usage)

Get metrics for a specific deployment. Args: deployment_id: Optional deployment ID (defaults to current) user_id: Optional user ID (admin only) Returns: Deployment metrics

Get cost estimation for the range. Args: user_id: Optional user ID (admin only) Returns: Cost estimation based on resource usage

Export metrics data. Args: format: Export format (json, csv, prometheus) start_time: Optional start time for metrics (ISO format) end_time: Optional end time for metrics (ISO format) ...

Get Ansible inventory for the range. Args: user_id: Optional user ID (admin only) Returns: Ansible inventory in INI format

Get SSH config for the range. Args: user_id: Optional user ID (admin only) Returns: SSH config content

Get RDP configuration files for the range. Args: user_id: Optional user ID (admin only) Returns: Dictionary of VM names to RDP config content

Get /etc/hosts entries for the range. Args: user_id: Optional user ID (admin only) Returns: /etc/hosts content

Test network connectivity between VMs. Args: source_vm: Source VM name target_vm: Target VM name protocol: Protocol to test (tcp, udp, icmp) port: Optional port number for tcp/udp ...

Get network topology visualization data. Args: user_id: Optional user ID (admin only) Returns: Network topology data

Diagnose network connectivity issues. Args: user_id: Optional user ID (admin only) Returns: Network diagnostics report

Capture network traffic on a VM. Args: vm_name: VM name to capture traffic from interface: Network interface to capture on duration: Capture duration in seconds filter: Optional BPF f...

Generate visualization data for the range. Args: user_id: Optional user ID (admin only) Returns: Visualization data (network diagram, topology, etc.)

Run health checks on all VMs in the range. Args: user_id: Optional user ID (admin only) Returns: Health check results for all VMs

Create a deployment pipeline with multiple stages. Args: name: Pipeline name stages: List of pipeline stages with configurations triggers: Optional trigger conditions (schedule, webhook, ...

Schedule recurring tasks for the range. Args: tasks: List of tasks to schedule schedule: Cron expression for scheduling user_id: Optional user ID (admin only) Returns: Task schedulin...

Configure auto-scaling for the range. Args: enable: Enable or disable auto-scaling min_vms: Minimum number of VMs max_vms: Maximum number of VMs scaling_policy: Scaling policy configu...

Schedule automatic snapshots for VMs. Args: vm_names: List of VM names to snapshot schedule: Cron expression for snapshot schedule retention_count: Number of snapshots to retain user_...

Clone the current range to another user. Args: target_user_id: User ID to clone range to include_snapshots: Whether to include snapshots in clone user_id: Optional user ID (admin only) R...

Export range backup. Args: include_vms: Include VM disk images in backup include_config: Include configuration in backup user_id: Optional user ID (admin only) Returns: Backup export...

Import and restore range from backup. Args: backup_file: Path to backup file restore_vms: Restore VM disk images restore_config: Restore configuration user_id: Optional user ID (admin...

Perform bulk operations on multiple VMs. Args: operation: Operation to perform (power_on, power_off, snapshot, delete) vm_names: Optional list of VM names (defaults to all VMs) parameters...

Delete the entire range. Permanently removes the range and all associated VMs, snapshots, and data. **Important:** If a deployment is in progress, abort it first with `abort_range_deployment()`. Ar...

Abort any active deployment and then remove the range. This is a convenience function that combines abort_range_deployment() and delete_range(). Equivalent to running: 1. `ludus range abort` 2. `ludu...

Get recovery recommendations for failed deployments. Args: user_id: Optional user ID (admin only) Returns: Recovery recommendations based on failure analysis

Manage webhook integrations. Args: action: Action to perform (create, update, delete, list, test) webhook_url: Webhook URL (for create/update) events: List of events to trigger webhook (f...

Configure Slack notifications. Args: action: Action to perform (enable, disable, test, configure) webhook_url: Slack webhook URL channel: Slack channel name events: List of events to ...

Integrate with Jira for issue tracking. Args: action: Action to perform (configure, create_issue, update_issue, link_deployment) jira_url: Jira instance URL project_key: Jira project key ...

Sync range configurations with Git repository. Args: action: Action to perform (configure, sync, status) repo_url: Git repository URL branch: Git branch to sync with sync_direction: S...

Generate comprehensive documentation for the range. Args: format: Documentation format (markdown, html, pdf) include_network_diagram: Include network topology diagram include_credentials:...

Generate attack path documentation for a scenario. Args: scenario_key: Optional scenario key (defaults to current deployment) user_id: Optional user ID (admin only) Returns: Attack path ...

Export lab guide for training purposes. Args: scenario_key: Optional scenario key (defaults to current deployment) format: Export format (markdown, html, pdf) include_solutions: Include s...

Create a scenario playbook for training. Args: scenario_key: Scenario identifier title: Playbook title description: Playbook description objectives: Learning objectives steps: Lis...

Share range configuration with other users. Args: target_user_ids: List of user IDs to share with make_public: Make configuration publicly accessible permissions: Permissions to grant (re...

Import a scenario from the community repository. Args: scenario_url: URL to community scenario user_id: Optional user ID (admin only) Returns: Import result with scenario information

Publish a scenario to the community repository. Args: scenario_key: Scenario to publish title: Scenario title description: Scenario description tags: Optional tags for categorization ...

List available range templates from the community. Args: user_id: Optional user ID (admin only) Returns: List of range templates

Get a specific range template configuration. Args: template_id: Range template ID user_id: Optional user ID (admin only) Returns: Range template configuration

Get resource quotas and current usage. Args: user_id: Optional user ID (admin only) Returns: Resource quotas and usage information

Optimize resource allocation for the range. Args: user_id: Optional user ID (admin only) Returns: Optimization recommendations and applied changes

Schedule a maintenance window for the range. Args: start_time: Start time in ISO format duration_minutes: Duration in minutes operations: List of operations to perform during maintenance ...

Interactively build a range using natural language prompts. Args: prompt: Natural language description of desired range user_id: Optional user ID (admin only) Returns: Suggested configur...

Build a range configuration from a natural language prompt. Args: prompt: Natural language description of desired range auto_deploy: Automatically deploy after building configuration user...

List all ranges (admin only). Args: user_id: Optional user ID (must be admin) Returns: List of all ranges in the system

Create snapshots for multiple VMs in parallel. This is much faster than creating snapshots sequentially, especially for large numbers of VMs. Args: vm_names: List of VM names to snapshot sna...

Rollback multiple VMs to a snapshot in parallel. Args: vm_names: List of VM names to rollback snapshot_name: Name of snapshot to rollback to user_id: Optional user ID (admin only) Return...

Remove snapshots from multiple VMs in parallel. Args: vm_names: List of VM names snapshot_name: Name of snapshot to remove user_id: Optional user ID (admin only) Returns: Results for...

Power on multiple VMs in parallel. Args: vm_names: List of VM names to power on user_id: Optional user ID (admin only) Returns: Results for each VM Example: result = await batch_pow...

Power off multiple VMs in parallel. Args: vm_names: List of VM names to power off user_id: Optional user ID (admin only) Returns: Results for each VM

Get status of multiple VMs in parallel. Args: vm_names: List of VM names user_id: Optional user ID (admin only) Returns: Status for each VM

Create a custom OS template with specific packages and configuration. This tool allows you to create custom Ludus templates from ANY operating system by providing an ISO URL. The OS type can be auto-...

Create a Kali Linux weekly template with automatic latest ISO detection. Automatically fetches the latest Kali Linux weekly ISO and checksum from https://cdimage.kali.org/kali-weekly/. The ISO URL an...

Get common ISO download URLs for popular operating systems. Returns a reference of ISO download URLs for various operating systems that can be used with create_custom_os_template. Returns: Dicti...

Build a custom container-based template for applications. This tool creates templates specifically designed to run Docker containers, perfect for deploying applications like Splunk, Wazuh, Grafana, e...

Get pre-configured container definitions for common applications. Returns a dictionary of common application containers (Splunk, Wazuh, ELK, Nginx, PostgreSQL, Redis, Grafana) that can be used with c...

Create a custom range configuration based on an existing scenario. This tool takes an existing scenario and allows you to customize it with your own modifications (add/remove VMs, change specs, modif...

Build a completely custom range configuration from scratch. This tool allows you to create a range configuration with full control over every VM and network rule, not based on any existing scenario. ...

Export a range configuration to a YAML file for download. This tool exports range configurations to YAML format that users can download and use with Ludus. The YAML content is provided in the respons...

Get the current range configuration and prepare it for download. This tool retrieves your currently deployed range configuration from Ludus and provides it in YAML format for download. Users can then...

Clone an existing scenario and modify it to create a new custom scenario. This is useful for creating variations of existing scenarios (e.g., "ad-basic" with more workstations, or "web-basic" with di...

Build a custom range configuration from a natural language description. This tool intelligently parses your description and automatically builds a complete range configuration with appropriate VMs, n...

List all available VM skeleton templates. Returns a dictionary of VM skeleton names and their descriptions. These skeletons can be used as starting points for building custom VMs. Categories include...

Get a specific VM skeleton template configuration. Retrieves a pre-configured VM skeleton that can be used directly in a range configuration or customized further. Args: name: Skeleton name (e.g...

List all available range skeleton templates. Returns a dictionary of complete range configurations for common scenarios. These provide fully-configured lab environments ready for deployment. Availab...

Get a complete range skeleton configuration. Retrieves a fully-configured range skeleton with all VMs and network rules. Some skeletons support additional customization parameters. Args: name: S...

List all available YAML configuration examples. Returns ready-to-use YAML configuration examples that can be directly saved to a file and deployed with Ludus. Available examples: - basic_ad: Basic A...

Get a ready-to-use YAML configuration example. Returns the complete YAML content for a specific example configuration. The YAML can be saved directly to a file and deployed with Ludus. Args: nam...

Build a complete range configuration starting from a skeleton. Combines the power of skeleton templates with custom modifications. Start with a base skeleton and add/remove VMs as needed. Args: ...

List all ranges with detailed information including identification. This tool provides comprehensive information about all ranges in the system, making it easy to identify which range belongs to whic...

Get detailed information about a specific user's range. Args: user_id: User ID whose range to retrieve Returns: Detailed range information for the specified user Example: # Get range in...

Find which range contains a specific VM by name. Args: vm_name: Name of the VM to search for Returns: Range information containing the VM, or None if not found Example: # Find which ran...

Delete a specific user's range (requires confirmation). This tool allows you to selectively delete a single range by user ID, rather than destroying all ranges. Requires explicit confirmation. Args:...

Delete all ranges matching a specific status (requires confirmation). Useful for cleaning up failed deployments or test ranges. Args: status_filter: Status to filter by (e.g., "ERROR", "FAILED",...

Delete all ranges EXCEPT those belonging to specified users. Useful for cleaning up test/temporary ranges while keeping production ones. Args: keep_user_ids: List of user IDs whose ranges should...

Generate a complete Ludus range configuration from natural language description. This is an enhanced AI-powered version of build_range_from_description that provides: - Better natural language unders...

Explain the design decisions and best practices for a range configuration request. This tool helps users understand WHY certain choices are made when building a cyber range, providing educational val...

Suggest enhancements to improve a range configuration. Given a basic range description, this tool suggests additional components, capabilities, and improvements to make the range more realistic, educ...

Apply adversary profile to inject realistic vulnerabilities for red team training. This tool transforms an existing Ludus configuration by injecting educational vulnerabilities that simulate real-wor...

Apply defender profile to add monitoring and detection capabilities for blue team training. This tool enhances an existing Ludus configuration with comprehensive security monitoring, logging, and det...

List all available adversary and defender profiles with descriptions. Returns detailed information about all available security profiles, their capabilities, and use cases. Returns: Dictionary c...

Preview changes that would be made by applying a profile without modifying the config. This is a dry-run tool that shows what would happen if you applied a profile, without actually modifying the con...

List all installed Ansible roles on the Ludus server. Uses the ludus CLI with --url when available for reliable remote access. Falls back to HTTP API if CLI is not available. Returns: Dictionary...

Check if a specific Ansible role is installed. Uses the ludus CLI with --url when available for reliable remote access. Falls back to HTTP API if CLI is not available. No SSH required. Args: rol...

Install an Ansible role on the Ludus server via MCP. This MCP tool automatically handles: - Galaxy roles (installed directly from Ansible Galaxy, e.g., "badsectorlabs.ludus_adcs") - Directory-based r...

Get the list of required Ansible roles for a specific scenario. Use this MCP tool to check which roles are needed before deploying a scenario. Then use `ensure_scenario_roles()` to automatically inst...

Configure SSH access for automatic role installation on Ludus server. This allows the MCP server to automatically clone and install directory-based roles (like ludus-ad-content) directly on the Ludus...

Ensure all required roles for a scenario are installed, installing missing ones automatically. **This is the recommended MCP tool to use before deploying a scenario.** It will: 1. Check which roles a...

Get information about a specific role, including installation method and requirements. Uses the ludus CLI with --url when available for reliable remote access. No SSH required for checking role infor...

Install an Ansible role directly from Ansible Galaxy. This is the simplest way to install roles. Provide the Galaxy role name in the format 'namespace.role_name' and it will be installed on the Ludus...

Install an Ansible role from a custom Git repository URL. Use this to install roles from custom Git repositories that are not on Ansible Galaxy. The repository will be cloned on the Ludus server and ...

Get a list of commonly used Ansible Galaxy roles for Ludus scenarios. Returns a curated list of Galaxy roles that are frequently used in security lab scenarios, along with their descriptions and exam...

List all roles that are available from GitHub repositories (directory-based roles). These roles must be cloned on the Ludus server before installation. Returns: Dictionary with available role re...