The present clause specifies
Table 7.1.1‑1 shows a summary of
Table 7.1.1‑1: Summary of defined
mgmtObj
|
mgmtDefinition
|
Intended use
|
Note
|
|---|---|---|---|
Registration
|
1020
|
Service Layer Configuration information needed to register an AE or CSE with a Registrar CSE.
|
This is M2M Service Provider dependent.
|
dataCollection
|
1021
|
Application Configuration information needed to establish collection of data within the AE and transmit the data to the Hosting CSE using |
This is M2M Application dependent.
|
authenticationProfile
|
1022
|
Security information needed to establish mutually-authenticated secure communications.
|
|
myCertFileCred
|
1023
|
Configuring a file containing a certificate and associated information.
|
|
trustAnchorCred
|
1024
|
Identifies a trust anchor certificate and provides a URL from which the certificate can be retrieved. The trust anchor certificate can be used to validate a certificate which the Managed Entity uses to authenticate another entity.
|
|
MAFClientRegCfg
|
1025
|
Instructions for performing the MAF Client Registration procedure with a MAF. Links to an Authentication Profile instance.
|
|
MEFClientRegCfg
|
1026
|
Instructions for performing the MEF Client Registration procedure with a MEF. Links to an Authentication Profile instance.
|
|
OAuth2Authentication
|
1027
|
To store access token and refresh token used in OAuth2 security protocol.
|
|
wificlient
|
1028
|
To store configuration of Wi-Fi® connection on the client device.
|
|
credentials
|
1029
|
To store credentials on the client device.
|
|
SIM
|
1030
|
To store configuration of Subscriber Identification Module (SIM)
|
|
mobileNetwork
|
1031
|
To store information about the currently connected mobile network.
|
This specialization of
The [registration] resource shall contain the child resource specified in table 7.1.2‑1.
Table 7.1.2‑1: Child resources of [registration] resource
Child Resources of [registration]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [registration] resource shall contain the attributes specified in table 7.1.2‑2.
Table 7.1.2‑2: Attributes of [registration] resource
Attributes of [registration]
|
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have the fixed value 1020 ("registration").
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
originatorID
|
0..1
|
RW
|
CSE-ID of the CSE hosted on the ASN/MN or the AE-ID of an AE hosted on an ASN/MN or ADN node. If the setting is for a CSE, then this attribute shall be present. |
pointOfAccess
|
0..1(L)
|
RW
|
The point of access URI of the Registrar CSE. It represents the list of physical address used by AE/CSEs to connect to registrar CSE. EXAMPLE: http://172.25.0.10:8080/xyz coap://m2m.sp.com:5683 mqtt://172.25.0.10:1883 ws://10.222.254.26:80 See note. |
CSEBase
|
0..1
|
RW
|
The resource identifier of the |
CSE-ID
|
0..1
|
RW
|
The CSE identifier of Registrar CSEin SP-relative CSE-ID format.
|
appID
|
0..1
|
RW
|
The App-ID of an AE. This attribute shall only be present when this resource is used for the registration of an AE.
|
externalID
|
0..1
|
RW
|
The M2M-Ext-ID of the ASN/MN CSE. This attribute can be present when the originatorID is a CSE-ID and the CSE uses the dynamic registration defined in clause 7.1.10 Trigger Recipient Identifier of oneM2M TS-0001 [2]. |
Trigger-Recipient-ID
|
0..1
|
RW
|
The Trigger-Recipient-ID of the ASN/MN CSE. This attribute can be present when the originatorID is a CSE-ID and the CSE uses the dynamic registration defined in clause 7.1.10 Trigger Recipient Identifier of oneM2M TS-0001 [2]. |
mgmtLink
|
0..1
|
RW
|
A link to a with the Registrar CSE. |
M2M-Sub-ID
|
0..1
|
WO
|
The identifier assigned by the M2M Service Provider for the M2M Service Subscription of the registree.
|
NOTE: Protocol binding is determined from the protocol schema in this URI.
|
|||
This specialization of
The [dataCollection] resource shall contain the child resource specified in table 7.1.3‑1.
Table 7.1.3‑1: Child resources of [dataCollection] resource
Child Resources of [dataCollection]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [dataCollection] resource shall contain the attributes specified in table 7.1.3‑2.
Table 7.1.3‑2: Attributes of [dataCollection] resource
Attributes of [dataCollection]
|
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have the fixed value 1021 ("dataCollection").
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
containerPath
|
1
|
RW
|
The URI of the |
reportingSchedule
|
0..1
|
RW
|
The frequency interval, in seconds, used to transmit the data to the Hosting CSE.
|
measurementSchedule
|
0..1
|
RW
|
The frequency interval, in seconds, that the device will use to collect or measure the data.
|
mgmtLink
|
0..1
|
RW
|
A link to a Security of Primitives (ESPrim) between AE and hosting CSE. ESPrim is specified in oneM2M TS-0003 [3]. |
NOTE: The present specification does not support configuration for End-to-End Security of Data (ESData) specified in oneM2M TS-0003 [3].
|
|||
The [authenticationProfile] specialization of the
An [authenticationProfile] instance identifies a security framework, TLS cipher suites, and credentials to be used. The applicable security framework is identified by the SUID attribute. The interpretation of SUID is specified in table 7.1.43.
NOTE 1: The present document does not support using [authenticationProfile] for identifying ESData credentials.
The [authenticationProfile] resource does not include any credentials, but either identifies credentials which are stored locally on the Managed Entity or identifies an M2M Authentication Function (MAF) which is to be used to facilitate establishing symmetric keys. The intended security principal on the Managed Entity is the security principal which can use either all the credentials identified by the [authenticationProfile] resource, or (in the case that a MAF is identified) all of the credentials required for mutual authentication with the MAF.
NOTE 2: The other security principal can be any of the following: CSE; AE; a Node terminating the security protocol on behalf of AE on Node; and an M2M Authentication Function (MAF).
The [authenticationProfile] resource shall contain the child resource specified in table 7.1.4‑1.
Table 7.1.4‑1: Child resources of [authenticationProfile] resource
Child Resources of [authenticationProfile]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [authenticationProfile] resource shall contain the attributes specified in table 7.1.4‑2.
Table 7.1.4‑2: Attributes of [authenticationProfile] resource
Attributes of [authenticationProfile] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have the fixed value 1022 ("authenticationProfile").
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
SUID
|
1
|
WO
|
Describes how the authentication profile is to be used. Further details about interpretation of each SUID are specified in table 7.1.4-3 of the present document.
|
TLSCiphersuites
|
0..1(L)
|
RW
|
If the security framework identified by SUID uses TLS, then this attributes provides a list of allowed TLS cipher suites.
|
symmKeyID
|
0..1
|
WO
|
Present when a symmetric key is to be used for mutual authentication. Identifier for a symmetric key already stored locally on the Managed Entity, or to be provisioned to the Managed Entity.
|
symmKeyValue
|
0..1
|
WO
|
Optionally present when a symmetric key is to be used for mutual authentication. Contains the value of the symmetric key to be used for mutual authentication.
|
MAFKeyRegLabels
|
0..1(L)
|
WO
|
Optionally present when a MAF is to be used to facilitate establishing a symmetric key for mutual authentication. Provides the content of the labels parameter in the MAF Key Registration request; see table 8.8.2.7‑1, oneM2M TS0003 [3].
|
MAFKeyRegDuration
|
0..1
|
WO
|
Present when a MAF is to be used to facilitate establishing one or more symmetric keys for mutual authentication. Provides the maximum duration for which an established symmetric key may be used.
|
mycertFingerprint
|
0..1
|
WO
|
Present when certificate-based authentication is to be used. Provides 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.
|
rawPubKeyID
|
0..1
|
WO
|
Present when certificate-based authentication is to be used and the other security principal will authenticate itself with a Raw Public Key Certificate.
|
M2M-Sub-ID
|
0..1
|
WO
|
The identifier assigned by the M2M Service Provider for the M2M Service Subscription of the registree.
|
mgmtLink
|
0..1(L)
|
RW
|
Present when MAF is to be used to facilitate establishing one or more symmetric keys for mutual authentication or certificate-based authentication is to be used. In the former case, the list contains one reference to a [MAFClientRegCfg] resource. In the latter case, the list contains one or more references pointing to [trustAnchorCred] resources.
|
Table 7.1.4‑3: SUID which are currently supported in the [authenticationProfile] resource, along with reference to the authentication procedure in oneM2M TS-0003 [3] and mapping to symmetric key
Value
|
Interpretation (see note) |
Authentication Procedure in oneM2M TS-0003 [3]
|
Derived Symmetric Key
|
DTLS/TLS Notes
|
|---|---|---|---|---|
10
|
A pre-provisioned symmetric key intended to be shared with a MEF
|
8.3.2.1
|
Kpm
|
See TLS-PSK Profile in clause 10.2.2 of oneM2M TS-0003 [3]
|
11
|
A pre-provisioned symmetric key intended to be shared with a MAF
|
8.8.2.2
|
Km
|
|
12
|
A pre-provisioned symmetric key intended for use in a Security Associated Establishment Framework (SAEF)
|
8.2.2.1
|
Kpsa
|
|
13
|
A pre-provisioned symmetric key intended for use in End-to-End Security of Primitives (ESPrim)
|
8.4.2
|
pairwiseESPrimKey
|
DTLS/TLS is not used
|
21
|
A symmetric key, provisioned via a Remote Security Provisioning Framework (RSPF), and intended to be shared with a MAF
|
RSPF: 8.3.1.2 MAF: 8.8.2.2, 8.8.3.1 |
Km
|
See TLS-PSK Profile in clause 10.2.2 of oneM2M TS-0003 [3]
|
22
|
A symmetric key, provisioned via a RSPF, and intended for use in a SAEF
|
RSPF: 8.3.1.2 SAEF: 8.2.2.1, 9.1.1.1 |
Kpsa
|
|
23
|
A symmetric key, provisioned via a RSPF, and intended for use in ESPrim
|
RSPF: 8.3.1.2 ESPrim: 8.4.2 |
pairwiseESPrimKey
|
DTLS/TLS is not used
|
32
|
A MAF-distributed symmetric key intended for use in a SAEF
|
MAF: 8.8.2.7, 8.8.3.3 SAEF: 8.2.2.3, 9.1.1.1 |
Kpsa
|
See TLS-PSK Profile in clause 10.2.2 of oneM2M TS-0003 [3]
|
33
|
A MAF-distributed symmetric key intended for use in ESPrim
|
MAF: 8.8.2.7, 8.8.3.3 ESPrim: 8.4.2 |
pairwiseESPrimKey
|
|
40
|
A certificate intended to be shared with a MEF
|
8.3.2.2
|
NP
|
See certificate-based TLS profile in clause 10.2.3 of oneM2M TS0003 [3]
|
41
|
A certificate intended to be shared with a MAF
|
8.8.2.2
|
NP
|
|
42
|
A certificate intended for use in a Security Associated Establishment Framework (SAEF)
|
8.2.2.2
|
NP
|
|
43
|
A certificate intended for use in End-to-End Security Certificate-based Key Establishment (ESCertKE) to establish a pairwiseESPrimKey for End-to-End Security of Primitives (ESPrim) |
ESCertKE: 8.7 ESPrim: 8.4.2 |
NP
|
For ESCertKE, see certificate-based TLS profile in clause 10.2.3 of oneM2M TS0003 [3]. For ESPrim, DTLS/TLS is not used
|
The Managed Entity shall allow only TLS cipher suites identified in TLSCiphersuites in the TLS Handshakes for a [authenticationProfile] instance. The final column of table 7.1.4‑3 provides references to clauses in oneM2M TS0003 [3] specifying the TLS Profiles to be used with the SUID values. The TLSCiphersuite attribute shall be present only when the value of SUID identifies a security framework that uses TLS or DTLS.
If the value of SUID is 10, 11, 12, 21, 22 or 23, then the symmKeyID attribute shall be present. The symmKeyID provides the symmetric key identifier for a symmetric key which shall be retrieved from local storage on the Managed Entity for use in the TLS Handshake. The symmetric key value may be configured in the symmKeyValue . Otherwise, the symmetric key, and associated symmetric key identifier, may be provisioned to the Managed Entity before or after the [authenticationProfile] is configured. Pre-provisioning or Remote Security Provisioning Frameworks (RSPFs), specified in oneM2M TS-0003 [3], should be used whenever possible to establish symmetric keys. Special care is recommended to ensure the confidentiality and integrity of the credentials when using the symmKeyValue to configure symmetric keys.
If the value of SUID is 32 or 33, then the MAFKeyRegDuration attribute shall be present, the MAFKeyRegLabels attribute may be present, and a [MAFClientRegCfg] specialization shall be configured as a child of the [authenticationProfile] resource. These attributes provide the configuration controlling how the Managed Entity shall interact with a MAF to establish the symmetric key subsequently used for mutual authentication. The fqdn attribute of the [MAFClientRegCfg] specialization identifies the MAF.
If the value of SUID is 40, 41, 42, or 43, then the mycertFingerprint attribute shall be present, and either the rawPubKeyID attribute shall be present or one or more [trustAnchorCred] specializations shall be configured as children of the [authenticationProfile] resource. The Managed Entity shall use the certificate matching mycertFingerprint to authenticate itself. The hash value portion of mycertFingerprint shall be computed over the X.509 ASN.1 DER encoded certificate:
[authenticationProfile] resources are expected to be protected by a secure environment on the Managed Entity, in order to preserve integrity of the attributes. Optimal protection is provided when the integrity protection of the management protocol message is verified in the secure environment.
This
The [myCertFileCred] resource shall contain the child resource specified in table 7.1.5‑1.
Table 7.1.5‑1: Child resources of [myCertFileCred] resource
Child Resources of [myCertFileCred]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [myCertFileCred] resource shall contain the attributes specified in table 7.1.5‑2.
Table 7.1.5‑2: Attributes of [myCertFileCred] resource
Attributes of [myCertFileCred] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have the fixed value 1023 ("myCertFileCred").
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
SUIDs
|
1 (L)
|
RW
|
Identifies the security framework(s) which may use this credential.
|
myCertFileFormat
|
1
|
WO
|
Media Type of myCertFileContent attribute. Default is "application/pkcs7-mime".
|
myCertFileContent
|
1
|
WO
|
Certificate or certificate chain. Default media-type is "application/pkcs7-mime".
|
The SUIDs attribute lists the Security Usage Identifiers (SUIDs) of the security frameworks which shall be allowed using this credential for establishing mutually-authenticated secure communication. Any SUID which is not in this list shall be prevented from using this credential for establishing mutually-authenticated secure communication. The SUID values allowed in this attribute are listed in table 7.1.5‑3. See table 7.1.4‑3 for references to the corresponding authentication procedure in oneM2M TS-0003 [3] and DTLS/TLS notes.
Table 7.1.5‑3: SUID which are currently supported in the [myCertFileCred] resource
Value
|
Interpretation (see note)
|
|---|---|
40
|
A certificate intended to be shared with a MEF
|
41
|
A certificate intended to be shared with a MAF
|
42
|
A certificate intended for use in a Security Associated Establishment Framework (SAEF)
|
43
|
A certificate intended for use in End-to-End Security Certificate-based Key Establishment (ESCertKE) to establish a pairwiseESPrimKey for End-to-End Security of Primitives (ESPrim)
|
The Certificate issuer should verify that the corresponding private key is known to the Managed Entity. The present specification does not provide a mechanism for such verification.
NOTE: In many scenarios, if the device management session takes place over a TLS connection in which the Managed Entity is authenticated using an existing certificate (e.g. a manufacturer certificate), then it would be acceptable to issue a certificate with SubjectPublicKeyInfo copied from the existing certificate.
Managed Entities shall support the default certificate-related media type.
If the mycertFingerprint attribute in an [authenticationProfile] resource matches the certificate in a [myCertFileCred] resource, then the authentication protocol based on that [authenticationProfile] shall provide the certificate or certificate chain in the myCertFileContent , and shall use the corresponding private key to authenticate the Managed Entity.
[myCertFileCred] instances are expected to be protected by a secure environment on the Managed Entity, in order to preserve confidentiality and integrity of the attributes. Optimal protection is provided when the decryption and integrity verification of the management protocol message occurs in the secure environment.
The [trustAnchorCred]
The [trustAnchorCred] resource shall contain the child resource specified in table 7.1.6‑1.
Table 7.1.6‑1: Child resources of [trustAnchorCred] resource
Child Resources of [trustAnchorCred]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [trustAnchorCred] resource shall contain the attributes specified in table 7.1.6‑2.
Table 7.1.6‑2: Attributes of [trustAnchorCred] resource
Attributes of [trustAnchorCred] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
Labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have the fixed value 1024 ("trustAnchorCred").
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
Description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
certFingerprint
|
1
|
WO
|
Provides a hash value for identifying a certificate authority certificate to be used for validating certificates presented by other entities.
|
URI
|
1
|
RW
|
A URI from which the trust anchor certificate may be retrieved.
|
The certFingerprint attribute of the [trustAnchorCred] resource identifies a Certificate Authority certificate to be used by the Managed Entity as a trust anchor when validating the certificate chains provided by other entities. The hash value portion of the certFingerprint attribute shall be computed over the X.509 ASN.1 DER encoded certificate using the SHA-256 hash algorithm defined in FIPS PUB 180-4 [10]. The certFingerprint attribute shall be represented in the named information (ni) URI format defined in IETF RFC 6920 [7], see tables 7.2.6.1‑2 and 7.3.2-1. Where the CA Certificate identified in a [trustAnchorCred] resource is not already in local storage, then the Managed Entity shall retrieve the certificate using the URI attribute in the [trustAnchorCred] resources.
[trustAnchorCred] resources are expected to be protected by a secure environment on the Managed Entity, in order to preserve integrity of the attributes. Optimal protection is provided when the integrity protection of the management protocol message is verified in the secure environment.
This
The [MAFClientRegCfg] resource shall contain the child resource specified in table 7.1.7‑1.
Table 7.1.7‑1: Child resources of [MAFClientRegCfg] resource
Child Resources of [MAFClientRegCfg]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [MAFClientRegCfg] resource shall contain the attributes specified in table 7.1.7‑2.
Table 7.1.7‑2: Attributes of [MAFClientRegCfg] resource
Attributes of [MAFClientRegCfg] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have the fixed value 1025 ("MAFClientRegCfg").
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
fqdn
|
1
|
WO
|
See clause 8.8.3.2 of oneM2M TS-0003 [3]
|
adminFQDN
|
1
|
WO
|
See clause 8.8.3.2 of oneM2M TS-0003 [3]
|
httpPort
|
0..1
|
WO
|
See clause 8.8.3.2 of oneM2M TS-0003 [3]
|
coapPort
|
0..1
|
WO
|
See clause 8.8.3.2 of oneM2M TS-0003 [3]
|
websocketPort
|
0..1
|
WO
|
See clause 8.8.3.2 of oneM2M TS-0003 [3]
|
mgmtLink
|
1
|
RW
|
A link to a [authenticationProfile] resource containing the parameters for the MAF Client to establish mutuallyauthenticated secure communications with the MAF.
|
The MAF Client shall perform the MAF Client Registration Procedure specified in clause 8.8.2.3 of oneM2M TS0003 [3], using the linked authentication profile for mutual authentication of the MAF Client and MAF.
The MOs configured to the Managed Entity via [MAFClientRegCfg] resources are expected to be protected by a secure environment on the Managed Entity, in order to preserve integrity of the attributes. Optimal protection is provided when the integrity protection of the management protocol message is verified in the secure environment.
This
The [MEFClientRegCfg] resource shall contain the child resource specified in table 7.1.8‑1.
Table 7.1.8‑1: Child resources of [MEFClientRegCfg] resource
Child Resources of [MEFClientRegCfg]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [MEFClientRegCfg] resource shall contain the attributes specified in table 7.1.8‑2.
Table 7.1.8‑2: Attributes of [MEFClientRegCfg] resource
Attributes of [MEFClientRegCfg] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
Labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have the fixed value 1026 ("MEFClientRegCfg").
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
Description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
Fqdn
|
1
|
WO
|
See clause 8.3.7 of oneM2M TS-0003 [3]
|
adminFQDN
|
1
|
WO
|
See clause 8.3.7 of oneM2M TS-0003 [3]
|
httpPort
|
0..1
|
WO
|
See clause 8.3.7 of oneM2M TS-0003 [3]
|
coapPort
|
0..1
|
WO
|
See clause 8.3.7 of oneM2M TS-0003 [3]
|
websocketPort
|
0..1
|
WO
|
See clause 8.3.7 of oneM2M TS-0003 [3]
|
mgmtLink
|
1
|
RW
|
A link to a [authenticationProfile] resource containing the parameters for the MEF Client to establish mutually-authenticated secure communications with the MEF.
|
The MEF Client shall perform the MEF Client Registration Procedure specified in clause 8.8.2.3 of oneM2M TS0003 [3], using the linked authentication profile for mutual authentication of the MEF Client and MEF.
The MOs configured to the Managed Entity via [MEFClientRegCfg] resources are expected to be protected by a secure environment on the Managed Entity, in order to preserve integrity of the attributes. Optimal protection is provided when the integrity protection of the management protocol message is verified in the secure environment.
This specialization of
The [OAuth2Authentication] resource shall contain the child resources specified in table 7.1.9‑1.
Table 7.1.9‑1: Child resources of [OAuth2Authentication] resource
Child Resources of [OAuth2Authentication]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [OAuth2Authentication] resource shall contain the attributes specified in table 7.1.9‑2.
Table 7.1.9‑2: Attributes of [OAuth2Authentication] resource
Attributes of [OAuth2Authentication] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have fixed value "OAuthAuthentication".
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
accessToken
|
1
|
RW
|
Indicates OAuth2 access token.
|
refreshToken
|
1
|
RW
|
Indicates OAuth2 refresh token.
|
This specialization of
The [wifiClient] resource shall contain the child resources specified in table 7.1.10‑1.
Table 7.1.10‑1: Child resources of [wifiClient] resource
Child Resources of [wifiClient]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [wifiClient] resource shall contain the attributes specified in table 7.1.10‑2.
Table 7.1.10‑2: Attributes of [wifiClient] resource
Attributes of [wifiClient] |
Multiplicity**
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2]. This attribute shall have the fixed value 1027(wifiClient).
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
ssid
|
1
|
RW
|
Indicates ssid of Wi-Fi® network. This attribute is a specialization of [objectAttribute] attribute.
|
credentials
|
0..1
|
RW
|
Indicates encryption type and credentials used to authenticate connection. This attribute is a specialization of [objectAttribute] attribute.
|
macAddress
|
0..1
|
RW
|
Indicates MAC address of network's access point. This attribute is a specialization of [objectAttribute] attribute.
|
channel
|
0..1
|
RO
|
Indicates Wi-Fi® channel. This attribute is a specialization of [objectAttribute] attribute.
|
connectionStatus
|
0..1
|
RW
|
Indicates current status of the connection. This attribute is a specialization of [objectAttribute] attribute.
|
scan
|
1
|
RW
|
The action that allows to scan the environment to find available Wi-Fi® networks. The action is triggered by assigning value "TRUE" to this attribute. This attribute is a specialization of [objectAttribute] attribute. This action will provide all the available ssids in scanResult .
|
scanResult
|
1
|
RW
|
Indicates list of networks detected by the device. This attribute is a specialization of [objectAttribute] attribute.
|
update
|
1
|
RW
|
The action is to trigger the device to update its Wi-Fi® configuration based on the provided values (e.g. ssid, credentials, etc.).The action is triggered by assigning value "TRUE" to this attribute. This attribute is a specialization of [objectAttribute] attribute.
|
updateStatus
|
1
|
RW
|
Indicates status of update operation. This attribute is a specialization of [objectAttribute] attribute.
|
toggleRadioStatus
|
0..1
|
RW
|
The action that allows to turn on and turn off the Wi-Fi® subsystem on Wi-Fi® client device according to present radioStatus attribute value. The action is triggered by assigning value "TRUE" to this attribute. This attribute is a specialization of [objectAttribute] attribute. This action will switch radioStatus .
|
radioStatus
|
0..1
|
RW
|
Indicates whether the Wi-Fi® sub-system on Wi-Fi® client device is turned on or turned off. This attribute is a specialization of [objectAttribute] attribute.
|
This specialization of
The [credentials] resource shall contain the child resources specified in table 7.1.11‑1.
Table 7.1.11‑1: Child resources of [credentials] resource
Child Resources of [credentials]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [credentials] resource shall contain the attributes specified in table 7.1.11.-2
Table 7.1.11‑2: Attributes of [credentials] resource
Attributes of [credentials] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].. This attribute shall have the fixed value 1029(credentials).
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
purpose
|
0..1
|
RW
|
Indicates the intended use of this credentials set.
|
credentialID
|
0..1
|
RW
|
Indicates a username or credential ID for authentication.
|
credentialSecret
|
0..1
|
RW
|
Indicates a password or credential secret for authentication.
|
credentialToken
|
0..1
|
RW
|
Indicates a token for authentication.
|
This specialization of
The terms "SIM" and "Subscriber Identity Module" are used in this resource to refer to the physical/logical platform hosting the application handling authentication of the related subscriber onto a 3GPP network.
The [SIM] resource shall contain the child resources specified in table 7.1.12‑1.
Table 7.1.12‑1: Child resources of [SIM] resource
Child Resources of [SIM]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [SIM] resource shall contain the attributes specified in table 7.1.12‑2.
Table 7.1.12‑2: Attributes of [SIM] resource
Attributes of [SIM] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].. This attribute shall have the fixed value 1030 (SIM).
|
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
imsi
|
0..1
|
RW
|
The international mobile subscriber identity (IMSI) that is associated with the SIM.
|
iccid
|
1
|
RW
|
The physical/logical platform for each SIM is uniquely identified by its integrated circuit card identifier (ICCID) as specified in ETSI TS 102 221_._ It is also used to identify eSIM profiles.
|
simStatus
|
0..1
|
RW
|
The activation status of the SIM in the device.
|
simType
|
0..1
|
RW
|
The type of the SIM.
|
serviceProviderName
|
0..1
|
RW
|
The Service Provider Name (SPN) of a SIM.
|
This specialization of
The [mobileNetwork] resource shall contain the child resources specified in table 7.1.13‑1.
Table 7.1.13‑1: Child resources of [mobileNetwork] resource
Child Resources of [mobileNetwork]
|
Child Resource Type
|
Multiplicity
|
Description
|
|---|---|---|---|
[variable]
|
0..n
|
See clause 9.6.8 of oneM2M TS-0001 [2]
|
The [mobileNetwork] resource shall contain the attributes specified in table 7.1.13‑2. The specialisation attributes are derived from and map to the LwM2M Object #4 "Connectivity Monitoring" definition [11].
Table 7.1.13‑2: Attributes of [mobileNetwork] resource
Attributes of [mobileNetwork] |
Multiplicity
|
RW/ RO/ WO |
Description
|
|---|---|---|---|
resourceType
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
resourceName
|
1
|
WO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
parentID
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
expirationTime
|
1
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
accessControlPolicyIDs
|
0..1 (L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
creationTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
lastModifiedTime
|
1
|
RO
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
labels
|
0..1(L)
|
RW
|
See clause 9.6.1.3 of oneM2M TS-0001 [2].
|
mgmtDefinition
|
1
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].. This attribute shall have the fixed value 1031 (mobileNetwork). |
objectIDs
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
objectPaths
|
0..1 (L)
|
WO
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
description
|
0..1
|
RW
|
See clause 9.6.15 of oneM2M TS-0001 [2].
|
cellularNetworkBearer
|
0..1
|
RW
|
Indicates the cellular network bearer used for the current cellular communication session.
|
radioSignalStrength
|
0..1
|
RW
|
Indicates the average value of the received signal strength indication used in the current cellular network bearer. For the following network bearers the signal strength parameters indicated below are represented by this resource: GSM: RSSI UMTS: RSCP LTE: RSRP NB-IoT: NRSRP |
linkQuality
|
0..1
|
RW
|
|
ipAddresses
|
0..1(L)
|
RW
|
The IP addresses assigned to the connectivity interface. (e.g. IPv4, IPv6, etc.)
|
routerIPAddresses
|
0..1(L)
|
RW
|
The IP address of the next-hop IP router, on each of the interfaces specified in resource 4 (IP Addresses).
|
apn
|
0..1
|
RW
|
Access Point Name of the cellular network.
|
cellID
|
0..1
|
RW
|
Serving Cell ID of a cellular Network.
|
smnc
|
0..1
|
RW
|
Serving Mobile Network Code of a cellular network. As specified in 3GPP 23.003 [14]. |
smcc
|
0..1
|
RW
|
Serving Mobile Country Code of a cellular network. As specified in 3GPP 23.003 [14]. |
lac
|
0..1
|
RW
|
|
coverageEnhancementLevel
|
0..1
|
RW
|
The present clause defines the resource-type specific details of the resource representations and protocol procedures for each
This specialization of
Table 7.2.2.1‑1: Data Type Definition of [registration]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
registration
|
DCFG-registration.xsd
|
Table 7.2.2.1‑2: Resource specific attributes of [registration]
Attribute Name
|
Request Optionality
|
Data Type
|
||
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1020 (registration).
|
objectIDs
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
originatorID
|
O
|
O
|
m2m:ID
|
CSE-ID of the CSE hosted on the ASN/MN or the AE-ID of an AE hosted on an ASN/MN or ADN node. If the setting is for a CSE, then this attribute shall be present. |
pointOfAccess
|
O
|
O
|
m2m:poaList
|
The point of access URI of the Registrar CSE. Note; protocol binding is determined from the protocol schema in this URI. |
CSEBase
|
O
|
O
|
xs:anyURI
|
No Defaults.
|
CSE-ID
|
O
|
O
|
m2m:ID
|
No Defaults.
|
appID
|
O
|
O
|
m2m:ID
|
The APP_ID of an AE. This attribute shall only be present when this resource is used for the registration of an AE. |
externalID
|
O
|
O
|
m2m:externalID
|
The M2M-Ext-ID of the ASN/MN CSE. This attribute can be present when the originatorID is a CSE-ID and the CSE uses the dynamic registration defined in clause 7.1.10 Trigger Recipient Identifier of oneM2M TS0001 [2]. |
Trigger-Recipient-ID
|
O
|
O
|
m2m:triggerRecipientID
|
The Trigger-Recipient-ID of the ASN/MN CSE. This attribute can be present when the originatorID is a CSE-ID and the CSE uses the dynamic registration defined in clause 7.1.10 Trigger Recipient Identifier of oneM2M TS-0001 [2]. |
mgmtLink
|
O
|
O
|
m2m:mgmtLinkRef
|
1 link to a [authenticationProfile] resource instance. See note.
|
M2M-Sub-ID
|
O
|
NP
|
m2m:ID
|
|
NOTE: The SUID in the linked [authenticationProfile] instance constrains the security framework to be used with the Authentication Profile. The security frameworks used with the [registration] resource are Security Association Establishment Frameworks (SAEF). The entity composing a [registration] instance is expected to confirm that the linked Authentication Profile contains a SUID corresponding to an SAEF. The SAEF SUIDs are the values 12, 22, 32 or 42 as defined in oneM2M TS-0004 [4].
|
||||
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
If appID attribute is set to a value starting with other than 'r', 'R' or 'N' then the Hosting CSE shall reject the request with "BAD_REQUEST" Response Status Code .
NOTE: Use of 'r' will be forbidden when subsequently registering an AE that supports release 4 or above.
Table 7.2.3.1‑1: Data Type Definition of [dataCollection]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dataCollection
|
DCFG-dataCollection.xsd
|
Table 7.2.3.1‑2: Resource specific attributes of [dataCollection]
Attribute Name
|
Request Optionality
|
Data Type
|
||
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1021 (dataCollection).
|
objectIDs
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
containerPath
|
M
|
O
|
m2m:ID
|
The URI of the |
reportingSchedule
|
O
|
O
|
m2m:scheduleEntries
|
The schedule, used to transmit the measured or collected data to the Hosting CSE. If the entity that reports the data misses a reporting interval, the entity shall wait until the next interval to report the data. |
measurementSchedule
|
O
|
O
|
m2m:scheduleEntries
|
The schedule, that the device will use to collect or measure the data. If the entity that measures or collects the data misses a measurement interval, the entity shall wait until the next interval to collect or measure the data. |
mgmtLink
|
O
|
O
|
m2m:mgmtLinkRef
|
1 link to a [authenticationProfile]. See note.
|
NOTE: The SUID in the linked [authenticationProfile] instance constrains the security framework to be used with the Authentication Profile. The security frameworks used with the [dataCollection] resource are End-to-End Security of Primitives (ESPrim). The entity composing a [dataCollection] instance is expected to confirm that the linked Authentication Profile contains a SUID corresponding to ESPrim. The SUIDs corresponding to ESPrim security frameworks are the values 13, 23, 33 or 43 as defined in oneM2M TS-0004 [4].
|
||||
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
Table 7.2.4.1‑1: Data Type Definition of [authenticationProfile]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
authenticationProfile
|
DCFG-authenticationProfile.xsd
|
Table 7.2.4.1‑2: Resource specific attributes of [authenticationProfile]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1022 (authenticationProfile).
|
objectID
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
SUID
|
M
|
NP
|
m2m:suid
|
Allowed values are listed in table 7.1.43.
|
TLSCiphersuites
|
O
|
O
|
dcfg:listOfTLSCiphersuite
|
|
symmKeyID
|
O
|
NP
|
sec:credentialID
|
|
symmKeyValue
|
O
|
NP
|
xs:hexBinary
|
The minimum key length is 256 bits.
|
MAFKeyRegLabels
|
O
|
NP
|
m2m:labels
|
|
MAFKeyRegDuration
|
O
|
NP
|
xs:duration
|
|
mycertFingerprint
|
O
|
NP
|
dcfg:niURI or dcfg:nihURI
|
|
rawPubKeyID
|
O
|
NP
|
dcfg:niURI or dcfg:nihURI
|
|
M2M-Sub-ID
|
O
|
NP
|
m2m:ID
|
|
mgmtLink
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
Table 7.2.4.13: Child resources of [authenticationProfile] resource
Child Resource Type
|
Child Resource Name
|
Multiplicity
|
Ref. to in Resource Type Definition
|
|---|---|---|---|
[variable]
|
0..n
|
Clause 7.4.8 of oneM2M TS-0004 [4]
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
Table 7.2.5.1‑1: Data Type Definition of [myCertFileCred]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
myCertFileCred
|
DCFG-myCertFileCred.xsd
|
Table 7.2.5.1‑2: Resource specific attributes of [myCertFileCred]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1023 (myCertFileCred)
|
objectID
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
SUIDs
|
M
|
O
|
xs:list of m2m:suid
|
Allowed values are listed in table 7.1.5‑3.
|
myCertFileFormat
|
M
|
NP
|
xs:anyURI
|
Media Type of myCertFileContent attribute. Default is "application/pkcs7-mime".
|
myCertFileContent
|
M
|
NP
|
xs:string
|
Certificate or certificate chain. Default media-type is "application/pkcs7-mime".
|
Table 7.2.5.13: Child resources of [myCertFileCred] resource
Child Resource Type
|
Child Resource Name
|
Multiplicity
|
Ref. to in Resource Type Definition
|
|---|---|---|---|
[variable]
|
0..n
|
Clause 7.4.8 of oneM2M TS-0004 [4]
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
Table 7.2.6.1‑1: Data Type Definition of [trustAnchorCred]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
trustAnchorCred
|
DCFG-trustAnchorCred.xsd
|
Table 7.2.6.1‑2: Resource specific attributes of [trustAnchorCred]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1024 (trustAnchorCred)
|
objectID
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
certFingerprint
|
M
|
NP
|
dcfg:niURI
|
|
URI
|
M
|
O
|
xs:anyURI
|
|
Table 7.2.6.13: Child resources of [trustAnchorCred] resource
Child Resource Type
|
Child Resource Name
|
Multiplicity
|
Ref. to in Resource Type Definition
|
|---|---|---|---|
[variable]
|
0..n
|
Clause 7.4.8 of oneM2M TS-0004 [4]
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
Table 7.2.7.1‑1: Data Type Definition of [MAFClientRegCfg]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
MAFClientRegCfg
|
DCFG-MAFClientRegCfg.xsd
|
Table 7.2.7.1‑2: Resource specific attributes of [MAFClientRegCfg]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1025 (MAFClientRegCfg)
|
fqdn
|
M
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
|
adminFQDN
|
M
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
|
httpPort
|
O
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
At least one of these attributes shall be present
|
coapPort
|
O
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
At least one of these attributes shall be present
|
websocketPort
|
O
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
At least one of these attributes shall be present
|
mgmtLink
|
M
|
O
|
m2m:mgmtLinkRef
|
1 link to a [authenticationProfile] resources instance
|
Table 7.2.7.13: Child resources of [MAFClientRegCfg] resource
Child Resource Type
|
Child Resource Name
|
Multiplicity
|
Ref. to in Resource Type Definition
|
|---|---|---|---|
[variable]
|
0..n
|
Clause 7.4.8 of oneM2M TS-0004 [4]
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
Table 7.2.8.1‑1: Data Type Definition of [MEFClientRegCfg]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
MEFClientRegCfg
|
DCFG-MEFClientRegCfg.xsd
|
Table 7.2.8.1‑2: Resource specific attributes of [MEFClientRegCfg]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1026 (MEFClientRegCfg)
|
fqdn
|
M
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
|
adminFQDN
|
M
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
|
httpPort
|
O
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
At least one of these attributes shall be present
|
coapPort
|
O
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
At least one of these attributes shall be present
|
websocketPort
|
O
|
NP
|
See table 12.4.2-1 of oneM2M TS-0003 [3]
|
At least one of these attributes shall be present
|
mgmtLink
|
M
|
O
|
m2m:mgmtLinkRef
|
|
Table 7.2.8.13: Child resources of [MEFClientRegCfg] resource
Child Resource Type
|
Child Resource Name
|
Multiplicity
|
Ref. to in Resource Type Definition
|
|---|---|---|---|
[variable]
|
0..n
|
Clause 7.4.8 of oneM2M TS-0004 [4]
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
This specialization of
Table 7.2.9.1‑1: Data Type Definition of [OAuth2Authentication]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
OAuth2Authentication
|
DCFG-OAuth2.xsd
|
Table 7.2.9.1‑2: Resource specific attributes of [OAuth2Authentication]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1027 (OAuth2Authentication)
|
objectIDs
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
accessToken
|
M
|
O
|
xs:string
|
|
refreshToken
|
M
|
O
|
xs:string
|
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 in oneM2M TS-0004 [4],'_
This specialization of
Table 7.2.10.11: Data Type Definition of [wifiClient]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
wifiClient
|
DCFG-wifiClient.xsd
|
Table 7.2.10.12: Resource specific attributes of [wifiClient]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
1028 (wifiClient)
|
objectIDs
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4]
|
|
ssid
|
M
|
O
|
dcfg:ssid
|
|
credentials
|
O
|
O
|
dcfg:wifiCredentials
|
|
macAddress
|
O
|
O
|
xs:string
|
|
channel
|
O
|
O
|
xs:integer
|
|
update
|
O
|
O
|
xs:boolean
|
|
scan
|
M
|
O
|
xs:boolean
|
|
toggleRadioStatus
|
O
|
O
|
xs:boolean
|
|
scanResult
|
O
|
O
|
dcfg:listOfSsids
|
|
updateStatus
|
O
|
O
|
m2m:actionStatus
|
|
connectionStatus
|
O
|
O
|
dcfg:wifiConnectionStatus
|
|
radioStatus
|
O
|
O
|
xs:boolean
|
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4],'
This specialization of
Table 7.2.11.11: Data Type Definition of [credentials]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
credentials
|
DCFG-credentials-v4_0_0.xsd
|
Table 7.2.11.12: Resource specific attributes of [credentials]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
1029 (credentials)
|
objectIDs
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
purpose
|
O
|
O
|
xs:string
|
|
credentialID
|
O
|
O
|
xs:string
|
|
credentialSecret
|
O
|
O
|
xs:string
|
|
credentialToken
|
O
|
O
|
Xs:string
|
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4] shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource.
This specialization of
Table 7.2.12.11: Data Type Definition of [SIM]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
SIM
|
DCFG-SIM.xsd
|
Table 7.2.12.12: Resource specific attributes of [SIM]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
1030 (SIM)
|
objectIDs
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
imsi
|
O
|
O
|
dcfg:imsi
|
|
iccid
|
M
|
NP
|
dcfg:iccid
|
|
simStatus
|
O
|
O
|
dcfg:simStatus
|
|
simType
|
O
|
O
|
dcfg:simType
|
|
serviceProviderName
|
O
|
O
|
xs:string
|
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
This specialization of
Table 7.2.13.11: Data Type Definition of [mobileNetwork]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
mobileNetwork
|
DCFG-mobileNetwork.xsd
|
Table 7.2.12.12: Resource specific attributes of [mobileNetwork]
Attribute Name
|
Request Optionality
|
Data Type
|
Default Value and Constraints
|
|
|---|---|---|---|---|
Create
|
Update
|
|||
mgmtDefinition
|
M
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
1031 (mobileNetwork)
|
objectIDs
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
objectPaths
|
O
|
NP
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
description
|
O
|
O
|
See clause 7.4.15 of oneM2M TS-0004 [4].
|
|
cellularNetworkBearer
|
O
|
O
|
dcfg:cellularNetworkBearerType
|
|
radioSignalStrength
|
O
|
O
|
xs:integer
|
|
linkQuality
|
O
|
O
|
xs:integer
|
|
ipAddresses
|
O
|
O
|
list of m2m:ipAddress
|
|
routerIPAddresses
|
O
|
O
|
list of m2m:ipAddress
|
|
apn
|
O
|
O
|
dcfg:apn
|
|
cellID
|
O
|
O
|
xs:integer
|
|
smnc
|
O
|
O
|
xs:integer
|
|
smcc
|
O
|
O
|
xs:integer
|
|
lac
|
O
|
O
|
dcfg:lac
|
|
coverageEnhancementLevel
|
O
|
O
|
dcfg:coverageEnhancementLevel
|
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '
Clause 7.3 defines data formats of resource attributes and parameters used in present document.
Any data types of XML elements defined for use in present document shall be one of name spaces in table 7.3.1‑1.
Table 7.3.1‑1: Namespaces used in present document
Name space
|
prefix
|
Namespace definition
|
|---|---|---|
oneM2M protocol CDT
|
m2m:
|
http://www.onem2m.org/xml/protocol
|
Device Configuration
|
dcfg:
|
http://www.onem2m.org/xml/deviceConfig
|
oneM2M Security
|
sec:
|
http://www.onem2m.org/xml/securityProtocols
|
Table 7.3.2‑1 describes simple data type definitions specific to security. The types in table 7.3.2‑1 are either:
Table 7.3.2‑1: oneM2M simple data types for device configuration
XSD type name
|
Used for
|
Examples
|
Description
|
|---|---|---|---|
dcfg:TLSCiphersuite
|
A TLS Ciphersuite identifier
|
C0A5
|
Four hexadecimal characters representing a TLS Cipher suite identifier. The list of TLS cipher suites identifiers can be found at the IANA TLS Cipher Suite Registry [8].
|
dcfg:ListOfTLSCiphersuite
|
A list of TLS Ciphersuite identifiers
|
xs:list of elements of data type dcfg:TLSCiphersuite.
|
|
dcfg:niURI
|
Identifying information with a hash value
|
ni:///sha-256;UyaQV... ni:///1;UyaQV... ("1" is a short identifier for sha-256) |
An xs:anyURI conforming to the Named Information 'ni' URI scheme specified in IETF RFC 6920 [7], with no authority field.
|
dcfg:nihURI
|
Identifying information with a human speakable encoding of a hash value
|
nih:sha-256-32;53269057;b nih:sha-256-32;5326-9057;b nih:6;5326-9057 ("6" is a short identifier for sha-256-32) |
An xs:anyURI conforming to the Human Speakable Named Information 'nih' URI scheme specified in IETF RFC 6920 [7], with no authority field. A checkdigit may be present.
|
dcfg:ssid
|
SSID of Wi-Fi® network
|
The ssid of Wi-Fi® network.
|
|
dcfg:listOfSsids
|
List of SSIDs
|
xs:list of elements of data type m2m:ssid.
|
|
dcfg:imsi
|
IMSI of a SIM
|
262019876543210
|
IMSI compliant numerical representation
|
dcfg:iccid
|
ICCID of a SIM
|
89490200000829149056
|
ICCID alphanumerical representation
|
dcfg:apn
|
APN of a cellular network
|
internet.t-mobile
|
xs:string with an internal format that follows the structure of an APN (Access Point Name). It usually consists of a network identifier and an operator identifier. See [14].
|
dcfg:lac
|
Location Area Code for a cellular network
|
0x0523
|
A Location Area Code is a fixed length code of 2 octets identifying a location area. The data type is xs:integer.
|
Used to indicate Wi-Fi® connection status.
Table 7.3.3.11: Interpretation of dcfg:wifiConnectionStatus
Value
|
Interpretation
|
Note
|
|---|---|---|
0
|
Disconnected
|
|
1
|
Connected
|
|
2
|
Idle
|
Indicates the state when the device tries to establish the connection to the network. It expires after the set number of unsuccessful attempts or when the connection is established.
|
3
|
No SSID available
|
|
4
|
Scan completed
|
|
5
|
Failed
|
|
6
|
Lost
|
Used for indicating which Wi-Fi® encryption protocol is used to provide security in wireless network.
Table 7.3.3.2‑1: Interpretation of dcfg:wifiEncyrptionType
Value
|
Interpretation
|
Note
|
|---|---|---|
1
|
none
|
|
2
|
WEP
|
|
3
|
WPA Personal
|
|
4
|
WPA2 Personal
|
|
5
|
WPA3 Personal
|
|
6
|
WPA Enterprise
|
|
7
|
WPA2 Enterprise
|
|
8
|
WPA3 Enterprise
|
Used for indicating a SIM status.
Table 7.3.3.3‑1: Interpretation of dcfg:simStatus
Value
|
Interpretation
|
Note
|
|---|---|---|
0
|
inactive
|
|
1
|
active
|
Used for indicating a SIM type.
Table 7.3.3.4‑1: Interpretation of dcfg:simType
Value
|
Interpretation
|
Note
|
|---|---|---|
0
|
UICC (removable)
|
|
1
|
eUICC (removable)
|
|
2
|
eUICC (non-removable)
|
|
3
|
iUICC
|
Used for indicating a Cellular Network Bearer type.
Table 7.3.3.5‑1: Interpretation of dcfg:cellularNetworkBearerType
Value
|
Interpretation
|
Note
|
|---|---|---|
0
|
GSM cellular network
|
|
1
|
TD-SCDMA cellular network
|
|
2
|
WCDMA cellular network
|
|
3
|
CDMA2000 cellular network
|
|
4
|
WiMAX cellular network
|
|
5
|
LTE-TDD cellular network
|
|
6
|
LTE-FDD cellular network
|
|
7
|
NB-IoT
|
Used for indicating a Coverage Enhancement Level.
Table 7.3.3.6‑1: Interpretation of dcfg:coverageEnhancementLevel
Value
|
Interpretation
|
Note
|
|---|---|---|
0
|
No Coverage Enhancement in the serving cell
|
|
1
|
Coverage Enhancement level 0
|
|
2
|
Coverage Enhancement level 1
|
|
3
|
Coverage Enhancement level 2
|
|
4
|
Coverage Enhancement level 3
|
Used for credentials in [wifiClient] Management Object resource. Values contained in username, password, wep.key and wpa.psk attributes shall not be readable. Each Retrieve request shall be forwarded to device and from there the data shall be retrieved.
Table 7.3.4.1‑1: Type Definition of dcfg:wifiCredentials
Element Path
|
Element Data Type
|
Multiplicity
|
Note
|
|---|---|---|---|
encryptionType
|
dcfg:wifiEncryptionType
|
1
|
Indicates type of encryption used to provide network security
|
username
|
xs:string
|
0..1
|
Indicates username used to authenticate user in WPA-Enterprise, WPA2-Enterprise or WPA3-Enterprise protocols Only valid if encryptionType=6,7 or 8 |
password
|
xs:string
|
0..1
|
Indicates password used to authenticate user in WPA-Enterprise, WPA2-Enterprise or WPA3-Enterprise protocols Only valid if encryptionType=6,7 or 8 |
wepKey
|
xs:string
|
0..1
|
Indicates key in case of WEP encryption. Only valid if field encryptionType =2 |
wpaPsk
|
xs:string
|
0..1
|
Indicates WPA Pre Shared Key Only valid if field encryptionType = 3,4 or 5 |