cisco.catalystcenter.images_site_wise_product_names_info module -- Information module for Images Site Wise Product Names Info

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

New in cisco.catalystcenter 6.15.0

Synopsis

  • This module represents an alias of the module images_site_wise_product_names_v1_info

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

assigned

string

Assigned query parameter. Filter with the assigned/unassigned, `ASSIGNED` option will filter network device products that are associated with the given image. The `NOT_ASSIGNED` option will filter network device products that have not yet been associated with the given image but apply to it. Available values ASSIGNED, NOT_ASSIGNED.

headers

dictionary

Additional headers.

imageId

string

ImageId path parameter. Software image identifier. Refer `/dna/intent/api/v1/images` API for obtaining `imageId`.

limit

float

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

offset

float

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

productId

string

ProductId query parameter. Filter with product ID (PID).

productName

string

ProductName query parameter. Filter with network device product name. Supports partial case-insensitive search. A minimum of 3 characters is required for the search.

string

Recommended query parameter. Filter with recommended source. If `CISCO` then the network device product assigned was recommended by Cisco and `USER` then the user has manually assigned. Available values CISCO, USER.

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

  • Paths used are get /dna/intent/api/v1/images/{imageId}/siteWiseProductNames,

  • It should be noted that this module is an alias of images_site_wise_product_names_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 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) RetrievesNetworkDeviceProductNamesAssignedToASoftwareImageV1

Complete reference of the RetrievesNetworkDeviceProductNamesAssignedToASoftwareImageV1 API.

Examples

- name: Get all Images Site Wise Product Names Info
  cisco.catalystcenter.images_site_wise_product_names_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    headers: "{{my_headers | from_json}}"
    productName: string
    productId: string
    recommended: string
    assigned: string
    offset: 0
    limit: 0
    imageId: string
  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": [{"id": "string", "productIds": ["string"], "productName": "string", "productNameOrdinal": 0, "recommended": "string", "siteIds": ["string"]}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)