W3cubDocs

/Ansible

community.general.chef_databag lookup – fetches data from a Chef Databag

Note

This lookup plugin is part of the community.general collection (version 10.7.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this lookup plugin, see Requirements for details.

To use it in a playbook, specify: community.general.chef_databag.

Synopsis

  • This is a lookup plugin to provide access to chef data bags using the pychef package. It interfaces with the chef server API using the same methods to find a knife or chef-client config file to load parameters from, starting from either the given base path or the current working directory. The lookup order mirrors the one from Chef, all folders in the base path are walked back looking for the following configuration file in order: .chef/knife.rb, ~/.chef/knife.rb, /etc/chef/client.rb.

Requirements

The below requirements are needed on the local controller node that executes this lookup.

Keyword parameters

This describes keyword parameters of the lookup. These are the values key1=value1, key2=value2 and so on in the following examples: lookup('community.general.chef_databag', key1=value1, key2=value2, ...) and query('community.general.chef_databag', key1=value1, key2=value2, ...)

Parameter

Comments

item

string / required

Item to fetch.

name

string / required

Name of the databag.

Examples

- ansible.builtin.debug:
    msg: "{{ lookup('community.general.chef_databag', 'name=data_bag_name item=data_bag_item') }}"

Return Value

Key

Description

Return value

list / elements=dictionary

The value from the databag.

Returned: success

Authors

  • Unknown

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/chef_databag_lookup.html