cisco.dnac.network_device_replacements_info module -- Information module for Network Device Replacements Info

Note

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

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

New in cisco.dnac 6.17.0

Synopsis

  • This module represents an alias of the module network_device_replacements_v1_info

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:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

family

string

Family query parameter. Faulty device family.

faultyDeviceName

string

FaultyDeviceName query parameter. Faulty device name.

faultyDevicePlatform

string

FaultyDevicePlatform query parameter. Faulty device platform.

faultyDeviceSerialNumber

string

FaultyDeviceSerialNumber query parameter. Faulty device serial number.

headers

dictionary

Additional headers.

limit

float

Limit query parameter. The number of records to show for this page. Maximum value can be 500.

offset

float

Offset query parameter. The first record to show for this page; the first record is numbered 1.

replacementDevicePlatform

string

ReplacementDevicePlatform query parameter. Replacement device platform.

replacementDeviceSerialNumber

string

ReplacementDeviceSerialNumber query parameter. Replacement device serial number.

replacementStatus

string

ReplacementStatus query parameter. Device replacement status. Available values MARKED_FOR_REPLACEMENT, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED, READY_FOR_REPLACEMENT, REPLACEMENT_SCHEDULED, REPLACEMENT_IN_PROGRESS, REPLACED, ERROR. Replacement status 'MARKED_FOR_REPLACEMENT' - The faulty device has been marked for replacement. 'NETWORK_READINESS_REQUESTED' - Initiated steps to shut down neighboring device interfaces and create a DHCP server on the uplink neighbor if the faulty device is part of a fabric setup. 'NETWORK_READINESS_FAILED' - Preparation of the network failed. Neighboring device interfaces were not shut down, and the DHCP server on the uplink neighbor was not created. 'READY_FOR_REPLACEMENT' - The network is prepared for the faulty device replacement. Neighboring device interfaces are shut down, and the DHCP server on the uplink neighbor is set up. 'REPLACEMENT_SCHEDULED' - Device replacement has been scheduled. 'REPLACEMENT_IN_PROGRESS' - Device replacement is currently in progress. 'REPLACED' - Device replacement was successful. 'ERROR' - Device replacement has failed.

sortBy

string

SortBy query parameter. A property within the response to sort by. Available values id, creationTime, family, faultyDeviceId, fautyDeviceName, faultyDevicePlatform, faultyDeviceSerialNumber, replacementDevicePlatform, replacementDeviceSerialNumber, replacementTime.

sortOrder

string

SortOrder query parameter. Whether ascending or descending order should be used to sort the response. Available values ASC, DESC.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are device_replacement.DeviceReplacement.retrieve_the_status_of_all_the_device_replacement_workflows_v1,

  • Paths used are get /dna/intent/api/v1/networkDeviceReplacements,

  • It should be noted that this module is an alias of network_device_replacements_v1_info

  • Supports 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 RetrieveTheStatusOfAllTheDeviceReplacementWorkflowsV1

Complete reference of the RetrieveTheStatusOfAllTheDeviceReplacementWorkflowsV1 API.

Examples

- name: Get all Network Device Replacements Info
  cisco.dnac.network_device_replacements_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    family: string
    faultyDeviceName: string
    faultyDevicePlatform: string
    faultyDeviceSerialNumber: string
    replacementDevicePlatform: string
    replacementDeviceSerialNumber: string
    replacementStatus: string
    offset: 0
    limit: 0
    sortBy: string
    sortOrder: string
  register: result

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: :ansible-rv-sample-value:`{"response": [{"creationTime": 0, "family": "string", "faultyDeviceId": "string", "faultyDeviceName": "string", "faultyDevicePlatform": "string", "faultyDeviceSerialNumber": "string", "id": "string", "neighborDeviceId": "string", "replacementDevicePlatform": "string", "replacementDeviceSerialNumber": "string", "replacementStatus": "string", "replacementTime": 0, "workflow": {"endTime": 0, "id": "string", "name": "string", "startTime": 0, "steps": [{"endTime": 0, "name": "string", "startTime": 0, "status": "string", "statusMessage": "string"}], "workflowStatus": "string"}}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)