/ansible-role-banner

Ansible role for installing CISA banner text.

Primary LanguageShellCreative Commons Zero v1.0 UniversalCC0-1.0

ansible-role-banner

GitHub Build Status CodeQL

An Ansible role for installing the CISA login banner for the SSH server.

Note OpenSSH is installed as a dependency.

Requirements

None.

Role Variables

None.

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: banner
  src: https://github.com/cisagov/ansible-role-banner

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 CISA login banner
      ansible.builtin.include_role:
        name: banner

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

Mark Feldhousen - mark.feldhousen@gwe.cisa.dhs.gov