onepassword - fetch field values from 1Password
New in version 2.6.
Synopsis
- onepassword wraps the
op
command line utility to fetch specific field values from 1Password
Requirements
The below requirements are needed on the local master node that executes this lookup.
-
op
1Password command line utility. See https://support.1password.com/command-line/ - must have already logged into 1Password using
op
CLI
Parameters
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
_terms
required
|
identifier(s) (UUID, name or domain; case-insensitive) of item(s) to retrieve
|
||
field | Default:
"password"
|
field to return from each matching item (case-insensitive)
|
|
section | Default:
"None"
|
item section containing the field to retrieve (case-insensitive); if absent will return first match from any section
|
|
vault | Default:
"None"
|
vault containing the item to retrieve (case-insensitive); if absent will search all vaults
|
Examples
- name: "retrieve password for KITT" debug: msg: "{{ lookup('onepassword', 'KITT') }}" - name: "retrieve password for Wintermute" debug: msg: "{{ lookup('onepassword', 'Tessier-Ashpool', section='Wintermute') }}" - name: "retrieve username for HAL" debug: msg: "{{ lookup('onepassword', 'HAL 9000', field='username', vault='Discovery') }}"
Return Values
Common return values are documented here, the following are the fields unique to this lookup:
Key | Returned | Description |
---|---|---|
_raw |
field data requested
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This lookup is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Scott Buchanan <sbuchanan@ri.pn>
- Andrew Zenk <azenk@umn.edu>
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/plugins/lookup/onepassword.html