Try SpotterInformation module for organizations _inventory _devices
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Get all organizations _inventory _devices.
Get organizations _inventory _devices by id.
Return a single device from the inventory of an organization.
Return the device inventory for an organization.
- name: Get all organizations _inventory _devices
cisco.meraki.organizations_inventory_devices_info:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
perPage: 0
startingAfter: string
endingBefore: string
usedState: string
search: string
macs: []
networkIds: []
serials: []
models: []
orderNumbers: []
tags: []
tagsFilterType: string
productTypes: []
organizationId: string
total_pages: -1
direction: next
register: result
- name: Get organizations _inventory _devices by id
cisco.meraki.organizations_inventory_devices_info:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
organizationId: string
serial: string
register: result
macs:
description:
- Macs query parameter. Search for devices in inventory based on mac addresses.
elements: str
type: list
tags:
description:
- 'Tags query parameter. Filter devices by tags. The filtering is case-sensitive.
If tags are included, ''tagsFilterType'' should also be included (see below).
'
elements: str
type: list
models:
description:
- Models query parameter. Search for devices in inventory based on model.
elements: str
type: list
search:
description:
- Search query parameter. Search for devices in inventory based on serial number,
mac address, or model.
type: str
serial:
description:
- Serial path parameter.
type: str
headers:
description: Additional headers.
type: dict
perPage:
description:
- PerPage query parameter. The number of entries per page returned. Acceptable range
is 3 - 1000. Default is 1000.
type: int
serials:
description:
- Serials query parameter. Search for devices in inventory based on serials.
elements: str
type: list
direction:
default: https://api.meraki.com/api/v1
description:
- direction (string), direction to paginate, either "next" (default) or "prev" page
type: str
usedState:
description:
- UsedState query parameter. Filter results by used or unused inventory. Accepted
values are 'used' or 'unused'.
type: str
networkIds:
description:
- 'NetworkIds query parameter. Search for devices in inventory based on network ids.
Use explicit ''null'' value to get available devices only.
'
elements: str
type: list
total_pages:
description:
- total_pages(int), use with perPage to get total results up to total_pages*perPage;
-1 for all pages
required: true
type: str
endingBefore:
description:
- 'EndingBefore query parameter. A token used by the server to indicate the end of
the page. Often this is a timestamp or an ID but it is not limited to those. This
parameter should not be defined by client applications. The link for the first,
last, prev, or next page in the HTTP Link header should define it.
'
type: str
orderNumbers:
description:
- OrderNumbers query parameter. Search for devices in inventory based on order numbers.
elements: str
type: list
productTypes:
description:
- 'ProductTypes query parameter. Filter devices by product type. Accepted values are
appliance, camera, cellularGateway, sensor, switch, systemsManager, and wireless.
'
elements: str
type: list
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
startingAfter:
description:
- 'StartingAfter query parameter. A token used by the server to indicate the start
of the page. Often this is a timestamp or an ID but it is not limited to those.
This parameter should not be defined by client applications. The link for the first,
last, prev, or next page in the HTTP Link header should define it.
'
type: str
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
organizationId:
description:
- OrganizationId path parameter. Organization ID.
type: str
tagsFilterType:
description:
- 'TagsFilterType query parameter. To use with ''tags'' parameter, to filter devices
which contain ANY or ALL given tags. Accepted values are ''withAnyTags'' or ''withAllTags'',
default is ''withAnyTags''.
'
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: "{\n \"claimedAt\": \"string\",\n \"countryCode\": \"string\",\n \"details\"\
: [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n\
\ ],\n \"licenseExpirationDate\": \"string\",\n \"mac\": \"string\",\n \"\
model\": \"string\",\n \"name\": \"string\",\n \"networkId\": \"string\",\n\
\ \"orderNumber\": \"string\",\n \"productType\": \"string\",\n \"serial\"\
: \"string\",\n \"tags\": [\n \"string\"\n ]\n}\n"
type: dict