Function remove

salt/modules/grains.py:385–425

.. versionadded:: 0.17.0 Remove a value from a list in the grains config file key The grain key to remove. val The value to remove. delimiter The key can be a nested dict key. Use this parameter to specify the delimiter you use, instead of the

(key, val, delimiter=DEFAULT_TARGET_DELIM)

def remove(key, val, delimiter=DEFAULT_TARGET_DELIM):
    """
    .. versionadded:: 0.17.0

    Remove a value from a list in the grains config file

    key
        The grain key to remove.

    val
        The value to remove.

    delimiter
        The key can be a nested dict key. Use this parameter to
        specify the delimiter you use, instead of the default ``:``.
        You can now append values to a list in nested dictionary grains. If the
        list doesn't exist at this level, it will be created.

        .. versionadded:: 2015.8.2

    CLI Example:

    .. code-block:: bash

        salt '*' grains.remove key val
    """
    grains = get(key, [], delimiter)
    if not isinstance(grains, list):
        return f"The key {key} is not a valid list"
    if val not in grains:
        return f"The val {val} was not in the list {key}"
    grains.remove(val)

    while delimiter in key:
        key, rest = key.rsplit(delimiter, 1)
        _grain = get(key, None, delimiter)
        if isinstance(_grain, dict):
            _grain.update({rest: grains})
        grains = _grain

    return setval(key, grains)


def delkey(key, force=False):