cisco.dnac.pnp_device (6.13.3) — module

Resource module for Pnp Device

| "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

Manage operations create, update and delete of the resource Pnp Device.

Adds a device to the PnP database.

Deletes specified device from PnP database.

Updates device details specified by device id in PnP database.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create
  cisco.dnac.pnp_device:
    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
    _id: string
    deviceInfo:
      aaaCredentials:
        password: string
        username: string
      addedOn: 0
      addnMacAddrs:
      - string
      agentType: string
      authStatus: string
      authenticatedSudiSerialNo: string
      capabilitiesSupported:
      - string
      cmState: string
      description: string
      deviceSudiSerialNos:
      - string
      deviceType: string
      featuresSupported:
      - string
      fileSystemList:
      - freespace: 0
        name: string
        readable: true
        size: 0
        type: string
        writeable: true
      firstContact: 0
      hostname: string
      httpHeaders:
      - key: string
        value: string
      imageFile: string
      imageVersion: string
      ipInterfaces:
      - ipv4Address: {}
        ipv6AddressList:
        - {}
        macAddress: string
        name: string
        status: string
      lastContact: 0
      lastSyncTime: 0
      lastUpdateOn: 0
      location:
        address: string
        altitude: string
        latitude: string
        longitude: string
        siteId: string
      macAddress: string
      mode: string
      name: string
      neighborLinks:
      - localInterfaceName: string
        localMacAddress: string
        localShortInterfaceName: string
        remoteDeviceName: string
        remoteInterfaceName: string
        remoteMacAddress: string
        remotePlatform: string
        remoteShortInterfaceName: string
        remoteVersion: string
      onbState: string
      pid: string
      pnpProfileList:
      - createdBy: string
        discoveryCreated: true
        primaryEndpoint:
          certificate: string
          fqdn: string
          ipv4Address: {}
          ipv6Address: {}
          port: 0
          protocol: string
        profileName: string
        secondaryEndpoint:
          certificate: string
          fqdn: string
          ipv4Address: {}
          ipv6Address: {}
          port: 0
          protocol: string
      populateInventory: true
      preWorkflowCliOuputs:
      - cli: string
        cliOutput: string
      projectId: string
      projectName: string
      reloadRequested: true
      serialNumber: string
      smartAccountId: string
      source: string
      stack: true
      stackInfo:
        isFullRing: true
        stackMemberList:
        - hardwareVersion: string
          licenseLevel: string
          licenseType: string
          macAddress: string
          pid: string
          priority: 0
          role: string
          serialNumber: string
          softwareVersion: string
          stackNumber: 0
          state: string
          sudiSerialNumber: string
        stackRingProtocol: string
        supportsStackWorkflows: true
        totalMemberCount: 0
        validLicenseLevels:
        - string
      state: string
      sudiRequired: true
      tags: {}
      userSudiSerialNos:
      - string
      virtualAccountId: string
      workflowId: string
      workflowName: string
    runSummaryList:
    - details: string
      errorFlag: true
      historyTaskInfo:
        addnDetails:
        - key: string
          value: string
        name: string
        timeTaken: 0
        type: string
        workItemList:
        - command: string
          endTime: 0
          outputStr: string
          startTime: 0
          state: string
          timeTaken: 0
      timestamp: 0
    systemResetWorkflow:
      _id: string
      addToInventory: true
      addedOn: 0
      configId: string
      currTaskIdx: 0
      description: string
      endTime: 0
      execTime: 0
      imageId: string
      instanceType: string
      lastupdateOn: 0
      name: string
      startTime: 0
      state: string
      tasks:
      - currWorkItemIdx: 0
        endTime: 0
        name: string
        startTime: 0
        state: string
        taskSeqNo: 0
        timeTaken: 0
        type: string
        workItemList:
        - command: string
          endTime: 0
          outputStr: string
          startTime: 0
          state: string
          timeTaken: 0
      tenantId: string
      type: string
      useState: string
      version: 0
    systemWorkflow:
      _id: string
      addToInventory: true
      addedOn: 0
      configId: string
      currTaskIdx: 0
      description: string
      endTime: 0
      execTime: 0
      imageId: string
      instanceType: string
      lastupdateOn: 0
      name: string
      startTime: 0
      state: string
      tasks:
      - currWorkItemIdx: 0
        endTime: 0
        name: string
        startTime: 0
        state: string
        taskSeqNo: 0
        timeTaken: 0
        type: string
        workItemList:
        - command: string
          endTime: 0
          outputStr: string
          startTime: 0
          state: string
          timeTaken: 0
      tenantId: string
      type: string
      useState: string
      version: 0
    tenantId: string
    version: 0
    workflow:
      _id: string
      addToInventory: true
      addedOn: 0
      configId: string
      currTaskIdx: 0
      description: string
      endTime: 0
      execTime: 0
      imageId: string
      instanceType: string
      lastupdateOn: 0
      name: string
      startTime: 0
      state: string
      tasks:
      - currWorkItemIdx: 0
        endTime: 0
        name: string
        startTime: 0
        state: string
        taskSeqNo: 0
        timeTaken: 0
        type: string
        workItemList:
        - command: string
          endTime: 0
          outputStr: string
          startTime: 0
          state: string
          timeTaken: 0
      tenantId: string
      type: string
      useState: string
      version: 0
    workflowParameters:
      configList:
      - configId: string
        configParameters:
        - key: string
          value: string
      licenseLevel: string
      licenseType: string
      topOfStackSerialNumber: string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update by id
  cisco.dnac.pnp_device:
    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
    _id: string
    deviceInfo:
      aaaCredentials:
        password: string
        username: string
      addedOn: 0
      addnMacAddrs:
      - string
      agentType: string
      authStatus: string
      authenticatedSudiSerialNo: string
      capabilitiesSupported:
      - string
      cmState: string
      description: string
      deviceSudiSerialNos:
      - string
      deviceType: string
      featuresSupported:
      - string
      fileSystemList:
      - freespace: 0
        name: string
        readable: true
        size: 0
        type: string
        writeable: true
      firstContact: 0
      hostname: string
      httpHeaders:
      - key: string
        value: string
      imageFile: string
      imageVersion: string
      ipInterfaces:
      - ipv4Address: {}
        ipv6AddressList:
        - {}
        macAddress: string
        name: string
        status: string
      lastContact: 0
      lastSyncTime: 0
      lastUpdateOn: 0
      location:
        address: string
        altitude: string
        latitude: string
        longitude: string
        siteId: string
      macAddress: string
      mode: string
      name: string
      neighborLinks:
      - localInterfaceName: string
        localMacAddress: string
        localShortInterfaceName: string
        remoteDeviceName: string
        remoteInterfaceName: string
        remoteMacAddress: string
        remotePlatform: string
        remoteShortInterfaceName: string
        remoteVersion: string
      onbState: string
      pid: string
      pnpProfileList:
      - createdBy: string
        discoveryCreated: true
        primaryEndpoint:
          certificate: string
          fqdn: string
          ipv4Address: {}
          ipv6Address: {}
          port: 0
          protocol: string
        profileName: string
        secondaryEndpoint:
          certificate: string
          fqdn: string
          ipv4Address: {}
          ipv6Address: {}
          port: 0
          protocol: string
      populateInventory: true
      preWorkflowCliOuputs:
      - cli: string
        cliOutput: string
      projectId: string
      projectName: string
      reloadRequested: true
      serialNumber: string
      smartAccountId: string
      source: string
      stack: true
      stackInfo:
        isFullRing: true
        stackMemberList:
        - hardwareVersion: string
          licenseLevel: string
          licenseType: string
          macAddress: string
          pid: string
          priority: 0
          role: string
          serialNumber: string
          softwareVersion: string
          stackNumber: 0
          state: string
          sudiSerialNumber: string
        stackRingProtocol: string
        supportsStackWorkflows: true
        totalMemberCount: 0
        validLicenseLevels:
        - string
      state: string
      sudiRequired: true
      tags: {}
      userSudiSerialNos:
      - string
      virtualAccountId: string
      workflowId: string
      workflowName: string
    id: string
    runSummaryList:
    - details: string
      errorFlag: true
      historyTaskInfo:
        addnDetails:
        - key: string
          value: string
        name: string
        timeTaken: 0
        type: string
        workItemList:
        - command: string
          endTime: 0
          outputStr: string
          startTime: 0
          state: string
          timeTaken: 0
      timestamp: 0
    systemResetWorkflow:
      _id: string
      addToInventory: true
      addedOn: 0
      configId: string
      currTaskIdx: 0
      description: string
      endTime: 0
      execTime: 0
      imageId: string
      instanceType: string
      lastupdateOn: 0
      name: string
      startTime: 0
      state: string
      tasks:
      - currWorkItemIdx: 0
        endTime: 0
        name: string
        startTime: 0
        state: string
        taskSeqNo: 0
        timeTaken: 0
        type: string
        workItemList:
        - command: string
          endTime: 0
          outputStr: string
          startTime: 0
          state: string
          timeTaken: 0
      tenantId: string
      type: string
      useState: string
      version: 0
    systemWorkflow:
      _id: string
      addToInventory: true
      addedOn: 0
      configId: string
      currTaskIdx: 0
      description: string
      endTime: 0
      execTime: 0
      imageId: string
      instanceType: string
      lastupdateOn: 0
      name: string
      startTime: 0
      state: string
      tasks:
      - currWorkItemIdx: 0
        endTime: 0
        name: string
        startTime: 0
        state: string
        taskSeqNo: 0
        timeTaken: 0
        type: string
        workItemList:
        - command: string
          endTime: 0
          outputStr: string
          startTime: 0
          state: string
          timeTaken: 0
      tenantId: string
      type: string
      useState: string
      version: 0
    tenantId: string
    version: 0
    workflow:
      _id: string
      addToInventory: true
      addedOn: 0
      configId: string
      currTaskIdx: 0
      description: string
      endTime: 0
      execTime: 0
      imageId: string
      instanceType: string
      lastupdateOn: 0
      name: string
      startTime: 0
      state: string
      tasks:
      - currWorkItemIdx: 0
        endTime: 0
        name: string
        startTime: 0
        state: string
        taskSeqNo: 0
        timeTaken: 0
        type: string
        workItemList:
        - command: string
          endTime: 0
          outputStr: string
          startTime: 0
          state: string
          timeTaken: 0
      tenantId: string
      type: string
      useState: string
      version: 0
    workflowParameters:
      configList:
      - configId: string
        configParameters:
        - key: string
          value: string
      licenseLevel: string
      licenseType: string
      topOfStackSerialNumber: string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete by id
  cisco.dnac.pnp_device:
    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: absent
    id: string

Inputs

    
id:
    description: Id path parameter.
    type: str

_id:
    description: Pnp Device's _id.
    type: str

version:
    description: Pnp Device's version.
    type: int

tenantId:
    description: Pnp Device's tenantId.
    type: str

workflow:
    description: Pnp Device's workflow.
    suboptions:
      _id:
        description: Pnp Device's _id.
        type: str
      addToInventory:
        description: AddToInventory flag.
        type: bool
      addedOn:
        description: Pnp Device's addedOn.
        type: int
      configId:
        description: Pnp Device's configId.
        type: str
      currTaskIdx:
        description: Pnp Device's currTaskIdx.
        type: int
      description:
        description: Pnp Device's description.
        type: str
      endTime:
        description: Pnp Device's endTime.
        type: int
      execTime:
        description: Pnp Device's execTime.
        type: int
      imageId:
        description: Pnp Device's imageId.
        type: str
      instanceType:
        description: Pnp Device's instanceType.
        type: str
      lastupdateOn:
        description: Pnp Device's lastupdateOn.
        type: int
      name:
        description: Pnp Device's name.
        type: str
      startTime:
        description: Pnp Device's startTime.
        type: int
      state:
        description: Pnp Device's state.
        type: str
      tasks:
        description: Pnp Device's tasks.
        elements: dict
        suboptions:
          currWorkItemIdx:
            description: Pnp Device's currWorkItemIdx.
            type: int
          endTime:
            description: Pnp Device's endTime.
            type: int
          name:
            description: Pnp Device's name.
            type: str
          startTime:
            description: Pnp Device's startTime.
            type: int
          state:
            description: Pnp Device's state.
            type: str
          taskSeqNo:
            description: Pnp Device's taskSeqNo.
            type: int
          timeTaken:
            description: Pnp Device's timeTaken.
            type: int
          type:
            description: Pnp Device's type.
            type: str
          workItemList:
            description: Pnp Device's workItemList.
            elements: dict
            suboptions:
              command:
                description: Pnp Device's command.
                type: str
              endTime:
                description: Pnp Device's endTime.
                type: int
              outputStr:
                description: Pnp Device's outputStr.
                type: str
              startTime:
                description: Pnp Device's startTime.
                type: int
              state:
                description: Pnp Device's state.
                type: str
              timeTaken:
                description: Pnp Device's timeTaken.
                type: int
            type: list
        type: list
      tenantId:
        description: Pnp Device's tenantId.
        type: str
      type:
        description: Pnp Device's type.
        type: str
      useState:
        description: Pnp Device's useState.
        type: str
      version:
        description: Pnp Device's version.
        type: int
    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

deviceInfo:
    description: Pnp Device's deviceInfo.
    suboptions:
      aaaCredentials:
        description: Pnp Device's aaaCredentials.
        suboptions:
          password:
            description: Pnp Device's password.
            type: str
          username:
            description: Pnp Device's username.
            type: str
        type: dict
      addedOn:
        description: Pnp Device's addedOn.
        type: int
      addnMacAddrs:
        description: Pnp Device's addnMacAddrs.
        elements: str
        type: list
      agentType:
        description: Pnp Device's agentType.
        type: str
      authStatus:
        description: Pnp Device's authStatus.
        type: str
      authenticatedSudiSerialNo:
        description: Pnp Device's authenticatedSudiSerialNo.
        type: str
      capabilitiesSupported:
        description: Pnp Device's capabilitiesSupported.
        elements: str
        type: list
      cmState:
        description: Pnp Device's cmState.
        type: str
      description:
        description: Pnp Device's description.
        type: str
      deviceSudiSerialNos:
        description: Pnp Device's deviceSudiSerialNos.
        elements: str
        type: list
      deviceType:
        description: Pnp Device's deviceType.
        type: str
      featuresSupported:
        description: Pnp Device's featuresSupported.
        elements: str
        type: list
      fileSystemList:
        description: Pnp Device's fileSystemList.
        elements: dict
        suboptions:
          freespace:
            description: Pnp Device's freespace.
            type: int
          name:
            description: Pnp Device's name.
            type: str
          readable:
            description: Readable flag.
            type: bool
          size:
            description: Pnp Device's size.
            type: int
          type:
            description: Pnp Device's type.
            type: str
          writeable:
            description: Writeable flag.
            type: bool
        type: list
      firstContact:
        description: Pnp Device's firstContact.
        type: int
      hostname:
        description: Pnp Device's hostname.
        type: str
      httpHeaders:
        description: Pnp Device's httpHeaders.
        elements: dict
        suboptions:
          key:
            description: Pnp Device's key.
            type: str
          value:
            description: Pnp Device's value.
            type: str
        type: list
      imageFile:
        description: Pnp Device's imageFile.
        type: str
      imageVersion:
        description: Pnp Device's imageVersion.
        type: str
      ipInterfaces:
        description: Pnp Device's ipInterfaces.
        elements: dict
        suboptions:
          ipv4Address:
            description: Pnp Device's ipv4Address.
            type: dict
          ipv6AddressList:
            description: Pnp Device's ipv6AddressList.
            elements: dict
            type: list
          macAddress:
            description: Pnp Device's macAddress.
            type: str
          name:
            description: Pnp Device's name.
            type: str
          status:
            description: Pnp Device's status.
            type: str
        type: list
      lastContact:
        description: Pnp Device's lastContact.
        type: int
      lastSyncTime:
        description: Pnp Device's lastSyncTime.
        type: int
      lastUpdateOn:
        description: Pnp Device's lastUpdateOn.
        type: int
      location:
        description: Pnp Device's location.
        suboptions:
          address:
            description: Pnp Device's address.
            type: str
          altitude:
            description: Pnp Device's altitude.
            type: str
          latitude:
            description: Pnp Device's latitude.
            type: str
          longitude:
            description: Pnp Device's longitude.
            type: str
          siteId:
            description: Pnp Device's siteId.
            type: str
        type: dict
      macAddress:
        description: Pnp Device's macAddress.
        type: str
      mode:
        description: Pnp Device's mode.
        type: str
      name:
        description: Pnp Device's name.
        type: str
      neighborLinks:
        description: Pnp Device's neighborLinks.
        elements: dict
        suboptions:
          localInterfaceName:
            description: Pnp Device's localInterfaceName.
            type: str
          localMacAddress:
            description: Pnp Device's localMacAddress.
            type: str
          localShortInterfaceName:
            description: Pnp Device's localShortInterfaceName.
            type: str
          remoteDeviceName:
            description: Pnp Device's remoteDeviceName.
            type: str
          remoteInterfaceName:
            description: Pnp Device's remoteInterfaceName.
            type: str
          remoteMacAddress:
            description: Pnp Device's remoteMacAddress.
            type: str
          remotePlatform:
            description: Pnp Device's remotePlatform.
            type: str
          remoteShortInterfaceName:
            description: Pnp Device's remoteShortInterfaceName.
            type: str
          remoteVersion:
            description: Pnp Device's remoteVersion.
            type: str
        type: list
      onbState:
        description: Pnp Device's onbState.
        type: str
      pid:
        description: Pnp Device's pid.
        type: str
      pnpProfileList:
        description: Pnp Device's pnpProfileList.
        elements: dict
        suboptions:
          createdBy:
            description: Pnp Device's createdBy.
            type: str
          discoveryCreated:
            description: DiscoveryCreated flag.
            type: bool
          primaryEndpoint:
            description: Pnp Device's primaryEndpoint.
            suboptions:
              certificate:
                description: Pnp Device's certificate.
                type: str
              fqdn:
                description: Pnp Device's fqdn.
                type: str
              ipv4Address:
                description: Pnp Device's ipv4Address.
                type: dict
              ipv6Address:
                description: Pnp Device's ipv6Address.
                type: dict
              port:
                description: Pnp Device's port.
                type: int
              protocol:
                description: Pnp Device's protocol.
                type: str
            type: dict
          profileName:
            description: Pnp Device's profileName.
            type: str
          secondaryEndpoint:
            description: Pnp Device's secondaryEndpoint.
            suboptions:
              certificate:
                description: Pnp Device's certificate.
                type: str
              fqdn:
                description: Pnp Device's fqdn.
                type: str
              ipv4Address:
                description: Pnp Device's ipv4Address.
                type: dict
              ipv6Address:
                description: Pnp Device's ipv6Address.
                type: dict
              port:
                description: Pnp Device's port.
                type: int
              protocol:
                description: Pnp Device's protocol.
                type: str
            type: dict
        type: list
      populateInventory:
        description: PopulateInventory flag.
        type: bool
      preWorkflowCliOuputs:
        description: Pnp Device's preWorkflowCliOuputs.
        elements: dict
        suboptions:
          cli:
            description: Pnp Device's cli.
            type: str
          cliOutput:
            description: Pnp Device's cliOutput.
            type: str
        type: list
      projectId:
        description: Pnp Device's projectId.
        type: str
      projectName:
        description: Pnp Device's projectName.
        type: str
      reloadRequested:
        description: ReloadRequested flag.
        type: bool
      serialNumber:
        description: Pnp Device's serialNumber.
        type: str
      smartAccountId:
        description: Pnp Device's smartAccountId.
        type: str
      source:
        description: Pnp Device's source.
        type: str
      stack:
        description: Stack flag.
        type: bool
      stackInfo:
        description: Pnp Device's stackInfo.
        suboptions:
          isFullRing:
            description: IsFullRing flag.
            type: bool
          stackMemberList:
            description: Pnp Device's stackMemberList.
            elements: dict
            suboptions:
              hardwareVersion:
                description: Pnp Device's hardwareVersion.
                type: str
              licenseLevel:
                description: Pnp Device's licenseLevel.
                type: str
              licenseType:
                description: Pnp Device's licenseType.
                type: str
              macAddress:
                description: Pnp Device's macAddress.
                type: str
              pid:
                description: Pnp Device's pid.
                type: str
              priority:
                description: Pnp Device's priority.
                type: int
              role:
                description: Pnp Device's role.
                type: str
              serialNumber:
                description: Pnp Device's serialNumber.
                type: str
              softwareVersion:
                description: Pnp Device's softwareVersion.
                type: str
              stackNumber:
                description: Pnp Device's stackNumber.
                type: int
              state:
                description: Pnp Device's state.
                type: str
              sudiSerialNumber:
                description: Pnp Device's sudiSerialNumber.
                type: str
            type: list
          stackRingProtocol:
            description: Pnp Device's stackRingProtocol.
            type: str
          supportsStackWorkflows:
            description: SupportsStackWorkflows flag.
            type: bool
          totalMemberCount:
            description: Pnp Device's totalMemberCount.
            type: int
          validLicenseLevels:
            description: Pnp Device's validLicenseLevels.
            elements: str
            type: list
        type: dict
      state:
        description: Pnp Device's state.
        type: str
      sudiRequired:
        description: SudiRequired flag.
        type: bool
      tags:
        description: Pnp Device's tags.
        type: dict
      userSudiSerialNos:
        description: Pnp Device's userSudiSerialNos.
        elements: str
        type: list
      virtualAccountId:
        description: Pnp Device's virtualAccountId.
        type: str
      workflowId:
        description: Pnp Device's workflowId.
        type: str
      workflowName:
        description: Pnp Device's workflowName.
        type: str
    type: dict

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

runSummaryList:
    description: Pnp Device's runSummaryList.
    elements: dict
    suboptions:
      details:
        description: Pnp Device's details.
        type: str
      errorFlag:
        description: ErrorFlag flag.
        type: bool
      historyTaskInfo:
        description: Pnp Device's historyTaskInfo.
        suboptions:
          addnDetails:
            description: Pnp Device's addnDetails.
            elements: dict
            suboptions:
              key:
                description: Pnp Device's key.
                type: str
              value:
                description: Pnp Device's value.
                type: str
            type: list
          name:
            description: Pnp Device's name.
            type: str
          timeTaken:
            description: Pnp Device's timeTaken.
            type: int
          type:
            description: Pnp Device's type.
            type: str
          workItemList:
            description: Pnp Device's workItemList.
            elements: dict
            suboptions:
              command:
                description: Pnp Device's command.
                type: str
              endTime:
                description: Pnp Device's endTime.
                type: int
              outputStr:
                description: Pnp Device's outputStr.
                type: str
              startTime:
                description: Pnp Device's startTime.
                type: int
              state:
                description: Pnp Device's state.
                type: str
              timeTaken:
                description: Pnp Device's timeTaken.
                type: int
            type: list
        type: dict
      timestamp:
        description: Pnp Device's timestamp.
        type: int
    type: list

systemWorkflow:
    description: Pnp Device's systemWorkflow.
    suboptions:
      _id:
        description: Pnp Device's _id.
        type: str
      addToInventory:
        description: AddToInventory flag.
        type: bool
      addedOn:
        description: Pnp Device's addedOn.
        type: int
      configId:
        description: Pnp Device's configId.
        type: str
      currTaskIdx:
        description: Pnp Device's currTaskIdx.
        type: int
      description:
        description: Pnp Device's description.
        type: str
      endTime:
        description: Pnp Device's endTime.
        type: int
      execTime:
        description: Pnp Device's execTime.
        type: int
      imageId:
        description: Pnp Device's imageId.
        type: str
      instanceType:
        description: Pnp Device's instanceType.
        type: str
      lastupdateOn:
        description: Pnp Device's lastupdateOn.
        type: int
      name:
        description: Pnp Device's name.
        type: str
      startTime:
        description: Pnp Device's startTime.
        type: int
      state:
        description: Pnp Device's state.
        type: str
      tasks:
        description: Pnp Device's tasks.
        elements: dict
        suboptions:
          currWorkItemIdx:
            description: Pnp Device's currWorkItemIdx.
            type: int
          endTime:
            description: Pnp Device's endTime.
            type: int
          name:
            description: Pnp Device's name.
            type: str
          startTime:
            description: Pnp Device's startTime.
            type: int
          state:
            description: Pnp Device's state.
            type: str
          taskSeqNo:
            description: Pnp Device's taskSeqNo.
            type: int
          timeTaken:
            description: Pnp Device's timeTaken.
            type: int
          type:
            description: Pnp Device's type.
            type: str
          workItemList:
            description: Pnp Device's workItemList.
            elements: dict
            suboptions:
              command:
                description: Pnp Device's command.
                type: str
              endTime:
                description: Pnp Device's endTime.
                type: int
              outputStr:
                description: Pnp Device's outputStr.
                type: str
              startTime:
                description: Pnp Device's startTime.
                type: int
              state:
                description: Pnp Device's state.
                type: str
              timeTaken:
                description: Pnp Device's timeTaken.
                type: int
            type: list
        type: list
      tenantId:
        description: Pnp Device's tenantId.
        type: str
      type:
        description: Pnp Device's type.
        type: str
      useState:
        description: Pnp Device's useState.
        type: str
      version:
        description: Pnp Device's version.
        type: int
    type: dict

workflowParameters:
    description: Pnp Device's workflowParameters.
    suboptions:
      configList:
        description: Pnp Device's configList.
        elements: dict
        suboptions:
          configId:
            description: Pnp Device's configId.
            type: str
          configParameters:
            description: Pnp Device's configParameters.
            elements: dict
            suboptions:
              key:
                description: Pnp Device's key.
                type: str
              value:
                description: Pnp Device's value.
                type: str
            type: list
        type: list
      licenseLevel:
        description: Pnp Device's licenseLevel.
        type: str
      licenseType:
        description: Pnp Device's licenseType.
        type: str
      topOfStackSerialNumber:
        description: Pnp Device's topOfStackSerialNumber.
        type: str
    type: dict

systemResetWorkflow:
    description: Pnp Device's systemResetWorkflow.
    suboptions:
      _id:
        description: Pnp Device's _id.
        type: str
      addToInventory:
        description: AddToInventory flag.
        type: bool
      addedOn:
        description: Pnp Device's addedOn.
        type: int
      configId:
        description: Pnp Device's configId.
        type: str
      currTaskIdx:
        description: Pnp Device's currTaskIdx.
        type: int
      description:
        description: Pnp Device's description.
        type: str
      endTime:
        description: Pnp Device's endTime.
        type: int
      execTime:
        description: Pnp Device's execTime.
        type: int
      imageId:
        description: Pnp Device's imageId.
        type: str
      instanceType:
        description: Pnp Device's instanceType.
        type: str
      lastupdateOn:
        description: Pnp Device's lastupdateOn.
        type: int
      name:
        description: Pnp Device's name.
        type: str
      startTime:
        description: Pnp Device's startTime.
        type: int
      state:
        description: Pnp Device's state.
        type: str
      tasks:
        description: Pnp Device's tasks.
        elements: dict
        suboptions:
          currWorkItemIdx:
            description: Pnp Device's currWorkItemIdx.
            type: int
          endTime:
            description: Pnp Device's endTime.
            type: int
          name:
            description: Pnp Device's name.
            type: str
          startTime:
            description: Pnp Device's startTime.
            type: int
          state:
            description: Pnp Device's state.
            type: str
          taskSeqNo:
            description: Pnp Device's taskSeqNo.
            type: int
          timeTaken:
            description: Pnp Device's timeTaken.
            type: int
          type:
            description: Pnp Device's type.
            type: str
          workItemList:
            description: Pnp Device's workItemList.
            elements: dict
            suboptions:
              command:
                description: Pnp Device's command.
                type: str
              endTime:
                description: Pnp Device's endTime.
                type: int
              outputStr:
                description: Pnp Device's outputStr.
                type: str
              startTime:
                description: Pnp Device's startTime.
                type: int
              state:
                description: Pnp Device's state.
                type: str
              timeTaken:
                description: Pnp Device's timeTaken.
                type: int
            type: list
        type: list
      tenantId:
        description: Pnp Device's tenantId.
        type: str
      type:
        description: Pnp Device's type.
        type: str
      useState:
        description: Pnp Device's useState.
        type: str
      version:
        description: Pnp Device's version.
        type: int
    type: dict

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

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"_id\": \"string\",\n  \"deviceInfo\": {\n    \"source\": \"string\"\
    ,\n    \"serialNumber\": \"string\",\n    \"stack\": true,\n    \"mode\": \"string\"\
    ,\n    \"state\": \"string\",\n    \"location\": {\n      \"siteId\": \"string\"\
    ,\n      \"address\": \"string\",\n      \"latitude\": \"string\",\n      \"longitude\"\
    : \"string\",\n      \"altitude\": \"string\"\n    },\n    \"description\": \"\
    string\",\n    \"onbState\": \"string\",\n    \"authenticatedMicNumber\": \"string\"\
    ,\n    \"authenticatedSudiSerialNo\": \"string\",\n    \"capabilitiesSupported\"\
    : [\n      \"string\"\n    ],\n    \"featuresSupported\": [\n      \"string\"\n\
    \    ],\n    \"cmState\": \"string\",\n    \"firstContact\": 0,\n    \"lastContact\"\
    : 0,\n    \"macAddress\": \"string\",\n    \"pid\": \"string\",\n    \"deviceSudiSerialNos\"\
    : [\n      \"string\"\n    ],\n    \"lastUpdateOn\": 0,\n    \"workflowId\": \"\
    string\",\n    \"workflowName\": \"string\",\n    \"projectId\": \"string\",\n\
    \    \"projectName\": \"string\",\n    \"deviceType\": \"string\",\n    \"agentType\"\
    : \"string\",\n    \"imageVersion\": \"string\",\n    \"fileSystemList\": [\n\
    \      {\n        \"type\": \"string\",\n        \"writeable\": true,\n      \
    \  \"freespace\": 0,\n        \"name\": \"string\",\n        \"readable\": true,\n\
    \        \"size\": 0\n      }\n    ],\n    \"pnpProfileList\": [\n      {\n  \
    \      \"profileName\": \"string\",\n        \"discoveryCreated\": true,\n   \
    \     \"createdBy\": \"string\",\n        \"primaryEndpoint\": {\n          \"\
    port\": 0,\n          \"protocol\": \"string\",\n          \"ipv4Address\": {},\n\
    \          \"ipv6Address\": {},\n          \"fqdn\": \"string\",\n          \"\
    certificate\": \"string\"\n        },\n        \"secondaryEndpoint\": {\n    \
    \      \"port\": 0,\n          \"protocol\": \"string\",\n          \"ipv4Address\"\
    : {},\n          \"ipv6Address\": {},\n          \"fqdn\": \"string\",\n     \
    \     \"certificate\": \"string\"\n        }\n      }\n    ],\n    \"imageFile\"\
    : \"string\",\n    \"httpHeaders\": [\n      {\n        \"key\": \"string\",\n\
    \        \"value\": \"string\"\n      }\n    ],\n    \"neighborLinks\": [\n  \
    \    {\n        \"localInterfaceName\": \"string\",\n        \"localShortInterfaceName\"\
    : \"string\",\n        \"localMacAddress\": \"string\",\n        \"remoteInterfaceName\"\
    : \"string\",\n        \"remoteShortInterfaceName\": \"string\",\n        \"remoteMacAddress\"\
    : \"string\",\n        \"remoteDeviceName\": \"string\",\n        \"remotePlatform\"\
    : \"string\",\n        \"remoteVersion\": \"string\"\n      }\n    ],\n    \"\
    lastSyncTime\": 0,\n    \"ipInterfaces\": [\n      {\n        \"status\": \"string\"\
    ,\n        \"macAddress\": \"string\",\n        \"ipv4Address\": {},\n       \
    \ \"ipv6AddressList\": [\n          {}\n        ],\n        \"name\": \"string\"\
    \n      }\n    ],\n    \"hostname\": \"string\",\n    \"authStatus\": \"string\"\
    ,\n    \"stackInfo\": {\n      \"supportsStackWorkflows\": true,\n      \"isFullRing\"\
    : true,\n      \"stackMemberList\": [\n        {\n          \"serialNumber\":\
    \ \"string\",\n          \"state\": \"string\",\n          \"role\": \"string\"\
    ,\n          \"macAddress\": \"string\",\n          \"pid\": \"string\",\n   \
    \       \"licenseLevel\": \"string\",\n          \"licenseType\": \"string\",\n\
    \          \"sudiSerialNumber\": \"string\",\n          \"hardwareVersion\": \"\
    string\",\n          \"stackNumber\": 0,\n          \"softwareVersion\": \"string\"\
    ,\n          \"priority\": 0\n        }\n      ],\n      \"stackRingProtocol\"\
    : \"string\",\n      \"validLicenseLevels\": [\n        \"string\"\n      ],\n\
    \      \"totalMemberCount\": 0\n    },\n    \"reloadRequested\": true,\n    \"\
    addedOn\": 0,\n    \"siteId\": \"string\",\n    \"aaaCredentials\": {\n      \"\
    password\": \"string\",\n      \"username\": \"string\"\n    },\n    \"userMicNumbers\"\
    : [\n      \"string\"\n    ],\n    \"userSudiSerialNos\": [\n      \"string\"\n\
    \    ],\n    \"addnMacAddrs\": [\n      \"string\"\n    ],\n    \"preWorkflowCliOuputs\"\
    : [\n      {\n        \"cli\": \"string\",\n        \"cliOutput\": \"string\"\n\
    \      }\n    ],\n    \"tags\": {},\n    \"sudiRequired\": true,\n    \"smartAccountId\"\
    : \"string\",\n    \"virtualAccountId\": \"string\",\n    \"populateInventory\"\
    : true,\n    \"siteName\": \"string\",\n    \"name\": \"string\"\n  },\n  \"systemResetWorkflow\"\
    : {\n    \"_id\": \"string\",\n    \"state\": \"string\",\n    \"type\": \"string\"\
    ,\n    \"description\": \"string\",\n    \"lastupdateOn\": 0,\n    \"imageId\"\
    : \"string\",\n    \"currTaskIdx\": 0,\n    \"addedOn\": 0,\n    \"tasks\": [\n\
    \      {\n        \"state\": \"string\",\n        \"type\": \"string\",\n    \
    \    \"currWorkItemIdx\": 0,\n        \"taskSeqNo\": 0,\n        \"endTime\":\
    \ 0,\n        \"startTime\": 0,\n        \"workItemList\": [\n          {\n  \
    \          \"state\": \"string\",\n            \"command\": \"string\",\n    \
    \        \"outputStr\": \"string\",\n            \"endTime\": 0,\n           \
    \ \"startTime\": 0,\n            \"timeTaken\": 0\n          }\n        ],\n \
    \       \"timeTaken\": 0,\n        \"name\": \"string\"\n      }\n    ],\n   \
    \ \"addToInventory\": true,\n    \"instanceType\": \"string\",\n    \"endTime\"\
    : 0,\n    \"execTime\": 0,\n    \"startTime\": 0,\n    \"useState\": \"string\"\
    ,\n    \"configId\": \"string\",\n    \"name\": \"string\",\n    \"version\":\
    \ 0,\n    \"tenantId\": \"string\"\n  },\n  \"systemWorkflow\": {\n    \"_id\"\
    : \"string\",\n    \"state\": \"string\",\n    \"type\": \"string\",\n    \"description\"\
    : \"string\",\n    \"lastupdateOn\": 0,\n    \"imageId\": \"string\",\n    \"\
    currTaskIdx\": 0,\n    \"addedOn\": 0,\n    \"tasks\": [\n      {\n        \"\
    state\": \"string\",\n        \"type\": \"string\",\n        \"currWorkItemIdx\"\
    : 0,\n        \"taskSeqNo\": 0,\n        \"endTime\": 0,\n        \"startTime\"\
    : 0,\n        \"workItemList\": [\n          {\n            \"state\": \"string\"\
    ,\n            \"command\": \"string\",\n            \"outputStr\": \"string\"\
    ,\n            \"endTime\": 0,\n            \"startTime\": 0,\n            \"\
    timeTaken\": 0\n          }\n        ],\n        \"timeTaken\": 0,\n        \"\
    name\": \"string\"\n      }\n    ],\n    \"addToInventory\": true,\n    \"instanceType\"\
    : \"string\",\n    \"endTime\": 0,\n    \"execTime\": 0,\n    \"startTime\": 0,\n\
    \    \"useState\": \"string\",\n    \"configId\": \"string\",\n    \"name\": \"\
    string\",\n    \"version\": 0,\n    \"tenantId\": \"string\"\n  },\n  \"workflow\"\
    : {\n    \"_id\": \"string\",\n    \"state\": \"string\",\n    \"type\": \"string\"\
    ,\n    \"description\": \"string\",\n    \"lastupdateOn\": 0,\n    \"imageId\"\
    : \"string\",\n    \"currTaskIdx\": 0,\n    \"addedOn\": 0,\n    \"tasks\": [\n\
    \      {\n        \"state\": \"string\",\n        \"type\": \"string\",\n    \
    \    \"currWorkItemIdx\": 0,\n        \"taskSeqNo\": 0,\n        \"endTime\":\
    \ 0,\n        \"startTime\": 0,\n        \"workItemList\": [\n          {\n  \
    \          \"state\": \"string\",\n            \"command\": \"string\",\n    \
    \        \"outputStr\": \"string\",\n            \"endTime\": 0,\n           \
    \ \"startTime\": 0,\n            \"timeTaken\": 0\n          }\n        ],\n \
    \       \"timeTaken\": 0,\n        \"name\": \"string\"\n      }\n    ],\n   \
    \ \"addToInventory\": true,\n    \"instanceType\": \"string\",\n    \"endTime\"\
    : 0,\n    \"execTime\": 0,\n    \"startTime\": 0,\n    \"useState\": \"string\"\
    ,\n    \"configId\": \"string\",\n    \"name\": \"string\",\n    \"version\":\
    \ 0,\n    \"tenantId\": \"string\"\n  },\n  \"runSummaryList\": [\n    {\n   \
    \   \"details\": \"string\",\n      \"historyTaskInfo\": {\n        \"type\":\
    \ \"string\",\n        \"workItemList\": [\n          {\n            \"state\"\
    : \"string\",\n            \"command\": \"string\",\n            \"outputStr\"\
    : \"string\",\n            \"endTime\": 0,\n            \"startTime\": 0,\n  \
    \          \"timeTaken\": 0\n          }\n        ],\n        \"timeTaken\": 0,\n\
    \        \"addnDetails\": [\n          {\n            \"key\": \"string\",\n \
    \           \"value\": \"string\"\n          }\n        ],\n        \"name\":\
    \ \"string\"\n      },\n      \"errorFlag\": true,\n      \"timestamp\": 0\n \
    \   }\n  ],\n  \"workflowParameters\": {\n    \"topOfStackSerialNumber\": \"string\"\
    ,\n    \"licenseLevel\": \"string\",\n    \"licenseType\": \"string\",\n    \"\
    configList\": [\n      {\n        \"configParameters\": [\n          {\n     \
    \       \"key\": \"string\",\n            \"value\": \"string\"\n          }\n\
    \        ],\n        \"configId\": \"string\"\n      }\n    ]\n  },\n  \"dayZeroConfig\"\
    : {\n    \"config\": \"string\"\n  },\n  \"dayZeroConfigPreview\": {},\n  \"version\"\
    : 0,\n  \"tenantId\": \"string\"\n}\n"
  type: dict

See also