cisco / cisco.meraki / 2.9.0 / module / meraki_mx_site_to_site_vpn Manage AutoVPN connections in Meraki | "added in version" 1.1.0 of cisco.meraki" Authors: Kevin Breit (@kbreit) preview | supported by communitycisco.meraki.meraki_mx_site_to_site_vpn (2.9.0) — module
Install with ansible-galaxy collection install cisco.meraki:==2.9.0
collections: - name: cisco.meraki version: 2.9.0
Allows for creation, management, and visibility into AutoVPNs implemented on Meraki MX firewalls.
- 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
host: default: api.meraki.com description: - Hostname for Meraki dashboard. - Can be used to access regional Meraki environments, such as China. type: str hubs: description: - List of hubs to assign to a spoke. elements: dict suboptions: hub_id: description: - Network ID of hub type: str use_default_route: description: - Indicates whether deafult troute traffic should be sent to this hub. - Only valid in spoke mode. type: bool type: list mode: choices: - none - hub - spoke description: - Set VPN mode for network type: str state: choices: - present - query default: present description: - Create or modify an organization. type: str net_id: description: - ID of network which MX firewall is in. type: str org_id: description: - ID of organization. type: str subnets: description: - List of subnets to advertise over VPN. elements: dict suboptions: local_subnet: description: - CIDR formatted subnet. type: str use_vpn: description: - Whether to advertise over VPN. type: bool type: list timeout: default: 30 description: - Time to timeout for HTTP requests. type: int auth_key: description: - Authentication key provided by the dashboard. Required if environmental variable C(MERAKI_KEY) is not set. required: true type: str net_name: description: - Name of network which MX firewall is in. type: str org_name: aliases: - organization description: - Name of organization. type: str use_https: default: true description: - If C(no), it will use HTTP. Otherwise it will use HTTPS. - Only useful for internal Meraki developers. type: bool use_proxy: default: false description: - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. type: bool output_level: choices: - debug - normal default: normal description: - Set amount of debug output during module execution. type: str output_format: choices: - snakecase - camelcase default: snakecase description: - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel case (ex. C(netId)). type: str validate_certs: default: true description: - Whether to validate HTTP certificates. type: bool rate_limit_retry_time: default: 165 description: - Number of seconds to retry if rate limiter is triggered. type: int internal_error_retry_time: default: 60 description: - Number of seconds to retry if server returns an internal server error. type: int
data: contains: hubs: contains: hub_id: description: ID of hub network. returned: always sample: N_12345 type: complex use_default_route: description: Whether to send all default route traffic over VPN. returned: always sample: true type: bool description: Hub networks to associate to. returned: always type: complex mode: description: Mode assigned to network. returned: always sample: spoke type: str subnets: contains: local_subnet: description: CIDR formatted subnet. returned: always sample: 192.168.1.0/24 type: str use_vpn: description: Whether subnet should use the VPN. returned: always sample: true type: bool description: List of subnets to advertise over VPN. returned: always type: complex description: VPN settings. returned: success type: complex