586 lines
20 KiB
Python
586 lines
20 KiB
Python
#!/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)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
ANSIBLE_METADATA = {
|
|
'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'
|
|
}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: meraki_mx_vlan
|
|
short_description: Manage VLANs in the Meraki cloud
|
|
description:
|
|
- Create, edit, query, or delete VLANs in a Meraki environment.
|
|
notes:
|
|
- Meraki's API will return an error if VLANs aren't enabled on a network. VLANs are returned properly if VLANs are enabled on a network.
|
|
- Some of the options are likely only used for developers within Meraki.
|
|
- Meraki's API defaults to networks having VLAN support disabled and there is no way to enable VLANs support in the API. VLAN support must be enabled manually.
|
|
options:
|
|
state:
|
|
description:
|
|
- Specifies whether object should be queried, created/modified, or removed.
|
|
choices: [absent, present, query]
|
|
default: query
|
|
type: str
|
|
net_name:
|
|
description:
|
|
- Name of network which VLAN is in or should be in.
|
|
aliases: [network]
|
|
type: str
|
|
net_id:
|
|
description:
|
|
- ID of network which VLAN is in or should be in.
|
|
type: str
|
|
vlan_id:
|
|
description:
|
|
- ID number of VLAN.
|
|
- ID should be between 1-4096.
|
|
type: int
|
|
name:
|
|
description:
|
|
- Name of VLAN.
|
|
aliases: [vlan_name]
|
|
type: str
|
|
subnet:
|
|
description:
|
|
- CIDR notation of network subnet.
|
|
type: str
|
|
appliance_ip:
|
|
description:
|
|
- IP address of appliance.
|
|
- Address must be within subnet specified in C(subnet) parameter.
|
|
type: str
|
|
dns_nameservers:
|
|
description:
|
|
- Semi-colon delimited list of DNS IP addresses.
|
|
- Specify one of the following options for preprogrammed DNS entries opendns, google_dns, upstream_dns
|
|
type: str
|
|
reserved_ip_range:
|
|
description:
|
|
- IP address ranges which should be reserve and not distributed via DHCP.
|
|
type: list
|
|
elements: dict
|
|
suboptions:
|
|
start:
|
|
description: First IP address of reserved IP address range, inclusive.
|
|
type: str
|
|
end:
|
|
description: Last IP address of reserved IP address range, inclusive.
|
|
type: str
|
|
comment:
|
|
description: Description of IP addresses reservation
|
|
type: str
|
|
vpn_nat_subnet:
|
|
description:
|
|
- The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN.
|
|
type: str
|
|
fixed_ip_assignments:
|
|
description:
|
|
- Static IP address assignments to be distributed via DHCP by MAC address.
|
|
type: list
|
|
elements: dict
|
|
suboptions:
|
|
mac:
|
|
description: MAC address for fixed IP assignment binding.
|
|
type: str
|
|
ip:
|
|
description: IP address for fixed IP assignment binding.
|
|
type: str
|
|
name:
|
|
description: Descriptive name of IP assignment binding.
|
|
type: str
|
|
dhcp_handling:
|
|
description:
|
|
- How to handle DHCP packets on network.
|
|
type: str
|
|
choices: ['Run a DHCP server',
|
|
'Relay DHCP to another server',
|
|
'Do not respond to DHCP requests',
|
|
'none',
|
|
'server',
|
|
'relay']
|
|
dhcp_relay_server_ips:
|
|
description:
|
|
- IP addresses to forward DHCP packets to.
|
|
type: list
|
|
elements: str
|
|
dhcp_lease_time:
|
|
description:
|
|
- DHCP lease timer setting
|
|
type: str
|
|
choices: ['30 minutes',
|
|
'1 hour',
|
|
'4 hours',
|
|
'12 hours',
|
|
'1 day',
|
|
'1 week']
|
|
dhcp_boot_options_enabled:
|
|
description:
|
|
- Enable DHCP boot options
|
|
type: bool
|
|
dhcp_boot_next_server:
|
|
description:
|
|
- DHCP boot option to direct boot clients to the server to load boot file from.
|
|
type: str
|
|
dhcp_boot_filename:
|
|
description:
|
|
- Filename to boot from for DHCP boot
|
|
type: str
|
|
dhcp_options:
|
|
description:
|
|
- List of DHCP option values
|
|
type: list
|
|
elements: dict
|
|
suboptions:
|
|
code:
|
|
description:
|
|
- DHCP option number.
|
|
type: int
|
|
type:
|
|
description:
|
|
- Type of value for DHCP option.
|
|
type: str
|
|
choices: ['text', 'ip', 'hex', 'integer']
|
|
value:
|
|
description:
|
|
- Value for DHCP option.
|
|
type: str
|
|
author:
|
|
- Kevin Breit (@kbreit)
|
|
extends_documentation_fragment: cisco.meraki.meraki
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Query all VLANs in a network.
|
|
meraki_vlan:
|
|
auth_key: abc12345
|
|
org_name: YourOrg
|
|
net_name: YourNet
|
|
state: query
|
|
delegate_to: localhost
|
|
|
|
- name: Query information about a single VLAN by ID.
|
|
meraki_vlan:
|
|
auth_key: abc12345
|
|
org_name: YourOrg
|
|
net_name: YourNet
|
|
vlan_id: 2
|
|
state: query
|
|
delegate_to: localhost
|
|
|
|
- name: Create a VLAN.
|
|
meraki_vlan:
|
|
auth_key: abc12345
|
|
org_name: YourOrg
|
|
net_name: YourNet
|
|
state: present
|
|
vlan_id: 2
|
|
name: TestVLAN
|
|
subnet: 192.0.1.0/24
|
|
appliance_ip: 192.0.1.1
|
|
delegate_to: localhost
|
|
|
|
- name: Update a VLAN.
|
|
meraki_vlan:
|
|
auth_key: abc12345
|
|
org_name: YourOrg
|
|
net_name: YourNet
|
|
state: present
|
|
vlan_id: 2
|
|
name: TestVLAN
|
|
subnet: 192.0.1.0/24
|
|
appliance_ip: 192.168.250.2
|
|
fixed_ip_assignments:
|
|
- mac: "13:37:de:ad:be:ef"
|
|
ip: 192.168.250.10
|
|
name: fixed_ip
|
|
reserved_ip_range:
|
|
- start: 192.168.250.10
|
|
end: 192.168.250.20
|
|
comment: reserved_range
|
|
dns_nameservers: opendns
|
|
delegate_to: localhost
|
|
|
|
- name: Enable DHCP on VLAN with options
|
|
meraki_vlan:
|
|
auth_key: abc123
|
|
state: present
|
|
org_name: YourOrg
|
|
net_name: YourNet
|
|
vlan_id: 2
|
|
name: TestVLAN
|
|
subnet: 192.168.250.0/24
|
|
appliance_ip: 192.168.250.2
|
|
dhcp_handling: server
|
|
dhcp_lease_time: 1 hour
|
|
dhcp_boot_options_enabled: false
|
|
dhcp_options:
|
|
- code: 5
|
|
type: ip
|
|
value: 192.0.1.1
|
|
delegate_to: localhost
|
|
|
|
- name: Delete a VLAN.
|
|
meraki_vlan:
|
|
auth_key: abc12345
|
|
org_name: YourOrg
|
|
net_name: YourNet
|
|
state: absent
|
|
vlan_id: 2
|
|
delegate_to: localhost
|
|
'''
|
|
|
|
RETURN = r'''
|
|
|
|
response:
|
|
description: Information about the organization which was created or modified
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
appliance_ip:
|
|
description: IP address of Meraki appliance in the VLAN
|
|
returned: success
|
|
type: str
|
|
sample: 192.0.1.1
|
|
dnsnamservers:
|
|
description: IP address or Meraki defined DNS servers which VLAN should use by default
|
|
returned: success
|
|
type: str
|
|
sample: upstream_dns
|
|
fixed_ip_assignments:
|
|
description: List of MAC addresses which have IP addresses assigned.
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
macaddress:
|
|
description: MAC address which has IP address assigned to it. Key value is the actual MAC address.
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
ip:
|
|
description: IP address which is assigned to the MAC address.
|
|
returned: success
|
|
type: str
|
|
sample: 192.0.1.4
|
|
name:
|
|
description: Descriptive name for binding.
|
|
returned: success
|
|
type: str
|
|
sample: fixed_ip
|
|
reserved_ip_ranges:
|
|
description: List of IP address ranges which are reserved for static assignment.
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
comment:
|
|
description: Description for IP address reservation.
|
|
returned: success
|
|
type: str
|
|
sample: reserved_range
|
|
end:
|
|
description: Last IP address in reservation range.
|
|
returned: success
|
|
type: str
|
|
sample: 192.0.1.10
|
|
start:
|
|
description: First IP address in reservation range.
|
|
returned: success
|
|
type: str
|
|
sample: 192.0.1.5
|
|
id:
|
|
description: VLAN ID number.
|
|
returned: success
|
|
type: int
|
|
sample: 2
|
|
name:
|
|
description: Descriptive name of VLAN.
|
|
returned: success
|
|
type: str
|
|
sample: TestVLAN
|
|
networkId:
|
|
description: ID number of Meraki network which VLAN is associated to.
|
|
returned: success
|
|
type: str
|
|
sample: N_12345
|
|
subnet:
|
|
description: CIDR notation IP subnet of VLAN.
|
|
returned: success
|
|
type: str
|
|
sample: "192.0.1.0/24"
|
|
dhcp_handling:
|
|
description: Status of DHCP server on VLAN.
|
|
returned: success
|
|
type: str
|
|
sample: Run a DHCP server
|
|
dhcp_lease_time:
|
|
description: DHCP lease time when server is active.
|
|
returned: success
|
|
type: str
|
|
sample: 1 day
|
|
dhcp_boot_options_enabled:
|
|
description: Whether DHCP boot options are enabled.
|
|
returned: success
|
|
type: bool
|
|
sample: no
|
|
dhcp_boot_next_server:
|
|
description: DHCP boot option to direct boot clients to the server to load the boot file from.
|
|
returned: success
|
|
type: str
|
|
sample: 192.0.1.2
|
|
dhcp_boot_filename:
|
|
description: Filename for boot file.
|
|
returned: success
|
|
type: str
|
|
sample: boot.txt
|
|
dhcp_options:
|
|
description: DHCP options.
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
code:
|
|
description:
|
|
- Code for DHCP option.
|
|
- Integer between 2 and 254.
|
|
returned: success
|
|
type: int
|
|
sample: 43
|
|
type:
|
|
description:
|
|
- Type for DHCP option.
|
|
- Choices are C(text), C(ip), C(hex), C(integer).
|
|
returned: success
|
|
type: str
|
|
sample: text
|
|
value:
|
|
description: Value for the DHCP option.
|
|
returned: success
|
|
type: str
|
|
sample: 192.0.1.2
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.cisco.meraki.plugins.module_utils.network.meraki.meraki import MerakiModule, meraki_argument_spec
|
|
import json
|
|
|
|
|
|
def fixed_ip_factory(meraki, data):
|
|
fixed_ips = dict()
|
|
for item in data:
|
|
fixed_ips[item['mac']] = {'ip': item['ip'], 'name': item['name']}
|
|
return fixed_ips
|
|
|
|
|
|
def get_vlans(meraki, net_id):
|
|
path = meraki.construct_path('get_all', net_id=net_id)
|
|
return meraki.request(path, method='GET')
|
|
|
|
|
|
# TODO: Allow method to return actual item if True to reduce number of calls needed
|
|
def is_vlan_valid(meraki, net_id, vlan_id):
|
|
vlans = get_vlans(meraki, net_id)
|
|
for vlan in vlans:
|
|
if vlan_id == vlan['id']:
|
|
return True
|
|
return False
|
|
|
|
|
|
def construct_payload(meraki):
|
|
payload = {'id': meraki.params['vlan_id'],
|
|
'name': meraki.params['name'],
|
|
'subnet': meraki.params['subnet'],
|
|
'applianceIp': meraki.params['appliance_ip'],
|
|
}
|
|
if meraki.params['dns_nameservers']:
|
|
if meraki.params['dns_nameservers'] not in ('opendns', 'google_dns', 'upstream_dns'):
|
|
payload['dnsNameservers'] = format_dns(meraki.params['dns_nameservers'])
|
|
else:
|
|
payload['dnsNameservers'] = meraki.params['dns_nameservers']
|
|
if meraki.params['fixed_ip_assignments']:
|
|
payload['fixedIpAssignments'] = fixed_ip_factory(meraki, meraki.params['fixed_ip_assignments'])
|
|
if meraki.params['reserved_ip_range']:
|
|
payload['reservedIpRanges'] = meraki.params['reserved_ip_range']
|
|
if meraki.params['vpn_nat_subnet']:
|
|
payload['vpnNatSubnet'] = meraki.params['vpn_nat_subnet']
|
|
if meraki.params['dhcp_handling']:
|
|
payload['dhcpHandling'] = normalize_dhcp_handling(meraki.params['dhcp_handling'])
|
|
if meraki.params['dhcp_relay_server_ips']:
|
|
payload['dhcpRelayServerIps'] = meraki.params['dhcp_relay_server_ips']
|
|
if meraki.params['dhcp_lease_time']:
|
|
payload['dhcpLeaseTime'] = meraki.params['dhcp_lease_time']
|
|
if meraki.params['dhcp_boot_options_enabled']:
|
|
payload['dhcpBootOptionsEnabled'] = meraki.params['dhcp_boot_options_enabled']
|
|
if meraki.params['dhcp_boot_next_server']:
|
|
payload['dhcpBootNextServer'] = meraki.params['dhcp_boot_next_server']
|
|
if meraki.params['dhcp_boot_filename']:
|
|
payload['dhcpBootFilename'] = meraki.params['dhcp_boot_filename']
|
|
if meraki.params['dhcp_options']:
|
|
payload['dhcpOptions'] = meraki.params['dhcp_options']
|
|
# if meraki.params['dhcp_handling']:
|
|
# meraki.fail_json(payload)
|
|
|
|
return payload
|
|
|
|
|
|
def format_dns(nameservers):
|
|
return nameservers.replace(';', '\n')
|
|
|
|
|
|
def normalize_dhcp_handling(parameter):
|
|
if parameter == 'none':
|
|
return 'Do not respond to DHCP requests'
|
|
elif parameter == 'server':
|
|
return 'Run a DHCP server'
|
|
elif parameter == 'relay':
|
|
return 'Relay DHCP to another server'
|
|
|
|
|
|
def main():
|
|
# define the available arguments/parameters that a user can pass to
|
|
# the module
|
|
|
|
fixed_ip_arg_spec = dict(mac=dict(type='str'),
|
|
ip=dict(type='str'),
|
|
name=dict(type='str'),
|
|
)
|
|
|
|
reserved_ip_arg_spec = dict(start=dict(type='str'),
|
|
end=dict(type='str'),
|
|
comment=dict(type='str'),
|
|
)
|
|
|
|
dhcp_options_arg_spec = dict(code=dict(type='int'),
|
|
type=dict(type='str', choices=['text', 'ip', 'hex', 'integer']),
|
|
value=dict(type='str'),
|
|
)
|
|
|
|
argument_spec = meraki_argument_spec()
|
|
argument_spec.update(state=dict(type='str', choices=['absent', 'present', 'query'], default='query'),
|
|
net_name=dict(type='str', aliases=['network']),
|
|
net_id=dict(type='str'),
|
|
vlan_id=dict(type='int'),
|
|
name=dict(type='str', aliases=['vlan_name']),
|
|
subnet=dict(type='str'),
|
|
appliance_ip=dict(type='str'),
|
|
fixed_ip_assignments=dict(type='list', default=None, elements='dict', options=fixed_ip_arg_spec),
|
|
reserved_ip_range=dict(type='list', default=None, elements='dict', options=reserved_ip_arg_spec),
|
|
vpn_nat_subnet=dict(type='str'),
|
|
dns_nameservers=dict(type='str'),
|
|
dhcp_handling=dict(type='str', choices=['Run a DHCP server',
|
|
'Relay DHCP to another server',
|
|
'Do not respond to DHCP requests',
|
|
'none',
|
|
'server',
|
|
'relay'],
|
|
),
|
|
dhcp_relay_server_ips=dict(type='list', default=None, elements='str'),
|
|
dhcp_lease_time=dict(type='str', choices=['30 minutes',
|
|
'1 hour',
|
|
'4 hours',
|
|
'12 hours',
|
|
'1 day',
|
|
'1 week']),
|
|
dhcp_boot_options_enabled=dict(type='bool'),
|
|
dhcp_boot_next_server=dict(type='str'),
|
|
dhcp_boot_filename=dict(type='str'),
|
|
dhcp_options=dict(type='list', default=None, elements='dict', options=dhcp_options_arg_spec),
|
|
)
|
|
|
|
# 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
|
|
module = AnsibleModule(argument_spec=argument_spec,
|
|
supports_check_mode=True,
|
|
)
|
|
meraki = MerakiModule(module, function='vlan')
|
|
|
|
meraki.params['follow_redirects'] = 'all'
|
|
|
|
query_urls = {'vlan': '/networks/{net_id}/appliance/vlans'}
|
|
query_url = {'vlan': '/networks/{net_id}/appliance/vlans/{vlan_id}'}
|
|
create_url = {'vlan': '/networks/{net_id}/appliance/vlans'}
|
|
update_url = {'vlan': '/networks/{net_id}/appliance/vlans/'}
|
|
delete_url = {'vlan': '/networks/{net_id}/appliance/vlans/'}
|
|
|
|
meraki.url_catalog['get_all'].update(query_urls)
|
|
meraki.url_catalog['get_one'].update(query_url)
|
|
meraki.url_catalog['create'] = create_url
|
|
meraki.url_catalog['update'] = update_url
|
|
meraki.url_catalog['delete'] = delete_url
|
|
|
|
payload = None
|
|
|
|
org_id = meraki.params['org_id']
|
|
if org_id is None:
|
|
org_id = meraki.get_org_id(meraki.params['org_name'])
|
|
net_id = meraki.params['net_id']
|
|
if net_id is None:
|
|
nets = meraki.get_nets(org_id=org_id)
|
|
net_id = meraki.get_net_id(net_name=meraki.params['net_name'], data=nets)
|
|
|
|
if meraki.params['state'] == 'query':
|
|
if not meraki.params['vlan_id']:
|
|
meraki.result['data'] = get_vlans(meraki, net_id)
|
|
else:
|
|
path = meraki.construct_path('get_one', net_id=net_id, custom={'vlan_id': meraki.params['vlan_id']})
|
|
response = meraki.request(path, method='GET')
|
|
meraki.result['data'] = response
|
|
elif meraki.params['state'] == 'present':
|
|
payload = construct_payload(meraki)
|
|
if is_vlan_valid(meraki, net_id, meraki.params['vlan_id']) is False: # Create new VLAN
|
|
if meraki.module.check_mode is True:
|
|
meraki.result['data'] = payload
|
|
meraki.result['changed'] = True
|
|
meraki.exit_json(**meraki.result)
|
|
path = meraki.construct_path('create', net_id=net_id)
|
|
response = meraki.request(path, method='POST', payload=json.dumps(payload))
|
|
meraki.result['changed'] = True
|
|
meraki.result['data'] = response
|
|
else: # Update existing VLAN
|
|
path = meraki.construct_path('get_one', net_id=net_id, custom={'vlan_id': meraki.params['vlan_id']})
|
|
original = meraki.request(path, method='GET')
|
|
ignored = ['networkId']
|
|
if meraki.is_update_required(original, payload, optional_ignore=ignored):
|
|
meraki.generate_diff(original, payload)
|
|
if meraki.module.check_mode is True:
|
|
original.update(payload)
|
|
meraki.result['changed'] = True
|
|
meraki.result['data'] = original
|
|
meraki.exit_json(**meraki.result)
|
|
path = meraki.construct_path('update', net_id=net_id) + str(meraki.params['vlan_id'])
|
|
response = meraki.request(path, method='PUT', payload=json.dumps(payload))
|
|
meraki.result['changed'] = True
|
|
meraki.result['data'] = response
|
|
meraki.generate_diff(original, response)
|
|
else:
|
|
if meraki.module.check_mode is True:
|
|
meraki.result['data'] = original
|
|
meraki.exit_json(**meraki.result)
|
|
meraki.result['data'] = original
|
|
elif meraki.params['state'] == 'absent':
|
|
if is_vlan_valid(meraki, net_id, meraki.params['vlan_id']):
|
|
if meraki.module.check_mode is True:
|
|
meraki.result['data'] = {}
|
|
meraki.result['changed'] = True
|
|
meraki.exit_json(**meraki.result)
|
|
path = meraki.construct_path('delete', net_id=net_id) + str(meraki.params['vlan_id'])
|
|
response = meraki.request(path, 'DELETE')
|
|
meraki.result['changed'] = True
|
|
meraki.result['data'] = response
|
|
|
|
# in the event of a successful module execution, you will want to
|
|
# simple AnsibleModule.exit_json(), passing the key/value results
|
|
meraki.exit_json(**meraki.result)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|