cisco.catalystcenter.device_replacement_v1 module -- Resource module for Device Replacement V1

Note

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

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

New in cisco.catalystcenter 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.

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-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 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 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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST 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.catalystcenter.device_replacement_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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.catalystcenter.device_replacement_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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
catalystcenter_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)