DATA MODEL DEFINITION |
|
The oneM2M Partners authorize you to copy this document, provided that you retain all copyright and other proprietary notices contained in the original materials on any copies of the materials and that you comply strictly with these terms. This copyright permission does not constitute an endorsement of the products or services, nor does it encompass the granting of any patent rights. The oneM2M Partners assume no responsibility for errors or omissions in this document. © oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TSDSI, TTA, TTC). All rights reserved.
Notice of Disclaimer & Limitation of Liability
The information provided in this document is directed solely to professionals who have the appropriate degree of experience to understand and interpret its contents in accordance with generally accepted engineering or other professional standards and applicable regulations. No recommendation as to products or vendors is made or should be implied.
NO REPRESENTATION OR WARRANTY IS MADE THAT THE INFORMATION IS TECHNICALLY ACCURATE OR SUFFICIENT OR CONFORMS TO ANY STATUTE, GOVERNMENTAL RULE OR REGULATION, AND FURTHER, NO REPRESENTATION OR WARRANTY IS MADE OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR AGAINST INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS. NO oneM2M PARTNER TYPE 1 SHALL BE LIABLE, BEYOND THE AMOUNT OF ANY SUM RECEIVED IN PAYMENT BY THAT PARTNER FOR THIS DOCUMENT, WITH RESPECT TO ANY CLAIM, AND IN NO EVENT SHALL oneM2M BE LIABLE FOR LOST PROFITS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES. oneM2M EXPRESSLY ADVISES ANY AND ALL USE OF OR RELIANCE UPON THIS INFORMATION PROVIDED IN THIS DOCUMENT IS AT THE RISK OF THE USER.
| Data Type | Base Type | Description |
|---|
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-106a7] | TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013. |
For a given implementation of this data model, the CPE MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the CPE supports only a single parameter that was introduced in version 2.99, then it will indicate support for version 2.99. The version number associated with each object and parameter is shown in the Version column.
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
| Device. | object | - | The top-level object for a Device. | - | 2.0 |
| X_oneM2M_org_CSENumberOfEntries | unsignedInt | - | The number of entries in the X_oneM2M_org_CSE table. | - | 2.99 |
| X_oneM2M_org_AENumberOfEntries | unsignedInt | - | The number of entries in the X_oneM2M_org_AE table. | - | 2.99 |
| Device.DeviceInfo. | object | - | This object contains general device information. | - | 2.0 |
| Device.DeviceInfo.X_oneM2M_org_BatteryStatus. | object | - | This object represents the status of the batteries on the device. | - | 2.99 |
| BatteryNumberOfEntries | unsignedInt | - | The number of entries in the Battery table. | - | 2.99 |
| Device.DeviceInfo.X_oneM2M_org_BatteryStatus.Battery.{i}. | object | - | This object represents information that the device has obtained via sampling the battery instance.
At most one entry in this table can exist with a given value for Alias. |
- | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| Level | unsignedInt[0:100] | - | The current battery level as a percent of the battery capacity. | - | 2.99 |
| Status | string | - | Current status of the battery. Enumeration of:
|
- | 2.99 |
| Device.DeviceInfo.X_oneM2M_org_Diagnostics. | object | - | This object represents the oneM2M diagnostics for a device. | - | 2.99 |
| EventLogNumberOfEntries | unsignedInt | - | The number of entries in the EventLog table. | - | 2.99 |
| Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i}. | object | W | This object represents a diagnostic that collects log data for the log type specified by the value of the Type parameter. The logging of the EventLog instance is manipulated using the parameter parameter . The data that has been logged is available via the value of the Data parameter.
At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables the log collection activity on this instance. | false | 2.99 |
| Status | string | - | The current logging state of the instance. Enumeration of:
When Enable is false then Status SHOULD normally be Stopped or Error if there is a error condition that does not allow the logging activity. When Enable is changed to true then Status
|
- | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| Type | string | W | The type of event log on which to collect data. The association of the value of this Type parameter with the associated VendorLogFile.{i} instance is CPE implementation specific. Enumeration of:
|
- | 2.99 |
| LogFile | string | - | The value MUST be the path name of a row in the VendorLogFile table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The referenced VendorLogFile.{i} instance for the type of log specified by the value of the Type parameter. |
- | 2.99 |
| Data | string(32768) | - | Data collected from the logging activity. | - | 2.99 |
| Device.ManagementServer. | object | - | This object contains parameters relating to the CPE's association with an ACS. | - | 2.0 |
| Device.ManagementServer.EmbeddedDevice.{i}. | object | - | Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4] for proxying devices.
At most one entry in this table can exist with the same values for ControllerID and ProxiedDeviceID. |
- | 2.3 |
| ProxyProtocol | string | - | The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to. |
- | 2.3 |
| DiscoveryProtocol | string | - | Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a3] MUST be adhered to. |
- | 2.6 |
| Device.ManagementServer.VirtualDevice.{i}. | object | - | Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex I.1.1/TR-069a4] for proxying devices.
At most one entry in this table can exist with all the same values for ManufacturerOUI, ProductClass and SerialNumber. |
- | 2.3 |
| ProxyProtocol | string | - | The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to. |
- | 2.3 |
| DiscoveryProtocol | string | - | Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a3] MUST be adhered to. |
- | 2.6 |
| Device.Security. | object | - | This object contains general information related to managing security features on the device. | - | 2.4 |
| Device.Security.Certificate.{i}. | object | - | This table provides information about all types of public key-based credentials, such as X.509 certificates, see [RFC5280].
At most one entry in this table can exist with the same values for SerialNumber and Issuer, or with a given value for X_oneM2M_org_Fingerprint. |
- | 2.4 |
| X_oneM2M_org_Fingerprint | string | - | This parameter represents a hash value for identifying the certificate to be used by the intended security principal on the Managed Entity to authenticate itself to other security principals. The hash value is computed over the X.509 ASN.1 DER encoded certificate using the sha-256 hash algorithm as specified in [IETF-HASH]. The format of the parameter value is defined in [Clause 7.3.2/ONEM2MDeviceConfig]. |
- | 2.99 |
| X_oneM2M_org_Format | string | - | This parameter represents the media type format of the Certificate instance. | - | 2.99 |
| X_oneM2M_org_SUIDs | string | W | Comma-separated list of unsigned integers, each entry is a Security Usage Identifier (SUID) of the security framework used for establishing mutually-authenticated secure communication. A SUID which is not in this list is prevented from using this credential for establishing mutually-authenticated secure communication. |
- | 2.99 |
| Device.X_oneM2M_org_SecuritySolution. | object | - | This object represents the oneM2M specific security solutions used by CSEs and AEs as defined in defined in [ONEM2MSecurity]. | - | 2.99 |
| AuthenticationProfileNumberOfEntries | string | - | The number of entries in the AuthenticationProfile table. | - | 2.99 |
| TrustAnchorCredentialNumberOfEntries | string | - | The number of entries in the TrustAnchorCredential table. | - | 2.99 |
| MAFClientRegistrationNumberOfEntries | string | - | The number of entries in the MAFClientRegistration table. | - | 2.99 |
| MEFClientRegistrationNumberOfEntries | string | - | The number of entries in the MEFClientRegistration table. | - | 2.99 |
| Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile.{i}. | object | W | This object represents an instance of a Authentication Profile that defines the method and information needed to establish mutually authenticated secure communications as defined in [Clause 7.1.4/ONEM2MDeviceConfig].
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| SUID | unsignedInt | W | The Security Usage Identifier (SUID) that represents this AuthenticationProfile instance that describes how this AuthenticationProfile instance is to be used in the authentication process. The values for this parameter are defined in [Clause 7.1.5/ONEM2MDeviceConfig]. |
- | 2.99 |
| TLSCipherSuites | string | W | Comma-separated list of strings, when the SUID indicates a use for TLS. This parameter provides a list of permitted TLS ciphersuites that can be used in the authentication process. The formatting of the cipher suite is defined in [Clause 7.3.2/ONEM2MDeviceConfig]. |
- | 2.99 |
| SymmetricKeyID | string | W | The identifier for the symmetric key that the entity uses to authenticate the peer entity. The format of the identifier is defined in [Clause 12.2/ONEM2MSecurity]. |
- | 2.99 |
| SymmetricKeyValue | string | W | Comma-separated list (0 to 2 items) of BASE64 strings, the value of the key. | - | 2.99 |
| MAFKeyRegLabels | string | W | Comma-separated list of strings, the value of the token label used to aid the discovery of the MAF client's registration. | - | 2.99 |
| MAFKeyRegDuration | unsignedInt | W | The duration, in seconds, that represents the expiration period for the key that is registered with the MAF by this MAF client. The value 0 represents an infinite duration. |
- | 2.99 |
| MyCert | string | W | The value MUST be the path name of the Security.Certificate.{i} object instance. The referenced certificate is intended security principal on the Managed Entity to authenticate itself to other security principals. If the referenced object is deleted, the parameter value MUST be set to an empty string. | - | 2.99 |
| RawPubKeyID | string | W | The identifier to authenticate other security prinicipals when the other security principal authenticate itself with a Raw Public Key Certificate. The format of the parameter value is defined in [Clause 7.3.2/ONEM2MDeviceConfig]. |
- | 2.99 |
| TrustAnchorCredentials | string | W | Comma-separated list of strings, Each list item MUST be the path name of the TrustAnchorCredential.{i} object instance. The referenced credential is intended security principal on the Managed Entity to authenticate other security principals that present certificates. If the referenced object is deleted, the corresponding item MUST be removed from the list. . | - | 2.99 |
| Device.X_oneM2M_org_SecuritySolution.TrustAnchorCredential.{i}. | object | W | This object represents an instance of a Authentication Profile that defines the method and information needed to establish mutually authenticated secure communications as defined in [Clause 7.1.4/ONEM2MDeviceConfig].
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| Fingerprint | string | W | This parameter represents a hash value for identifying the certificate to be used by the intended security principal on the Managed Entity to authenticate other security principals. The hash value is computed over the X.509 ASN.1 DER encoded certificate using the sha-256 hash algorithm as specified in [IETF-HASH]. The format of the parameter value is defined in [Clause 7.3.2/ONEM2MDeviceConfig]. |
- | 2.99 |
| RemoteTrustStore | string | W | The URI [RFC3986] that represents the identifier of the remote trust store from which the Managed Entity can retrieve the CA Certificate if the certificate is not locally stored. | - | 2.99 |
| Device.X_oneM2M_org_SecuritySolution.MAFClientRegistration.{i}. | object | W | This object represents an instance of a configuration object needed for the MAF Client to mutually authenticate with a MAF as defined in [Clause 8.8.3/ONEM2MSecurity].
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| AuthenticationProfile | string | W | The value MUST be the path name of the AuthenticationProfile.{i} object instance containing the information for this MAFClientRegistration instance to authenticate with the MAF. If the referenced object is deleted, the parameter value MUST be set to an empty string. | - | 2.99 |
| FQDN | string | W | The Fully Qualified Domain Name that represents address to which the MAF client will send the registration request. | - | 2.99 |
| AdminFQDN | string | W | The Fully Qualified Domain Name of the administrating stakeholder. | - | 2.99 |
| HTTPPort | unsignedInt[0:65535] | W | The port that MAF will be listening on when the communication uses the HTTP protocol. | - | 2.99 |
| CoAPPort | unsignedInt[0:65535] | W | The port that MAF will be listening on when the communication uses the HTTP protocol. | - | 2.99 |
| WebsocketPort | unsignedInt[0:65535] | W | The port that MAF will be listening on when the communication uses the Websocket protocol. | - | 2.99 |
| ExpirationTimeStamp | dateTime | W | Time at which the registration will expire. | - | 2.99 |
| Device.X_oneM2M_org_SecuritySolution.MEFClientRegistration.{i}. | object | W | This object represents an instance of a configuration object needed for the MEF Client to mutually authenticate with a MEF as defined in [Clause 8.8.3/ONEM2MSecurity].
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| AuthenticationProfile | string | W | The value MUST be the path name of the AuthenticationProfile.{i} object instance containing the information for this MEFClientRegistration instance to authenticate with the MEF. If the referenced object is deleted, the parameter value MUST be set to an empty string. | - | 2.99 |
| FQDN | string | W | The Fully Qualified Domain Name that represents address to which the MEF client will send the registration request. | - | 2.99 |
| AdminFQDN | string | W | The Fully Qualified Domain Name of the administrating stakeholder. | - | 2.99 |
| HTTPPort | unsignedInt[0:65535] | W | The port that MAF will be listening on when the communication uses the HTTP protocol. | - | 2.99 |
| CoAPPort | unsignedInt[0:65535] | W | The port that MAF will be listening on when the communication uses the HTTP protocol. | - | 2.99 |
| WebsocketPort | unsignedInt[0:65535] | W | The port that MAF will be listening on when the communication uses the Websocket protocol. | - | 2.99 |
| ExpirationTimeStamp | dateTime | W | Time at which the registration will expire. | - | 2.99 |
| Device.X_oneM2M_org_CSE.{i}. | object | W | This object represents an instance of a Common Service Entity (CSE) for a M2M device or gateway. The X_oneM2M_org_CSE MAY be maintained by the ACS or by the CPE. When the X_oneM2M_org_CSE provides the administration of an CSE that is represented as a SoftwareModules.ExecutionUnit the X_oneM2M_org_CSE is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter. Clause 6.2.9 of the oneM2M Functional Architecture [ONEM2MFA] describes the high level description for CSE registration. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ID. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| ID | string | W | The CSE-ID of this object. The CSE-ID is required for this X_oneM2M_org_CSE instance in order for the CSE to register with the registrar CSE defined by the value of the PointOfAccess parameter. | - | 2.99 |
| PointOfAccess | string | W | The URL of the Registrar CSE to which this X_oneM2M_org_CSE instance registers for M2M Service Layer operation. | - | 2.99 |
| ExternalID | string | W | The M2M-Ext-ID of the this X_oneM2M_org_CSE instance. | - | 2.99 |
| TriggerRecipientID | string | W | The The Trigger-Recipient-ID of the this X_oneM2M_org_CSE instance. | - | 2.99 |
| AuthenticationProfile | string | W | The value MUST be the path name of the X_oneM2M_org_SecuritySolution.AuthenticationProfile.{i} object instance. The referenced authentication profile is used to convey configuration information regarding establishing mutually-authenticated secure communications. If the referenced object is deleted, the parameter value MUST be set to an empty string. | - | 2.99 |
| M2MAreaNetworkNumberOfEntries | unsignedInt | - | The number of entries in the M2MAreaNetwork table. | - | 2.99 |
| M2MAreaNetworkDeviceNumberOfEntries | unsignedInt | - | The number of entries in the M2MAreaNetworkDevice table. | - | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.M2MAreaNetwork.{i}. | object | - | The M2M Area Network information provides administration capabilities for remote management of Application Dedicated Nodes (ADN) and devices in the M2M Network that are attached to this X_oneM2M_org_CSE instance. This object provides the administration of the properties needed by the CSE to remotely manage ADN and devices in the M2M Network within a specific type of M2M Area network as defined by Type. Multiple instances of M2MAreaNetwork with the same Type is permitted.
At most one entry in this table can exist with a given value for ID. |
- | 2.99 |
| ID | string | - | URI [RFC3986] that represents the identifier of the instance. | - | 2.99 |
| Type | string | - | ADN and devices in the M2M Network that connect to an CSE are said to be "attached devices" and are organized by M2M Area Networks within the X_oneM2M_org_CSE instance. The Type is an implementation-chosen string that indicates the type of M2M Area Network. | - | 2.99 |
| Devices | string | - | Comma-separated list of strings. Each list item MUST be the path name of a row in the M2MAreaNetworkDevice table, or an empty string. The list represents the ADN and devices in the M2M Network that are attached to this X_oneM2M_org_CSE instance that are within this M2MAreaNetwork instance. The list does not contain an instance for this CPE. |
- | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.M2MAreaNetworkDevice.{i}. | object | - | This object provides the administration capability to the CSE for maintenance of ADN and devices in the M2M Network that are attached to this X_oneM2M_org_CSE instance. While discovery and identification of devices by the M2M Gateway or Device (CPE) is implementation specific, each device is represented by an instance of the Hosts.Host table. When the ADN or a device in the M2M Network is managed by the CWMP endpoint of the CPE, the M2MAreaNetworkDevice is expected to be referenced by an instance of one of the following tables:
This object instance provides the administration properties required by a CSE to remotely manage an instance of a ADN or a device in the M2M Network within a M2M area network. A ADN or a device in the M2M Network is associated with an instance of a M2MAreaNetwork. This table contains parameters and information of the ADN or a device in the M2M Network related to each M2MAreaNetwork instance. Instances of this table are created and deleted by the CPE. The ACS MAY modify the writeable parameters of this object instance but it is possible that the value set by the ACS is not retained between reboots of the M2M Device. |
- | 2.99 |
| M2MAreaNetwork | string | - | The value MUST be the path name of a row in the M2MAreaNetwork table. | - | 2.99 |
| Host | string | - | Comma-separated list of strings. Each list item MUST be the path name of the Hosts.Host table entry that represents an active or inactive ADN or a device in the M2M Network. If the referenced object is deleted, the corresponding item MUST be removed from the list. | - | 2.99 |
| Type | string | - | The type of that device that indicates the functions or services provided by the ADN or a device in the M2M Network. Examples include temperature sensor, actuator, Zigbee coordinator or Zigbee router. | - | 2.99 |
| Neighbors | string | - | Comma-separated list of strings. Each list item MUST be the path name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that represent the reachable neighbors of this ADN or a device in the M2M Network. | - | 2.99 |
| SleepInterval | unsignedInt | W | The interval, in seconds, between sleep periods for the device. A value of 0 represents a device that does not sleep. Note: When this value is modified, the CPE could modify the SleepInterval for this ADN or a device in the M2M Network in other M2M Area Networks. |
- | 2.99 |
| SleepDuration | unsignedInt | W | The duration, in seconds, of a sleep period. The value 0 represents an unknown value. Note: When this value is modified, the CPE could modify the SleepDuration for this ADN or a device in the M2M Network in other M2M Area Networks. |
- | 2.99 |
| Status | string | - | The sleep status of the device. Enumeration of:
|
- | 2.99 |
| Active | boolean | - | Whether or not this M2M Device is currently attached to this X_oneM2M_org_CSE instance. The ability to list inactive a ADN or device in the M2M Network is OPTIONAL. If the CPE includes inactive ADNs and devices in the M2M Network in this table, Active is set to false for each inactive ADN or device in the M2M Network. The length of time an inactive ADN or device in the M2M Network remains listed in this table is a local matter to the CPE. |
- | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH. | object | - | This object represents the Policies and Rules necessary to administer the Communication Management and Delivery Handling (CMDH) functions within a CSE. | - | 2.99 |
| PolicyNumberOfEntries | unsignedInt | - | The number of entries in the Policy table. | - | 2.99 |
| DefaultNumberOfEntries | unsignedInt | - | The number of entries in the Default table. | - | 2.99 |
| DefaultECRuleNumberOfEntries | unsignedInt | - | The number of entries in the DefaultECRule table. | - | 2.99 |
| DefaultECParamRuleNumberOfEntries | unsignedInt | - | The number of entries in the DefaultECParamRule table. | - | 2.99 |
| LimitNumberOfEntries | unsignedInt | - | The number of entries in the Limit table. | - | 2.99 |
| NetworkAccessECRuleNumberOfEntries | unsignedInt | - | The number of entries in the NetworkAccessECRule table. | - | 2.99 |
| NetworkAccessRuleNumberOfEntries | unsignedInt | - | The number of entries in the NetworkAccessRule table. | - | 2.99 |
| BufferNumberOfEntries | unsignedInt | - | The number of entries in the Buffer table. | - | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i}. | object | W | This object describes the parameters necessary to administer the Communication Management and Delivery Handling (CMDH) handling policies applied to requests to access remotely hosted resources. Annex D.12 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH processing. Only one instance of this object shall be enabled for the X_oneM2M_org_CSE.{i} instance.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| Name | string(64) | W | The name that of this Policy instance. | - | 2.99 |
| DefaultRule | string | W | The value MUST be the path name of an Default.{i} object instance. If the referenced object is deleted, the parameter value MUST be set to an empty string. | - | 2.99 |
| LimitRules | string | W | Comma-separated list of strings. Each list item MUST be the path name of an Limit.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. | - | 2.99 |
| NetworkAccessECRules | string | W | Comma-separated list of strings. Each list item MUST be the path name of an NetworkAccessECRule.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. | - | 2.99 |
| BufferRules | string | W | Comma-separated list of strings. Each list item MUST be the path name of an Buffer.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. | - | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH.Default.{i}. | object | W | This object describes the parameters necessary to administer the CMDH default values that are used for requests issued by Originators (registered AEs or functions inside the CSE itself). Annex D.12.2 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Default processing.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| DefaultECRules | string | W | Comma-separated list of strings. Each list item MUST be the path name of an DefaultECRule.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. | - | 2.99 |
| DefaultECParamRules | string | W | Comma-separated list of strings. Each list item MUST be the path name of an DefaultECParamRule.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. | - | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i}. | object | W | This object is used to define a value for the event category (ec) for an incoming request when it is not defined. Annex D.12.3 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for determining the ec based on the rule criteria.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| Order | unsignedLong[1:] | W | Position of the DefaultECRule entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each request, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a DefaultECRule table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). |
- | 2.99 |
| RequestOrigin | string | W | Rule criterion. Comma-separated list of strings, of zero or more local AE-IDs, App-IDs, or the strings ‘localAE’ or ‘thisCSE’. |
- | 2.99 |
| RequestContext | string | W | Rule criterion. This parameter defines the dynamic context condition under which the rule is applicable. This may refer to conditions such as current battery status, or current network signal strength |
- | 2.99 |
| RequestContextNotificationEnable | boolean | W | When true, the CSE will establish a subscription to the dynamic context information defined in the RequestContext parameter as well as a subscription to the value of the EventCategory for all AEs corresponding to the AE-ID or an App-ID appearing in the RequestOrigin parameter. | false | 2.99 |
| RequestCharacteristics | string | W | Rule criterion. This parameter defines the conditions pertaining to the request itself, such as the requested response type (rt attribute) or other attributes of the request. |
- | 2.99 |
| EventCategory | string | W | Rule result. The value to use for the ec parameter of the request if the conditions expressed in the rule criterion match. Enumeration of:
|
- | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECParamRule.{i}. | object | W | This object is used to define a specific set of default values for the CMDH related parameters request expiration timestamp (rget), result expiration timestamp (rset), operational execution time (oet), response persistence (rp) and delivery aggregation (da) that are applicable for a given event category (ec) if these parameters are not specified in the request. Annex D.12.3 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for determining the ec based on the rule criteria.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for EventCategories. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| EventCategories | string | W | Comma-separated list of strings. The applicable Event Categories for which the defaults are used when a request doesn't have a value for request field. Each list item is an enumeration of:
|
- | 2.99 |
| RequestExpTime | long[-1:] | W | Default value, in milliseconds, for the request expiration time parameter (‘rqet’) in a request when the ‘rqet’ attribute of the request is not set. A value of -1 indicates an infinite time. | - | 2.99 |
| ResultExpTime | long[-1:] | W | Default value, in milliseconds, for the result expiration time parameter (‘rset’) in a request when the ‘rset’ attribute of the request is not set. A value of -1 indicates an infinite time. | - | 2.99 |
| OperationExecTime | long[-1:] | W | Default value, in milliseconds, for the operational execution time parameter (‘oet’) in a request when the ‘oet’ attribute of the request is not set. A value of -1 indicates an infinite time. | - | 2.99 |
| ResponsePersistence | long[-1:] | W | Default value, in milliseconds, for the response persistence parameter (‘rp’) in a request when the ‘rp’ attribute of the request is not set. A value of -1 indicates an infinite time. | - | 2.99 |
| DeliveryAggregation | boolean | W | Default value for the delivery aggregation parameter (‘da’) in a request when the ‘da’ attribute of the request is not set. | false | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}. | object | W | This object describes the parameters necessary to administer the CMDH limits for requests issued by Originators (registered AEs or functions inside the CSE itself). Annex D.12.5 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Limits processing.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| Order | unsignedLong[1:] | W | Position of the Limit entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each request, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Limit table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). |
- | 2.99 |
| RequestOrigin | string | W | Rule criterion. Comma-separated list of strings, of zero or more local AE-IDs, App-IDs, or the strings ‘localAE’ or ‘thisCSE’. |
- | 2.99 |
| RequestContext | string | W | Rule criterion. This parameter defines the dynamic context condition under which the rule is applicable. This may refer to conditions such as current battery status, or current network signal strength |
- | 2.99 |
| RequestContextNotificationEnable | boolean | W | When true, the CSE will establish a subscription to the dynamic context information defined in the RequestContext parameter as well as a subscription to this resource for all AEs corresponding to the AE-ID or an App-ID appearing in the RequestOrigin parameter. | false | 2.99 |
| RequestCharacteristics | string | W | Rule criterion. This parameter defines the conditions pertaining to the request itself, such as the requested response type (rt attribute) or other attributes of the request. |
- | 2.99 |
| EventCategories | string | W | Rule Limit. Comma-separated list of strings. Allowed values for the event category parameter (‘ec’) in a request Each list item is an enumeration of:
|
- | 2.99 |
| RequestExpTime | string | W | Rule Limit Comma-separated list (2 items) of longs (value at least -1). Range of allowed values for the request expiration time parameter (‘rqet’) in a request. The first entry refers to the minimum time increment and the second entry refers to the maximum time increment. A value of -1 in an entry range is defined as an infinite time. |
- | 2.99 |
| ResultExpTime | string | W | Rule Limit Comma-separated list (2 items) of longs (value at least -1). Range of allowed values for the result expiration time parameter (‘rset’) in a request. The first entry refers to the minimum time increment and the second entry refers to the maximum time increment. A value of -1 in an entry range is defined as an infinite time. |
- | 2.99 |
| OperationExecTime | string | W | Rule Limit Comma-separated list (2 items) of longs (value at least -1). Range of allowed values for the operational execution time parameter(‘oet’) in a request. The first entry refers to the minimum time increment and the second entry refers to the maximum time increment. A value of -1 in an entry range is defined as an infinite time. |
- | 2.99 |
| ResponsePersistence | string | W | Rule Limit Comma-separated list (2 items) of longs (value at least -1). Range of allowed values for the response persistence parameter (‘rp’) in a request. The first entry refers to the minimum time increment and the second entry refers to the maximum time increment. A value of -1 in an entry range is defined as an infinite time. |
- | 2.99 |
| DeliveryAggregation | string | W | Rule Limit Comma-separated list (1 to 2 items) of booleans. Allowed values for the Delivery aggregation parameter (‘da’) in a request. |
- | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessECRule.{i}. | object | W | This object describes the parameters necessary to define the usage of underlying networks for forwarding information to other CSEs during processing of CMDH-related requests in a CSE. Annex D.12.6 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Network Access Rule processing for specified event categories.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| EventCategories | string | W | Rule Criterion. Comma-separated list of strings. This parameter defines the applicable event categories for which requests the rules contained in NetworkAccessRules are applied. Each list item is an enumeration of:
|
- | 2.99 |
| NetworkAccessRules | string | W | Comma-separated list of strings. Each list item MUST be the path name of an NetworkAccessRule.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. | - | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessRule.{i}. | object | W | This object describes the parameters necessary is used define limits in usage of specific underlying networks for forwarding information to other CSEs during processing of CMDH related requests. Annex D.2.7 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Network Access Rule processing.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| TargetNetworks | string | W | Rule Criterion. Comma-separated list of strings. This parameter defines for which underlying networks the usage limits contained in this NetworkAccessRule instance is applied. |
- | 2.99 |
| AllowedSchedule | string | W | Rule Criterion Comma-separated list of strings, the format of schedule entry is defined in [Clause 7.4.9.1/ONEM2MProtocol]. This parameter defines the allowed schedule before any of the Underlying Networks matching a value in the TargetNetworks parameter can be used for forwarding information to other CSEs. |
- | 2.99 |
| MinimumReqVolume | unsignedLong | W | Rule Criterion This parameter defines the minimum amount of data, in bytes, that needs to be aggregated before any of the Underlying Networks matching a value in the TargetNetworks parameter can be used for forwarding information to other CSEs. |
- | 2.99 |
| OtherConditions | string | W | Rule Criterion This parameter defines the vendor specific criteria that can be applied this object. |
- | 2.99 |
| BackoffTime | unsignedLong | W | Rule Result This parameter defines the time, in milliseconds, that defines how long a CSE needs to wait before attempting to use a specific Underlying Network again after a first failed attempt. |
- | 2.99 |
| BackoffTimeIncrement | unsignedLong | W | Rule Result This parameter defines by how much, in milliseconds, the back-off time shall be increased after each additional consecutive failed attempt to use the same Underlying Network without success. |
- | 2.99 |
| MaximumBackoffTime | unsignedLong | W | Rule Result This parameter defines the time, in milliseconds, that defines the maximum wait time before attempting to use an Underlying Network again after previous failures. |
- | 2.99 |
| Device.X_oneM2M_org_CSE.{i}.CMDH.Buffer.{i}. | object | W | This object describes the parameters necessary to administer the CMDH limits in usage of buffers for temporarily storing information that needs to be forwarded to other CSEs during processing of CMDH-related requests in a CSE). Annex D.12.8 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Buffer processing.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| EventCategories | string | W | Rule Limit. Comma-separated list of strings. Allowed values for the event category parameter (‘ec’) in a request Each list item is an enumeration of:
|
- | 2.99 |
| MaximumBufferSize | unsignedLong[:1024] | W | Rule Limit Maximum amount of memory, in kilobytes, that can be used for buffering requests matching with a value in the EventCategories parameter. |
- | 2.99 |
| StoragePriority | unsignedInt[1:10] | W | Rule Result Storage priority for data that is stored for buffering requests matching with this Buffer instance |
- | 2.99 |
| Device.X_oneM2M_org_AE.{i}. | object | W | This object represents an instance of a Application Entity (AE) for a M2M device or gateway. The X_oneM2M_org_AE MAY be maintained by the ACS or by the CPE. When the X_oneM2M_org_AE provides the administration of an CSE that is represented as a SoftwareModules.ExecutionUnit the X_oneM2M_org_AE is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter. Clause 6.2.9 of the oneM2M Functional Architecture [ONEM2MFA] describes the high level description for CSE registration. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ID. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| ID | string | W | The AE identifier of this object. The AE-ID is required for this X_oneM2M_org_AE instance in order for the AE to register with the registrar CSE defined by the value of the PointOfAccess parameter. | - | 2.99 |
| PointOfAccess | string | W | The URL of the Registrar CSE to which this X_oneM2M_org_AE instance registers for M2M Service Layer operation. | - | 2.99 |
| ApplicationID | string | W | The APP-ID of this X_oneM2M_org_AE instance. | - | 2.99 |
| AuthenticationProfile | string | W | The value MUST be the path name of the X_oneM2M_org_SecuritySolution.AuthenticationProfile.{i} object instance. The referenced authentication profile is used to convey configuration information regarding establishing mutually-authenticated secure communications. If the referenced object is deleted, the parameter value MUST be set to an empty string. | - | 2.99 |
| Device.X_oneM2M_org_AE.{i}.DataCollection. | object | - | This object represents the data collection (measurement) and transmittal (reporting) properties for an AE. | - | 2.99 |
| ContainerPath | string | W | URI [RFC3986] of the container resource in the Hosting CSE that stores the data transmitted by this DataCollection instance. | - | 2.99 |
| ReportingSchedule | string | W | Comma-separated list of strings, the format of schedule entry is defined in [Clause 7.4.9.1/ONEM2MProtocol]. This parameter defines the schedule used to transmit the data that was collected. | - | 2.99 |
| CollectionSchedule | string | W | Comma-separated list of strings, the format of schedule entry is defined in [Clause 7.4.9.1/ONEM2MProtocol]. This parameter defines the schedule used to collect the data for transmission. | - | 2.99 |
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i}. |
| Status |
| Abbreviation | Description |
|---|---|
| R | Read support is REQUIRED. |
| W | Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only. |
| P | The object is REQUIRED to be present. |
| C | Creation and deletion of instances of the object via AddObject and DeleteObject is REQUIRED. |
| A | Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED. |
| D | Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED. |
| Name | Requirement |
|---|---|
| Device. | P |
| X_oneM2M_org_CSENumberOfEntries | R |
| Device.X_oneM2M_org_CSE.{i}. | C |
| Enable | W |
| Name | Requirement |
|---|---|
| Device.X_oneM2M_org_CSE.{i}. | C |
| ID | W |
| PointOfAccess | W |
| ExternalID | W |
| TriggerRecipientID | W |
| Name | Requirement |
|---|---|
| Device.DeviceInfo.X_oneM2M_org_BatteryStatus. | P |
| BatteryNumberOfEntries | R |
| Device.DeviceInfo.X_oneM2M_org_BatteryStatus.Battery.{i}. | P |
| Level | R |
| Status | R |
| Name | Requirement |
|---|---|
| Device.DeviceInfo.X_oneM2M_org_Diagnostics. | P |
| EventLogNumberOfEntries | R |
| Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i}. | C |
| Enable | W |
| Status | R |
| Type | W |
| LogFile | R |
| Data | R |
| Name | Requirement |
|---|---|
| Device. | P |
| X_oneM2M_org_AENumberOfEntries | R |
| Device.X_oneM2M_org_AE.{i}. | C |
| ID | W |
| PointOfAccess | W |
| ApplicationID | W |
| Name | Requirement |
|---|---|
| Device.X_oneM2M_org_AE.{i}. | C |
| ID | W |
| PointOfAccess | W |
| ApplicationID | W |
| Name | Requirement |
|---|---|
| Device.X_oneM2M_org_AE.{i}.DataCollection. | P |
| ContainerPath | W |
| ReportingSchedule | W |
| CollectionSchedule | W |