diff --git a/README.md b/README.md index c1ca7cd..a5f505c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ -# ansible_role_iperf + ansible_role_iperf +==================== Ansible role to install, run and configure a iperf3 server. -``` -WORK IN PROGRESS -EVERYTHING CAN CHANGE ANY TIME -``` + variables +------------ -RTFM -https://iperf.fr/iperf-doc.php +| variable | default value | description | +| -------- | ------------- | ----------- | +| ``iperf__systemd_enable`` | ``true`` | enable and run or stop and mask the systemd iperf.service | +| ``iperf__options`` | ``'--server'`` | The option for the iperf3 Server | +| ``iperf__packages`` | ``iperf3`` | Packages to install by this role | +| ``iperf__package_state`` | ``present`` | package state. use latest for upgrading installed "{{ iperf__packages }}" | +| ``iperf__user`` | ``iperf`` | User that will run iperf3 as systemd service | +| ``iperf__group`` | ``iperf`` | Group for "{{ iperf__user }}" | +| ``submodules_versioncheck`` | ``false`` | Perform a optional simple versionscheck to prevent running a old version of this role *(recomended)* | + + DOCS +------ +Have a look at https://iperf.fr/iperf-doc.php for iperf Dokumentation Testing ---------- -This role is tested with [these github-action](https://github.com/search?q=topic%3Acheck-ansible+topic%3Agithub-actions+org%3Aroles-ansible&type=Repositories) tests for different versions of differen linux systems. Linting is tested via travis-ci and the [ansible-lint action](https://github.com/marketplace/actions/ansible-lint). -If you want to find out more about our tests, please have a look at the github marketplace. - +Linting of this role is tested using github actions. If you know a great way to test systemd stuff via github-actions please leave a note! diff --git a/defaults/main.yml b/defaults/main.yml index e78aeff..2f06fba 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -1,7 +1,7 @@ --- # run systemd service with an iperf3 server (Y/n) iperf__systemd_enable: true -iperf__options: '-s' +iperf__options: '--server' iperf__packages: - iperf3 diff --git a/vars/main.yml b/vars/main.yml index a7ce796..2ed3889 100644 --- a/vars/main.yml +++ b/vars/main.yml @@ -1,4 +1,4 @@ --- # versionscheck -playbook_version_number: 5 # should be a integer +playbook_version_number: 6 # should be a integer playbook_version_path: 'role-do1jlr.iperf.version'