diff --git a/docs/docsite/rst/playbooks_lookups.rst b/docs/docsite/rst/playbooks_lookups.rst index 6a350465473..4152a795e1d 100644 --- a/docs/docsite/rst/playbooks_lookups.rst +++ b/docs/docsite/rst/playbooks_lookups.rst @@ -109,40 +109,42 @@ The Passwordstore Lookup .. versionadded:: 2.3 The ``passwordstore`` lookup enables Ansible to retrieve, create or update passwords from -the passwordstore.org ``pass`` utility. It also retrieves YAML style keys stored as multilines +the passwordstore.org_ ``pass`` utility. It also retrieves YAML style keys stored as multilines in the passwordfile. +.. _passwordstore.org: https://www.passwordstore.org + Examples -------- Basic lookup. Fails if example/test doesn't exist:: - password="{{ lookup('passwordstore', 'example/test')}}` + password="{{ lookup('passwordstore', 'example/test')}}" Create pass with random 16 character password. If password exists just give the password:: - password="{{ lookup('passwordstore', 'example/test create=true')}}` + password="{{ lookup('passwordstore', 'example/test create=true')}}" Different size password:: - password="{{ lookup('passwordstore', 'example/test create=true length=42')}}` + password="{{ lookup('passwordstore', 'example/test create=true length=42')}}" Create password and overwrite the password if it exists. As a bonus, this module includes the old password inside the pass file:: - password="{{ lookup('passwordstore', 'example/test create=true overwrite=true')}}` + password="{{ lookup('passwordstore', 'example/test create=true overwrite=true')}}" Return the value for user in the KV pair user: username:: - password="{{ lookup('passwordstore', 'example/test subkey=user')}}` + password="{{ lookup('passwordstore', 'example/test subkey=user')}}" Return the entire password file content:: - password="{{ lookup('passwordstore', 'example/test returnall=true')}}` + password="{{ lookup('passwordstore', 'example/test returnall=true')}}" The location of the password-store directory can be specified in the following ways: - Default is ~/.password-store - Can be overruled by PASSWORD_STORE_DIR environment variable - Can be overruled by 'passwordstore: path/to/.password-store' ansible setting - - Can be overrules by 'directory=path' argument in the lookup call + - Can be overruled by 'directory=path' argument in the lookup call .. _csvfile_lookup: