ansible-role-vnc-server

An Ansible role for installing a VNC server.

Requirements

None.

Role Variables

Variable	Description	Default	Required
vnc_server_password	The password for the VNC user.	Defaults to a random value.	No
vnc_server_private_ssh_key	The private ssh key for the VNC user.	By default no such key is assigned to the VNC user.	No
vnc_server_public_ssh_key	The public ssh key for the VNC user.	By default no such key is assigned to the VNC user.	No
vnc_server_ssh_key_type	The case-independent SSH key type. Valid values are the key types supported by SSH: DSA, ECDSA, ECDSA_SK, ED25519, ED25519_SK, and RSA.	ed25519	No
vnc_server_username	The name of the VNC user, which will be created.	vnc	No
vnc_server_user_groups	A list of additional groups to which the VNC user should belong.	Omitted	No
vnc_server_user_uid	The UID to use for the VNC user.	Omitted	No

Dependencies

None.

Installation

This role can be installed via the command:

ansible-galaxy install --role-file path/to/requirements.yml

where requirements.yml looks like:

---
- name: vnc_server
  src: https://github.com/cisagov/ansible-role-vnc-server

and may contain other roles as well.

For more information about installing Ansible roles via a YAML file, please see the ansible-galaxy documentation.

Example Playbook

Here's how to use it in a playbook:

- hosts: all
  become: true
  become_method: sudo
  tasks:
    - name: Install VNC server
      ansible.builtin.include_role:
        name: vnc_server

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

License

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Author Information

David Redmin - david.redmin@gwe.cisa.dhs.gov