cisco.catalystcenter.iot_fabric_prp_deploy_update module -- Resource module for Iot Fabric Prp Deploy Update

Note

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operation update of the resource Iot Fabric Prp Deploy Update.

  • This API updates PRP configuration without generating a config preview.

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

activityDescription

string

ActivityDescription query parameter. Optional free-form description that is recorded in the audit log for this activity. If omitted, a default description is generated by the server based on the target device.

allowedVlans

string

VLANs that are permitted on the PRP channel.

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

networkDeviceId

string

Identifier of the network device. It is the `id` attribute in the response of API - `/dna/intent/api/v1/networkDevices`. It must be networkDeviceId of the Redbox device.

supervisionFrameOption

dictionary

PRP supervision frame option.

isVlanAwareEnabled

boolean

Indicates whether VLAN Aware mode is enabled.

Choices:

isVlanAwareRejectUntagged

boolean

Indicates whether untagged supervision frames are rejected.

Choices:

isVlanTagged

boolean

Indicates whether VLAN tagging is enabled.

Choices:

vlanAwareAllowedVlans

string

Allowed VLANs in VLAN Aware Mode.

vlanId

integer

Identifier for a VLAN.

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

  • Paths used are put /dna/intent/api/v1/iot/fabric/prp/deploy,

  • Does not support 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 UpdatePRPConfigurationWithoutGeneratingConfigPreview

Complete reference of the UpdatePRPConfigurationWithoutGeneratingConfigPreview API.

Examples

---
- name: Update all
  cisco.catalystcenter.iot_fabric_prp_deploy_update:
    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}}"
    activityDescription: PRP configuration deploy for device IE3400-Edge-01
    allowedVlans: string
    networkDeviceId: string
    supervisionFrameOption:
      isVlanAwareEnabled: true
      isVlanAwareRejectUntagged: true
      isVlanTagged: true
      vlanAwareAllowedVlans: string
      vlanId: 0

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": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)