Scout Command Interface

Commands for device management

March 7, 2025

Contributed by:

S C S

[Scout] commands for device management are applied to an OU, an individual device or a list of devices.They can be applied at once or scheduled to be run once or periodically.

General options for [Scout] commands

Scheduling Options
SchedulerSettings/	-now	Command is executed at once
	-once -at DateTime	Command is executed at once at the time specified
	-every {-day Day, -sun,-mon, -tue, -wed, -thu, -fri, -sat} -at Time	Command is executed periodically in the time period specified
	The following date and time formats are allowed
	Date	dd.mm.[yy]yy, mm-dd-[yy]yy
	Time	hh:mm[:ss]
	Day	Example: With 15, the 15th of the month is meant.

Example of a periodically recurring command:

Example of a periodically recurring command: [scmd -sendmsg -msg “Hello” -to /TestOU -every -mon -day 1 15 -at 9:00]

The message is sent every Monday and at the 1st and 15th of every month at 9:00.

Destination options
-to [FQName]	For [FQName], the following options are available
	Fully-qualified name of an OU or device
	Example: [DE/Karlsruhe/KA1]
	MAC address of one device
	Example: [00E0C5422A2E]
	Specify also the [-mac] parameter!
	Text file containing multiple MAC addresses (one MAC address per line)
	Example: [devices_xy.txt]
	Specify also the [-list] parameter!
-subous	If you specify an OU as destination ([-to]), the subordinated OUs are included.
-mac	Use this parameter if you specify a MAC address as destination ([-to]).
-list	Use this parameter if you specify a device list (text file) as destination ([-to]).

Send messages

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -sendmsg -msg Message [-title Title] -to FQName [-subous] [-mac] [-list] [-visible Seconds] [-deviceswait Milliseconds]SchedulerSettings

Option	Description
-user	Required for logon to server
-password
-domain
-sendmsg	Send message command
-title	Text for the message title
-msg	Message text
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)
-visible	Specify a timeout (in seconds) after that the message will be closed.
-deviceswait	Delay (in milliseconds) after execution if more than one device is affected

Restart devices

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -reboot -to FQName [-subous] [-mac] [-list] [-informuser [-informtime Seconds]] [-cancancel] [-deviceswait Milliseconds] SchedulerSettings

Option	Description
-reboot	Restart device command
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)
-deviceswait	Delay (in milliseconds) after execution if more than one device is affected
-cancancel	Users are allowed to cancel the command.

Switch off devices

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -switchoff -to FQName [-subous] [-mac] [-list] [-informuser [-informtime Seconds]] [-cancancel] [-deviceswait Milliseconds]SchedulerSettings

Option	Description
-switchoff	Switch off command
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)
-informuser	Inform users by message before execution [for the specified time period]
-cancancel	Users are allowed to cancel the command.

Switch on devices[1[[ ]from Scout 15 2209]]

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -switchon -to FQName [-mac] [-list] SchedulerSettings

Option	Description
-switchon	Switch on command
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)

Perform firmware updates

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -update -to FQName [-subous] [-mac] [-list] [-format] [-informuser [-informtime Seconds]] [-cancancel] [-deviceswait Milliseconds] (-now

-once at Date Time)

Option	Description
-update	Update command
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)
-format	Before installation, the system partition of the devices will be formatted.
-informuser	Inform users by message before execution [for the specified time period]
-cancancel	Users are allowed to cancel the command.
-now , -once at	Specify the time of execution. A periodic execution is not possible.

Deliver software

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -delivery -to FQName [-subous] [-mac] [-list] [-clean] [-informuser [-informtime Seconds]] [-cancancel] [-deviceswait Milliseconds] (-now

-once at Date Time)

Option	Description
-delivery	Delivery command
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)
-clean	Before delivery, the update partition of the devices will be formatted.
-informuser	Inform users by message before execution [for the specified time period]
-cancancel	Users are allowed to cancel the command.
-now, -once at	Specify the time of execution. A periodic execution is not possible.

Perform a configuration run

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -configrun -to FQNameSchedulerSettings

Option	Beschreibung
-configrun	Configuration command
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)

Refresh the device status

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -refreshdevicestatus -to FQName [-subous] SchedulerSettings

Option	Beschreibung
-refreshdevicestatus	Refresh device status command
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)

Reset to factory status

Run the program with the following syntax:

scmd -u[ser] Username -p[assword] Password [-d[omain] Domain] -factoryreset -to FQName [-subous] [-mac] [-list] [-retainlocalconfig] [-removescoutaddress] [-removelicenses] [-informuser [-informtime Seconds]] [-cancancel] [-deviceswait Milliseconds] (-now

-once at Date Time)

Option	Description
-factoryreset	Remote factory reset command
-to	OU/device, MAC address or text file with multiple MAC addresses (see above)
-retainlocalconfig	Retain local user-defined device configuration in unlocked fields
-removescoutaddress	Delete Scout Server address on the device
-removelicenses	Additionally delete client-side stored license information
-informuser	Inform users by message before execution [for the specified time period]
-cancancel	Users are allowed to cancel the command.
-now , -once at	Specify the time of execution. A periodic execution is not possible.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Commands for device management

March 7, 2025

Contributed by:

S C S

March 7, 2025

Contributed by:

S C S

Commands for device management

General options for [Scout] commands

Send messages

Restart devices

Switch off devices

Switch on devices[1[[ ]from Scout 15 2209]]

Perform firmware updates

Deliver software

Perform a configuration run

Refresh the device status

Reset to factory status

In this article