cisco.catalystcenter.product_series_info module -- Information module for Product Series

Note

This module is part of the cisco.catalystcenter collection (version 2.3.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.product_series_info.

New in cisco.catalystcenter 6.18.0

Synopsis

• Get all Product Series.

• Get Product Series by id.

• Get the list of network device product series and their ordinal on filter criteria.

• Get the network device product series, its ordinal.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.6.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
headers dictionary	Additional headers.
limit integer	Limit query parameter. The number of records to show for this page. The minimum and maximum values are 1 and 500, respectively.
name string	Name query parameter. Product series name. Supports partial case-insensitive search. A minimum of 3 characters is required for the search.
offset integer	Offset query parameter. The first record to show for this page; the first record is numbered 1. The minimum value is 1.
productSeriesOrdinal float	ProductSeriesOrdinal path parameter. Unique identifier of product series.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are software_image_management_swim.SoftwareImageManagementSwim.retrieve_network_device_product_series, software_image_management_swim.SoftwareImageManagementSwim.retrieves_the_list_of_network_device_product_series,

• Paths used are get /dna/intent/api/v1/productSeries, get /dna/intent/api/v1/productSeries/{productSeriesOrdinal},

• 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) RetrieveNetworkDeviceProductSeries

Complete reference of the RetrieveNetworkDeviceProductSeries API.

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

Complete reference of the RetrievesTheListOfNetworkDeviceProductSeries API.

Examples

---
- name: Get all Product Series
  cisco.catalystcenter.product_series_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    name: string
    offset: 0
    limit: 0
  register: result
- name: Get Product Series by id
  cisco.catalystcenter.product_series_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    productSeriesOrdinal: 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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)