Command Line

The Insight Teacher Command Line gives network administrators increased flexibility in managing Insight computers. These commands can be run with several different third-party enterprise management tools, such as Apple Remote Desktop, and/or central management solutions; this includes executing commands in Terminal while connected to a remote computer via SSH.

CommandDescription

--help

Display this help.

--settings

Display the current settings saved on this computer.

--uninstall

Uninstall Insight Teacher from this computer.

--license

Set the license key.

--securityToken

Define the security token.

If supplied, the value can be passed as an environment variable by specifying '--env' at the end.

Example:

TOKEN="token" ADMINPSWD="password1" TEACHERPSWD="password2" insightteacher --securityToken --adminPassword --teacherPassword --env

--adminPassword

Define the Insight admin password.

If supplied, the value can be passed as an environment variable by specifying '--env' at the end.

Example:

TOKEN="token" ADMINPSWD="password1" TEACHERPSWD="password2" insightteacher --securityToken --adminPassword --teacherPassword --env

--teacherPassword

Define the Teacher password.

If supplied, the value can be passed as an environment variable by specifying '--env' at the end.

Example:

TOKEN="token" ADMINPSWD="password1" TEACHERPSWD="password2" insightteacher --securityToken --adminPassword --teacherPassword --env

--connectorAddress "value"

The value can be any valid IP address.

--defaultClassId "Class ID"

Set the default Class ID to the value specified.

Note: If Class ID has space, the Class ID must be enclosed in quotes.

Example:

--defaultClassId "Home 100"

Except for the --help, --settings, --uninstall, and --license commands, the other commands may contain multiple options at the same time.

When password and/or token is specified, the command will prompt for the password and confirm it. Characters typed for the password and confirmation password will not be echoed on the Terminal.

In the event that command line is run with third-party management tool, the full path /usr/local/bin/insightteacher needs to be specified and the command has to be run as 'root' user.

When using third-party management tool, password and security token should be passed as environment variable by specifying --env at the end, to avoid having to enter the password and confirmation password. 'sudo' should not be used because the command is already running as 'root'.

Sample command line scenarios:

Terminal.appThird-party management tool (executed as 'root' user)Description

sudo insightteacher --settings

/usr/local/bin/insightteacher --settings

Prints the current settings.

sudo insightteacher --license "ABCDEFGH-ABCDEFGH-ABCDEFGH-ABCDEFGH-ABCDEFGH"

/usr/local/bin/insightteacher --license "ABCDEFGH-ABCDEFGH-ABCDEFGH-ABCDEFGH-ABCDEFGH"

Sets the license key.

sudo insightteacher --adminPassword

ADMINPSWD="password" /usr/local/bin/insightteacher --adminPassword --env

Sets the admin password and enters the password and confirmation at the prompt.

sudo insightteacher --securityToken

TOKEN="token" /usr/local/bin/insightteacher --securityToken --env

Sets the security token and enters the token and confirmation at the prompt.

sudo insightteacher --adminPassword --defaultClassId "Home 100" --connectorAddress "192.168.0.1"

ADMINPSWD="password" /usr/local/bin/insightteacher --adminPassword --defaultClassId "Home 100" --connectorAddress "192.168.0.1" --env

Combines multiple options to set admin password, default class ID and Insight Connector IP address.

sudo insightteacher --uninstall

/usr/local/bin/insightteacher --uninstall

Uninstalls Insight Teacher.

Last updated