deploy_range
Deploy custom cyber range configurations or resume partial deployments with optional filters for specific VMs and tasks.
Instructions
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 tool is for:
Custom configurations you've built manually
Resuming partial deployments with tags/limit
Deploying after you've already set the config via update_range_config()
This tool supports both full deployments and resuming partial deployments.
Full Deployment: deploy_range(config=configuration_dict)
Resume After Pause/Abort: deploy_range(tags="user,domain") # Run specific Ansible tags only deploy_range(limit="DC*") # Deploy only to matching VMs deploy_range(tags="user", limit="WS*") # Combine filters
Common Ansible Tags: - "base": Base system configuration - "domain": Domain join operations - "user": User creation and management - "configure": General configuration - "testing": Testing configuration Use get_range_tags() to see all available tags for your range
Args: config: Range configuration (required for full deployment, optional for resume) user_id: Optional user ID (admin only) tags: Ansible tags to run (comma-separated, e.g., "user,domain") limit: Limit to VMs matching pattern (e.g., "DC*", "WS*", "*-DC01") only_roles: Limit user-defined roles (comma-separated) force: Force deployment if testing is enabled
Returns: Deployment result
Use Cases:
1. Initial deployment: deploy_range(config=my_config)
2. Resume after abort: deploy_range(tags="user,domain")
3. Re-run specific tags: deploy_range(tags="configure")
4. Fix specific VM: deploy_range(limit="DC01")
5. Update workstations only: deploy_range(limit="WS*", tags="user")
6. After role installation: deploy_range(tags="configure")
Example Workflow - Resume After Failure: 1. abort_range_deployment() # Stop the failed deployment 2. get_range_tags() # See available tags 3. deploy_range(tags="user,domain") # Resume from specific step
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| config | No | ||
| user_id | No | ||
| tags | No | ||
| limit | No | ||
| only_roles | No | ||
| force | No |