a-c-m
/
ansible.utils
mirror of https://github.com/ansible-collections/ansible.utils.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ansible.utils/plugins/filter/consolidate.py

1243 lines
38 KiB
Python
Raw Normal View History

init code
2022-04-04 12:25:01 +00:00
#
# -*- coding: utf-8 -*-
update 1
2022-04-04 15:26:07 +00:00
# Copyright 2022 Red Hat
init code
2022-04-04 12:25:01 +00:00
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
"""
The consolidate filter plugin
"""
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
name: consolidate
author: Sagar Paul (@KB-perByte)
docs and examples
2022-04-04 14:32:43 +00:00
version_added: "2.5.2"
short_description: Consolidate facts together on common attributes.
init code
2022-04-04 12:25:01 +00:00
description:
docs and examples
2022-04-04 14:32:43 +00:00
- This plugin presents a 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- C(data_source|ansible.utils.consolidate(fail_missing_match_key=False)))
init code
2022-04-04 12:25:01 +00:00
options:
data_source:
description:
docs and examples
2022-04-04 14:32:43 +00:00
- This option represents a list of dictionaries to perform the operation on.
- For example C(facts_source|ansible.utils.consolidate(fail_missing_match_key=False))), in this case C(facts_source) represents this option.
init code
2022-04-04 12:25:01 +00:00
type: list
elements: dict
suboptions:
data:
docs and examples
2022-04-04 14:32:43 +00:00
description: Specify facts data that gets consolidated.
init code
2022-04-04 12:25:01 +00:00
type: raw
match_key:
docs and examples
2022-04-04 14:32:43 +00:00
description: Specify key to match on.
init code
2022-04-04 12:25:01 +00:00
type: str
prefix:
docs and examples
2022-04-04 14:32:43 +00:00
description: Specify the prefix with which the result set be created.
init code
2022-04-04 12:25:01 +00:00
type: str
fail_missing_match_key:
docs and examples
2022-04-04 14:32:43 +00:00
description: Fail if match_key is not found in a specific data set.
init code
2022-04-04 12:25:01 +00:00
type: bool
fail_missing_match_value:
docs and examples
2022-04-04 14:32:43 +00:00
description: Fail if a keys to match in not same accross all data sets.
init code
2022-04-04 12:25:01 +00:00
type: bool
fail_duplicate:
docs and examples
2022-04-04 14:32:43 +00:00
description: Fail if duplicate values for any key is found.
init code
2022-04-04 12:25:01 +00:00
type: bool
"""
EXAMPLES = r"""
docs and examples
2022-04-04 14:32:43 +00:00
# Consolidated facts example
# ------------
##facts.yml
init code
2022-04-04 12:25:01 +00:00
interfaces:
docs and examples
2022-04-04 14:32:43 +00:00
- name: GigabitEthernet0/0
init code
2022-04-04 12:25:01 +00:00
enabled: true
duplex: auto
speed: auto
note:
- Connected green wire
docs and examples
2022-04-04 14:32:43 +00:00
- name: GigabitEthernet0/1
init code
2022-04-04 12:25:01 +00:00
description: Configured by Ansible - Interface 1
mtu: 1500
speed: auto
duplex: auto
enabled: true
note:
- Connected blue wire
- Configured by Paul
vifs:
docs and examples
2022-04-04 14:32:43 +00:00
- 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
init code
2022-04-04 12:25:01 +00:00
description: Configured by Ansible - Interface 2 (ADMIN DOWN)
mtu: 600
enabled: false
docs and examples
2022-04-04 14:32:43 +00:00
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
init code
2022-04-04 12:25:01 +00:00
##Playbook
docs and examples
2022-04-04 14:32:43 +00:00
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
init code
2022-04-04 12:25:01 +00:00
docs and examples
2022-04-04 14:32:43 +00:00
- name: Combine all the facts based on match_keys
set_fact:
combined: "{{ data_source|ansible.utils.consolidate(fail_missing_match_value=False) }}"
init code
2022-04-04 12:25:01 +00:00
##Output
# ok: [localhost] => {
# "ansible_facts": {
docs and examples
2022-04-04 14:32:43 +00:00
# "data_source": [
init code
2022-04-04 12:25:01 +00:00
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "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"
# }
init code
2022-04-04 12:25:01 +00:00
# ],
docs and examples
2022-04-04 14:32:43 +00:00
# "match_key": "name",
# "prefix": "interfaces"
init code
2022-04-04 12:25:01 +00:00
# },
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "data": [
init code
2022-04-04 12:25:01 +00:00
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "name": "GigabitEthernet0/0"
init code
2022-04-04 12:25:01 +00:00
# },
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "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"
# }
init code
2022-04-04 12:25:01 +00:00
# }
docs and examples
2022-04-04 14:32:43 +00:00
# ],
# "match_key": "name",
# "prefix": "l2_interfaces"
init code
2022-04-04 12:25:01 +00:00
# },
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "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"
init code
2022-04-04 12:25:01 +00:00
# }
# ]
# },
# "changed": false
# }
docs and examples
2022-04-04 14:32:43 +00:00
# Read vars_file 'facts.yml'
init code
2022-04-04 12:25:01 +00:00
docs and examples
2022-04-04 14:32:43 +00:00
# TASK [Combine all the facts based on match_keys] ****************************************************************************************************************
init code
2022-04-04 12:25:01 +00:00
# ok: [localhost] => {
docs and examples
2022-04-04 14:32:43 +00:00
# "ansible_facts": {
# "combined": {
# "GigabitEthernet0/0": {
# "interfaces": {
# "duplex": "auto",
init code
2022-04-04 12:25:01 +00:00
# "enabled": true,
docs and examples
2022-04-04 14:32:43 +00:00
# "name": "GigabitEthernet0/0",
# "note": [
# "Connected green wire"
# ],
# "speed": "auto"
# },
# "l2_interfaces": {
# "name": "GigabitEthernet0/0"
init code
2022-04-04 12:25:01 +00:00
# },
docs and examples
2022-04-04 14:32:43 +00:00
# "l3_interfaces": {
# "ipv4": [
# {
# "address": "192.168.0.2/24"
# }
# ],
# "name": "GigabitEthernet0/0"
# }
# },
# "GigabitEthernet0/1": {
# "interfaces": {
# "description": "Configured by Ansible - Interface 1",
# "duplex": "auto",
init code
2022-04-04 12:25:01 +00:00
# "enabled": true,
docs and examples
2022-04-04 14:32:43 +00:00
# "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"
init code
2022-04-04 12:25:01 +00:00
# }
docs and examples
2022-04-04 14:32:43 +00:00
# },
# "Loopback999": {
# "interfaces": {},
# "l2_interfaces": {},
# "l3_interfaces": {
# "name": "Loopback999"
# }
# }
init code
2022-04-04 12:25:01 +00:00
# }
docs and examples
2022-04-04 14:32:43 +00:00
# },
# "changed": false
init code
2022-04-04 12:25:01 +00:00
# }
docs and examples
2022-04-04 14:32:43 +00:00
# Failing on missing match values
# -------------------------------
##facts.yaml
init code
2022-04-04 12:25:01 +00:00
interfaces:
docs and examples
2022-04-04 14:32:43 +00:00
- name: GigabitEthernet0/0
init code
2022-04-04 12:25:01 +00:00
enabled: true
duplex: auto
speed: auto
note:
- Connected green wire
docs and examples
2022-04-04 14:32:43 +00:00
- name: GigabitEthernet0/1
init code
2022-04-04 12:25:01 +00:00
description: Configured by Ansible - Interface 1
mtu: 1500
speed: auto
duplex: auto
enabled: true
note:
- Connected blue wire
- Configured by Paul
vifs:
docs and examples
2022-04-04 14:32:43 +00:00
- 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
init code
2022-04-04 12:25:01 +00:00
description: Configured by Ansible - Interface 2 (ADMIN DOWN)
mtu: 600
enabled: false
docs and examples
2022-04-04 14:32:43 +00:00
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
init code
2022-04-04 12:25:01 +00:00
##Playbook
docs and examples
2022-04-04 14:32:43 +00:00
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
init code
2022-04-04 12:25:01 +00:00
docs and examples
2022-04-04 14:32:43 +00:00
- 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) }}"
init code
2022-04-04 12:25:01 +00:00
##Output
# ok: [localhost] => {
# "ansible_facts": {
docs and examples
2022-04-04 14:32:43 +00:00
# "data_source": [
init code
2022-04-04 12:25:01 +00:00
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "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"
# }
init code
2022-04-04 12:25:01 +00:00
# ],
docs and examples
2022-04-04 14:32:43 +00:00
# "match_key": "name",
# "prefix": "interfaces"
init code
2022-04-04 12:25:01 +00:00
# },
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "data": [
init code
2022-04-04 12:25:01 +00:00
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "name": "GigabitEthernet0/0"
init code
2022-04-04 12:25:01 +00:00
# },
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "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"
# }
init code
2022-04-04 12:25:01 +00:00
# }
docs and examples
2022-04-04 14:32:43 +00:00
# ],
# "match_key": "name",
# "prefix": "l2_interfaces"
init code
2022-04-04 12:25:01 +00:00
# },
# {
docs and examples
2022-04-04 14:32:43 +00:00
# "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"
init code
2022-04-04 12:25:01 +00:00
# }
# ]
# },
# "changed": false
# }
docs and examples
2022-04-04 14:32:43 +00:00
# Read vars_file 'facts.yml'
init code
2022-04-04 12:25:01 +00:00
docs and examples
2022-04-04 14:32:43 +00:00
# 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"
init code
2022-04-04 12:25:01 +00:00
# }
docs and examples
2022-04-04 14:32:43 +00:00
# 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"
}
init code
2022-04-04 12:25:01 +00:00
"""
from ansible.errors import AnsibleFilterError
from ansible_collections.ansible.utils.plugins.plugin_utils.consolidate import (
consolidate,
)
from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import (
AnsibleArgSpecValidator,
)
try:
from jinja2.filters import pass_environment
except ImportError:
from jinja2.filters import environmentfilter as pass_environment
docs and examples
2022-04-04 14:32:43 +00:00
# import debugpy
init code
2022-04-04 12:25:01 +00:00
docs and examples
2022-04-04 14:32:43 +00:00
# debugpy.listen(3000)
# debugpy.wait_for_client()
init code
2022-04-04 12:25:01 +00:00
@pass_environment
def _consolidate(*args, **kwargs):
"""keep specific keys from a data recursively"""
keys = [
"data_source",
"fail_missing_match_key",
"fail_missing_match_value",
"fail_duplicate",
]
data = dict(zip(keys, args[1:]))
data.update(kwargs)
docs and examples
2022-04-04 14:32:43 +00:00
aav = AnsibleArgSpecValidator(data=data, schema=DOCUMENTATION, name="consolidate")
init code
2022-04-04 12:25:01 +00:00
valid, errors, updated_data = aav.validate()
if not valid:
raise AnsibleFilterError(errors)
return consolidate(**updated_data)
class FilterModule(object):
update 1
2022-04-04 15:26:07 +00:00
"""consolidate"""
init code
2022-04-04 12:25:01 +00:00
def filters(self):
"""a mapping of filter names to functions"""
return {"consolidate": _consolidate}