Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Option

Description

[-l, --list]

List all connected desktop sessions include SSO login.

Returns a table with session details.

Format: <Name>, <Session ID>, <Username>

Code Block
Example,
+----------------+---------------------+----------+
| Name           | Session ID          | Username |
+----------------+---------------------+----------+
| legacy-desktop | 192.168.0.224:53631 | john     |
| desktop        | 154379321           | sarah    |
+----------------+---------------------+----------+

For Legacy Desktop, Session ID column will display <IP Address:Port>.

For Desktop, Session ID column will display Session ID.

[-k, --locks]

Retrieves a list of locked configurations for each currently connected desktop.

Must be used with the -l option.

Code Block
Example,
+----------+------------+----------+-------------------------+
| Name     | Session ID | Username | Locked Configuration(s) |
+----------+------------+----------+-------------------------+
| desktop  | 1363198261 | john     |                         |
| desktop  | 1545132119 | sarah    | autotest.asserts        |
+----------+------------+----------+-------------------------+

[-m, --message]

Broadcasts a message to all currently logged-in desktops and those that log in later.

Use with -n to send the message to a specific desktop.

This message can be removed using the -r option.

[-r, --reset]

Cancel and clear scheduled shutdown and message, if any.

[-n, --session]

Apply the command to a specific desktop session obtained using the -l option.

Use with one of the following options: -x, -m, -r, or -s.

[-x, --shutdown]

Schedules a forced shutdown for all desktops after the specified number of minutes (0 for immediate shutdown).

Use it with -n to shutdown a specific desktop.

An optional message can be included using -m.

Code Block
Example,
desktopadmin -n 15300940 -x 5 "Shutting down in 5minutes"

This message will pop up on the desktop and count down of 5 minutes to shutdown.

[-s, --status]

Use this option to display the current shutdown timeout and message, if any.

Use it with -n to display the current shutdown timeout status of a specific desktop.

Return Codes

Listed below are the different return codes for the desktopadmin command:

...