APIs Device to Cloud One M2 M mgmtObj
The mgmtObj (resourceType = 13) are children of a node
.
The mgmtObj resource contains management data which represents individual M2M management functions.
It functions mostly as a base class for defining specializations for management aspects, such as for “battery”, “memory”, etc.
Note: All instances of mgmtObj share the same resourceType, namely 13.
They are distinguished by setting the mandatory mgmtDefinition attribute to the appropriate value (see “Interpretation of mgmtDefinition”) on this page.
Supported child resources
| Child Resources Type | Multiplicity | Description |
|---|---|---|
| subscription | 0..n | A subscription
to a resource allows an entity in the oneM2M architecture to be notified about changes of the subscribed-to resource. |
| semanticDescriptor | 0..n | |
| transaction | 0..n |
Universal and common attributes
| Name | Full Name | Type | Multiplicity | Mode |
|---|---|---|---|---|
| ty | resourceType | m2m:resourceType / integer | 1 | RO |
| ri | resourceID | m2m:ID / string | 1 | RO |
| rn | resourceName | string | 1 | WO |
| pi | parentID | m2m:ID / string | 1 | RO |
| lbl | labels | m2m:labels / list of string | 0..1(L) | RW |
| acpi | accessControlPolicyIDs | m2m:acpType / list of resouceID | 0..1(L) | RW |
| ct | creationTime | m2m:timestamp | 1 | RO |
| lt | lastModifiedTime | m2m:timestamp | 1 | RO |
| at | announceTo | list of URI | 0..1 (L) | RW |
| aa | announcedAttribute | list of string | 0..1 (L) | RW |
| holder | 0..1 | RW |
Mode: RW = Read/Write, RO = Read Only, WO = Write Once
Resource specific attributes
| Name | Full Name | Multiplicity | Mode | Create | Update | Description |
|---|---|---|---|---|---|---|
| mgd | mgmtDefinition | 1 | WO | M | NP | Specifies the type of mgmtObjresource e.g. software, firmware, memory. The list of the values of the attribute can be seen below. |
| objectIDs | obis | 0..1(L) | WO | O | NP | Contains the list URNs that uniquely identify the technology specific data model objects used for this mgmtObjresource as well as the managed function and version it represents. This attribute shall be provided during the creation of the mgmtObjresource and shall not be modifiable afterwards. If the mgmtObjresource is mapped to multiple technology specific data model objects, this attribute shall list all URNs for each mapped technology specific data model objects. This is mandatory for the |
| objectAttribute | see specializations | 0..n | RW | O | O | Each objectAttribute is mapped from a leaf node of a hierarchical structured technology specific data model object (including oneM2M data model and the technology specific data model objects) based on the mapping rules defined by each specialization. In other words: These are the attributes added by each specialization. |
Mode: RW = Read/Write, RO = Read Only, WO = Write Once
Request Optionality: NP = not provisioned, O = optional, M = Mandatory
Interpretation of “mgmtDefinition”
| Value | Interpretation |
|---|---|
| 1001 | firmware |
| 1002 | software |
| 1003 | memory |
| 1004 | areaNwkInfo |
| 1005 | areaNwkDeviceInfo |
| 1006 | battery |
| 1007 | deviceInfo |
| 1008 | deviceCapability |
| 1009 | reboot |
| 1023 | myCertFileCred |
DVI - DeviceInfo attributes
DeviceInfo (resourceType=13, mgmtDefinition=1007)
| Name | Full Name | Multiplicity | Mode | Create | Update |
|---|---|---|---|---|---|
| mgd | mgmtDefinition | 1 | WO | M | NP |
| obis | objectIDs | 0..1(L) | WO | O | NP |
| dc | description | 0..1 | RW | O | O |
| dlb | deviceLabel | 1 | RW | M | O |
| mod | model | 1 | WO | M | NP |
| dvnm | deviceName | 0..1 | RW | O | O |
| loc | location | 0..1 | RW | O | O |
Attribute: mgd (mgmtDefinition)
Specifies the type of mgmtObjresource e.g. software, firmware, memory. The list of the values of the attribute can be seen below.
Attribute: obis (objectIDs)
Contains the list URNs that uniquely identify the technology specific data model objects used for this mgmtObjresource as well as the managed function and version it represents. This attribute shall be provided during the creation of the mgmtObjresource and shall not be modifiable afterwards. If the mgmtObjresource is mapped to multiple technology specific data model objects, this attribute shall list all URNs for each mapped technology specific data model objects. This is mandatory for the mgmtObj, for which the data model is not specified by oneM2M but mapped from technology specific data model.
Attribute: dc (description)
Text format description of
Attribute: dlb (deviceLabel)
Unique device label assigned by the manufacturer. The value of the attribute typically exposes the device’s serial number that is specific to a manufacturer and possibly further restricted within the manufacturer by a deviceType or model.
Attribute: mod (model)
The name/identifier of the device mode assigned by the manufacturer.
Attribute: dvnm (deviceName)
Device name.
Attribute: loc (location)
Location where the device is installed. It may be configured via the user interface provided by the ‘presentationURL’ property or any other means. The type of this attribute is a URN and follows the Geo URI format (see https://en.wikipedia.org/wiki/Geo_URI_scheme
and RFC 5870). A simple geo URI might look like:
geo:48.861069,2.335796 where the two numerical values represent latitude and longitude respectively, and are separated by a comma. They are coordinates of a horizontal grid (2D). If a third comma-separated value is present, it represents altitude; so, coordinates of a 3D grid. Coordinates in the Southern and Western hemispheres as well as altitudes below the coordinate reference system (depths) are signed negative with a leading dash.
CRDS - credentials
Credentials (resourceType=13, mgmtDefinition=1029)
| Name | Full Name | Multiplicity | Mode | Create | Update | Description |
|---|---|---|---|---|---|---|
| mgd | mgmtDefinition | 1 | WO | M | NP | Specifies the type of mgmtObjresource e.g. software, firmware, memory. The list of the values of the attribute can be seen below. |
| objectIDs | obis | 0..1(L) | WO | O | NP | Contains the list URNs that uniquely identify the technology specific data model objects used for this mgmtObjresource as well as the managed function and version it represents. This attribute shall be provided during the creation of the mgmtObjresource and shall not be modifiable afterwards. If the mgmtObjresource is mapped to multiple technology specific data model objects, this attribute shall list all URNs for each mapped technology specific data model objects. This is mandatory for the |
| dc | description | 0..1 | RW | O | O | Text format description of |
| credentialID | 0..1 | RW | O | O | ||
| credentialSecret | 0..1 | RW | O | O | ||
| credentialToken | 0..1 | RW | O | O |