salt.modules.pillar¶
Extract the pillar data for this minion
-
salt.modules.pillar.ext(external, pillar=None)¶ Generate the pillar and apply an explicit external pillar
CLI Example:
- pillar : None
If specified, allows for a dictionary of pillar data to be made available to pillar and ext_pillar rendering. These pillar variables will also override any variables of the same name in pillar or ext_pillar.
New in version 2015.5.0.
salt '*' pillar.ext '{libvirt: _}'
-
salt.modules.pillar.get(key, default=<type 'exceptions.KeyError'>, merge=False, delimiter=':')¶ New in version 0.14.
Attempt to retrieve the named value from pillar, if the named value is not available return the passed default. The default return is an empty string except __opts__['pillar_raise_on_missing'] is set to True, in which case a KeyError will be raised.
If the merge parameter is set to
True, the default will be recursively merged into the returned pillar data.The value can also represent a value in a nested dict using a ":" delimiter for the dict. This means that if a dict in pillar looks like this:
{'pkg': {'apache': 'httpd'}}
To retrieve the value associated with the apache key in the pkg dict this key can be passed:
pkg:apache
- merge
Specify whether or not the retrieved values should be recursively merged into the passed default.
New in version 2014.7.0.
- delimiter
Specify an alternate delimiter to use when traversing a nested dict
New in version 2014.7.0.
CLI Example:
salt '*' pillar.get pkg:apache
-
salt.modules.pillar.item(*args, **kwargs)¶ New in version 0.16.2.
Return one or more pillar entries
- pillar : none
if specified, allows for a dictionary of pillar data to be made available to pillar and ext_pillar rendering. these pillar variables will also override any variables of the same name in pillar or ext_pillar.
New in version 2015.5.0.
CLI Examples:
salt '*' pillar.item foo salt '*' pillar.item foo bar baz
-
salt.modules.pillar.items(*args, **kwargs)¶ Calls the master for a fresh pillar and generates the pillar data on the fly
Contrast with
raw()which returns the pillar data that is currently loaded into the minion.- pillar : none
if specified, allows for a dictionary of pillar data to be made available to pillar and ext_pillar rendering. these pillar variables will also override any variables of the same name in pillar or ext_pillar.
New in version 2015.5.0.
CLI Example:
salt '*' pillar.items
-
salt.modules.pillar.keys(key, delimiter=':')¶ New in version 2015.8.0.
Attempt to retrieve a list of keys from the named value from the pillar.
The value can also represent a value in a nested dict using a ":" delimiter for the dict, similar to how pillar.get works.
- delimiter
- Specify an alternate delimiter to use when traversing a nested dict
CLI Example:
salt '*' pillar.keys web:sites
-
salt.modules.pillar.ls(*args)¶ New in version 2015.8.0.
Calls the master for a fresh pillar, generates the pillar data on the fly (same as
items()), but only shows the available main keys.CLI Examples:
salt '*' pillar.ls
-
salt.modules.pillar.obfuscate(*args)¶ New in version 2015.8.0.
Same as
items(), but replace pillar values with a simple type indication.This is useful to avoid displaying sensitive information on console or flooding the console with long output, such as certificates. For many debug or control purposes, the stakes lie more in dispatching than in actual values.
In case the value is itself a collection type, obfuscation occurs within the value. For mapping types, keys are not obfuscated. Here are some examples:
'secret password'becomes'<str>'['secret', 1]becomes['<str>', '<int>']{'login': 'somelogin', 'pwd': 'secret'}becomes{'login': '<str>', 'pwd': '<str>'}
CLI Examples:
salt '*' pillar.obfuscate
-
salt.modules.pillar.raw(key=None)¶ Return the raw pillar data that is currently loaded into the minion.
Contrast with
items()which calls the master to fetch the most up-to-date Pillar.CLI Example:
salt '*' pillar.rawWith the optional key argument, you can select a subtree of the pillar raw data.:
salt '*' pillar.raw key='roles'
