asc.ap.ap_kali role – This role deploys Kali Linux Virtual Machines

Note

This role is part of the asc.ap 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/ap $HOME/.ansible/collections/ansible_collections/asc/ap.

To use it in a playbook, specify: asc.ap.ap_kali.

Entry point main – This role deploys Kali Linux Virtual Machines

New in asc.ap 1.0.0

Synopsis

  • This role deploys Kali Linux Virtual Machines

  • 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>`

Parameters

Parameter

Comments

ap_kali

dictionary

Configuration options for the `ap_kali` role.

enabled

boolean

Whether to enable the role

Choices:

  • false ← (default)

  • true

vms

list / elements=dictionary

Virtual Machines to deploy (see example file for details)

admins

list / elements=string

List of users that’ll be able to get admin access to the VM (through Guacamole / AAD SSH - if enabled)

Default: []

enable_aad_ssh

boolean

Whether to enable AAD SSH authentication

Choices:

  • false ← (default)

  • true

enable_disk_encryption

boolean

Whether to enable disk encryption

Choices:

  • false

  • true ← (default)

extra_tags

dictionary

Extra tags to add to the VM Example: `{‘engagement_code’: ‘I-12345678’, ‘project’: ‘myproject’}`

Default: {}

guac_title

string

The title to use for the Guacamole connection

Default: "Kali - <vm_name>"

public_ip

boolean

Whether to assign a public IP to the VM

Choices:

  • false ← (default)

  • true

vm_name

string

The name of the VM

vm_size

string

The size of the VM

Default: "Standard_B2ms"

Authors

  • Lorenzo Bernardi