cisco.meraki.meraki_mx_content_filtering – Edit Meraki MX content filtering policies

Note

This plugin is part of the cisco.meraki collection (version 2.5.0).

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_mx_content_filtering.

Synopsis

Allows for setting policy on content filtering.

Parameters

Parameter	Choices/Defaults	Comments
allowed_urls list / elements=string		List of URL patterns which should be allowed.
auth_key string / required		Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
blocked_categories list / elements=string		List of content categories which should be blocked. Use the `meraki_content_filtering_facts` module for a full list of categories.
blocked_urls list / elements=string		List of URL patterns which should be blocked.
category_list_size string	Choices: top sites full list	Determines whether a network filters fo rall URLs in a category or only the list of top blocked sites.
host string	Default: "api.meraki.com"	Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China.
internal_error_retry_time integer	Default: 60	Number of seconds to retry if server returns an internal server error.
net_id string		ID number of a network.
net_name string		Name of a network. aliases: network
org_id string		ID of organization.
org_name string		Name of organization. aliases: organization
output_format string	Choices: snakecase ← camelcase	Instructs module whether response keys should be snake case (ex. `net_id`) or camel case (ex. `netId`).
output_level string	Choices: debug normal ←	Set amount of debug output during module execution.
rate_limit_retry_time integer	Default: 165	Number of seconds to retry if rate limiter is triggered.
state string	Choices: present ← query	States that a policy should be created or modified.
subset string	Choices: categories policy	Display only certain facts.
timeout integer	Default: 30	Time to timeout for HTTP requests.
use_https boolean	Choices: no yes ←	If `no`, it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers.
use_proxy boolean	Choices: no ← yes	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs boolean	Choices: no yes ←	Whether to validate HTTP certificates.

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 to camelcase.
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: Set single allowed URL pattern
  meraki_content_filtering:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourMXNet
    allowed_urls:
      - "http://www.ansible.com/*"

- name: Set blocked URL category
  meraki_content_filtering:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourMXNet
    state: present
    category_list_size: full list
    blocked_categories:
      - "Adult and Pornography"

- name: Remove match patterns and categories
  meraki_content_filtering:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourMXNet
    state: present
    category_list_size: full list
    allowed_urls: []
    blocked_urls: []

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
data complex			info	Information about the created or manipulated object.
	allowed_url_patterns list / elements=string		query for policy	Explicitly permitted URL patterns Sample: ['http://www.ansible.com']
	blocked_url_categories complex		query for policy	List of blocked URL categories
		id list / elements=string	query for policy	Unique ID of category to filter Sample: ['meraki:contentFiltering/category/1']
		name list / elements=string	query for policy	Name of category to filter Sample: ['Real Estate']
	blocked_url_patterns list / elements=string		query for policy	Explicitly denied URL patterns Sample: ['http://www.ansible.net']
	categories complex		query for categories	List of available content filtering categories.
		id string	query for categories	Unique ID of content filtering category. Sample: meraki:contentFiltering/category/1
		name string	query for categories	Name of content filtering category. Sample: Real Estate
	url_cateogory_list_size string		query for policy	Size of categories to cache on MX appliance Sample: topSites

Authors

Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_mx_content_filtering_module.html

Docs

Docs4dev

Title here