racampos.dnac.device_replacement (0.0.1) — module

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1

Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

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.

Marks device for replacement.

UnMarks device for replacement.

Get replacement devices count.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: return_replacement_devices_with_details
  cisco.dnac.device_replacement:
    state: query  # required
    family: SomeValue  # string
    faulty_device_name: SomeValue  # string
    faulty_device_platform: SomeValue  # string
    faulty_device_serial_number: SomeValue  # string
    limit: 1  #  integer
    offset: 1  #  integer
    replacement_device_platform: SomeValue  # string
    replacement_device_serial_number: SomeValue  # string
    replacement_status: SomeValue  # string
    sort_by: SomeValue  # string
    sort_order: SomeValue  # string
  register: query_result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
- name: mark_device_for_replacement
  cisco.dnac.device_replacement:
    state: create  # required
    payload:  # required
    - faultyDeviceId: SomeValue  # string, required
      replacementStatus: SomeValue  # string, required
      creationTime: 1  #  integer
      family: SomeValue  # string
      faultyDeviceName: SomeValue  # string
      faultyDevicePlatform: SomeValue  # string
      faultyDeviceSerialNumber: SomeValue  # string
      id: SomeValue  # string
      neighbourDeviceId: SomeValue  # string
      networkReadinessTaskId: SomeValue  # string
      replacementDevicePlatform: SomeValue  # string
      replacementDeviceSerialNumber: SomeValue  # string
      replacementTime: 1  #  integer
      workflowId: SomeValue  # string

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
- name: unmark_device_for_replacement
  cisco.dnac.device_replacement:
    state: update  # required
    payload:  # required
    - faultyDeviceId: SomeValue  # string, required
      replacementStatus: SomeValue  # string, required
      creationTime: 1  #  integer
      family: SomeValue  # string
      faultyDeviceName: SomeValue  # string
      faultyDevicePlatform: SomeValue  # string
      faultyDeviceSerialNumber: SomeValue  # string
      id: SomeValue  # string
      neighbourDeviceId: SomeValue  # string
      networkReadinessTaskId: SomeValue  # string
      replacementDevicePlatform: SomeValue  # string
      replacementDeviceSerialNumber: SomeValue  # string
      replacementTime: 1  #  integer
      workflowId: SomeValue  # string

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
- name: return_replacement_devices_count
  cisco.dnac.device_replacement:
    state: query  # required
    count: True  # boolean, required
    replacement_status: SomeValue  # string
  register: query_result

Inputs

    
count:
    description:
    - If true gets the number of objects.
    - Required for state query.
    type: bool

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

family:
    description:
    - List of families[Routers, Switches and Hubs, AP].
    type: str

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

payload:
    description:
    - An object to send in the Request body.
    elements: dict
    required: true
    suboptions:
      creationTime:
        description:
        - It is the device replacement's creationTime.
        type: int
      family:
        description:
        - It is the device replacement's family.
        type: str
      faultyDeviceId:
        description:
        - It is the device replacement's faultyDeviceId.
        - Required for states create and update.
        type: str
      faultyDeviceName:
        description:
        - It is the device replacement's faultyDeviceName.
        type: str
      faultyDevicePlatform:
        description:
        - It is the device replacement's faultyDevicePlatform.
        type: str
      faultyDeviceSerialNumber:
        description:
        - It is the device replacement's faultyDeviceSerialNumber.
        type: str
      id:
        description:
        - It is the device replacement's id.
        type: str
      neighbourDeviceId:
        description:
        - It is the device replacement's neighbourDeviceId.
        type: str
      networkReadinessTaskId:
        description:
        - It is the device replacement's networkReadinessTaskId.
        type: str
      replacementDevicePlatform:
        description:
        - It is the device replacement's replacementDevicePlatform.
        type: str
      replacementDeviceSerialNumber:
        description:
        - It is the device replacement's replacementDeviceSerialNumber.
        type: str
      replacementStatus:
        description:
        - It is the device replacement's replacementStatus.
        - Required for states create and update.
        type: str
      replacementTime:
        description:
        - It is the device replacement's replacementTime.
        type: int
      workflowId:
        description:
        - It is the device replacement's workflowId.
        type: str
    type: list

sort_by:
    description:
    - SortBy this field. SortBy is mandatory when order is used.
    type: str

sort_order:
    description:
    - Order on displayName[ASC,DESC].
    type: str

faulty_device_name:
    description:
    - Faulty Device Name.
    type: str

replacement_status:
    description:
    - Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED,
      REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED].
    - Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED,
      REPLACED, ERROR].
    type: str

faulty_device_platform:
    description:
    - Faulty Device Platform.
    type: str

faulty_device_serial_number:
    description:
    - Faulty Device Serial Number.
    type: str

replacement_device_platform:
    description:
    - Replacement Device Platform.
    type: str

replacement_device_serial_number:
    description:
    - Replacement Device Serial Number.
    type: str

Outputs

mark_device_for_replacement:
  contains: null
  description: Marks device for replacement.
  response:
    contains:
      taskId:
        description: It is the device replacement's taskId.
        returned: success
        type: dict
      url:
        description: It is the device replacement's url.
        returned: success
        sample: <url>
        type: str
    description: DeviceReplacementDataDTO's response.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: DeviceReplacementDataDTO's version.
    returned: success
    sample: '1.0'
    type: str
return_replacement_devices_count:
  contains: null
  description: Get replacement devices count.
  response:
    description: Response, property of the response body.
    returned: always
    sample: 0
    type: int
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
return_replacement_devices_with_details:
  contains: null
  description: 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.
  response:
    contains:
      creationTime:
        description: It is the device replacement's creationTime.
        returned: always
        sample: 0
        type: int
      family:
        description: It is the device replacement's family.
        returned: always
        sample: <family>
        type: str
      faultyDeviceId:
        description: It is the device replacement's faultyDeviceId.
        returned: always
        sample: <faultydeviceid>
        type: str
      faultyDeviceName:
        description: It is the device replacement's faultyDeviceName.
        returned: always
        sample: <faultydevicename>
        type: str
      faultyDevicePlatform:
        description: It is the device replacement's faultyDevicePlatform.
        returned: always
        sample: <faultydeviceplatform>
        type: str
      faultyDeviceSerialNumber:
        description: It is the device replacement's faultyDeviceSerialNumber.
        returned: always
        sample: <faultydeviceserialnumber>
        type: str
      id:
        description: It is the device replacement's id.
        returned: always
        sample: '478012'
        type: str
      neighbourDeviceId:
        description: It is the device replacement's neighbourDeviceId.
        returned: always
        sample: <neighbourdeviceid>
        type: str
      networkReadinessTaskId:
        description: It is the device replacement's networkReadinessTaskId.
        returned: always
        sample: <networkreadinesstaskid>
        type: str
      replacementDevicePlatform:
        description: It is the device replacement's replacementDevicePlatform.
        returned: always
        sample: <replacementdeviceplatform>
        type: str
      replacementDeviceSerialNumber:
        description: It is the device replacement's replacementDeviceSerialNumber.
        returned: always
        sample: <replacementdeviceserialnumber>
        type: str
      replacementStatus:
        description: It is the device replacement's replacementStatus.
        returned: always
        sample: <replacementstatus>
        type: str
      replacementTime:
        description: It is the device replacement's replacementTime.
        returned: always
        sample: 0
        type: int
      workflowId:
        description: It is the device replacement's workflowId.
        returned: always
        sample: <workflowid>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
unmark_device_for_replacement:
  contains: null
  description: UnMarks device for replacement.
  response:
    contains:
      taskId:
        description: It is the device replacement's taskId.
        returned: changed
        type: dict
      url:
        description: It is the device replacement's url.
        returned: changed
        sample: <url>
        type: str
    description: DeviceReplacementDataDTO's response.
    returned: changed
    type: dict
  returned: changed
  type: dict
  version:
    description: DeviceReplacementDataDTO's version.
    returned: changed
    sample: '1.0'
    type: str

See also

• cisco.dnac.plugins.module_utils.definitions.device_replacement
• DeviceReplacement reference: Complete reference of the DeviceReplacement object model. link
• DeviceReplacement reference: SDK reference. link