You are here: Home > CLI Commands > Just_CLI_Topics > iot transportProfile

iot transportProfile

iot transportProfile <profile>

accessID <accessID>

accessToken <token>

ageFilter

authentication URL

cellSizeFilter

clientID <id>

clone

customFadingFactor

deviceClassFilter {all|aruba-beacons|aruba-sensors|aruba-tags|assa-abloy|eddystone|enocean-sensors|enocean-switches|ibeacon|unclassified|zf-tags}

enableOnController

environmentType {auditorium|custom|office|outdoor|shipboard|warehouse}

include-ap-group

movementFilter <threshold>

no

password <password>

reportingInterval <interval>

rssiReporting

serverType {Meridian-Asset-Tracking | Meridian-Beacon-Management | Telemetry Websocket | Telemetry HTTPS | ZF-Openmatics}

serverURL <url>

uidNamespaceFilter

urlFilter

username <user>

uuidFilter <filter>

Description

This command configures an IoTInternet of Things. IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet. transport profile.

Syntax

Parameter

Description

Range

Default

accessID <accessID>

An access ID will grant extended access. Applies only to endpoint type Assa-Abloy.

accessToken <accessToken>

Access token. Configure this only if you want to bypass authentication.

ageFilter

Age filter. Devices without recent activity will not be reported.

authenticationURL <url>

Server URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. for authentication.

cellSizeFilter

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

clientId <id>

This ID identifies the sender to the server.

clone

Copy data from another IoTInternet of Things. IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet. data profile.

customFadingFactor

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

10-40

deviceClassFilter <device>

A list of device class tags to filter the devices included in the reports. You can specify a maximum of 10 device classes.

all

All BLEBluetooth Low Energy. The BLE functionality is offered by Bluetooth® to enable devices to run for long durations with low power consumption. data

aruba-beacons

Aruba beacon data

aruba-sensors

Aruba sensor data

aruba-tags

Aruba tag data

assa-abloy

Assa Abloy door lock data

eddystone

Eddystone data

enocean-sensors

EnOcean sensor data

enocean-switches

EnOcean switch data

ibeacon

iBeacon data

unclassified

Unclassified data

zf-tags

ZF tag data

enableOnController

Send transport profile to BLEBluetooth Low Energy. The BLE functionality is offered by Bluetooth® to enable devices to run for long durations with low power consumption. process on 9000 Series controllers.

environmentType

Configure the working environment type.

auditorium

Configure the working environment type as auditorium.

custom

Configure a custom working environment type. Optionally, configure customFadingFactor.

office

Configure the working environment type as office.

outdoor

Configure outdoor working environment type.

shipboard

Configure the working environment type as shipboard.

warehouse

Configure the working environment type as warehouse.

include-ap-group

Configure AP groups that use the transport profile.

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.

no

Removes any existing configuration.

password <password>

Password for authentication

reportingInterval<interval>

Reporting interval in seconds.

5 to 3600 seconds

rssiReporting <format>

Set the preferred format for RSSIReceived Signal Strength Indicator. RSSI is a mechanism by which RF energy is measured by the circuitry on a wireless NIC (0-255). The RSSI is not standard across vendors. Each vendor determines its own RSSI scale/values. reporting.

average

RSSIReceived Signal Strength Indicator. RSSI is a mechanism by which RF energy is measured by the circuitry on a wireless NIC (0-255). The RSSI is not standard across vendors. Each vendor determines its own RSSI scale/values. averaged over the reporting period

bulk

RSSIReceived Signal Strength Indicator. RSSI is a mechanism by which RF energy is measured by the circuitry on a wireless NIC (0-255). The RSSI is not standard across vendors. Each vendor determines its own RSSI scale/values. Bulk

last

Most Recent RSSIReceived Signal Strength Indicator. RSSI is a mechanism by which RF energy is measured by the circuitry on a wireless NIC (0-255). The RSSI is not standard across vendors. Each vendor determines its own RSSI scale/values.

max

Maximum RSSIReceived Signal Strength Indicator. RSSI is a mechanism by which RF energy is measured by the circuitry on a wireless NIC (0-255). The RSSI is not standard across vendors. Each vendor determines its own RSSI scale/values. measured over the reporting period

smooth

Smoothed RSSIReceived Signal Strength Indicator. RSSI is a mechanism by which RF energy is measured by the circuitry on a wireless NIC (0-255). The RSSI is not standard across vendors. Each vendor determines its own RSSI scale/values. measured over the reporting period

serverType <type>

The type of server that is receiving the telemetry stream.

Meridian-Asset-Tracking

Stream data to meridian WebSocket server.

Meridian-Beacon-Management

Sends a POSTPower On Self Test. An HTTP request method that requests data from a specified resource. request on a RESTRepresentational State Transfer. REST is a simple and stateless architecture that the web services use for providing interoperability between computer systems on the Internet. In a RESTful web service, requests made to the URI of a resource will elicit a response that may be in XML, HTML, JSON or some other defined format. meridian APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software..

Telemetry-Https

POSTPower On Self Test. An HTTP request method that requests data from a specified resource. to RESTful Aruba apiApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.

Telemetry-Websocket

Stream data to Websocket based server

ZF-Openmatics

ZF Openmatics

serverURL <url>

Server URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. for sending telemetry.

uidNamespaceFilter

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

A list of URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. strings to filter devices included in the reports. Applies only Eddystone-URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. devices. The string listed here can be partial URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. strings. You can specify a maximum of 10 URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. strings.

username <user>

Username for authentication.

uuidFilter <filter>

A list of UUIDs to filter the devices included in the reports. Applies only to iBeacon devices. You can specify a maximum of 10 UUIDs.

Usage Guidelines

Use this command to create or modify an IoTInternet of Things. IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet. transport profile. An IoTInternet of Things. IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet. transport profile is a global profile that is used to transport BLEBluetooth Low Energy. The BLE functionality is offered by Bluetooth® to enable devices to run for long durations with low power consumption. information to an endpoint server.

 

In some cases, the iot transport profile having a serverType that is supported from ArubaOS 8.4.0.0 version onwards will be skipped when downgrading to a previous version. In such cases, the default serverType will be applied. The default serverType applied might not be a valid serverType that corresponds with other parameters configured in the iot transport profile. The operator must manually fix the configuration parameters in the iot transport profile to match the serverType.

Example

The following example configures an IoTInternet of Things. IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet. transport profile.

(host) [mynode] (config)# iot transportProfile sample

(host) [mynode] (IoT Data Profile "sample")# serverURL https://edit.meridianapps.com/api/beacons/manage

(host) [mynode] (IoT Transport Profile "sample")# serverType Meridian-Beacons-Management

(host) [mynode] (IoT Transport Profile "sample")# deviceClassFilter managed-beacons

(host) [mynode] (IoT Transport Profile "sample")# reportingInterval 300

(host) [mynode] (IoT Transport Profile "sample")# accessToken MzkxMTZlMWYtYTgzYS00YWUxLTkzYWEtYjQyNzE1MGMyMjAxOjBiZWJjYWViLTRjNjItNGEwNC1hMGIyLWYzZTM5ZDFlNGVkNg==

Related Commands

Command

Description

iot usetransportProfile

Sets an IoTInternet of Things. IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet. management server profile.

show iot transportProfile

Shows the IoTInternet of Things. IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet. profile status.

Command History

Version

Modification

ArubaOS 8.5.0.0

Added the aruba-sensors sub-parameter to the deviceClassFilter parameter.

ArubaOS 8.4.0.0

The following server types were introduced:

Assa-Abloy

Meridian-beacons-management

Meridian-asset-tracking

Telemetry-https

Telemetry-websocket

ZF-openmatics

The following deviceClassFilters were introduced:

all

aruba-beacons

aruba-tags

assa-abloy

eddystone

enocean-sensors

enocean-switches

ibeacon

unclassified

zf-tags

The following parameters were renamed from:

endpointType to serverType

endpointID to clientID

endpointURL to serverURL

endpointToken to accessToken

transportInterval to reportingInterval

payloadContent to deviceClassFilter

filterAttribute to uuidFilter

namespaceFilter to uidNamespaceFilter

cellSize to cellSizeFilter

thresholdAttribute to movementFilter

outrangeAgeout to ageFilter

ArubaOS 8.3.0.0

Command introduced.

Command Information

Platforms

License

Command Mode

All platforms

Base operating system.

Configuration IoTInternet of Things. IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet. Data Profile Mode (config-submode).

/*]]>*/