Video Screencast Help
Symantec to Separate Into Two Focused, Industry-Leading Technology Companies. Learn more.

Management Agent Command Line Tool Documentation

Created: 02 Jan 2013 • Updated: 02 Jan 2013
Language Translations
delvalled's picture
+1 1 Vote
Login to vote

Important This article contains steps that allows direct modification of the streaming server architecture (including the database). However, serious problems might occur if the architecture is modified incorrectly. All changes should be tested in a non-production environment prior to rolling out changes into production. It is highly recommended to have a current backup of the production systems before making modifications using this tool.

Symantec Workspace Streaming includes a console program that you can run to communicate with the AWE Agent on streaming servers.

You can access the tool at: {server installation dir}\server\common\bin\runClient.cmd

Command line options to the tool:

Command Description
[-noconnect]
Do not attempt initial connection to Management Agent.
[-host] [arg]
The host name (or IP) to connect to.
[-ipresolve] [arg]
Find out the IP a hostname will resolve to.
[-key] [arg]
The access key.
[-port] [int]
The port the Management Agent is listening to.
[-root] [arg]
The root directory of the server to start with
[-version]
Print the version and exit.
[-script] [arg]
File containing commands to run.
[-force]
Ignore errors and continue executing a script
[-continue]
Leave program running after script execution completes.

Commands within the tool:

Command Description
Connect
Connects to a Management Agent
CD
Change the server that all future commands will be issued against.
Chdir

Change the server that all future commands will be issued against.

The following case sensitive strings, when used as a directory parameter have special meanings:

"*WSS"
The default path for a Symantec Streaming Server for a Management Agent.
"*AWESE"
The default path for a Symantec Streamlet Engine for a Management Agent.
"*AWELS"
The default path for a Symantec Launch Server for a Management Agent.
"*AWEDA"
The default path for a Symantec Data Access Server for a Management Agent.
 
Note: The default path for a server for a Management Agent is a server installed in the same Appstream installation location as the Agent.
Get
Various functions for getting information about a server, the Management Agent, or this client.
Get Status

Get the current status of the server.

A server is assumed "Down" if it cannot be contacted for any reason (so if the server is up but configured with the wrong Management port - it will be reported as "Down").

If the Management Agent seems to have "lost" a server or is reporting strange error messages (like "not a socket") for other commands, use this command to reset the Management Agent's communication with the server.

If a server's auto-recovery parameters are configured to check the server every X seconds, executing this command - and receiving a status of "Up" - will cause the auto-recovery status check to be delayed until X seconds from when this command is issued.

Get Info
Get the vital statistics of the machine the server is running on, and statistics of the server process.
Get Loglist
Get the list of log files in the log directory of this server.
Get Logfile
Get the entire contents of a log file on the server.
Get Logpage
Get a portion of the contents of a log file on the server.
Get Schedule
Get the list of scheduled actions for a server.
Get License
Get the contents of the license file for a server.
Get AllServersStatus
Get the status of all servers this Management Agent knows about.
Get Servers
Get the list of root directories of the servers this Management Agent knows about.
Get Configfile
Get the contents of a configuration file on the server.
Get File

Get the contents of a file on the server.

This command will not accept absolute paths or paths with directory navigation (i.e. a path like "somewhere/../../../above/somewhereelse").

Get CommonFile

Get the contents of a file from the common installation area for the server.

This command will not accept absolute paths or paths with directory navigation (i.e. a path like "somewhere/../../../above/somewhereelse").

Get Autorecovery
Get the auto-recovery parameters of this server.
Get Mailnotification
Get the mail notification parameters of this server.
Get Clientconfig
Display the current configuration of this client (which Management Agent and server it is communicating with).
Get AllApplicationData
Display data on all applications known to the server.
Get SessionsOverview
Display a summary of all sessions on a running server.
Get Users
Display all of the info about all users connected to a running server.
Get Sessions
Display all of the info about all sessions belonging to a specific user connected to running server.
Get ApplicationsUsage
Display all of the info about all applications usage on a running server.
Get Property
Get a property from the configuration of the windows server.
Get ManagementAgentVersion
Display the version of the Management Agent with which the client is currently communicating.
Get Time

Display the current time on the machine the Management Agent is running on.

The time will be reported in the time zone of the Management Agent.

Put
Various functions for putting or changing server or Management Agent settings.
Put Configfile

Put the contents of a configuration file on the server replacing the existing contents or creating a new file depending on the [usedate] argument.

This function will not cause the server to immediately notice these changes, a restart command must be issued before the server will pick up the changes made to its configuration.

Put File
Put the contents of a file on the server replacing the existing contents or creating a new file depending on the [usedate] argument.
Put CommonFile
Put the contents of a file in the common installation area on the server replacing the existing contents or creating a new file depending on the [usedate] argument.
Put Autorecovery

Put the new auto-recovery parameters that the Management Agent should use when attempting to perform auto-recovery on a server.

These settings take immediate effect, the Management Agent will interrupt any current wait and continue the auto-recovery process with the new parameters.  If the number of retries is set to lower than the number of retries already made, the Management Agent will stop retrying and move to the next step in the auto-recovery process.

Put Mailnotification

Put the new mail notification parameters that the Management Agent should use for this server.

These settings take immediate effect unless the Management Agent is already in the process of sending e-mails in which case the next e-mail notification will reflect these changes.

Put Property
Put a property into the configuration of the windows server.
Upload
Function for uploading packaged applications and enabling them on Streaming Server(s).
AddProvision
Function for creating provision for a user or group from a script file.
 
Start
Starts the current server.
Stop
Stops the current server.
Restart
Restarts the current server.
Reload
Various functions for reloading information.
ReloadConfiguration
Instructs the streamlet engine or streaming server to reload its configuration.
 
ReloadServers
Instructs the streamlet engine to reload its servers information.
ReloadLogConfiguration

Instructs the streamlet engine to reload its logging configuration.

If executed on a streaming server, this will reload the streaming server's configuration (it does not support reloading it's log configuration separately).

Change
Various functions for changing information on the Management Agent or client.
Change Accesskey
Change the access key that this Management Agent uses to authorize commands.
Change Clientaccesskey
Change the access key that the client will send to the Management Agent for authorization.
Change Server
Change the server that all future commands will be issued against.
Discover
Send out a discovery broadcast request to detect the presence of Management Agents on the network.
Wait
Wait for a specified interval, only valid inside scripts.
Quit
Quits this program and disconnects from the Management Agent connected to if any.