iot transportProfile

iot transportProfile <profile>

ZSDFilter <Zigbee_Socket_Device_Filter>

accessID <accessID>

ageFilter <ageout>

authenticationURL <url>

authentication-mode {client-credentials|none|password}

azure-dps-auth-type group-enrollment symmetric-key <key>

azure-dps-id-scope <id_scope>

bleDataForwarding

blePeriodicTelemetryDisable

cellSizeFilter <cellsize>

client-secret

companyIdentifierFilter <filter>

customFadingFactor <type>

data-filter <filter>

deviceCountOnly

endpointID <id>

endpointToken <token>

endpointType {Meridian-Asset-Tracking|Meridian-Beacon-Management|telemetry-https|telemetry-websocket|iot-operations|Assa-Abloy|Azure-IoTHub}

endpointURL <url>

environmentType <type>

localNameFilter <filter>

macOuiFilter <filter>

movementFilter <threshold>

password <password>

payloadContent {managed-beacons|managed-tags|zf-tags|all|enocean-sensors/enocean-switches|google|ibeacon|eddystone|assa-abloy|unclassified|aruba-sensors|minew|mysphera|wifi-tags|wifi-assoc-sta|wifi-unassoc-sta|ability-smart-sensor|sbeacon|wiliot|zsd|serial-data|exposure-notification}

perFrameFiltering

proxyserver <host> <port> [<username>|<password>]

rssiReporting <type>

rtlsDestMAC <mac_address>

serviceUUIDFilter <filter>

uidNamespaceFilter <filter>

usbSerialDeviceTypeFilter <filter>

transportInterval <interval>

uuidFilter <filter>

urlFilter <filter>

username <user>

vendorFilter

vlan <vlan_id>

zone <zone>

no…

Description

This command configures an IoT transport profile on an Instant network. An IoT transport profile is a global profile that is created for transporting BLE information from an Instant AP to an endpoint server. Use this command to create or modify an IoT transport profile.

Parameter

Description

ZSDFilter <filter>

A list of Zigbee socket devices to filter the packets fro m Zigbee.

accessID

An access ID can grant extended access

ageFilter <ageout>

Devices without recent activity will not be reported.

Range: 0 to 3600 seconds

Default: 0

authentication-mode

Authentication mode to use with authentication server. Available options are:

  • client-credentials - Use credentials of the client
  • none - Do not use any credentials
  • password - Use password as credentials

authenticationURL <url>

Denotes the server URL used for authentication.

azure-dps-auth-type group-enrollment symmetric-key <key>

Denotes the symmetric key to enroll devices in a group on the Azure DPS.

azure-dps-id-scope <id_scope>

Denotes the Azure DPS ID scope for device provisioning.

blePeriodicTelemetryDisable

Disables the periodic telemetry report.

NOTE: This command only works when telemetry-websocket is configured as the Server Type.

cellSizeFilter <cellsize>

This is a proximity filter. Devices outside the cell will not be reported. Size is specified in meters. Setting to 0 disables the cell size filter.

Range: 0 to 255 meters

Default: 0

client-secret

Password to use when authenticating using client credentials.

companyIdentifierFilter <filter>

It is a 2-bytes integer, for example, "HPE - 0x011B" or "Wiliot - 0x0500. You can also include an extra byte which indicates the next layer type, like for HPE - 0x011B, 0x08, which means that the device type used is HPE Aruba Networkingsensors.

customFadingFactor <type>

When environment type is custom, you can define a fading factor to get the most accurate distance according to your environment.

Range: 10 to 40

data-filter <filter>

A list of numbers to filter the data before reporting to a server. The numbers correspond to protobuf files. For more information, see DataFilter Values.

deviceCountOnly

Send only the aggregated device counts per configured device class

endpointID <id>

Endpoint ID of the IoT management server.

endpointToken <token>

Configures a text string of text string of 1-255 characters as the BLE endpoint authorization token. The authorization token is used by the BLE devices in the HTTPS header when communicating with the BMC.

Range: 1 to 255 characters

endpointType

This parameter registers the WebSocket endpoint of a management server for BLE data on the Instant AP. The WebSocket endpoint allows the management server to receive messages from the BLE relay process on the Instant AP.

NOTE: Only one endpoint configuration is supported at a given time. A new endpoint configuration will overwrite the existing configuration.

The following endpoint types are supported:

  • Meridian-Asset-Tracking—Stream data to meridian WebSocket server.

NOTE: When the meridian asset tracking endpoint is configured and the firmware is upgraded to Instant 8.7.0.0, the CA certificate should be uploaded in order to connect to the Meridian server.

  • Meridian-Beacon-Management—Sends a POST request on a REST meridian API.
  • iot-operations—Forwards the raw BLE data.
  • telemetry-https—Sends a POST request on a REST meridian API. However, the payload encoding adheres to the published Aruba Telemetry JSON schema.
  • telemetry-websocket—Stream data to meridian WebSocket server. However. the payload encoding adheres to the published HPE Aruba Networking Telemetry.proto format.
  • Assa-Abloy—Sends Assa Abloy data.
  • Azure-IoTHub—The Azure IoT Hub transport type allows secure, bi-directional communication between devices and the Azure cloud through a managed device that acts as a gateway.

localNameFilter <filter>

It is a string, that can do string matching. It matches both advertisement and scan response.

macOuiFilter <filter>

It is a 3 bytes array. Only public MAC address(non-randomized) are considered. For example, 60:C0:BF is MAC OUI of Blyott devices.

movementFilter <threshold>

Filters devices that do not change distance. Specified in meters. Applicable only if a cell size is set. Setting to 0 disables the movement filter.

Range: 0 to 255 meters

Default: 0

endpointURL <url>

Configures the URL of the IoT management server to which the BLE monitoring data is sent.

environmentType <type>

Configures the working environment type.

uuidFilter

Denotes the universal unique identifiers (UUIDs) through comma separated strings.

usbSerialDeviceTypeFilter <filter>

Enables the use to filter serial data based on the USB serial dongle type. The following serial data type can be filtered:

  • EnOcean
  • OSU
  • Piera

vendorFilter

A list of list of vendor IDs and vendor names. You can specify a maximum of 5 vendor IDs or vendor names.

password <password>

Endpoint password.

payloadContent <payload>

Content of the messages sent to the IoT management server. The following payload options are supported:

  • ability-smart-sensor—ABB ability smart sensor data.
  • managed-beacons—Beacon management data.
  • managed-tags—Asset tag RSSI data.
  • zf-tags—ZF tag data
  • all—All the BLE device data
  • enocean-sensors—EnOcean sensor device data
  • enocean-switches—EnOcean switch device data
  • ibeacon—iBeacon device data
  • assa-abloy—Assa Abloy dor lock data
  • unclassified—Raw data of the BLE chip
  • exposure-notification—Exposure notification based on the presence of service UUID 0xFD6F and service data 0xFD6F.
  • eddystone—Eddystone device data.
  • google—Google sensor data
  • aruba-sensorsHPE Aruba Networking sensor data.
  • miniew—Minew data
  • onity—Onity data
  • mysphera—MySphera data.
  • sbeacon—sbeacon data.
  • diract—DirAct data
  • gwahygiene—Gwa Hygiene data
  • polestar—Polestar data
  • blyott—Blyott data
  • wiliot—Wiliot data.
  • wifi-assoc-sta—Data of Wi-Fi associated stations.
  • wifi-tags—WiFi RTLS tag data.
  • wifi-unassoc-sta—Data of WiFi unassociated stations.
  • zsd—Zigbee Socket Device.
  • serial-data—Serial data.

proxyserver <host> <port> [<username>|<password>]

Denotes the proxy server to which the IoT data is sent.

  • host—IP address or domain name of the proxy server.
  • port—Port number through which the connection to the proxy server is established.
  • username—Username to log in to the proxy server. This parameter is optional.
  • password—Password to log in to the proxy server. This parameter is optional.

serviceUUIDFilter <filter>

It is a 2 bytes integer, and it could be more than one entry. For example, 0x180F is SIG-adopted service UUID.

transportInterval <interval>

Instant AP IoT data interval in seconds.

Range: 5 to 3600 seconds

Default: 300 seconds

rssiReporting <type>

Sets the preferred format for RSSI reporting.

Default: average

rtlsDestMAC <mac_address>

Set the destination MAC address filter for RTLS tags.

uidNamespaceFilter <filter>

A list of UID namespaces to filter devices included in the reports. Applies only Eddystone-UID devices. You can specify a maximum of 10 namespaces

urlFilter <filter>

A list of URL strings to filter devices included in the reports. Applies only to Eddystone-URL devices. The string listed here can be partial URL strings. You can specify a maximum of 10 URL strings.

username <user>

Endpoint user name.

vlan <vlan_id>

Configures a client specific VLAN to transport IoT telemetry data

zone <zone>

Denotes the zone names for the IoT transport profile. When a zone is defined in the transport profile and the same zone name is defined on an Instant AP, the transport profile is created on that Instant AP. You can enter multiple zone names as comma-separated values.

no…

Removes any existing configuration.

DataFilter Values

Value

Description

#2

reporter

2.1

name

2.3

ipv4

2.4

ipv6

2.5

hwType

2.6

swVersion

2.7

swBuild

2.8

time

#3

reported

3.2

deviceClass

3.3

model

3.4

firmware

3.5

assetId

3.6

publicKey

3.7

lastSeen

3.9

bevent

3.10

rssi

3.11

cell

3.12

beacons

3.13

txpower

3.14

sensors

3.14.1

accelerometer

3.14.2

battery

3.14.3

temperatureC

3.14.4

humidity

3.14.5

voltage

3.14.6

illumination

3.14.7

motion

3.14.8

current

3.14.9

CO

3.14.10

CO2

3.14.11

VOC

3.14.12

resistance

3.14.13

pressure

3.14.14

alarm

3.14.15

contact

3.14.16

occupancy

3.14.17

mechanicalHandle

3.14.18

distance

3.14.19

capacitance

3.16

stats

3.16.1

uptime

3.16.2

adv_cnt

3.16.3

seq_nr

3.17

inputs

3.18

vendorData

3.19

vendorName

3.20

sensorTimestamp

3.21

flags

3.22

localName

3.23

identity

Example

The following example configures an IoT transport profile:

(Instant AP)(config)# iot transportProfile sample

(Instant AP)(IoT Data Profile "sample")# endpointURL https://edit.meridianapps.com/api/beacons/manage

(Instant AP)(IoT Transport Profile "sample")# endpointType Meridian-Beacon-Management

(Instant AP)(IoT Transport Profile "sample")# payloadContent managed-beacons

(Instant AP)(IoT Transport Profile "sample")# transportInterval 300

(Instant AP)(IoT Transport Profile "sample")# endpointToken MzkxMTZlMWYtYTgzYS00YWUxLTkzYWEtYjQyNzE1MGMyMjAxOjBiZWJjYWViLTRjNjItNGEwNC1hMGIyLWYzZTM5ZDFlNGVkNg==

(Instant AP)(IoT Transport Profile "sample")# end

(Instant AP)# commit apply

Command History

Release

Modification

Instant Mode 8.11.0.0

The blePeriodicTelemetryDisable parameter was introduced.

Instant Mode 8.10.0.0

The zone parameter was introduced.

Instant Mode 8.9.0.0

The following parameters were added:

  • usbSerialDeviceTypeFilter <filter>
  • companyIdentifierFilter <filter>
  • serviceUUIDFilter <filter>
  • macOuiFilter <filter>
  • localNameFilter <filter>

The following parameter was removed:

  • endpointType <zf>

Instant Mode 8.8.0.0

The following parameters were introduced:

  • authentication-mode
  • client-secret
  • bleDataForwarding
  • perFrameFiltering

The following endpoint type was introduced:

  • Azure-IoTHub

The following deviceClassFilters were introduced:

  • google
  • minew
  • onity
  • polestar
  • blyott
  • gwahygiene

Instant Mode 8.7.0.0

The following parameters were introduced:

  • ZSDFilter
  • data-filter

The following payload content were introduced:

  • wiliot
  • exposure-notification
  • zsd
  • serial-data

Instant Mode 8.6.0.0

The following parameters were introduced:

  • proxyserver
  • vendorFilter
  • vlan <vlan_id>

The following payloadContent were introduced:

  • mysphera
  • ability-smart-sensor
  • sbeacon
  • wifi-assoc-sta
  • wifi-tags
  • wifi-unassoc-sta

Instant Mode 8.5.0.0

The aruba-sensors payload content was introduced.

HPE Aruba Networking Instant 8.4.0.0

The following parameters were introduced:

  • uuidFilter
  • rssiReporting

The following endpoint types were introduced:

  • telemetry-https
  • telemetry-websocket

The following payload contents were introduced:

  • unclassified
  • enocean-sensors
  • enocean-switches
  • ibeacons

HPE Aruba Networking Instant 8.3.0.0

Command introduced.

Command Information

Platforms

Command Mode

All platforms

Configuration mode and IoT transport profile configuration sub-mode.