.. 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 .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.pnp_device_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.pnp_device module -- Resource module for Pnp Device ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.25.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.pnp_device`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module represents an alias of the module pnp\_device\_v1 .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.pnp_device_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo: .. rst-class:: ansible-option-title **deviceInfo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Pnp Device's deviceInfo. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/devicesudiserialnos: .. rst-class:: ansible-option-title **deviceSudiSerialNos** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Device Sudi Serial Nos. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/hostname: .. rst-class:: ansible-option-title **hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/macaddress: .. rst-class:: ansible-option-title **macAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mac Address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/pid: .. rst-class:: ansible-option-title **pid** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pid. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/serialnumber: .. rst-class:: ansible-option-title **serialNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Serial Number. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/siteid: .. rst-class:: ansible-option-title **siteId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stack: .. rst-class:: ansible-option-title **stack** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Stack. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo: .. rst-class:: ansible-option-title **stackInfo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Pnp Device's stackInfo. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/isfullring: .. rst-class:: ansible-option-title **isFullRing** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Is Full Ring. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist: .. rst-class:: ansible-option-title **stackMemberList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Pnp Device's stackMemberList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/hardwareversion: .. rst-class:: ansible-option-title **hardwareVersion** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Hardware Version. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/licenselevel: .. rst-class:: ansible-option-title **licenseLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
License Level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/licensetype: .. rst-class:: ansible-option-title **licenseType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
License Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/macaddress: .. rst-class:: ansible-option-title **macAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mac Address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/pid: .. rst-class:: ansible-option-title **pid** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pid. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/priority: .. rst-class:: ansible-option-title **priority** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Priority. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/role: .. rst-class:: ansible-option-title **role** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Role. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/serialnumber: .. rst-class:: ansible-option-title **serialNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Serial Number. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/softwareversion: .. rst-class:: ansible-option-title **softwareVersion** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Software Version. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/stacknumber: .. rst-class:: ansible-option-title **stackNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Stack Number. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
State. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackmemberlist/sudiserialnumber: .. rst-class:: ansible-option-title **sudiSerialNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sudi Serial Number. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/stackringprotocol: .. rst-class:: ansible-option-title **stackRingProtocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Stack Ring Protocol. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/supportsstackworkflows: .. rst-class:: ansible-option-title **supportsStackWorkflows** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Supports Stack Workflows. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/totalmembercount: .. rst-class:: ansible-option-title **totalMemberCount** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Total Member Count. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/stackinfo/validlicenselevels: .. rst-class:: ansible-option-title **validLicenseLevels** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Valid License Levels. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/sudirequired: .. rst-class:: ansible-option-title **sudiRequired** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Is Sudi Required. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/usermicnumbers: .. rst-class:: ansible-option-title **userMicNumbers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
User Mic Numbers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/usersudiserialnos: .. rst-class:: ansible-option-title **userSudiSerialNos** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of Secure Unique Device Identifier (SUDI) serial numbers to perform SUDI authorization, Required if sudiRequired is true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/workflowid: .. rst-class:: ansible-option-title **workflowId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Workflow Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-deviceinfo/workflowname: .. rst-class:: ansible-option-title **workflowName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Workflow Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.pnp_device_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are device\_onboarding\_pnp.DeviceOnboardingPnp.add\_device, device\_onboarding\_pnp.DeviceOnboardingPnp.delete\_device\_by\_id\_from\_pnp\_v1, device\_onboarding\_pnp.DeviceOnboardingPnp.update\_device\_v1, - Paths used are post /dna/intent/api/v1/onboarding/pnp-device, delete /dna/intent/api/v1/onboarding/pnp-device/{id}, put /dna/intent/api/v1/onboarding/pnp-device/{id}, - It should be noted that this module is an alias of pnp\_device\_v1 - Does not support \ :literal:`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:: `Cisco DNA Center documentation for Device Onboarding (PnP) AddDeviceV1 `_ Complete reference of the AddDeviceV1 API. `Cisco DNA Center documentation for Device Onboarding (PnP) DeleteDeviceByIdFromPnPV1 `_ Complete reference of the DeleteDeviceByIdFromPnPV1 API. `Cisco DNA Center documentation for Device Onboarding (PnP) UpdateDeviceV1 `_ Complete reference of the UpdateDeviceV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 deviceInfo: description: string deviceSudiSerialNos: - string hostname: string macAddress: string pid: string serialNumber: string siteId: 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 sudiRequired: true userMicNumbers: - string userSudiSerialNos: - string workflowId: string workflowName: string - 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 deviceInfo: hostname: string pid: string serialNumber: string stack: true sudiRequired: true userSudiSerialNos: - string id: string - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.pnp_device_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"\_id": "string", "dayZeroConfig": {"config": "string"}, "dayZeroConfigPreview": {}, "deviceInfo": {"aaaCredentials": {"password": "string", "username": "string"}, "addedOn": 0, "addnMacAddrs": ["string"], "agentType": "string", "authStatus": "string", "authenticatedMicNumber": "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", "siteId": "string", "siteName": "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": {}, "userMicNumbers": ["string"], "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"}}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors