.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.dnac.device_replacement_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.device_replacement -- Resource module for Device Replacement +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.2.2). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.device_replacement`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create and update of the resource Device Replacement. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk >= 2.3.1 - python >= 3.5 .. Options Parameters ---------- .. raw:: html

Parameter		Choices/Defaults	Comments
dnac_debug boolean		Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required			The Cisco DNA Center hostname.
dnac_password string			The Cisco DNA Center password to authenticate.
dnac_port string		Default: 443	The Cisco DNA Center port.
dnac_username string		Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean		Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string		Default: "2.2.2.3"	Informs the SDK which version of Cisco DNA Center to use.
payload list / elements=string			Device Replacement's payload.
	creationTime integer		Device Replacement's creationTime.
	family string		Device Replacement's family.
	faultyDeviceId string		Device Replacement's faultyDeviceId.
	faultyDeviceName string		Device Replacement's faultyDeviceName.
	faultyDevicePlatform string		Device Replacement's faultyDevicePlatform.
	faultyDeviceSerialNumber string		Device Replacement's faultyDeviceSerialNumber.
	id string		Device Replacement's id.
	neighbourDeviceId string		Device Replacement's neighbourDeviceId.
	networkReadinessTaskId string		Device Replacement's networkReadinessTaskId.
	replacementDevicePlatform string		Device Replacement's replacementDevicePlatform.
	replacementDeviceSerialNumber string		Device Replacement's replacementDeviceSerialNumber.
	replacementStatus string		Device Replacement's replacementStatus.
	replacementTime integer		Device Replacement's replacementTime.
	workflowId string		Device Replacement's workflowId.
validate_response_schema boolean		Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Device Replacement reference `_ Complete reference of the Device Replacement object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update all cisco.dnac.device_replacement: 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: - name: Create cisco.dnac.device_replacement: 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: .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "response": { "taskId": "string", "url": "string" }, "version": "string" }

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors