Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

POST pnp/status/{serialNumber}

Since Product Version: 3.0

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

POST

Resource URL

/webacs/api/v3/op/pnp/status/{serialNumber}

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

serialNumber String

path

Optional

Request Payload Parameters

Attribute Description

description String

deviceHostName String

deviceIPAddress String

deviceType String

PID of device

message String

detailed message on state

serialID String

device serial ID

state String

Response Parameters

Attribute Description

description String

state String

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://10.64.88.203/webacs/api/v3/op/pnp/status/sample_serial_number

<?xml version="1.0" ?>
<pnPDeviceState>
  <description>String value</description>
  <deviceHostName>String value</deviceHostName>
  <deviceIPAddress>String value</deviceIPAddress>
  <deviceType>String value</deviceType>
  <message>String value</message>
  <serialID>String value</serialID>
  <state>String value</state>
</pnPDeviceState>

Sample JSON Request Payload

https://10.64.88.203/webacs/api/v3/op/pnp/status/sample_serial_number.json

{
  "pnPDeviceState" : {
    "description" : "String value",
    "deviceHostName" : "String value",
    "deviceIPAddress" : "String value",
    "deviceType" : "String value",
    "message" : "String value",
    "serialID" : "String value",
    "state" : "String value"
  }
}

Sample XML Response Payload

https://10.64.88.203/webacs/api/v3/op/pnp/status/sample_serial_number

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v3/op/pnp/status/sample_serial_number" rootUrl="https://10.64.88.203/webacs/api/v3/op">
  <pnPResponse>
    <description>String value</description>
    <state>String value</state>
  </pnPResponse>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/pnp/status/sample_serial_number.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.88.203/webacs/api/v3/op/pnp/status/sample_serial_number",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
    "pnPResponse" : [ {
      "description" : "String value",
      "state" : "String value"
    } ]
  }
}