set dcloud_msgservice

Purpose

Configures the ability to send and receive machine-to-machine (M2M) messages between Remote Manager, and the Remote Manager-registered device, known as Remote Manager SMS support. These settings are used in sending Short Message Service (SMS) messages to Remote Manager.

The iridium settings configure power management and message handling for the Iridium satellite modem in a Digi device.

Required permissions

For Digi products with two or more users, to use this command, permissions must be set to set permissions-dcloud-sms=read to display the Remote Manager message service settings, and set permissions s‑dcloud-sms=rw to display and configure Remote Manager message service settings. See set permissions for details on setting user permissions for commands.

Syntax

set dcloud_msgservice [sms_state={on|off}]
  [sms_restrict_sender={on|off}]
  [sms_phnum=string]
  [sms_service_identifier=string]
  [iridium_state={on|off}]
  [iridium_automatically_manage_power={on|off}]
  [iridium_poll_rate=integer]
  [iridium_set_power={on|off}]

Options

sms_state={on|off}]

Enables or disables Remote Manager SMS support.

sms_restrict_sender={on|off}

If set to on, the Digi device will only process inbound messages for Remote Manager if they are from the phone number specified on the sms_phnum option. Messages from other phone numbers will be passed on to other SMS services on the Digi device.

sms_phnum=string

The phone number or short code of the Remote Manager server. For Remote Manager, the short code is 64225.

sms_service_identifier=string

The service identifier (prefix) of the Remote Manager server.

This field is an optional setting and is used in cases where there is a shared short code in use, and an identifier (prefix) is required to redirect a message to a specific service under that short code. The default value is idgp. Use of the service identifier idgp is mandatory when the sms_phnum value is 64225.

iridium_state={on|off

Enables or disables Remote Manager Iridium support.

iridium_automatically_manage_power={on|off}

Enables or disables having the Digi device automatically manage the power to the Iridium modem. This means power will only be turned on prior to sending a message, and turned off once the message has been sent. If this is NOT selected, the power will be turned on or off based on the setting for the iridium power={on|off} command for the device. If Remote Manager Iridium support is NOT enabled, the power will be turned off when the device starts up. If iridium_automatically_manage_power is turned on, the device will only be able to receive messages when polling, or if a message is sent. (that is, the modem will be off at all other times, so RING alerts will in general be missed). Turning on and off the modem can take up to a minute, which may result in delays sending messages.

iridium_poll_rate=integer

The number of minutes between poll attempts to the Iridium network. An entry of 0 disables polling. Polling may be needed to check for pending receive messages if the RING alert is missed. A RING alert is a notification from the network that a Mobile Terminated SBD Message is queued at the Gateway. Polling is chargeable. Every poll is the same as sending a message in terms of Iridium costs.

iridium_set_power={on|off}

Enables or disables having the Digi device set power to the Iridium modem. If the Digi device is configured to automatically manage power by setting iridium_automatically_manage_power to on, this option has no effect.

Example

#> set dcloud_msgservice sms_state=on sms_restrict_sender=on sms_phnum=64225 sms_service_identifier=idgp