Sending custom commands and scripts to devices

SMART Board interactive displays with iQ 4

SMART Board interactive displays with iQ 3

SMART Board GX series interactive displays

Android devices

iOS devices

macOS devices

Windows devices

Chrome OS devices

Supported 1

Supported 2

Supported

Supported

Not supported

Not supported

Supported

Not supported

You can create remote execution commands and scripts in SMART Remote Management and send them to devices for a variety of purposes, including:

  • Installing certificates on SMART Board interactive displays with iQ

  • Enabling or disabling automatic over-the-air (OTA) updates on SMART Board interactive displays with iQ

  • Activating software, such as SMART Notebook or SMART Meeting Pro, on computers

You can send remote execution commands and scripts to a single device, multiple devices, all devices that match a saved filter’s criteria, or a group. Alternatively, you can:

To create a remote execution command

  1. Click Repositories and select Remote execute.

    The Remote execute window appears.

    Tip 

    If your organization created its domain account after May 2023, the Remote execute window includes sample remote execution commands that you can use as starting point for creating your own remote execution commands. These sample remote execution commands have turquoise icons.

  2. Click Add New.

    The New remote execution window appears.

  3. Type a name in the Name box.

  4. Select Command line.

  5. Type the command in the Command box.

  6. OptionalType arguments in the Arguments box.

    Note 

    You cannot send the remote execution command settings put to devices when users are signed into those devices. Use the command smartcli settings put instead.

    See alsoInstalling certificates on SMART Board interactive displays with iQ

    See alsoUpdating SMART Board interactive displays with iQ

    See alsoRandomizing MAC addresses for SMART Board interactive displays with iQ

  7. Select or clear the following check boxes.

    Check box

    Select to

    Notes

    Wait for exit

    Allow the system to wait for the command’s execution to finish before reporting the result.

    This is critical for commands that depend on completion confirmation before subsequent actions can occur.

    Collect output

    Collect and return the output of the command as part of the command results.

    This provides administrators with essential feedback and diagnostics, improving troubleshooting and verifying command success.

    Run with high privileges

    Execute the command with elevated local device permissions.

    This ensures compatibility with commands requiring administrative privileges, especially for critical device or system changes.

  8. Turn on Set as private to mark the command as private so it is only visible to the creator of the command.

    Note 

    This enhances control over sensitive commands, promoting user privacy and security.

  9. Click Confirm.

    The remote execution command is added to the repository.

To create a remote execution script

  1. Click Repositories and select Remote execute.

    The Remote execute window appears.

    Tip 

    If your organization created its domain account after May 2023, the Remote execute window includes sample remote execution scripts that you can use as starting point for creating your own remote execution scripts. These sample remote execution scripts have turquoise icons.

  2. Click Add New.

    The New remote execution window appears.

  3. Type a name in the Name box.

  4. Select Script.

  5. Type the script in the Script box.

  6. Select or clear the following check boxes.

    Check box

    Select to

    Notes

    Wait for exit

    Allow the system to wait for the script’s execution to finish before reporting the result.

    This is critical for scripts that depend on completion confirmation before subsequent actions can occur.

    Collect output

    Collect and return the output of the script as part of the script results.

    This provides administrators with essential feedback and diagnostics, improving troubleshooting and verifying script success.

    Run with high privileges

    Execute the script with elevated local device permissions.

    This ensures compatibility with scripts requiring administrative privileges, especially for critical device or system changes.

  7. Turn on Set as private to mark the script as private so it is only visible to the creator of the script.

    Note 

    This enhances control over sensitive scripts, promoting user privacy and security.

  8. Click Confirm.

    The remote execution script is added to the repository.

To send a remote execution command or script to a device

  1. Click Devices to open the Devices view.

  2. OptionalFilter the devices shown in the Devices view.

    SeeFinding devices

  3. Click the device’s row.

    The device’s dashboard window appears.

  4. Click Repositories actions, and then click Remote Execute.

    The Remote execute window appears.

  5. Select a command or script from the list and click Apply.

To send a remote execution command or script to multiple devices

  1. Click Devices to open the Devices view.

  2. OptionalFilter the devices shown in the Devices view.

    SeeFinding devices

  3. Select the devices’ check boxes.

  4. Click More actions and select Remote execute.

    The Remote execute window appears.

  5. Select a command or script from the list and click Apply.

To send a remote execution command or script to all devices that match a saved filter’s criteria

  1. Click Devices to open the Devices view.

  2. Click Filters in the Search bar.

  3. Click Actions in the saved filter’s row and select Remote execute.

    The Remote execute window appears.

  4. Select a command or script from the list and click Apply.

To send a remote execution command or script to a group

  1. Click Devices to open the Devices view.

  2. Click Groups to open the Groups panel.

  3. Click Actions in the group’s row and select Remote execute.

    The Remote execute window appears.

  4. Select a command or script from the list and click Apply.

You can use remote execution commands to install certificates on SMART Board interactive displays with iQ.

These are the commands for installing certificates on SMART Board interactive displays with iQ 4:

Task

Command

Arguments

Install CA certificate

install_ca

<Certificate> --delete_file --for_all_users

Where

  • <Certificate> is the path to the certificate (for example, /sdcard/certs/certificate.p12 or /sdcard/Download/certificate.p12)

  • Optional--delete_file specifies whether the certificate file should be deleted (true by default)

  • Optional--for-all-users specifies whether the certificate should be installed for all signed-in users (false by default)

Install user certificate

install_user

<Certificate> --delete_file --alias --cert-password

Where

  • <Certificate> is the path to the certificate (for example, /sdcard/certs/certificate.p12 or /sdcard/Download/certificate.p12)

  • Optional--delete_file specifies whether the certificate file should be deleted (true by default)

  • Optional--alias specifies the alias for the certificate

  • Optional--cert-password specifies the password for the certificate

Install user certificate for Wi-Fi

install_wifi

<Certificate> --delete_file --alias --cert-password

Where

  • <Certificate> is the path to the certificate (for example, /sdcard/certs/certificate.p12 or /sdcard/Download/certificate.p12)

  • Optional--delete_file specifies whether the certificate file should be deleted (true by default)

  • Optional--alias specifies the alias for the certificate

  • Optional--cert-password specifies the password for the certificate

These are the commands for installing certificates on SMART Board interactive displays with iQ 3:

Task

Command

Arguments

Install CA certificate

install_ca

<Certificate> --delete_file --for_all_users

Where

  • <Certificate> is the path to the certificate (for example, /sdcard/certs/certificate.p12 or /sdcard/Download/certificate.p12)

  • Optional--delete_file specifies whether the certificate file should be deleted (true by default)

  • Optional--for-all-users specifies whether the certificate should be installed for all signed-in users (false by default)

Install user certificate

install_user

<Certificate> --delete_file --alias --cert-password --board_lock_type password|pin --board_lock_value

Where

  • <Certificate> is the path to the certificate (for example, /sdcard/certs/certificate.p12 or /sdcard/Download/certificate.p12)

  • Optional--delete_file specifies whether the certificate file should be deleted (true by default)

  • Optional--alias specifies the alias for the certificate

  • Optional--cert-password specifies the password for the certificate

  • Optional--board_lock_type specifies the display’s lock type (password or pin)

  • Optional--board_lock_value specifies the display’s lock alpha-numeric password or numeric PIN (between 4 and 17 characters).

Install user certificate for Wi-Fi

install_wifi

<Certificate> --delete_file --alias --cert-password --board_lock_type password|pin --board_lock_value

Where

  • <Certificate> is the path to the certificate (for example, /sdcard/certs/certificate.p12 or /sdcard/Download/certificate.p12)

  • Optional--delete_file specifies whether the certificate file should be deleted (true by default)

  • Optional--alias specifies the alias for the certificate

  • Optional--cert-password specifies the password for the certificate

  • Optional--board_lock_type specifies the display’s lock type (password or pin)

  • Optional--board_lock_value specifies the display’s lock alpha-numeric password or numeric PIN (between 4 and 17 characters).

You can use remote execution commands to update SMART Board interactive displays with iQ.

These are the commands for updating SMART Board interactive displays with iQ 4:

Task

Command

Arguments

Enable automatic OTA updates

smartcli

update feature auto enable

Disable automatic OTA updates

smartcli

update feature auto disable

Get the status of the automatic OTA update

smartcli

update feature auto

Set the time of day automatic OTA updates run

smartcli

update property update-daily-window <Start time> <End time>

Where

  • <Start time> is the start time in minutes

  • <End time> is the end time in minutes

Example 

To set automatic OTA updates to run from 1 am to 5 am:

update property update-daily-window 60 300

Get the time of day automatic OTA updates run

smartcli

update property update-daily-window

Set the days of the week automatic OTA updates run

smartcli

update property update-days-of-week <Days of the week>

Where <Days of the week> are the days of the week on which you want automatic OTA updates to run, separated by spaces:

  • 1 = Sunday

  • 2 = Monday

  • 3 = Tuesday

  • 4 = Wednesday

  • 5 = Thursday

  • 6 = Friday

  • 7 = Saturday

Example 

To set automatic OTA updates to run on Sundays and Mondays:

update property update-days-of-week 1 2

Get the days of the week automatic OTA updates run

smartcli

update property update-days-of-week

Check if a system update is available, download it, and install it

smartcli

update install system --reboot --async

Where

  • Optional--reboot reboots the display after the update is complete to apply it.

  • Optional--async prevents the command from remaining in Pending state until the update is applied (When the update is applied, the command is marked as successful. If the command fails, the output should indicate the reason for failure.)

Example 

To set the display to reboot after the update is complete to apply it:

update install system --reboot

These are the commands for updating SMART Board interactive displays with iQ 3:

Task

Command

Arguments

Enable automatic OTA updates

smartcli

update auto enable

Disable automatic OTA updates

smartcli

update auto disable

Check for updates immediately

smartcli

update schedule none

Check for updates at a specified time

smartcli

update schedule <Status>

Where <Status> is

  • tonight

  • tomorrow night

  • this weekend

These are the commands for randomizing MAC addresses for SMART Board interactive displays with iQ4.

Task

Command

Arguments

Get MAC randomization settings for a specified network

smartcli

networking wifi get mac_randomization <Network name>

Where <Network name> is the name of the network for which you want to get MAC randomization settings

Set MAC randomization settings for a specified network

smartcli

networking wifi set mac_randomization <Network name> <Randomization option>

Where

  • <Network name> is the name of the network for which you want to set MAC randomization settings

  • <Randomization option> is

    • auto to let the Wi-Fi framework automatically decide the MAC randomization strategy

    • none to use the factory MAC when connecting to the network

    • persistent to generate a randomized MAC once and reuse it for all connections to the network

    • non_persistent to use a randomly generated MAC address for connections to the network

      Note 

      This option does not persist the randomized MAC address.

Related documents