cisco.catalystcenter.network_device_image_updates_count_v1_info module -- Information module for Network Device Image Updates Count V1

Note

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

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

New in cisco.catalystcenter 6.15.0

Synopsis

  • Get all Network Device Image Updates Count V1.

  • Returns the count 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 >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

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

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 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.count_of_network_device_image_updates_v1,

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

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

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST 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 V1
  cisco.catalystcenter.network_device_image_updates_count_v1_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)