Notifications about device modules
Since Product Version: 3.7
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/sse/ModulesResponse Parameters
Attribute | Description |
---|---|
assemblyNumber String |
Assembly number |
assemblyRevision String |
Assembly revision |
description String |
A description provided for this module. |
deviceId Long |
An internal id for the device. |
equipmentType EquipmentTypeEnum |
An indication of the general hardware type of the physical entity. This should be set to the standard enumeration value that most accurately indicates the general class of the physical entity or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, then the value "other" is returned.
|
operationStatus String |
The operational status of this module. |
productId String |
The product ID associated with this module. |
productName String |
The name associated with this module. This is the official name given to a product. For example, Cisco 12000 Six-port DS3 Line card. |
serialNr String |
The serial number of this module. |
softwareVersion String |
The version of the software installed on this module. |
vendorType String |
An indication of the vendor-specific hardware type of the physical entity. Represents an independently extensible type identification value. It can, for example, indicate a particular subtree with further MIB definitions, or define a particular type of protocol or hardware (for example, 1.3.6.1.4.1.9.12.3.1.9.3.131). See CISCO-ENTITY-VENDORTYPE-OID-MIB. |
versionId String |
The hardware version ID of this module. |
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 Payload
https://localhost/webacs/api/v4/sse/Modules
<?xml version="1.0" ?>
<streamResponse count="1" responseType="listEvents" requestUrl="https://localhost/webacs/api/v4/sse/Modules" rootUrl="https://localhost/webacs/api/v4/sse">
<streamEvent dtoType="modulesDTO" id="Modules" action="CREATED">
<modulesDTO displayName="String value" id="15" uuid="String value">
<assemblyNumber>String value</assemblyNumber>
<assemblyRevision>String value</assemblyRevision>
<description>String value</description>
<deviceId>15</deviceId>
<equipmentType>OTHER</equipmentType>
<operationStatus>String value</operationStatus>
<productId>String value</productId>
<productName>String value</productName>
<serialNr>String value</serialNr>
<softwareVersion>String value</softwareVersion>
<vendorType>String value</vendorType>
<versionId>String value</versionId>
</modulesDTO>
</streamEvent>
</streamResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/sse/Modules.json
{
"streamResponse" : {
"@count" : 1,
"@requestUrl" : "https://localhost/webacs/api/v4/sse/Modules",
"@responseType" : "listEvents",
"@rootUrl" : "https://localhost/webacs/api/v4/sse",
"streamEvent" : [ {
"@action" : "CREATED",
"@dtoType" : "modulesDTO",
"@id" : "Modules",
"modulesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"assemblyNumber" : "String value",
"assemblyRevision" : "String value",
"description" : "String value",
"deviceId" : 15,
"equipmentType" : "OTHER",
"operationStatus" : "String value",
"productId" : "String value",
"productName" : "String value",
"serialNr" : "String value",
"softwareVersion" : "String value",
"vendorType" : "String value",
"versionId" : "String value"
}
} ]
}
}