cisco.meraki.meraki_mr_l7_firewall module – Manage MR access point layer 7 firewalls in the Meraki cloud
Note
This module is part of the cisco.meraki collection (version 2.18.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_mr_l7_firewall
.
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.networks_appliance_firewall_l7_firewall_rules
Synopsis
Allows for creation, management, and visibility into layer 7 firewalls implemented on Meraki MR access points.
Module assumes a complete list of firewall rules are passed as a parameter.
If there is interest in this module allowing manipulation of a single firewall rule, please submit an issue against this module.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
When Choices:
|
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
Number of seconds to retry if server returns an internal server error. Default: |
|
ID of network containing access points. |
|
Name of network containing access points. |
|
Number of SSID to apply firewall rule to. |
|
ID of organization. |
|
Name of organization. |
|
Instructs module whether response keys should be snake case (ex. Choices:
|
|
Set amount of debug output during module execution. Choices:
|
|
Number of seconds to retry if rate limiter is triggered. Default: |
|
List of layer 7 firewall rules. |
|
Application to filter. |
|
URI of application as defined by Meraki. |
|
Name of application to filter as defined by Meraki. |
|
FQDN of host to filter. |
|
CIDR notation range of IP addresses to apply rule to. Port can be appended to range with a |
|
Policy to apply if rule is hit. Choices:
|
|
TCP or UDP based port to filter. |
|
Type of policy to apply. Choices:
|
|
Name of SSID to apply firewall rule to. |
|
Query or modify a firewall rule. Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Whether to validate HTTP certificates. Choices:
|
Notes
Note
More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
Some of the options are likely only used for developers within Meraki.
As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the
ANSIBLE_MERAKI_FORMAT
environment variable tocamelcase
.Ansible’s Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.
Examples
- name: Query firewall rules
meraki_mr_l7_firewall:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: query
number: 1
delegate_to: localhost
- name: Query applications and application categories
meraki_mr_l7_firewall:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
number: 1
categories: yes
state: query
delegate_to: localhost
- name: Set firewall rules
meraki_mr_l7_firewall:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
number: 1
state: present
rules:
- policy: deny
type: port
port: 8080
- type: port
port: 1234
- type: host
host: asdf.com
- type: application
application:
id: meraki:layer7/application/205
- type: application_category
application:
id: meraki:layer7/category/24
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Firewall rules associated to network SSID. Returned: success |
|
List of application categories and applications. Returned: success, when querying applications |
|
List of applications within a category. Returned: success |
|
URI of application. Returned: success Sample: |
|
Descriptive name of application. Returned: success Sample: |
|
URI of application category. Returned: success Sample: |
|
Descriptive name of application category. Returned: success Sample: |
|
Ordered list of firewall rules. Returned: success, when not querying applications |
|
List of application categories within a category. Returned: success |
|
URI of application. Returned: success Sample: |
|
Descriptive name of application. Returned: success Sample: |
|
List of applications within a category. Returned: success |
|
URI of application. Returned: success Sample: |
|
Descriptive name of application. Returned: success Sample: |
|
Range of IP addresses in rule. Returned: success Sample: |
|
Action to apply when rule is hit. Returned: success Sample: |
|
Port number in rule. Returned: success Sample: |
|
Type of rule category. Returned: success Sample: |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.