W3cubDocs

/Ansible

cisco.dnac.device_replacement_v1 module – Resource module for Device Replacement V1

Note

This module is part of the cisco.dnac collection (version 6.31.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.device_replacement_v1.

New in cisco.dnac 3.1.0

Synopsis

  • Manage operations create and update of the resource Device Replacement V1.
  • Marks device for replacement.
  • UnMarks device for replacement.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9
  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)
  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false
  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

payload

list / elements=dictionary

Device Replacement’s payload.

creationTime

integer

Date and time of marking the device for replacement.

family

string

Faulty device family.

faultyDeviceId

string

Unique identifier of the faulty device.

faultyDeviceName

string

Faulty device name.

faultyDevicePlatform

string

Faulty device platform.

faultyDeviceSerialNumber

string

Faulty device serial number.

id

string

Unique identifier of the device replacement resource.

neighbourDeviceId

string

Unique identifier of the neighbor device to create the DHCP server.

networkReadinessTaskId

string

Unique identifier of network readiness task.

replacementDevicePlatform

string

Replacement device platform.

replacementDeviceSerialNumber

string

Replacement device serial number.

replacementStatus

string

Device replacement status. Use NON-FAULTY to unmark the device for replacement.

replacementTime

integer

Date and time of device replacement.

workflowId

string

Unique identifier of the device replacement workflow.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false
  • true ← (default)

Notes

Note

  • SDK Method used are device_replacement.DeviceReplacement.mark_device_for_replacement_v1, device_replacement.DeviceReplacement.unmark_device_for_replacement_v1,
  • Paths used are post /dna/intent/api/v1/device-replacement, put /dna/intent/api/v1/device-replacement,
  • Does not support 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 DNAC SDK
  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Device Replacement MarkDeviceForReplacementV1

Complete reference of the MarkDeviceForReplacementV1 API.

Cisco DNA Center documentation for Device Replacement UnMarkDeviceForReplacementV1

Complete reference of the UnMarkDeviceForReplacementV1 API.

Examples

- name: Update all
  cisco.dnac.device_replacement_v1:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    payload:
      - creationTime: 0
        family: string
        faultyDeviceId: string
        faultyDeviceName: string
        faultyDevicePlatform: string
        faultyDeviceSerialNumber: string
        id: string
        neighbourDeviceId: string
        networkReadinessTaskId: string
        replacementDevicePlatform: string
        replacementDeviceSerialNumber: string
        replacementStatus: string
        replacementTime: 0
        workflowId: string
- name: Create
  cisco.dnac.device_replacement_v1:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    payload:
      - creationTime: 0
        family: string
        faultyDeviceId: string
        faultyDeviceName: string
        faultyDevicePlatform: string
        faultyDeviceSerialNumber: string
        id: string
        neighbourDeviceId: string
        networkReadinessTaskId: string
        replacementDevicePlatform: string
        replacementDeviceSerialNumber: string
        replacementStatus: string
        replacementTime: 0
        workflowId: string

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

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/device_replacement_v1_module.html