cisco.meraki.networks_firmware_upgrades module – Resource module for networks _firmwareupgrades

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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.networks_firmware_upgrades.

New in cisco.meraki 2.16.0

Synopsis

  • Manage operation update of the resource networks _firmwareupgrades.

  • Update firmware upgrade information for a network.

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

meraki_action_batch_retry_wait_time

integer

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

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: "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: ""

meraki_caller

string

meraki_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER

Default: ""

meraki_certificate_path

string

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

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), Inherits your own logger instance

Choices:

  • false ← (default)

  • true

meraki_log_file_prefix

string

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

Default: "meraki_api_"

meraki_log_path

string

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

Default: ""

meraki_maximum_retries

integer

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

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time

Default: 60

meraki_output_log

boolean

meraki_output_log (boolean), create an output log file?

Choices:

  • false

  • true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), print logging output to console?

Choices:

  • false

  • true ← (default)

meraki_requests_proxy

string

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

Default: ""

meraki_retry_4xx_error

boolean

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

Choices:

  • false ← (default)

  • true

meraki_retry_4xx_error_wait_time

integer

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

Default: 60

meraki_simulate

boolean

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

Choices:

  • false ← (default)

  • true

meraki_single_request_timeout

integer

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

Default: 60

meraki_suppress_logging

boolean

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

Choices:

  • false ← (default)

  • true

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:

  • false ← (default)

  • true

meraki_wait_on_rate_limit

boolean

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

Choices:

  • false

  • true ← (default)

networkId

string

NetworkId path parameter. Network ID.

products

dictionary

Contains information about the network to update.

appliance

dictionary

The network device to be updated.

nextUpgrade

dictionary

The pending firmware upgrade if it exists.

time

string

The time of the last successful upgrade.

toVersion

dictionary

The version to be updated to.

id

string

The version ID.

participateInNextBetaRelease

boolean

Whether or not the network wants beta firmware.

Choices:

  • false

  • true

camera

dictionary

The network device to be updated.

nextUpgrade

dictionary

The pending firmware upgrade if it exists.

time

string

The time of the last successful upgrade.

toVersion

dictionary

The version to be updated to.

id

string

The version ID.

participateInNextBetaRelease

boolean

Whether or not the network wants beta firmware.

Choices:

  • false

  • true

cellularGateway

dictionary

The network device to be updated.

nextUpgrade

dictionary

The pending firmware upgrade if it exists.

time

string

The time of the last successful upgrade.

toVersion

dictionary

The version to be updated to.

id

string

The version ID.

participateInNextBetaRelease

boolean

Whether or not the network wants beta firmware.

Choices:

  • false

  • true

sensor

dictionary

The network device to be updated.

nextUpgrade

dictionary

The pending firmware upgrade if it exists.

time

string

The time of the last successful upgrade.

toVersion

dictionary

The version to be updated to.

id

string

The version ID.

participateInNextBetaRelease

boolean

Whether or not the network wants beta firmware.

Choices:

  • false

  • true

switch

dictionary

The network device to be updated.

nextUpgrade

dictionary

The pending firmware upgrade if it exists.

time

string

The time of the last successful upgrade.

toVersion

dictionary

The version to be updated to.

id

string

The version ID.

participateInNextBetaRelease

boolean

Whether or not the network wants beta firmware.

Choices:

  • false

  • true

wireless

dictionary

The network device to be updated.

nextUpgrade

dictionary

The pending firmware upgrade if it exists.

time

string

The time of the last successful upgrade.

toVersion

dictionary

The version to be updated to.

id

string

The version ID.

participateInNextBetaRelease

boolean

Whether or not the network wants beta firmware.

Choices:

  • false

  • true

timezone

string

The timezone for the network.

upgradeWindow

dictionary

Upgrade window for devices in network.

dayOfWeek

string

Day of the week.

hourOfDay

string

Hour of the day.

Notes

Note

  • SDK Method used are networks.Networks.update_network_firmware_upgrades,

  • Paths used are put /networks/{networkId}/firmwareUpgrades,

  • Does not support 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 DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco Meraki documentation for networks updateNetworkFirmwareUpgrades

Complete reference of the updateNetworkFirmwareUpgrades API.

Examples

- name: Update all
  cisco.meraki.networks_firmware_upgrades:
    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}}"
    state: present
    networkId: string
    products:
      appliance:
        nextUpgrade:
          time: '2019-03-17T17:22:52Z'
          toVersion:
            id: '1001'
        participateInNextBetaRelease: false
      camera:
        nextUpgrade:
          time: '2019-03-17T17:22:52Z'
          toVersion:
            id: '1003'
        participateInNextBetaRelease: false
      cellularGateway:
        nextUpgrade:
          time: '2019-03-17T17:22:52Z'
          toVersion:
            id: '1004'
        participateInNextBetaRelease: false
      sensor:
        nextUpgrade:
          time: '2019-03-17T17:22:52Z'
          toVersion:
            id: '1005'
        participateInNextBetaRelease: false
      switch:
        nextUpgrade:
          time: '2019-03-17T17:22:52Z'
          toVersion:
            id: '1002'
        participateInNextBetaRelease: false
      wireless:
        nextUpgrade:
          time: '2019-03-17T17:22:52Z'
          toVersion:
            id: '1000'
        participateInNextBetaRelease: false
    timezone: America/Los_Angeles
    upgradeWindow:
      dayOfWeek: sun
      hourOfDay: '4:00'

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: {"products": {"appliance": {"availableVersions": [{"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}], "currentVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "lastUpgrade": {"fromVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "nextUpgrade": {"time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "participateInNextBetaRelease": true}, "camera": {"availableVersions": [{"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}], "currentVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "lastUpgrade": {"fromVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "nextUpgrade": {"time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "participateInNextBetaRelease": true}, "cellularGateway": {"availableVersions": [{"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}], "currentVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "lastUpgrade": {"fromVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "nextUpgrade": {"time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "participateInNextBetaRelease": true}, "sensor": {"availableVersions": [{"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}], "currentVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "lastUpgrade": {"fromVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "nextUpgrade": {"time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "participateInNextBetaRelease": true}, "switch": {"availableVersions": [{"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}], "currentVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "lastUpgrade": {"fromVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "nextUpgrade": {"time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "participateInNextBetaRelease": true}, "wireless": {"availableVersions": [{"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}], "currentVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "lastUpgrade": {"fromVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}, "time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "nextUpgrade": {"time": "string", "toVersion": {"firmware": "string", "id": "string", "releaseDate": "string", "releaseType": "string", "shortName": "string"}}, "participateInNextBetaRelease": true}}, "timezone": "string", "upgradeWindow": {"dayOfWeek": "string", "hourOfDay": "string"}}

Authors

  • Francisco Munoz (@fmunoz)