.. _ansible.utils.consolidate_filter: ************************* ansible.utils.consolidate ************************* **Consolidate facts together on common attributes.** Version added: 2.5.2 .. contents:: :local: :depth: 1 Synopsis -------- - This plugin presents collective structured data including all supplied facts grouping on common attributes mentioned. - All other boolean parameter defaults to False unless parameters is explicitly mentioned. - Using the parameters below- ``data_source|ansible.utils.consolidate(fail_missing_match_key=False``)) Parameters ---------- .. raw:: html
Parameter Choices/Defaults Configuration Comments
data_source
list / elements=dictionary / required
This option represents a list of dictionaries to perform the operation on.
For example facts_source|ansible.utils.consolidate(fail_missing_match_key=False)), in this case facts_source represents this option.
data
raw / required
Specify facts data that gets consolidated.
match_key
string / required
Specify key to match on.
prefix
string / required
Specify the prefix with which the result set be created.
fail_duplicate
boolean
    Choices:
  • no
  • yes
Fail if duplicate values for any key is found.
fail_missing_match_key
boolean
    Choices:
  • no
  • yes
Fail if match_key is not found in a specific data set.
fail_missing_match_value
boolean
    Choices:
  • no
  • yes
Fail if a keys to match in not same accross all data sets.

Examples -------- .. code-block:: yaml # Consolidated facts example # -------------------------- ##facts.yml interfaces: - name: GigabitEthernet0/0 enabled: true duplex: auto speed: auto note: - Connected green wire - name: GigabitEthernet0/1 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: GigabitEthernet0/2 description: Configured by Ansible - Interface 2 (ADMIN DOWN) mtu: 600 enabled: false l2_interfaces: - name: GigabitEthernet0/0 - mode: access name: GigabitEthernet0/1 trunk: allowed_vlans: - "11" - "12" - "59" - "67" - "75" - "77" - "81" - "100" - 400-408 - 411-413 - "415" - "418" - "982" - "986" - "988" - "993" - mode: trunk name: GigabitEthernet0/2 trunk: allowed_vlans: - "11" - "12" - "59" - "67" - "75" - "77" - "81" - "100" - 400-408 - 411-413 - "415" - "418" - "982" - "986" - "988" - "993" encapsulation: dot1q l3_interfaces: - ipv4: - address: 192.168.0.2/24 name: GigabitEthernet0/0 - name: GigabitEthernet0/1 - name: GigabitEthernet0/2 - name: Loopback888 - name: Loopback999 ##Playbook vars_files: - "facts.yml" tasks: - name: Build the facts collection set_fact: data_source: - data: "{{ interfaces }}" match_key: name prefix: interfaces - data: "{{ l2_interfaces }}" match_key: name prefix: l2_interfaces - data: "{{ l3_interfaces }}" match_key: name prefix: l3_interfaces - name: Combine all the facts based on match_keys set_fact: combined: "{{ data_source|ansible.utils.consolidate(fail_missing_match_value=False) }}" ##Output # ok: [localhost] => { # "ansible_facts": { # "data_source": [ # { # "data": [ # { # "duplex": "auto", # "enabled": true, # "name": "GigabitEthernet0/0", # "note": [ # "Connected green wire" # ], # "speed": "auto" # }, # { # "description": "Configured by Ansible - Interface 1", # "duplex": "auto", # "enabled": true, # "mtu": 1500, # "name": "GigabitEthernet0/1", # "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": "GigabitEthernet0/2" # } # ], # "match_key": "name", # "prefix": "interfaces" # }, # { # "data": [ # { # "name": "GigabitEthernet0/0" # }, # { # "mode": "access", # "name": "GigabitEthernet0/1", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ] # } # }, # { # "mode": "trunk", # "name": "GigabitEthernet0/2", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ], # "encapsulation": "dot1q" # } # } # ], # "match_key": "name", # "prefix": "l2_interfaces" # }, # { # "data": [ # { # "ipv4": [ # { # "address": "192.168.0.2/24" # } # ], # "name": "GigabitEthernet0/0" # }, # { # "name": "GigabitEthernet0/1" # }, # { # "name": "GigabitEthernet0/2" # }, # { # "name": "Loopback888" # }, # { # "name": "Loopback999" # } # ], # "match_key": "name", # "prefix": "l3_interfaces" # } # ] # }, # "changed": false # } # Read vars_file 'facts.yml' # TASK [Combine all the facts based on match_keys] # ok: [localhost] => { # "ansible_facts": { # "combined": { # "GigabitEthernet0/0": { # "interfaces": { # "duplex": "auto", # "enabled": true, # "name": "GigabitEthernet0/0", # "note": [ # "Connected green wire" # ], # "speed": "auto" # }, # "l2_interfaces": { # "name": "GigabitEthernet0/0" # }, # "l3_interfaces": { # "ipv4": [ # { # "address": "192.168.0.2/24" # } # ], # "name": "GigabitEthernet0/0" # } # }, # "GigabitEthernet0/1": { # "interfaces": { # "description": "Configured by Ansible - Interface 1", # "duplex": "auto", # "enabled": true, # "mtu": 1500, # "name": "GigabitEthernet0/1", # "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 # } # ] # }, # "l2_interfaces": { # "mode": "access", # "name": "GigabitEthernet0/1", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ] # } # }, # "l3_interfaces": { # "name": "GigabitEthernet0/1" # } # }, # "GigabitEthernet0/2": { # "interfaces": { # "description": "Configured by Ansible - Interface 2 (ADMIN DOWN)", # "enabled": false, # "mtu": 600, # "name": "GigabitEthernet0/2" # }, # "l2_interfaces": { # "mode": "trunk", # "name": "GigabitEthernet0/2", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ], # "encapsulation": "dot1q" # } # }, # "l3_interfaces": { # "name": "GigabitEthernet0/2" # } # }, # "Loopback888": { # "interfaces": {}, # "l2_interfaces": {}, # "l3_interfaces": { # "name": "Loopback888" # } # }, # "Loopback999": { # "interfaces": {}, # "l2_interfaces": {}, # "l3_interfaces": { # "name": "Loopback999" # } # } # } # }, # "changed": false # } # Failing on missing match values # ------------------------------- ##facts.yaml interfaces: - name: GigabitEthernet0/0 enabled: true duplex: auto speed: auto note: - Connected green wire - name: GigabitEthernet0/1 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: GigabitEthernet0/2 description: Configured by Ansible - Interface 2 (ADMIN DOWN) mtu: 600 enabled: false l2_interfaces: - name: GigabitEthernet0/0 - mode: access name: GigabitEthernet0/1 trunk: allowed_vlans: - "11" - "12" - "59" - "67" - "75" - "77" - "81" - "100" - 400-408 - 411-413 - "415" - "418" - "982" - "986" - "988" - "993" - mode: trunk name: GigabitEthernet0/2 trunk: allowed_vlans: - "11" - "12" - "59" - "67" - "75" - "77" - "81" - "100" - 400-408 - 411-413 - "415" - "418" - "982" - "986" - "988" - "993" encapsulation: dot1q l3_interfaces: - ipv4: - address: 192.168.0.2/24 name: GigabitEthernet0/0 - name: GigabitEthernet0/1 - name: GigabitEthernet0/2 - name: Loopback888 - name: Loopback999 ##Playbook vars_files: - "facts.yml" tasks: - name: Build the facts collection set_fact: data_source: - data: "{{ interfaces }}" match_key: name prefix: interfaces - data: "{{ l2_interfaces }}" match_key: name prefix: l2_interfaces - data: "{{ l3_interfaces }}" match_key: name prefix: l3_interfaces - name: Combine all the facts based on match_keys set_fact: combined: "{{ data_source|ansible.utils.consolidate(fail_missing_match_value=True) }}" ##Output # ok: [localhost] => { # "ansible_facts": { # "data_source": [ # { # "data": [ # { # "duplex": "auto", # "enabled": true, # "name": "GigabitEthernet0/0", # "note": [ # "Connected green wire" # ], # "speed": "auto" # }, # { # "description": "Configured by Ansible - Interface 1", # "duplex": "auto", # "enabled": true, # "mtu": 1500, # "name": "GigabitEthernet0/1", # "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": "GigabitEthernet0/2" # } # ], # "match_key": "name", # "prefix": "interfaces" # }, # { # "data": [ # { # "name": "GigabitEthernet0/0" # }, # { # "mode": "access", # "name": "GigabitEthernet0/1", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ] # } # }, # { # "mode": "trunk", # "name": "GigabitEthernet0/2", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ], # "encapsulation": "dot1q" # } # } # ], # "match_key": "name", # "prefix": "l2_interfaces" # }, # { # "data": [ # { # "ipv4": [ # { # "address": "192.168.0.2/24" # } # ], # "name": "GigabitEthernet0/0" # }, # { # "name": "GigabitEthernet0/1" # }, # { # "name": "GigabitEthernet0/2" # }, # { # "name": "Loopback888" # }, # { # "name": "Loopback999" # } # ], # "match_key": "name", # "prefix": "l3_interfaces" # } # ] # }, # "changed": false # } # Read vars_file 'facts.yml' # TASK [Combine all the facts based on match_keys] # fatal: [localhost]: FAILED! => { # "msg": "Error when using plugin 'consolidate': 'fail_missing_match_value' reported Missing match value Loopback999, # Loopback888 in data source 0, Missing match value Loopback999, Loopback888 in data source 1" # } # Failing on missing match keys # ----------------------------- ##facts.yaml interfaces: - name: GigabitEthernet0/0 enabled: true duplex: auto speed: auto note: - Connected green wire - name: GigabitEthernet0/1 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: GigabitEthernet0/2 description: Configured by Ansible - Interface 2 (ADMIN DOWN) mtu: 600 enabled: false l2_interfaces: - name: GigabitEthernet0/0 - mode: access name: GigabitEthernet0/1 trunk: allowed_vlans: - "11" - "12" - "59" - "67" - "75" - "77" - "81" - "100" - 400-408 - 411-413 - "415" - "418" - "982" - "986" - "988" - "993" - mode: trunk name: GigabitEthernet0/2 trunk: allowed_vlans: - "11" - "12" - "59" - "67" - "75" - "77" - "81" - "100" - 400-408 - 411-413 - "415" - "418" - "982" - "986" - "988" - "993" encapsulation: dot1q l3_interfaces: - ipv4: - address: 192.168.0.2/24 inft_name: GigabitEthernet0/0 - inft_name: GigabitEthernet0/1 - inft_name: GigabitEthernet0/2 - inft_name: Loopback888 - inft_name: Loopback999 ##Playbook vars_files: - "facts.yml" tasks: - name: Build the facts collection set_fact: data_source: - data: "{{ interfaces }}" match_key: name prefix: interfaces - data: "{{ l2_interfaces }}" match_key: name prefix: l2_interfaces - data: "{{ l3_interfaces }}" match_key: name prefix: l3_interfaces - name: Combine all the facts based on match_keys set_fact: combined: "{{ data_source|ansible.utils.consolidate(fail_missing_match_key=True) }}" ##Output # ok: [localhost] => { # "ansible_facts": { # "data_source": [ # { # "data": [ # { # "duplex": "auto", # "enabled": true, # "name": "GigabitEthernet0/0", # "note": [ # "Connected green wire" # ], # "speed": "auto" # }, # { # "description": "Configured by Ansible - Interface 1", # "duplex": "auto", # "enabled": true, # "mtu": 1500, # "name": "GigabitEthernet0/1", # "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": "GigabitEthernet0/2" # } # ], # "match_key": "name", # "prefix": "interfaces" # }, # { # "data": [ # { # "name": "GigabitEthernet0/0" # }, # { # "mode": "access", # "name": "GigabitEthernet0/1", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ] # } # }, # { # "mode": "trunk", # "name": "GigabitEthernet0/2", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ], # "encapsulation": "dot1q" # } # } # ], # "match_key": "name", # "prefix": "l2_interfaces" # }, # { # "data": [ # { # "inft_name": "GigabitEthernet0/0", # "ipv4": [ # { # "address": "192.168.0.2/24" # } # ] # }, # { # "inft_name": "GigabitEthernet0/1" # }, # { # "inft_name": "GigabitEthernet0/2" # }, # { # "inft_name": "Loopback888" # }, # { # "inft_name": "Loopback999" # } # ], # "match_key": "name", # "prefix": "l3_interfaces" # } # ] # }, # "changed": false # } # Read vars_file 'facts.yml' # TASK [Combine all the facts based on match_keys] # fatal: [localhost]: FAILED! => { # "msg": "Error when using plugin 'consolidate': 'fail_missing_match_key' reported Missing match # key 'name' in data source 2 in list entry 0, Missing match key 'name' in data # source 2 in list entry 1, Missing match key 'name' in data source 2 in list # entry 2, Missing match key 'name' in data source 2 in list entry 3, Missing # match key 'name' in data source 2 in list entry 4" # } # Failing on duplicate values in facts # ------------------------------------ ##facts.yaml interfaces: - name: GigabitEthernet0/0 enabled: true duplex: auto speed: auto note: - Connected green wire - name: GigabitEthernet0/1 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: GigabitEthernet0/2 description: Configured by Ansible - Interface 2 (ADMIN DOWN) mtu: 600 enabled: false l2_interfaces: - name: GigabitEthernet0/0 - name: GigabitEthernet0/0 - mode: access name: GigabitEthernet0/1 trunk: allowed_vlans: - "11" - "12" - "59" - "67" - "75" - "77" - "81" - "100" - 400-408 - 411-413 - "415" - "418" - "982" - "986" - "988" - "993" - mode: trunk name: GigabitEthernet0/2 trunk: allowed_vlans: - "11" - "12" - "59" - "67" - "75" - "77" - "81" - "100" - 400-408 - 411-413 - "415" - "418" - "982" - "986" - "988" - "993" encapsulation: dot1q l3_interfaces: - ipv4: - address: 192.168.0.2/24 name: GigabitEthernet0/0 - name: GigabitEthernet0/1 - name: GigabitEthernet0/2 - name: Loopback888 - name: Loopback999 ##Playbook vars_files: - "facts.yml" tasks: - name: Build the facts collection set_fact: data_source: - data: "{{ interfaces }}" match_key: name prefix: interfaces - data: "{{ l2_interfaces }}" match_key: name prefix: l2_interfaces - data: "{{ l3_interfaces }}" match_key: name prefix: l3_interfaces - name: Combine all the facts based on match_keys set_fact: combined: "{{ data_source|ansible.utils.consolidate(fail_duplicate=True) }}" ##Output # ok: [localhost] => { # "ansible_facts": { # "data_source": [ # { # "data": [ # { # "duplex": "auto", # "enabled": true, # "name": "GigabitEthernet0/0", # "note": [ # "Connected green wire" # ], # "speed": "auto" # }, # { # "description": "Configured by Ansible - Interface 1", # "duplex": "auto", # "enabled": true, # "mtu": 1500, # "name": "GigabitEthernet0/1", # "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": "GigabitEthernet0/2" # } # ], # "match_key": "name", # "prefix": "interfaces" # }, # { # "data": [ # { # "name": "GigabitEthernet0/0" # }, # { # "name": "GigabitEthernet0/0" # }, # { # "mode": "access", # "name": "GigabitEthernet0/1", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ] # } # }, # { # "mode": "trunk", # "name": "GigabitEthernet0/2", # "trunk": { # "allowed_vlans": [ # "11", # "12", # "59", # "67", # "75", # "77", # "81", # "100", # "400-408", # "411-413", # "415", # "418", # "982", # "986", # "988", # "993" # ], # "encapsulation": "dot1q" # } # } # ], # "match_key": "name", # "prefix": "l2_interfaces" # }, # { # "data": [ # { # "ipv4": [ # { # "address": "192.168.0.2/24" # } # ], # "name": "GigabitEthernet0/0" # }, # { # "name": "GigabitEthernet0/1" # }, # { # "name": "GigabitEthernet0/2" # }, # { # "name": "Loopback888" # }, # { # "name": "Loopback999" # } # ], # "match_key": "name", # "prefix": "l3_interfaces" # } # ] # }, # "changed": false # } # Read vars_file 'facts.yml' # TASK [Combine all the facts based on match_keys] # fatal: [localhost]: FAILED! => { # "msg": "Error when using plugin 'consolidate': 'fail_duplicate' reported Duplicate values in data source 1" # } Status ------ Authors ~~~~~~~ - Sagar Paul (@KB-perByte) .. hint:: Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.