Variables

The following variables are supported:

packages

List of packages to install via apt.

This list can be modified by passing a packages array when including the role on a playbook or via –extra-vars from a terminal.

This variable is empty by default.

# Including from terminal.
ansible localhost -m include_role -a name=constrict0r.aptitude -K -e \
    "{packages: [gedit, rolldice]}"

# Including on a playbook.
- hosts: servers
  roles:
    - role: constrict0r.aptitude
      packages:
        - gedit
        - rolldice

# To a playbook from terminal.
ansible-playbook -i tests/inventory tests/test-playbook.yml -K -e \
    "{packages: [gedit, rolldice]}"

packages_purge

List of packages to purge using apt.

This list can be modified by passing a packages_purge array when including the role on a playbook or via –extra-vars from a terminal.

This variable is empty by default.

# Including from terminal.
ansible localhost -m include_role -a name=constrict0r.aptitude -K -e \
    "{packages_purge: [gedit, rolldice]}"

# Including on a playbook.
- hosts: servers
  roles:
    - role: constrict0r.aptitude
      packages_purge:
        - gedit
        - rolldice

# To a playbook from terminal.
ansible-playbook -i tests/inventory tests/test-playbook.yml -K -e \
    "{packages_purge: [gedit, rolldice]}"

configuration

Absolute file path or URL to a .yml file that contains all or some of the variables supported by this role.

It is recommended to use a .yml or .yaml extension for the configuration file.

This variable is empty by default.

# Using file path.
ansible localhost -m include_role -a name=constrict0r.aptitude -K -e \
    "configuration=/home/username/my-config.yml"

# Using URL.
ansible localhost -m include_role -a name=constrict0r.aptitude -K -e \
    "configuration=https://my-url/my-config.yml"

To see how to write a configuration file see the YAML file format section.