archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Allow module to claim devices into an organization (#42448)

Browse Source 
- Before this, it allowed claiming devices into a network only
- Make integration tests a block
- Note, API doesn't allow unclaiming in an organization, only net
- Added an integration test for claiming into an org
	- Requires unclaiming manually
- There is a bug in the API which isn't showing claimed devices
pull/42439/merge
Kevin Breit 6 years ago committed by Dag Wieers
parent 5960b215bb
commit 779f3c0c1a
2 changed files with 263 additions and 246 deletions
Show Stats Download Patch File Download Diff File

96
lib/ansible/modules/network/meraki/meraki_device.py
Unescape Escape View File

@ -211,6 +211,14 @@ def is_device_valid(meraki, serial, data):
return False return False
def get_org_devices(meraki, org_id):
path = meraki.construct_path('get_all_org', org_id=org_id)
response = meraki.request(path, method='GET')
if meraki.status != 200:
meraki.fail_json(msg='Failed to query all devices belonging to the organization')
return response
def temp_get_nets(meraki, org_name, net_name): def temp_get_nets(meraki, org_name, net_name):
org_id = meraki.get_org_id(org_name) org_id = meraki.get_org_id(org_name)
path = meraki.construct_path('get_all', function='network', org_id=org_id) path = meraki.construct_path('get_all', function='network', org_id=org_id)
@ -263,24 +271,19 @@ def main():
meraki.params['follow_redirects'] = 'all' meraki.params['follow_redirects'] = 'all'
query_urls = {'device': '/networks/{net_id}/devices', query_urls = {'device': '/networks/{net_id}/devices'}
} query_org_urls = {'device': '/organizations/{org_id}/deviceStatuses'}
query_device_urls = {'device': '/networks/{net_id}/devices/'}
query_device_urls = {'device': '/networks/{net_id}/devices/', claim_device_urls = {'device': '/networks/{net_id}/devices/claim'}
} bind_org_urls = {'device': '/organizations/{org_id}/claim'}
update_device_urls = {'device': '/networks/{net_id}/devices/'}
claim_device_urls = {'device': '/networks/{net_id}/devices/claim', delete_device_urls = {'device': '/networks/{net_id}/devices/'}
}
update_device_urls = {'device': '/networks/{net_id}/devices/',
}
delete_device_urls = {'device': '/networks/{net_id}/devices/',
}
meraki.url_catalog['get_all'].update(query_urls) meraki.url_catalog['get_all'].update(query_urls)
meraki.url_catalog['get_all_org'] = query_org_urls
meraki.url_catalog['get_device'] = query_device_urls meraki.url_catalog['get_device'] = query_device_urls
meraki.url_catalog['create'] = claim_device_urls meraki.url_catalog['create'] = claim_device_urls
meraki.url_catalog['bind_org'] = bind_org_urls
meraki.url_catalog['update'] = update_device_urls meraki.url_catalog['update'] = update_device_urls
meraki.url_catalog['delete'] = delete_device_urls meraki.url_catalog['delete'] = delete_device_urls
@ -297,15 +300,19 @@ def main():
# manipulate or modify the state as needed (this is going to be the # manipulate or modify the state as needed (this is going to be the
# part where your module will do what it needs to do) # part where your module will do what it needs to do)
nets = temp_get_nets(meraki, meraki.params['org_name'], meraki.params['net_name'])
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:
if meraki.params['net_name']:
nets = temp_get_nets(meraki, meraki.params['org_name'], meraki.params['net_name'])
net_id = meraki.get_net_id(net_name=meraki.params['net_name'], data=nets)
if meraki.params['state'] == 'query': if meraki.params['state'] == 'query':
if meraki.params['net_name'] or meraki.params['net_id']: if meraki.params['net_name'] or meraki.params['net_id']:
device = [] device = []
if meraki.params['net_name']:
net_id = meraki.get_net_id(net_name=meraki.params['net_name'], data=nets)
elif meraki.params['net_id']:
net_id = meraki.params['net_id']
if meraki.params['serial']: if meraki.params['serial']:
path = meraki.construct_path('get_device', net_id=net_id) + meraki.params['serial'] path = meraki.construct_path('get_device', net_id=net_id) + meraki.params['serial']
request = meraki.request(path, method='GET') request = meraki.request(path, method='GET')
@ -341,24 +348,16 @@ def main():
request = meraki.request(path, method='GET') request = meraki.request(path, method='GET')
meraki.result['data'] = request meraki.result['data'] = request
else: else:
devices = [] path = meraki.construct_path('get_all_org', org_id=org_id)
for net in nets: # Gather all devices in all networks devices = meraki.request(path, method='GET')
path = meraki.construct_path('get_all', net_id=net['id'])
request = meraki.request(path, method='GET')
devices.append(request)
if meraki.params['serial']: if meraki.params['serial']:
for network in devices: for device in devices:
for dev in network: if device['serial'] == meraki.params['serial']:
if dev['serial'] == meraki.params['serial']: meraki.result['data'] = device
meraki.result['data'] = [dev]
else: else:
meraki.result['data'] = devices meraki.result['data'] = devices
elif meraki.params['state'] == 'present': elif meraki.params['state'] == 'present':
device = [] device = []
if meraki.params['net_name']:
net_id = meraki.get_net_id(net_name=meraki.params['net_name'], data=nets)
elif meraki.params['net_id']:
net_id = meraki.params['net_id']
if meraki.params['hostname']: if meraki.params['hostname']:
query_path = meraki.construct_path('get_all', net_id=net_id) query_path = meraki.construct_path('get_all', net_id=net_id)
device_list = meraki.request(query_path, method='GET') device_list = meraki.request(query_path, method='GET')
@ -380,21 +379,28 @@ def main():
meraki.result['data'] = updated_device meraki.result['data'] = updated_device
meraki.result['changed'] = True meraki.result['changed'] = True
else: else:
query_path = meraki.construct_path('get_all', net_id=net_id) if net_id is None:
device_list = meraki.request(query_path, method='GET') device_list = get_org_devices(meraki, org_id)
if is_device_valid(meraki, meraki.params['serial'], device_list) is False: if is_device_valid(meraki, meraki.params['serial'], device_list) is False:
payload = {'serial': meraki.params['serial']} payload = {'serial': meraki.params['serial']}
path = meraki.construct_path('create', net_id=net_id) path = meraki.construct_path('bind_org', org_id=org_id)
created_device = [] created_device = []
created_device.append(meraki.request(path, method='POST', payload=json.dumps(payload))) created_device.append(meraki.request(path, method='POST', payload=json.dumps(payload)))
meraki.result['data'] = created_device meraki.result['data'] = created_device
meraki.result['changed'] = True meraki.result['changed'] = True
else:
query_path = meraki.construct_path('get_all', net_id=net_id)
device_list = meraki.request(query_path, method='GET')
if is_device_valid(meraki, meraki.params['serial'], device_list) is False:
if net_id:
payload = {'serial': meraki.params['serial']}
path = meraki.construct_path('create', net_id=net_id)
created_device = []
created_device.append(meraki.request(path, method='POST', payload=json.dumps(payload)))
meraki.result['data'] = created_device
meraki.result['changed'] = True
elif meraki.params['state'] == 'absent': elif meraki.params['state'] == 'absent':
device = [] device = []
if meraki.params['net_name']:
net_id = meraki.get_net_id(net_name=meraki.params['net_name'], data=nets)
elif meraki.params['net_id']:
net_id = meraki.params['net_id']
query_path = meraki.construct_path('get_all', net_id=net_id) query_path = meraki.construct_path('get_all', net_id=net_id)
device_list = meraki.request(query_path, method='GET') device_list = meraki.request(query_path, method='GET')
if is_device_valid(meraki, meraki.params['serial'], device_list) is True: if is_device_valid(meraki, meraki.params['serial'], device_list) is True:

413
test/integration/targets/meraki_device/tasks/main.yml
Unescape Escape View File

@ -1,202 +1,213 @@
--- ---
- name: Claim a device - block:
meraki_device: - name: Claim a device into an organization
auth_key: '{{auth_key}}' meraki_device:
org_name: '{{test_org_name}}' auth_key: '{{auth_key}}'
net_name: '{{test_net_name}}' org_name: '{{test_org_name}}'
serial: '{{serial}}' serial: '{{serial}}'
state: present state: present
delegate_to: localhost delegate_to: localhost
register: claim_device register: claim_device_org
- debug: - assert:
msg: '{{claim_device}}' that:
- claim_device_org.changed == true
- assert:
that: - name: Query status of all devices in an organization
- claim_device.changed == true meraki_device:
auth_key: '{{auth_key}}'
- name: Query all devices org_name: '{{test_org_name}}'
meraki_device: state: query
auth_key: '{{auth_key}}' delegate_to: localhost
org_name: '{{test_org_name}}' register: query_device_org
state: query
delegate_to: localhost - debug:
register: query_all msg: '{{query_device_org}}'
- debug: - name: Claim a device into a network
msg: '{{query_all}}' meraki_device:
auth_key: '{{auth_key}}'
- assert: org_name: '{{test_org_name}}'
that: net_name: '{{test_net_name}}'
- query_all.changed == False serial: '{{serial}}'
state: present
- name: Query all devices in one network by network ID delegate_to: localhost
meraki_device: register: claim_device
auth_key: '{{auth_key}}'
org_name: '{{test_org_name}}' - debug:
net_id: '{{test_net_id}}' msg: '{{claim_device}}'
state: query
delegate_to: localhost - assert:
register: query_one_net_id that:
- claim_device.changed == true
- debug:
msg: '{{query_one_net_id}}' - name: Query all devices in one network by network ID
meraki_device:
- name: Query all devices in one network auth_key: '{{auth_key}}'
meraki_device: org_name: '{{test_org_name}}'
auth_key: '{{auth_key}}' net_id: '{{test_net_id}}'
org_name: '{{test_org_name}}' state: query
net_name: '{{test_net_name}}' delegate_to: localhost
state: query register: query_one_net_id
delegate_to: localhost
register: query_one_net - debug:
msg: '{{query_one_net_id}}'
- debug:
msg: '{{query_one_net}}' - name: Query all devices in one network
meraki_device:
- name: Query device by serial auth_key: '{{auth_key}}'
meraki_device: org_name: '{{test_org_name}}'
auth_key: '{{auth_key}}' net_name: '{{test_net_name}}'
org_name: '{{test_org_name}}' state: query
serial: '{{serial}}' delegate_to: localhost
state: query register: query_one_net
delegate_to: localhost
register: query_serial_no_net - debug:
msg: '{{query_one_net}}'
- debug:
msg: '{{query_serial_no_net}}' - name: Query device by serial
meraki_device:
- name: Query device by serial auth_key: '{{auth_key}}'
meraki_device: org_name: '{{test_org_name}}'
auth_key: '{{auth_key}}' serial: '{{serial}}'
org_name: '{{test_org_name}}' state: query
net_name: '{{test_net_name}}' delegate_to: localhost
serial: '{{serial}}' register: query_serial_no_net
state: query
delegate_to: localhost - debug:
register: query_serial msg: '{{query_serial_no_net}}'
- debug: - name: Query device by serial
msg: '{{query_serial}}' meraki_device:
auth_key: '{{auth_key}}'
- assert: org_name: '{{test_org_name}}'
that: net_name: '{{test_net_name}}'
- query_serial.changed == False serial: '{{serial}}'
state: query
- name: Query uplink information for a device delegate_to: localhost
meraki_device: register: query_serial
auth_key: '{{auth_key}}'
org_name: '{{test_org_name}}' - debug:
net_name: '{{test_net_name}}' msg: '{{query_serial}}'
serial_uplink: '{{serial}}'
state: query - assert:
delegate_to: localhost that:
register: query_serial_uplink - query_serial.changed == False
- debug: - name: Query uplink information for a device
msg: '{{query_serial_uplink}}' meraki_device:
auth_key: '{{auth_key}}'
- name: Query LLDP/CDP information about a device org_name: '{{test_org_name}}'
meraki_device: net_name: '{{test_net_name}}'
auth_key: '{{auth_key}}' serial_uplink: '{{serial}}'
org_name: '{{test_org_name}}' state: query
net_name: '{{test_net_name}}' delegate_to: localhost
serial_lldp_cdp: '{{serial}}' register: query_serial_uplink
lldp_cdp_timespan: 6000
state: query - debug:
delegate_to: localhost msg: '{{query_serial_uplink}}'
register: query_serial_lldp_cdp
- name: Query LLDP/CDP information about a device
- debug: meraki_device:
msg: '{{query_serial_lldp_cdp}}' auth_key: '{{auth_key}}'
org_name: '{{test_org_name}}'
- name: Query a device by hostname net_name: '{{test_net_name}}'
meraki_device: serial_lldp_cdp: '{{serial}}'
auth_key: '{{auth_key}}' lldp_cdp_timespan: 6000
org_name: '{{test_org_name}}' state: query
net_name: '{{test_net_name}}' delegate_to: localhost
hostname: test-hostname register: query_serial_lldp_cdp
state: query
delegate_to: localhost - debug:
register: query_hostname msg: '{{query_serial_lldp_cdp}}'
- debug: - name: Query a device by hostname
msg: '{{query_hostname}}' meraki_device:
auth_key: '{{auth_key}}'
- name: Query a device by model org_name: '{{test_org_name}}'
meraki_device: net_name: '{{test_net_name}}'
auth_key: '{{auth_key}}' hostname: test-hostname
org_name: '{{test_org_name}}' state: query
net_name: '{{test_net_name}}' delegate_to: localhost
model: MR26 register: query_hostname
state: query
delegate_to: localhost - debug:
register: query_model msg: '{{query_hostname}}'
- debug: - name: Query a device by model
msg: '{{query_model}}' meraki_device:
auth_key: '{{auth_key}}'
- name: Update a device org_name: '{{test_org_name}}'
meraki_device: net_name: '{{test_net_name}}'
auth_key: '{{auth_key}}' model: MR26
org_name: '{{test_org_name}}' state: query
net_name: '{{test_net_name}}' delegate_to: localhost
serial: '{{serial}}' register: query_model
name: mr26
address: 1060 W. Addison St., Chicago, IL - debug:
lat: 41.948038 msg: '{{query_model}}'
lng: -87.65568
tags: recently-added - name: Update a device
state: present meraki_device:
move_map_marker: True auth_key: '{{auth_key}}'
delegate_to: localhost org_name: '{{test_org_name}}'
register: update_device net_name: '{{test_net_name}}'
serial: '{{serial}}'
- debug: name: mr26
msg: '{{update_device}}' address: 1060 W. Addison St., Chicago, IL
lat: 41.948038
# - assert: lng: -87.65568
# that: tags: recently-added
# - update_device.changed == true state: present
# - '"1060 W. Addison St., Chicago, IL" in update_device.data.0.address' move_map_marker: True
delegate_to: localhost
- name: Update a device with idempotency register: update_device
meraki_device:
auth_key: '{{auth_key}}' - debug:
org_name: '{{test_org_name}}' msg: '{{update_device}}'
net_name: '{{test_net_name}}'
serial: '{{serial}}' # - assert:
name: mr26 # that:
address: 1060 W. Addison St., Chicago, IL # - update_device.changed == true
lat: 41.948038 # - '"1060 W. Addison St., Chicago, IL" in update_device.data.0.address'
lng: -87.65568
tags: recently-added - name: Update a device with idempotency
state: present meraki_device:
move_map_marker: True auth_key: '{{auth_key}}'
delegate_to: localhost org_name: '{{test_org_name}}'
register: update_device_idempotent net_name: '{{test_net_name}}'
serial: '{{serial}}'
- debug: name: mr26
msg: '{{update_device_idempotent}}' address: 1060 W. Addison St., Chicago, IL
lat: 41.948038
- assert: lng: -87.65568
that: tags: recently-added
- update_device_idempotent.changed == False state: present
move_map_marker: True
- name: Remove a device delegate_to: localhost
meraki_device: register: update_device_idempotent
auth_key: '{{auth_key}}'
org_name: '{{test_org_name}}' - debug:
net_name: '{{test_net_name}}' msg: '{{update_device_idempotent}}'
serial: '{{serial}}'
state: absent - assert:
delegate_to: localhost that:
register: delete_device - update_device_idempotent.changed == False
- debug: always:
msg: '{{delete_device}}' - name: Remove a device
meraki_device:
- assert: auth_key: '{{auth_key}}'
that: org_name: '{{test_org_name}}'
- delete_device.changed == true net_name: '{{test_net_name}}'
serial: '{{serial}}'
state: absent
delegate_to: localhost
register: delete_device
- debug:
msg: '{{delete_device}}'
- assert:
that:
- delete_device.changed == true
Write Preview
Loading…
Cancel
Save