cisco.catalystcenter.network_device_replacements_workflow_deploy_create module -- Resource module for Network Device Replacements Workflow Deploy Create

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operation create of the resource Network Device Replacements Workflow Deploy Create. - > API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images.

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

configKey

string

If the faulty device was configured with AES password encryption, please provide the same master encryption config key to enable encryption on the replacement device. `Failing to provide the Master Encryption Configuration Key or providing an incorrect one will result in the RMA process transferring only a partial configuration to the replacement device. Configurations such as encrypted passwords or keys would fail to restore without the correct encryption key.`.

configureSso

boolean

Flag to configure HA SSO (High Availability Stateful Switchover) .

Choices:

faultyDeviceSerialNumber

string

Serial number of the faulty device.

haSsoDetail

dictionary

Network Device Replacements Workflow Deploy Create's haSsoDetail.

haInterfaceName

string

An optional HA interface for the primary device, required only for `9800 CL` device type.

localRedundancyIp

string

The IP address assigned to the HA interface on the primary device (either the active or standby device).

peerDeviceSerialNumber

string

Serial number of the peer device.

peerHaInterfaceName

string

An optional HA interface for the peer device, required only for `9800 CL` device type.

redundancyIp

string

Specifies the IP address of the HA interface on the peer device (the other device in the HA pair).

outOfBand

boolean

Indicates that device replacement was performed manually outside the system (out-of-band). Set to true to complete remaining configuration and integration steps and bring device to managed state.

Choices:

primaryGatewayIp

string

Primary gateway IP address of PnP device.

primaryGatewayIpv6

string

Primary gateway IPv6 address of PnP device.

primaryIpInterfaceName

string

Primary IP interface name of PnP device.

primaryNetmask

string

Primary netmask of PnP device.

primaryPrefixLength

integer

IPv6 Primary Prefix Length.Mandatory for IPv6, default is 'null' otherwise.

primaryVlanId

integer

Primary VLAN ID of PnP device.

primaryWirelessManagementIp

string

Primary wireless management IP address of PnP device.

primaryWirelessManagementIpv6

string

Primary wireless management IPv6 address of PnP device.

replacementDeviceSerialNumber

string

Serial number of the replacement device.

secondaryGatewayIp

string

Secondary gateway IP address of PnP device.

secondaryGatewayIpv6

string

Secondary gateway IPv6 address of PnP device.

secondaryIpInterfaceName

string

Secondary IP interface name of PnP device.

secondaryNetmask

string

Secondary netmask of PnP device.

secondaryPrefixLength

integer

IPv6 Secondary Prefix Length.Mandatory for IPv6, default is 'null' otherwise.

secondaryVlanId

integer

Secondary VLAN ID of PnP device.

secondaryWirelessManagementIp

string

Secondary wireless management IP address of PnP device.

secondaryWirelessManagementIpv6

string

Secondary wireless management IPv6 address of PnP device.

type

string

Type of the device.

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 device_replacement.DeviceReplacement.deploy_device_replacement_workflow_site_management,

  • Paths used are post /dna/intent/api/v1/networkDeviceReplacements/workflow/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 Device Replacement DeployDeviceReplacementWorkflowSiteManagement

Complete reference of the DeployDeviceReplacementWorkflowSiteManagement API.

Examples

---
- name: Create
  cisco.catalystcenter.network_device_replacements_workflow_deploy_create:
    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}}"
    configKey: string
    configureSso: true
    faultyDeviceSerialNumber: string
    haSsoDetail:
      haInterfaceName: string
      localRedundancyIp: string
      peerDeviceSerialNumber: string
      peerHaInterfaceName: string
      redundancyIp: string
    outOfBand: true
    primaryGatewayIp: string
    primaryGatewayIpv6: string
    primaryIpInterfaceName: string
    primaryNetmask: string
    primaryPrefixLength: 0
    primaryVlanId: 0
    primaryWirelessManagementIp: string
    primaryWirelessManagementIpv6: string
    replacementDeviceSerialNumber: string
    secondaryGatewayIp: string
    secondaryGatewayIpv6: string
    secondaryIpInterfaceName: string
    secondaryNetmask: string
    secondaryPrefixLength: 0
    secondaryVlanId: 0
    secondaryWirelessManagementIp: string
    secondaryWirelessManagementIpv6: string
    type: string

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)