cisco.meraki.meraki_mx_site_to_site_vpn – Manage AutoVPN connections in Meraki

Note

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

To install it use: ansible-galaxy collection install cisco.meraki.

To use it in a playbook, specify: cisco.meraki.meraki_mx_site_to_site_vpn.

New in version 1.1.0: of cisco.meraki

Synopsis

• Allows for creation, management, and visibility into AutoVPNs implemented on Meraki MX firewalls.

Parameters

Parameter		Choices/Defaults	Comments
auth_key string / required			Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
host string		Default: "api.meraki.com"	Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China.
hubs list / elements=dictionary			List of hubs to assign to a spoke.
	hub_id string		Network ID of hub
	use_default_route boolean	Choices: no yes	Indicates whether deafult troute traffic should be sent to this hub. Only valid in spoke mode.
internal_error_retry_time integer		Default: 60	Number of seconds to retry if server returns an internal server error.
mode string		Choices: none hub spoke	Set VPN mode for network
net_id string			ID of network which MX firewall is in.
net_name string			Name of network which MX firewall is in.
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	Create or modify an organization.
subnets list / elements=dictionary			List of subnets to advertise over VPN.
	local_subnet string		CIDR formatted subnet.
	use_vpn boolean	Choices: no yes	Whether to advertise over VPN.
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 hub mode
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: hub_network
    mode: hub
  delegate_to: localhost
  register: set_hub

- name: Set spoke mode
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: spoke_network
    mode: spoke
    hubs:
      - hub_id: N_1234
        use_default_route: false
  delegate_to: localhost
  register: set_spoke

- name: Query rules for hub
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: hub_network
  delegate_to: localhost
  register: query_all_hub

Return Values

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

Key			Returned	Description
data complex			success	VPN settings.
	hubs complex		always	Hub networks to associate to.
		hub_id complex	always	ID of hub network. Sample: N_12345
		use_default_route boolean	always	Whether to send all default route traffic over VPN. Sample: True
	mode string		always	Mode assigned to network. Sample: spoke
	subnets complex		always	List of subnets to advertise over VPN.
		local_subnet string	always	CIDR formatted subnet. Sample: 192.168.1.0/24
		use_vpn boolean	always	Whether subnet should use the VPN. Sample: True

Authors

• Kevin Breit (@kbreit)