/ home / ansible / ansible.utils / 4.0.0 / filter / keep_keys

ansible.utils.keep_keys (4.0.0) — filter

Keep specific keys from a data recursively.

| "added in version" 2.5.0 of ansible.utils"

Authors: Sagar Paul (@KB-perByte)

Install collection

Install with ansible-galaxy collection install ansible.utils:==4.0.0

Add to requirements.yml

  collections:
    - name: ansible.utils
      version: 4.0.0

Description

This plugin keep only specified keys from a provided data recursively.

Matching parameter defaults to equals unless C(matching_parameter) is explicitly mentioned.

Using the parameters below- C(data|ansible.utils.keep_keys(target([....])))

Usage examples

Scanned by Steampunk Spotter


# example.yaml
# interfaces:
#   - name: eth0
#     enabled: true
#     duplex: auto
#     speed: auto
#     note:
#       - Connected green wire
#   - name: eth1
#     description: Configured by Ansible - Interface 1
#     mtu: 1500
#     speed: auto
#     duplex: auto
#     enabled: true
#     note:
#       - Connected blue wire
#       - Configured by Paul
#     vifs:
#       - vlan_id: 100
#         description: Eth1 - VIF 100
#         mtu: 400
#         enabled: true
#         comment: Needs reconfiguration
#       - vlan_id: 101
#         description: Eth1 - VIF 101
#         enabled: true
#   - name: eth2
#     description: Configured by Ansible - Interface 2 (ADMIN DOWN)
#     mtu: 600
#     enabled: false

# Playbook
- name: keep selective keys from dict/list of dict data
  ansible.builtin.set_fact:
    data: '{{ interfaces }}'

Scanned by Steampunk Spotter

- debug:
    msg: >-
      {{ data|ansible.utils.keep_keys(target=['description', 'name', 'mtu',
      'duplex', 'enabled', 'vifs', 'vlan_id']) }}

Scanned by Steampunk Spotter

# Output
# TASK [keep selective keys from python dict/list of dict] ****************************************************************************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": [
#             {
#                 "duplex": "auto",
#                 "enabled": true,
#                 "name": "eth0",
#                 "note": [
#                     "Connected green wire"
#                 ],
#                 "speed": "auto"
#             },
#             {
#                 "description": "Configured by Ansible - Interface 1",
#                 "duplex": "auto",
#                 "enabled": true,
#                 "mtu": 1500,
#                 "name": "eth1",
#                 "note": [
#                     "Connected blue wire",
#                     "Configured by Paul"
#                 ],
#                 "speed": "auto",
#                 "vifs": [
#                     {
#                         "comment": "Needs reconfiguration",
#                         "description": "Eth1 - VIF 100",
#                         "enabled": true,
#                         "mtu": 400,
#                         "vlan_id": 100
#                     },
#                     {
#                         "description": "Eth1 - VIF 101",
#                         "enabled": true,
#                         "vlan_id": 101
#                     }
#                 ]
#             },
#             {
#                 "description": "Configured by Ansible - Interface 2 (ADMIN DOWN)",
#                 "enabled": false,
#                 "mtu": 600,
#                 "name": "eth2"
#             }
#         ]
#     },
#     "changed": false
# }
# Read vars_file 'example.yaml'

# TASK [debug] *************************************************************************************************************
# ok: [localhost] => {
#     "msg": [
#         {
#             "duplex": "auto",
#             "enabled": true,
#             "name": "eth0"
#         },
#         {
#             "description": "Configured by Ansible - Interface 1",
#             "duplex": "auto",
#             "enabled": true,
#             "mtu": 1500,
#             "name": "eth1",
#             "vifs": [
#                 {
#                     "description": "Eth1 - VIF 100",
#                     "enabled": true,
#                     "mtu": 400,
#                     "vlan_id": 100
#                 },
#                 {
#                     "description": "Eth1 - VIF 101",
#                     "enabled": true,
#                     "vlan_id": 101
#                 }
#             ]
#         },
#         {
#             "description": "Configured by Ansible - Interface 2 (ADMIN DOWN)",
#             "enabled": false,
#             "mtu": 600,
#             "name": "eth2"
#         }
#     ]
# }

# Playbook

- name: keep selective keys from dict/list of dict data
  ansible.builtin.set_fact:
    data: "{{ interfaces }}"

Scanned by Steampunk Spotter

- debug:
    msg: "{{ data|ansible.utils.keep_keys(target=['desc', 'name'], matching_parameter= 'starts_with') }}"

Inputs

    
data:
    description:
    - This option represents a list of dictionaries or a dictionary with any level of
      nesting data.
    - For example C(config_data|ansible.utils.keep_keys(target([....]))), in this case
      C(config_data) represents this option.
    required: true
    type: raw

target:
    description: Specify the target keys to keep in list format.
    elements: str
    required: true
    type: list

matching_parameter:
    choices:
    - starts_with
    - ends_with
    - regex
    description: Specify the matching configuration of target keys and data attributes.
    type: str