/ home / cisco / cisco.dnac / 6.13.3 / module / device_replacement_info

cisco.dnac.device_replacement_info (6.13.3) — module

Information module for Device Replacement

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Device Replacement.

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Device Replacement
  cisco.dnac.device_replacement_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}}"
    faultyDeviceName: string
    faultyDevicePlatform: string
    replacementDevicePlatform: string
    faultyDeviceSerialNumber: string
    replacementDeviceSerialNumber: string
    replacementStatus: []
    family: []
    sortBy: string
    sortOrder: string
    offset: 0
    limit: 0
  register: result

Inputs

    
limit:
    description:
    - Limit query parameter.
    type: int

family:
    description:
    - Family query parameter. List of familiesRouters, Switches and Hubs, AP.
    elements: str
    type: list

offset:
    description:
    - Offset query parameter.
    type: int

sortBy:
    description:
    - SortBy query parameter. SortBy this field. SortBy is mandatory when order is used.
    type: str

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

sortOrder:
    description:
    - SortOrder query parameter. Order on displayNameASC,DESC.
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

faultyDeviceName:
    description:
    - FaultyDeviceName query parameter. Faulty Device Name.
    type: str

replacementStatus:
    description:
    - 'ReplacementStatus query parameter. Device Replacement status READY-FOR-REPLACEMENT,
      REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED,
      NETWORK_READINESS_FAILED.

      '
    elements: str
    type: list

faultyDevicePlatform:
    description:
    - FaultyDevicePlatform query parameter. Faulty Device Platform.
    type: str

faultyDeviceSerialNumber:
    description:
    - FaultyDeviceSerialNumber query parameter. Faulty Device Serial Number.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

replacementDevicePlatform:
    description:
    - ReplacementDevicePlatform query parameter. Replacement Device Platform.
    type: str

replacementDeviceSerialNumber:
    description:
    - ReplacementDeviceSerialNumber query parameter. Replacement Device Serial Number.
    type: str

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": [\n    {\n      \"creationTime\": 0,\n      \"family\"\
    : \"string\",\n      \"faultyDeviceId\": \"string\",\n      \"faultyDeviceName\"\
    : \"string\",\n      \"faultyDevicePlatform\": \"string\",\n      \"faultyDeviceSerialNumber\"\
    : \"string\",\n      \"id\": \"string\",\n      \"neighbourDeviceId\": \"string\"\
    ,\n      \"networkReadinessTaskId\": \"string\",\n      \"replacementDevicePlatform\"\
    : \"string\",\n      \"replacementDeviceSerialNumber\": \"string\",\n      \"\
    replacementStatus\": \"string\",\n      \"replacementTime\": 0,\n      \"workflowId\"\
    : \"string\"\n    }\n  ],\n  \"version\": \"string\"\n}\n"
  type: dict