2.2.5 desktopadmin
- Jenni Wallin
- Former user (Deleted)
- Former user (Deleted)
usage: desktopadmin [options]
This command can be used for shutting down connected Desktops or for displaying an administrator message to all Desktop users. This is useful during system upgrades.
Options
The command accepts the following options:
| Option | Description |
|---|---|
| [-a, --address] | Use this option to apply the entered command for only the stated Desktop session. To state a Desktop session, enter the session's <IP address:port> as presented using the --list option. Note! The |
| [-l, --list] | Use this option to list all the Desktop sessions currently connected to the platform. The returned list will show <Pico Name>, <IP Address:Port>, <User> for each session. |
[-m, --message] | Use this option to write a message that will be displayed on all connected Desktops before shutdown. This message will also be displayed to any newly logged in Desktop. It can be removed using the reset option. |
[-r, --reset] | Use this option to reset any message or timeout that have been set by a previous execution of the command. |
[-x, --shutdown] | Use this option to enter a timeout interval in minutes that should pass before the Desktops are shutdown. If you want you can also append an optional message to this option within quotes, e g desktopadmin -shutdown 5 "My message". |
[-s, --status] | Use this option to show the current status of message and timeout. |
Return Codes
Listed below are the different return codes for the desktopadmin command:
| Code | Description |
|---|---|
0 | Will be returned if the command was successful. |
1 | Will be returned if there was a problem parsing command parameters. |
| 2 | Will be returned if there was a failure scheduling shutdown of Desktops |