cisco.meraki.meraki_mx_site_to_site_vpn module – Manage AutoVPN connections in Meraki
Note
This module is part of the cisco.meraki collection (version 2.13.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_site_to_site_vpn
.
New in cisco.meraki 1.1.0
Synopsis
Allows for creation, management, and visibility into AutoVPNs implemented on Meraki MX firewalls.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
List of hubs to assign to a spoke. |
|
Network ID of hub |
|
Indicates whether deafult troute traffic should be sent to this hub. Only valid in spoke mode. Choices:
|
|
Number of seconds to retry if server returns an internal server error. Default: |
|
Set VPN mode for network Choices:
|
|
ID of network which MX firewall is in. |
|
Name of network which MX firewall is in. |
|
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: |
|
Create or modify an organization. Choices:
|
|
List of subnets to advertise over VPN. |
|
CIDR formatted subnet. |
|
Whether to advertise over VPN. 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: 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 |
Description |
---|---|
VPN settings. Returned: success |
|
Hub networks to associate to. Returned: always |
|
ID of hub network. Returned: always Sample: |
|
Whether to send all default route traffic over VPN. Returned: always Sample: |
|
Mode assigned to network. Returned: always Sample: |
|
List of subnets to advertise over VPN. Returned: always |
|
CIDR formatted subnet. Returned: always Sample: |
|
Whether subnet should use the VPN. Returned: always Sample: |