asc.xhack.students_vms role – Deploy the per-student Kali and Windows 10 VMs

Note

This role is part of the asc.xhack collection (version 2.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: git clone git@ssh.dev.azure.com:v3/cloudasc/iac-ansible-collections/xhack $HOME/.ansible/collections/ansible_collections/asc/xhack.

To use it in a playbook, specify: asc.xhack.students_vms.

Entry point main – Deploy the per-student Kali and Windows 10 VMs

New in asc.xhack 1.0.0

Synopsis

  • Deploys the per-student attack VMs for the eXtreme Hacking environment - a Kali Linux host and/or a Windows 10 client per student, with optional Cobalt Strike and Stage1 tooling and optional lab domain join, driven by students_vms_config.

  • The Kali marketplace image requires its terms to be accepted once per subscription with az vm image terms accept before the first deployment.

Parameters

Parameter

Comments

student_vms

dictionary

Configuration options for the `student_vms` role.

enabled

boolean

Whether to enable the role

Choices:

  • false ← (default)

  • true

kali

dictionary

Configuration options for the Kali Linux VM

enabled

boolean

Whether to enable the Kali Linux VM

Choices:

  • false ← (default)

  • true

monitor

boolean

Whether to enable monitoring of the VM

Choices:

  • false ← (default)

  • true

vm_size

string

Size of the VM to deploy (Azure VM size)

Default: "Standard_B2as_v2"

vm_suffix

string

Suffix to use for the VM name

Default: "kali"

win10

dictionary

Configuration options for the Windows 10 VM

domain_joined

boolean

Whether to join the VM to the lab_dc01 domain

Choices:

  • false ← (default)

  • true

enabled

boolean

Whether to enable the Windows 10 VM

Choices:

  • false ← (default)

  • true

monitor

boolean

Whether to enable monitoring of the VM

Choices:

  • false ← (default)

  • true

vm_size

string

Size of the VM to deploy (Azure VM size)

Default: "Standard_B2as_v2"

vm_suffix

string

Suffix to use for the VM name

Default: "win10"

students_vms_config

dictionary

added in asc.xhack 2.0.0

Configuration of the per-student Kali and Windows 10 VMs.

enabled

boolean

Whether to deploy the student VMs.

Choices:

  • false ← (default)

  • true

kali

dictionary

Kali VM settings.

enabled

boolean

Whether to deploy a Kali VM per student.

Choices:

  • false ← (default)

  • true

monitor

boolean

Whether to enrol the VM in monitoring.

Choices:

  • false ← (default)

  • true

vm_size

string

Azure VM size.

Default: "Standard_B2as_v2"

vm_suffix

string

Suffix appended to the VM name.

Default: "kali"

win10

dictionary

Windows 10 VM settings.

domain_joined

boolean

Whether to join the VM to the lab domain.

Choices:

  • false ← (default)

  • true

enabled

boolean

Whether to deploy a Windows 10 VM per student.

Choices:

  • false ← (default)

  • true

monitor

boolean

Whether to enrol the VM in monitoring.

Choices:

  • false ← (default)

  • true

tools

list / elements=string

Extra tooling to install on the VM.

Choices:

  • "cobaltstrike"

  • "stage1"

Default: []

vm_size

string

Azure VM size.

Default: "Standard_B2as_v2"

vm_suffix

string

Suffix appended to the VM name.

Default: "win10"

Authors

  • Ignace De Cock