cisco.catalystcenter.network_device_image_updates_info module -- Information module for Network Device Image Updates

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

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

To use it in a playbook, specify: cisco.catalystcenter.network_device_image_updates_info.

New in cisco.catalystcenter 6.15.0

Synopsis

  • Get all Network Device Image Updates.

  • Returns the list of network device image updates based on the given filter criteria.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

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

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

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

endTime

float

EndTime query parameter. Image update started before the given time (as milliseconds since UNIX epoch).

headers

dictionary

Additional headers.

hostName

string

HostName query parameter. Host name of the network device for the image update. Supports case- insensitive partial search.

id

string

Id query parameter. Update id which is unique for each network device under the parentId.

imageName

string

ImageName query parameter. Software image name for the update.

limit

float

Limit query parameter. The number of records to show for this page. The minimum and maximum values are 1 and 500, respectively.

managementAddress

string

ManagementAddress query parameter. Management address of the network device.

networkDeviceId

string

NetworkDeviceId query parameter. Network device id.

offset

float

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

parentId

string

ParentId query parameter. Updates that have this parent id.

sortBy

string

SortBy query parameter. A property within the response to sort by.

startTime

float

StartTime query parameter. Image update started after the given time (as milliseconds since UNIX epoch).

status

string

Status query parameter. Status of the image update. Available values FAILURE, SUCCESS, IN_PROGRESS, PENDING.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are software_image_management_swim.SoftwareImageManagementSwim.get_network_device_image_updates,

  • Paths used are get /dna/intent/api/v1/networkDeviceImageUpdates,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Software Image Management (SWIM) GetNetworkDeviceImageUpdates

Complete reference of the GetNetworkDeviceImageUpdates API.

Examples

---
- name: Get all Network Device Image Updates
  cisco.catalystcenter.network_device_image_updates_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    headers: "{{my_headers | from_json}}"
    id: string
    parentId: string
    networkDeviceId: string
    status: string
    imageName: string
    hostName: string
    managementAddress: string
    startTime: 0
    endTime: 0
    sortBy: string
    order: string
    offset: 0
    limit: 0
  register: result

Return Values

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

Key

Description

dnac_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"endTime": 0, "hostName": "string", "id": "string", "managementAddress": "string", "networkDeviceId": "string", "parentId": "string", "startTime": 0, "status": "string", "type": "string", "updateImageVersion": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)