Coverage for plugins/modules/meraki_site_to_site_vpn.py : 94%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
#!/usr/bin/python # -*- coding: utf-8 -*-
# Copyright: (c) 2018, Kevin Breit (@kbreit) <kevin.breit@kevinbreit.net> # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'community' }
--- module: meraki_site_to_site_vpn short_description: Manage AutoVPN connections in Meraki version_added: "2.10" description: - Allows for creation, management, and visibility into AutoVPNs implemented on Meraki MX firewalls. options: state: description: - Create or modify an organization. choices: ['present', 'query'] default: present type: str net_name: description: - Name of network which MX firewall is in. type: str net_id: description: - ID of network which MX firewall is in. type: str mode: description: - Set VPN mode for network choices: ['none', 'hub', 'spoke'] type: str hubs: description: - List of hubs to assign to a spoke. type: list 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 subnets: description: - List of subnets to advertise over VPN. type: list suboptions: local_subnet: description: - CIDR formatted subnet. type: str use_vpn: description: - Whether to advertise over VPN. type: bool author: - Kevin Breit (@kbreit) extends_documentation_fragment: meraki '''
- 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 '''
data: description: VPN settings. returned: success type: complex contains: mode: description: Mode assigned to network. returned: always type: str sample: spoke hubs: description: Hub networks to associate to. returned: always type: complex contains: hub_id: description: ID of hub network. returned: always type: complex sample: N_12345 use_default_route: description: Whether to send all default route traffic over VPN. returned: always type: bool sample: true subnets: description: List of subnets to advertise over VPN. returned: always type: complex contains: local_subnet: description: CIDR formatted subnet. returned: always type: str sample: 192.168.1.0/24 use_vpn: description: Whether subnet should use the VPN. returned: always type: bool sample: true '''
# define the available arguments/parameters that a user can pass to # the module
use_default_route=dict(type='bool'), ) use_vpn=dict(type='bool'), )
net_name=dict(type='str'), net_id=dict(type='str'), hubs=dict(type='list', default=None, elements='dict', options=hubs_args), subnets=dict(type='list', default=None, elements='dict', options=subnets_args), mode=dict(type='str', choices=['none', 'hub', 'spoke']), )
# the AnsibleModule object will be our abstraction working with Ansible # this includes instantiation, a couple of common attr would be the # args/params passed to the execution, as well as if the module # supports check mode supports_check_mode=True, )
# manipulate or modify the state as needed (this is going to be the # part where your module will do what it needs to do) data=meraki.get_nets(org_id=org_id))
else:
# in the event of a successful module execution, you will want to # simple AnsibleModule.exit_json(), passing the key/value results
|