asc.xhack.students_vms role – This role deploys the students Virtual Machines for the xHack infrastructure.

Note

This role is part of the asc.xhack collection (version 1.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 – This role deploys the students Virtual Machines for the xHack infrastructure.

New in asc.xhack 1.0.0

Synopsis

  • This role deploys the students Virtual Machines for the xHack infrastructure.

  • When using this role, you need to accept the Market Place terms and conditions for the Kali Linux image. This can be done by running the following command: `az vm image terms accept –urn kali-linux:kali:kali-20231:2023.1.0 –subscription <subscription_name_or_id>`

  • The VM will be named `s<student_id><vm_suffix>`, where `student_id` is the student ID and `vm_suffix` defined in the configuration. E.g. `s01kali` for student 1 and Kali Linux (using default suffix).

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_B2ms"

vm_suffix

string

Suffix to use for the VM name

Default: "kali"

win10

dictionary

Configuration options for the Windows 10 VM

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_B2ms"

vm_suffix

string

Suffix to use for the VM name

Default: "win10"

Authors

  • Lorenzo Bernardi