cisco.meraki.organizations_devices_cellular_data_devices_info module -- Information module for organizations _devices _cellular _data _devices

Note

This module is part of the cisco.meraki collection (version 2.25.0).

To install it, use: ansible-galaxy collection install cisco.meraki. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.meraki.organizations_devices_cellular_data_devices_info.

New in cisco.meraki 1.0.0

Synopsis

  • Get all organizations _devices _cellular _data _devices. - > List devices eligible for Cellular Data Management profile assignment in this organization. Returns paginated device assignment candidates with current profile, software version, modem, and SIM details. Supports filtering by device serials, profile IDs, device types, and supported SIM slots.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • meraki >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

deviceTypes

list / elements=string

DeviceTypes query parameter. List of device types to filter by. Maximum 1000 device types.

direction

string

direction (string), direction to paginate, either "next" (default) or "prev" page

Default: :ansible-option-default:`"https://api.meraki.com/api/v1"`

endingBefore

string

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.

excludedProfileIds

list / elements=string

ExcludedProfileIds query parameter. List of Cellular Data Management Profile IDs to exclude from the results. Maximum 1000 profile IDs.

excludedSerials

list / elements=string

ExcludedSerials query parameter. List of device serials to force-exclude from the response when the devices would otherwise be returned. This override is primarily useful for hiding selected devices while paging through results. Maximum 1000 serials.

headers

dictionary

Additional headers.

includeAssigned

boolean

IncludeAssigned query parameter. Whether to include devices that have already been assigned to a Cellular Data Management Profile.

Choices:

includedProfileIds

list / elements=string

IncludedProfileIds query parameter. List of Cellular Data Management Profile IDs to include in the results. Maximum 1000 profile IDs.

includedSerials

list / elements=string

IncludedSerials query parameter. List of device serials to force-include in the response when the devices would otherwise be filtered out. This override is primarily useful for keeping selected devices visible while paging through results. Maximum 1000 serials.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time

Default: :ansible-option-default:`60`

meraki_api_key

string / required

meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), preceding all endpoint resources

Default: :ansible-option-default:`"https://api.meraki.com/api/v1"`

meraki_be_geo_id

string

meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID

Default: :ansible-option-default:`""`

meraki_certificate_path

string

meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy

Default: :ansible-option-default:`""`

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), Inherits your own logger instance

Choices:

meraki_log_file_prefix

string

meraki_log_file_prefix (string), log file name appended with date and timestamp

Default: :ansible-option-default:`"meraki\_api\_"`

meraki_log_path

string

log_path (string), path to output log; by default, working directory of script if not specified

Default: :ansible-option-default:`""`

meraki_maximum_retries

integer

meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors

Default: :ansible-option-default:`2`

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time

Default: :ansible-option-default:`60`

meraki_output_log

boolean

meraki_output_log (boolean), create an output log file?

Choices:

meraki_print_console

boolean

meraki_print_console (boolean), print logging output to console?

Choices:

meraki_requests_proxy

string

meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS

Default: :ansible-option-default:`""`

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)?

Choices:

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time

Default: :ansible-option-default:`60`

meraki_simulate

boolean

meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?

Choices:

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), maximum number of seconds for each API call

Default: :ansible-option-default:`60`

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), disable all logging? you're on your own then!

Choices:

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items

Choices:

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?

Choices:

name

string

Name query parameter. Name of the device to filter by (partial matches allowed).

organizationId

string

OrganizationId path parameter. Organization ID.

perPage

integer

PerPage query parameter. The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.

serials

list / elements=string

Serials query parameter. List of device serials to filter by. Maximum 1000 serials.

slots

list / elements=string

Slots query parameter. List of SIM slot types that devices must support. Accepted values are sim1, sim2, and esim. Maximum 3 slots.

startingAfter

string

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.

total_pages

string / required

total_pages(int), use with perPage to get total results up to total_pages*perPage; -1 for all pages

Notes

Note

  • SDK Method used are organizations.Organizations.get_organization_devices_cellular_data_devices,

  • Paths used are get /organizations/{organizationId}/devices/cellular/data/devices,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco meraki SDK

  • The parameters starting with meraki_ are used by the Cisco meraki Python SDK to establish the connection

See Also

See also

Cisco Meraki documentation for organizations getOrganizationDevicesCellularDataDevices

Complete reference of the getOrganizationDevicesCellularDataDevices API.

Examples

- name: Get all organizations _devices _cellular _data _devices
  cisco.meraki.organizations_devices_cellular_data_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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    includeAssigned: true
    includedSerials: []
    excludedSerials: []
    includedProfileIds: []
    excludedProfileIds: []
    deviceTypes: []
    slots: []
    name: string
    serials: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meraki_response

dictionary

A dictionary or list with the response returned by the Cisco Meraki Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"items": [{"model": "string", "modems": [{"index": 0, "sims": [{"active": true, "slot": "string", "type": "string"}]}], "name": "string", "network": {"id": "string", "name": "string"}, "profile": {"assigned": true, "id": {}, "name": {}}, "serial": "string", "software": {"currentVersion": {"shortName": "string"}}, "url": "string"}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}`

Authors

  • Francisco Munoz (@fmunoz)