ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Meraki scenario guide - describe how to merge new data with old data (#48999)

Browse source 
* Described how to merge new data with old data in the Meraki guide
Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
This commit is contained in:
Kevin Breit 2018-11-29 15:42:10 -06:00 committed by Alicia Cozine
parent 02baae6e99
commit a9d68f3d52
1 changed files with 102 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

143
docs/docsite/rst/scenario_guides/guide_meraki.rst
View file

@ -37,58 +37,58 @@ Meraki modules provide a user-friendly interface to manage your Meraki environme
.. code-block:: yaml
- name: Query SNMP settings
meraki_snmp:
api_key: abc123
org_name: AcmeCorp
state: query
delegate_to: localhost
- name: Query SNMP settings
meraki_snmp:
api_key: abc123
org_name: AcmeCorp
state: query
delegate_to: localhost
Information about a particular object can be queried. For example, the `meraki_admin <meraki_admin_module>` module supports
.. code-block:: yaml
- name: Gather information about Jane Doe
meraki_admin:
api_key: abc123
org_name: AcmeCorp
state: query
email: janedoe@email.com
delegate_to: localhost
- name: Gather information about Jane Doe
meraki_admin:
api_key: abc123
org_name: AcmeCorp
state: query
email: janedoe@email.com
delegate_to: localhost
Common Parameters
=================
All Ansible Meraki modules support the following parameters which affect communication with the Meraki Dashboard API. Most of these should only be used by Meraki developers and not the general public.
host
Hostname or IP of Meraki Dashboard.
host
Hostname or IP of Meraki Dashboard.
use_https
Specifies whether communication should be over HTTPS. (Defaults to ``yes``)
use_https
Specifies whether communication should be over HTTPS. (Defaults to ``yes``)
use_proxy
Whether to use a proxy for any communication.
use_proxy
Whether to use a proxy for any communication.
validate_certs
Determine whether certificates should be validated or trusted. (Defaults to ``yes``)
validate_certs
Determine whether certificates should be validated or trusted. (Defaults to ``yes``)
These are the common parameters which are used for most every module.
org_name
Name of organization to perform actions in.
org_name
Name of organization to perform actions in.
org_id
ID of organization to perform actions in.
org_id
ID of organization to perform actions in.
net_name
Name of network to perform actions in.
net_name
Name of network to perform actions in.
net_id
ID of network to perform actions in.
net_id
ID of network to perform actions in.
state
General specification of what action to take. ``query`` does lookups. ``present`` creates or edits. ``absent`` deletes.
state
General specification of what action to take. ``query`` does lookups. ``present`` creates or edits. ``absent`` deletes.
.. hint:: Use the ``org_id`` and ``net_id`` parameters when possible. ``org_name`` and ``net_name`` require additional behind-the-scenes API calls to learn the ID values. ``org_id`` and ``net_id`` will perform faster.
@ -108,22 +108,83 @@ Meraki and its related Ansible modules return most information in the form of a
.. code-block:: json
[
{
"orgAccess": "full",
"name": "John Doe",
"tags": [],
"networks": [],
"email": "john@doe.com",
"id": "12345677890"
}
]
[
{
"orgAccess": "full",
"name": "John Doe",
"tags": [],
"networks": [],
"email": "john@doe.com",
"id": "12345677890"
}
]
Handling Returned Data
======================
Since Meraki's response data uses lists instead of properly keyed dictionaries for responses, certain strategies should be used when querying data for particular information. For many situations, use the ``selectattr()`` Jinja2 function.
Merging Existing and New Data
=============================
Ansible's Meraki modules do not allow for manipulating data. For example, you may need to insert a rule in the middle of a firewall ruleset. Ansible and the Meraki modules lack a way to directly merge to manipulate data. However, a playlist can use a few tasks to split the list where you need to insert a rule and then merge them together again with the new rule added. The steps involved are as follows:
1. Create blank "front" and "back" lists.
::
vars:
- front_rules: []
- back_rules: []
2. Get existing firewall rules from Meraki and create a new variable.
::
- name: Get firewall rules
meraki_mx_l3_firewall:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: query
delegate_to: localhost
register: rules
- set_fact:
original_ruleset: '{{rules.data}}'
3. Write the new rule. The new rule needs to be in a list so it can be merged with other lists in an upcoming step. The blank `-` puts the rule in a list so it can be merged.
::
- set_fact:
new_rule:
-
- comment: Block traffic to server
src_cidr: 192.0.1.0/24
src_port: any
dst_cidr: 192.0.1.2/32
dst_port: any
protocol: any
policy: deny
4. Split the rules into two lists. This assumes the existing ruleset is 2 rules long.
::
- set_fact:
front_rules: '{{front_rules + [ original_ruleset[:1] ]}}'
- set_fact:
back_rules: '{{back_rules + [ original_ruleset[1:] ]}}'
5. Merge rules with the new rule in the middle.
::
- set_fact:
new_ruleset: '{{front_rules + new_rule + back_rules}}'
6. Upload new ruleset to Meraki.
::
- name: Set two firewall rules
meraki_mx_l3_firewall:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: present
rules: '{{ new_ruleset }}'
delegate_to: localhost
Error Handling
==============