Setup

Install

Galaxy

Installing directly from ansible galaxy is likely the easiest way and recommended.

For installing into your default ansible collections path:

ansible-galaxy collection install sedi.openaudit

If you want to install in a different collections path (must be enabled in your ansible.cfg):

ansible-galaxy collection install sedi.openaudit [-p <collection-path>]

Git

If you cannot or do not want to install from Ansible Galaxy you can always use the git way as well.

For installing into your default ansible collections path:

ansible-galaxy collection install git+https://github.com/secure-diversITy/ansible_openaudit

If you want to install in a different collections path (must be enabled in your ansible.cfg):

ansible-galaxy collection install git+https://github.com/secure-diversITy/ansible_openaudit [-p <collection-path>]

Uninstall

1. rm -rf <collection-path>/ansible_collections/sedi/openaudit/
   (e.g. on linux <collection-path> is ~/.ansible/collections).
   If you specified a non-standard path in the installation step choose that path, obviously.
2. remove sedi.openaudit.inventory from the [inventory] stanza of your ansible.cfg

Upgrade

Option a:

1. force install with ansible-galaxy collection install --force-with-deps

Option b:

1. Follow topic "Uninstall" (but skip step-2, i.e skip the ansible.cfg removal)
2. Follow topic "Install"

Open-AudIT configuration

1. Create a specific API user account (Users -> Create User)
2. Ensure you set proper permissions:
   • Roles (* indicates mandatory permission, rest depends on what you want to do later):
     • Endpoint devices: Create, Read*, Update, Delete
     • Endpoint orgs: Create, Read*, Update, Delete
     • Endpoint locations: Create, Read*, Update, Delete
     • Hint: when using the community edition which does not allow to create custom roles, you have to use one of the following available roles:
       • user: when using the dynamic inventory only
       • org_admin: if you want to use the action plugin (e.g. add, update a device etc)
   • Organisations (checkbox list):
     Grant permission to all orgs this account should has access to. Note: selecting a parent will automatically provide access to its children (although it won't be indicated here).

You need these created credentials for the next steps in "Module configuration"

Module configuration

Dynamic Inventory

See Dynamic Inventory Configuration

Action Module

See Action Module Configuration