cisco.catalystcenter.iot_fabric_prp_configuration_models_network_devices_config_info module -- Information module for Iot Fabric Prp Configuration Models Network Devices Config

Note

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

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get Iot Fabric Prp Configuration Models Network Devices Config by id. - > This API retrieves the configuration preview for a specific network device for the given PRP configuration model, identified by `previewActivityId` and `networkDeviceId`.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_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.

networkDeviceId

string

NetworkDeviceId path parameter. Identifier of the network device. It is the `id` attribute in the response of API - `/dna/intent/api/v1/networkDevices`.

previewActivityId

string

PreviewActivityId path parameter. The unique identifier for the PRP configuration model activity. It can be retrieved by following the Response Details steps in one of the following APIs and using the `activityId` value returned in the activity details as the `previewActivityId` - `POST /dna/intent/api/v1/iot/fabric/prp/configurationModels/create` - `POST /dna/intent/api/v1/iot/fabric/prp/configurationModels/update` - `POST /dna/intent/api/v1/iot/fabric/prp/configurationModels/delete`.

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 industrial_configuration.IndustrialConfiguration.retrieve_generated_prp_configuration_for_the_given_network_device_and_prp_configuration_model,

  • Paths used are get /dna/intent/api/v1/iot/fabric/prp/configurationModels/{previewActivityId}/networkDevices/{networkDeviceId}/config,

  • 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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Industrial Configuration RetrieveGeneratedPRPConfigurationForTheGivenNetworkDeviceAndPRPConfigurationModel

Complete reference of the RetrieveGeneratedPRPConfigurationForTheGivenNetworkDeviceAndPRPConfigurationModel API.

Examples

---
- name: Get Iot Fabric Prp Configuration Models Network Devices Config by id
  cisco.catalystcenter.iot_fabric_prp_configuration_models_network_devices_config_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}}"
    previewActivityId: 7f422eeb-effe-4938-9371-ccf6dc2fe15e
    networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
  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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"networkDeviceId": "string", "previewItems": [{"configPreview": "string", "configType": "string", "errorMessages": ["string"], "name": "string"}], "status": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)