Verifying and Deleting Tasks

Verifying Tasks

Verifying the Task

GET http://<mgmt0_IP>/api/mo/sys/action/lsubj-[sys]/topSystemCreateCheckpointLTask.json

{
  "totalCount": "1",
  "imdata": [
    {
      "topSystemCreateCheckpointLTask": {
        "attributes": {
          "adminSt": "start",
          "childAction": "",
          "delete": "no",
          "descr": "",
          "description": "",
          "dn": "sys/action/lsubj-[sys]/topSystemCreateCheckpointLTask",
          "filename": "",
          "freq": "one-shot",
          "modTs": "2018-10-08T15:26:16.730+00:00",
          "name": "xyz",
          "peerClassId": "topSystemCreateCheckpointRslt",
          "persistentOnReload": "true",
          "rSz": "100",
          "rTm": "00:00:00:00.000",
          "startTs": "never",
          "status": "",
          "type": "clear"
        }
      }
    }
  ]
}

To verify a task, send a GET request using the DN found inside the payload you sent in the POST operation.

This example demonstrates how to verify the Creating a Checkpoint to a File task, which is located in the Managing the Infrastructure section.

Note: The property information for this example was added in Release 9.3(3).

Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
topSystemCreateCheckpointLTask	sys/action/lsubj-{[oDn]}/topSystemCreateCheckpointLTask

topSystemCreateCheckpointLTask Properties

The following table contains information about the topSystemCreateCheckpointLTask properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	action:AdminSt scalar:Enum8	The administrative state of the object or policy.	SELECTION: 0 - unknown 1 - start 2 - stop 3 - suspend DEFAULT: unknown(0)
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
delete	infra:deletemode scalar:Enum8	NO COMMENTS	SELECTION: 1 - yes 2 - no DEFAULT: no(2)
descr	action:Descr string:Basic		RANGE: Min: "0" Max: "128"
description	infra:checkpointStr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "79"
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
filename	string:Basic	NO COMMENTS	RANGE: Min: "0" Max: "512"
freq	action:Freq scalar:Time	Frequency at which tasks are executed	SELECTION: 0ull - one-shot DEFAULT: 0
modTs	mo:TStamp scalar:Date	The time when this object was last modified.	SELECTION: 0ull - never DEFAULT: never(0ull)
name	infra:checkpointStr string:Basic	The name of the object.	RANGE: Min: "0" Max: "79"
peerClassId	mo:MoClassId	The BGP neighbor.	DEFAULT: topSystemCreateCheckpointRslt
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rSz	action:RetentionSize scalar:Uint16	The retention size of the task results.	RANGE: Min: 1 Max: 1024 DEFAULT: 100
rTm	action:RetentionTime scalar:Time	The retention time of the task results.
startTs	mo:TStamp scalar:Date	The date and time when the task began.	SELECTION: 0ull - never DEFAULT: never(0ull)
status	mo:ModificationStatus scalar:Bitmask32	The upgrade status. This property is for internal use only.	SELECTION: 16u - replaced 2u - created 4u - modified 8u - deleted DEFAULT: 0
type	action:Type scalar:Enum8	The specific type of the object or component.	SELECTION: 1 - clear 2 - reset 3 - reload 4 - locate 5 - install 6 - test 7 - collect 8 - interface-in-service DEFAULT: clear(1)

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting All Tasks (Using DELETE)

Deleting All Tasks (Using DELETE)

DELETE http://IP-address/api/mo/sys/action/lsubj-[sys].json

Deleting All Tasks (Using POST)

Deleting All Tasks (Using POST)

POST  http://IP-address/api/mo/sys/action.json

{
  "actionLCont": {
    "attributes": {
      "dn": "sys/action",
      “status”: “deleted”
}}}

Note: The property information for this example was added in Release 9.3(3).

MO	DN
actionLCont	sys/action

actionLCont Properties

The following table contains information about the actionLCont properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
status	mo:ModificationStatus scalar:Bitmask32	The upgrade status. This property is for internal use only.	SELECTION: 16u - replaced 2u - created 4u - modified 8u - deleted DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Task Result (Using DELETE)

Deleting a Task Result (Using DELETE)

DELETE http://<mgmt0_IP>/api/mo/sys/action/lsubj-[sys]/topSystemCreateCheckpointLTask.json

{
  "imdata": []
}

To delete a task result, send a DELETE request using the DN found inside the payload you posted.

This example demonstrates how to delete the result of the Creating a Checkpoint to a File task, which is located in the Managing the Infrastructure section.

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference:

https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Task Result (Using POST)

Deleting a Task Result (Using POST)

POST http://<mgmt0_IP>/api/mo/sys/action/lsubj-[sys]/topSystemCreateCheckpointLTask.json

{
                "topSystemCreateCheckpointLTask": {
                    "attributes": {
                        "dn": "sys/action/lsubj-[sys]/topSystemCreateCheckpointLTask",
                        "status": "deleted"
}}}
```			
                    
```[DME]json-Response
{
  "imdata": []
}

To delete a task result, send a DELETE request using the DN found inside the payload you posted.

This example demonstrates how to delete the result of the Creating a Checkpoint to a File task, which is located in the Managing the Infrastructure section.

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystemCreateCheckpointLTask	sys/action/lsubj-{[oDn]}/topSystemCreateCheckpointLTask

topSystemCreateCheckpointLTask Properties

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
status	mo:ModificationStatus scalar:Bitmask32	The upgrade status. This property is for internal use only.	SELECTION: 16u - replaced 2u - created 4u - modified 8u - deleted DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html