cisco.dnac.network_device_image_updates_count_info module – Information module for Network Device Image Updates Count Info

Note

This module is part of the cisco.dnac collection (version 6.27.0).

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.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.network_device_image_updates_count_info.

New in cisco.dnac 6.15.0

Synopsis

  • This module represents an alias of the module network_device_image_updates_count_v1_info

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

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

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.

managementAddress

string

ManagementAddress query parameter. Management address of the network device.

networkDeviceId

string

NetworkDeviceId query parameter. Network device id.

parentId

string

ParentId query parameter. Updates that have this parent id.

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 DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are software_image_management_swim.SoftwareImageManagementSwim.count_of_network_device_image_updates_v1,

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

  • It should be noted that this module is an alias of network_device_image_updates_count_v1_info

  • 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 DNAC SDK

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

See Also

See also

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

Complete reference of the CountOfNetworkDeviceImageUpdatesV1 API.

Examples

- name: Get all Network Device Image Updates Count Info
  cisco.dnac.network_device_image_updates_count_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    id: string
    parentId: string
    networkDeviceId: string
    status: string
    imageName: string
    hostName: string
    managementAddress: string
    startTime: 0
    endTime: 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 DNAC Python SDK

Returned: always

Sample: {"response": {"count": 0}, "version": "string"}

Authors

  • Rafael Campos (@racampos)