Skip to main content

DigDeo Syspass Ansible Lookup

Project description


coverage report pipeline status

Module page:

Normal installation

python3 -m venv venv
. venv/bin/activate
pip install digdeo-syspass-ansible-lookup

Force a Ansible version

python3 -m venv venv
. venv/bin/activate
pip install wheel "ansible == 2.7.13"
pip install digdeo-syspass-ansible-lookup

Note that module use digdeo-syspass-client module Please pay attention about config.yml file.

This module has been heavily inspired by for password generation and term handling and thus is under GPL.

lookup: syspass
author: Gousseaud Gaëtan <>, Pierre-Henry Muller <>
short_description: get syspass user password and syspass API client
- This lookup returns the contents from Syspass database, a user's password more specificly. Other functions are also implemented for further use.
ansible_version: ansible 2.6.2 with mitogen
python_version: 2.7.9
syspass_version: 3.0 Beta (300.18082701)


  • term: the account name (required and must be unique)
  • login: login given to created account
  • category: category given to created account
  • customer: client given to created account
  • state: like in Ansible absent to remove the password, present in default to create (Optional)
  • pass_length: generated password length (Optional)
  • chars: type of chars used in generated (Optional)
  • url: url given to created account (Optional)
  • notes: notes given to created account (Optional)
  • private: is this password private for users who have access or public for all users in acl (default false)
  • privategroup: is private only for users in same group (default false)
  • expirationDate: expiration date given to created account (Optional) and not tested (no entry in webui)



syspass_API_KEY: 'API_KEY' #Found in Users & Accesses -> API AUTHORIZATION -> User token
syspass_API_ACC_TOKPWD: Password for API_KEY for Account create / view / delete password account permission in API
syspass_default_length: number of chars in password


NOTE: Default values are handled

- name: Minimum declaration to get / create password
  local_action: debug msg="{{ lookup('syspass', 'Server 1 test account', login=test, category='MySQL', customer='Customer 1') }}"

- name: All details for password declaration
  local_action: debug msg="{{ lookup('syspass', 'Server 1 test account', login=test, category='MySQL', customer='Customer 1', 
    url='https://exemp.le', notes='Additionnal infos', private=True, privategroupe=True) }}"

- name: Minimum declaration to delete password
  local_action: debug msg="{{ lookup('syspass', 'Server 1 test account', state=absent) }}"

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for digdeo-syspass-ansible-lookup, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size digdeo-syspass-ansible-lookup-0.1.1.tar.gz (14.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page