Remote Desktop Remote Desktop AppleScript dictionary reference
Learn about classes and commands for the Remote Desktop app.
Important: This reference topic isn’t a substitute for the complete AppleScript dictionary, which you can view in Script Editor. It’s included as a quick reference so you can find AppleScript commands by searching in help. For the most recent and comprehensive information about scriptable objects and events in Remote Desktop, see the complete dictionary.
add v: Add a computer to a task.
add computer: The computer.
to computer list: The computer list (or task) to add the computer to.
control v: Start a control session with the computer.
control computer: The computer to control.
execute v: Executes a task.
execute task: The task to execute.
[on computer list]: The computer list (or computer) on which to run the task.
observe v: Start an observation session.
observe item: The computer, list, or computer list to observe.
release v: Release computers from a control or observation session.
release item: The computer, list, or computer list to release.
remove v: Remove a computer from a task.
remove computer: The computer to remove.
from computer list: The computer list (or task) to remove the computer from.
stop v: Stops an executing Share Screen task.
stop task: The task to stop.
application n [inh. application; see also Standard Suite]: the Remote Desktop top-level scripting object.
ELEMENTS
contains computers, computer lists, copy items tasks, copy to me tasks, documents, empty Trash tasks, install package tasks, lock screen tasks, logout tasks, open app tasks, open item tasks, rename computer tasks, restart tasks, send message tasks, send unix command tasks, set local startup disk tasks, set network startup disk tasks, share screen tasks, shutdown tasks, sleep tasks, unlock screen tasks, upgrade client tasks, wake up tasks, windows.
PROPERTIES
selection (item, r/o): The current selection.
computer n [inh. item]: A physical computer.
ELEMENTS
contained by application, computer lists.
PROPERTIES
boot volume (Unicode text, r/o): The boot volume of the computer.
CPU (Unicode text, r/o): The CPU type of the computer.
current application (Unicode text, r/o): The current frontmost app on the computer.
current user (Unicode text, r/o): The currently logged-in user on the computer.
DNS name (Unicode text, r/o): The DNS name of the computer.
id (Unicode text, r/o): The unique identifier (UUID) of the computer.
Internet address (Unicode text, r/o): The Internet address of the computer.
last activity (date, r/o): The time of the most recent activity on the computer.
last contacted (date, r/o): The time of last contact with the computer.
machine model (Unicode text, r/o): The model of the computer.
name (Unicode text, r/o): The name of the computer.
physical memory (Unicode text, r/o): The physical RAM installed in the computer.
primary Ethernet address (Unicode text, r/o): The primary Ethernet address of the computer.
remote desktop version (Unicode text, r/o): The version of the Remote Desktop client running on the computer.
status message (Unicode text, r/o): The current status of the computer.
system version (Unicode text, r/o): The version of OS X running on the computer.
computer list n [inh. item]: A list which holds computers.
ELEMENTS
contains computers; contained by application.
PROPERTIES
id (Unicode text, r/o): The unique identifier (UUID) of the computer list.
name (Unicode text): The name of the computer list.
copy items task n [inh. task > item]: Copy items to the target computers.
ELEMENTS
contained by application.
PROPERTIES
bandwidth limit (integer): Network usage limit in kilobytes per second (0 = unlimited).
conflict resolution (ask what to do/rename the existing item/rename the item being copied/replace/replace if older): Specifies what to do if the item(s) already exist in this location.
copy items (list): A list of files and/or folders to copy.
destination group (Unicode text): If ownership is set to a “specific owner,” a valid group name on the destination computer.
destination owner (Unicode text): If ownership is set to a “specific owner,” a valid user name on the destination computer.
destination path (alias): If the location is “specific folder,” a fully specified path to the destination folder.
encrypting (boolean): Whether the items should be encrypted during copying.
location (Applications folder/current users desktop folder/current users home directory/same relative location/specific folder/system folder/system fonts folder/system preferences folder/top folder of the boot disk): The target location to copy to.
ownership (current console user/current owner/destination folder owner/specific owner): Specifies the new ownership of the copied item(s).
should open (boolean): Whether the items should be opened after being copied.
stopping on error (boolean): Whether the copy should terminate if an error occurs during copying.
copy to me task n [inh. task > item]: Copy items from the target computers to the administrator computer.
ELEMENTS
contained by application.
PROPERTIES
bandwidth limit (integer): Network usage limit in kilobytes per second (0 = unlimited).
conflict resolution (ask what to do/rename the existing item/rename the item being copied/replace/replace if older): Specifies what to do if the item(s) already exist in this location.
copy items (list): A list of files and/or folders to copy.
destination path (alias): If the location is “specific folder,” a fully specified path to the destination folder.
encrypting (boolean): Whether the items should be encrypted during copying.
location (Applications folder/current users desktop folder/current users home directory/same relative location/specific folder/system folder/system fonts folder/system preferences folder/top folder of the boot disk): The target location to copy to.
empty trash task n [inh. task > item]: Empty the Trash on the target computers.
ELEMENTS
contained by application.
install package task n [inh. task > item]: Install package(s) on the target computers.
ELEMENTS
contained by application.
PROPERTIES
after installing (attempt rest../GlobalArt/do nothing/force immediate restart): Specifies what to do after installing the package(s).
bandwidth limit (integer): Network usage limit in kilobytes per second (0 = unlimited).
delegating to Task Server (boolean): Whether this task should be delegated to the Task Server.
encrypting (boolean): Whether the packages should be encrypted during copying.
packages (list): A list of packages to install.
stopping on error (boolean): Whether the copy should terminate if an error occurs during copying.
lock screen task n [inh. task > item]: Lock the screen(s) on the target computers.
ELEMENTS
contained by application.
PROPERTIES
message (Unicode text): Message to display on the screen(s).
logout task n [inh. task > item]: Log out the current user on the target computers.
ELEMENTS
contained by application.
open application task n [inh. task > item]: Launch an application on the target computers.
ELEMENTS
contained by application.
PROPERTIES
application (alias): The path to the application to open.
open item task n [inh. task > item]: Open files on the target computers.
ELEMENTS
contained by application.
PROPERTIES
files (list): A list of files to open.
power on task n [inh. task > item]: Start up the target computers.
ELEMENTS
contained by application.
rename computer task n [inh. task > item]: Change the name of the target computers.
ELEMENTS
contained by application.
PROPERTIES
naming uniquely (boolean): Whether each machine should be forced to have a numerically unique name.
target name (Unicode text): The new name for the computer.
restart task n [inh. task > item]: Restart the target computers.
ELEMENTS
contained by application.
PROPERTIES
user can save changes or cancel (boolean): Whether the user is allowed to save changes or cancel the restart.
send message task n [inh. task > item]: Send a text message to the target computers.
ELEMENTS
contained by application.
PROPERTIES
message (Unicode text): Message to display on the screen(s).
send unix command task n [inh. task > item]: Send a UNIX command or script to the target computers.
ELEMENTS
contained by application.
PROPERTIES
script (Unicode text): The command string to be executed.
showing output (boolean): Whether the complete output of the command should be displayed in a window.
user (Unicode text): The user to execute the command as.
set local startup disk task n [inh. task > item]: Set the startup volume on the target computers.
ELEMENTS
contained by application.
PROPERTIES
boot volume (Unicode text): Specific volume of drive to boot (optional).
restarting (boolean): Whether the machine should be restarted after setting the startup volume.
set network startup disk task n [inh. task > item]: Set the startup volume on the target computers.
ELEMENTS
contained by application.
PROPERTIES
from server (Unicode text): Internet address of the server to boot from.
mount volume (Unicode text): Volume name on the server to mount.
restarting (boolean): Whether the machine should be restarted after setting the startup volume.
share screen task n [inh. task > item]: Share a computer’s screen to the target computers.
ELEMENTS
contained by application.
PROPERTIES
source computer (computer): The computer (other than the admin) whose screen to share.
shutdown task n [inh. task > item]: Shutdown the target computers.
ELEMENTS
contained by application.
PROPERTIES
user can save changes or cancel (boolean): Whether the user is allowed to save changes or cancel the shutdown.
sleep task n [inh. task > item]: Put the target computers to sleep.
ELEMENTS
contained by application.
task n [inh. item]: A task. This abstract class represents the tasks that can be executed by Remote Desktop. There are subclasses for each specific type of task.
ELEMENTS
contained by application.
PROPERTIES
computer list (computer list): The computer list associated with the task.
id (Unicode text, r/o): The unique identifier (UUID) of the computer.
name (Unicode text): The name of the task.
recurrence (Unicode text, r/o): A string that describes the task recurrence, if defined.
starting at (date): If the task is scheduled, the date and time of the first execution.
unlock screen task n [inh. task > item]: Release the screen(s) of the target computers.
ELEMENTS
contained by application.
upgrade client task n [inh. task > item]: Upgrade the Remote Desktop client on the target computers.
ELEMENTS
contained by application.
wake up task n [inh. task > item]: Wake up the target computers.
ELEMENTS
contained by application.