Aclient command lines

Article:HOWTO1768  |  Created: 2006-01-19  |  Updated: 2007-09-26  |  Article URL http://www.symantec.com/docs/HOWTO1768
Article Type
How To

Product(s)


Question

Where are the command lines for the  Deployment Agent for Windows (AClient)?

Answer


Deployment Agent for Windows (AClient)

The following sections identify command-line areand input parameters for AClient.exe, the executable file for the Deployment Agent for Windows.

AClient.exe Command-line Switches

AClient.exe executable installs and runs on client computers, enabling them to be managed by a Deployment Server. It enables clients to receive work from the Deployment Server, and it reports client status to the Server.

The program is normally installed and configured remotely using the Client Install wizard, or the program is run at the client computer. However, you can use the command-line options to run it from a script file if you want to. (If you use a script file, see the following section on aclient.inp for information on using an import file to specify install switches for AClient.)

You can use either a forward slash (/) or a dash (-) with the command-line options. Commands are not case sensitive.

Switch
Details
-ver
Function: Shows the version of aclient.exe running on the computer.
-install
Function: Installs the client.
Option: -silent allows install to complete without sending output to the client.
Example: To install aclient.exe from the Deployment Server directory without sending messages to the client, type
Deployment Server /aclient /install /silent
-remove
Function: Removes (uninstalls) aclient.exe from a computer.
Option: -silent removes the aclient without sending output to the client.
Example: To remove aclient, type
aclient -remove
-start
Function: Manually starts aclient.exe on a computer.
Option: -silent starts the aclient.exe without sending output to the client.
-stop
Function: Manually turns off aclient on a computer.
Option: -silent turns off aclient without sending output to the client.

Aclient.inp Parameters

You can use this input file to set installation parameters for aclient.exe, so you can install the client program from a script file. The file is copied to the Deployment Server program directory when you install the product. Command-line parameters are included in the file, but are marked with a REM statement.

To use the input file, open it and remove the REM commands from the parameters you want to use. When you have the file set up the way you want it, you can run it by entering the file name as the first parameter after the aclient command. You can also put the same line in a script file if you want to run it from a file. Type

aclient aclient.inp 

The input file name (aclient.inp) and InstallDir parameters are required; all others are optional. Parameters are case sensitive.

Note: Many parameters will work after setting other parameters first. For example, you can only use ServerName after the multicast parameters, MCastAddr and MCastPort, are set.

Parameters
Details
ForceReboot
Function: Specifies how the system should be shut down and rebooted. Applications are forced closed and the system shuts down even if programs hang. (User data could be lost.)
Example: To force clients to reboot when a reboot task is assigned, type
ForceReboot=Yes
The default is "No."
HardTimeout
Function: Specifies the length of time (in seconds) that aclient.exe will maintain an idle connection with the Deployment Server. After the time limit is exceeded, the client will disconnect and then establish a new connection with the Server.
Example: To establish a new connection with the Deployment Server whenever the connection is idle for 900 seconds, type
HardTimeout=900
InstallDir
(required)
Function: Specifies the full path name to the directory where aclient.exe will be installed. The default location is c:\altiris\aclient.
Example: To change the default location, replace it with a new path. Type
InstallDir=c:\programs\aclient
LogFile
Function: Specifies the full path name to the log file.
Example: To write log entries to a log file in your AClient directory, type
LogFile=c:\altiris\aclient\aclient.log
LogSize
Function: Sets the maximum log file size (in bytes).
Example: To set the log file size limit to 4096 bytes, type
LogSize=4096
MCastAddr
Function: Specifies the multicast group address to be used to find the Deployment Server.
Example: To set the IP address for multicasting, type
MCastAddr=225.1.2.3
MCastPort
Function: Specifies the port number to use for multicasting.
Example: To use port 402 for multicasting, type
MCastPort=402
Password
Function: Sets a password on the client to prevent users from accessing aclient.exe settings.
Example: To lock the settings, type
Password=clientmanager
PromptExecute
Function: Sends output (messages) to the client when tasks are being executed.
Options: Yes, No
Examples: To allow prompts and messages to be sent to the client, type
PromptExecute=Yes
To suppress output, type
PromptExecute=No
PromptOverride
Function: Specifies the default action to take when there is no user response to a restart prompt.
Options: Abort, Continue
Examples: To abort the client reboot, type
PromptOverride=Abort
To reboot the client, type
PromptOverride=Continue
PromptReboot
Function: Prompts the user before restarting the client.
Options: Yes, No
Examples: To prompt for user input before restarting a client, type
PromptReboot=Yes
To restart a client without requiring user input, type
PromptReboot=No
PromptSeconds
Function: Specifies the length of time (in seconds) that the client will wait for a response from the user.
Example: To wait 30 seconds for user input, type
PromptSeconds=30
ShowTrayIcon
Function: Specifies whether or not to show the Altiris client icon in the system tray. If the icon is not in the tray, users can't access Aclient.
Example: To not show the icon, type
ShowTrayIcon=No
The default is "Yes," which loads the icon into the system tray.
SpeedLimit
Function: Sets the minimum transfer rate accepted from the Deployment Server (in bytes per second). If aclient.exe cannot receive data from the Server at this rate, it will disconnect and retry at specified intervals. See HardTimeout below.
Example: To set a minimum ransfer rate of 7500 bytes per second, type
SpeedLimit=7500
TcpAddr
Function: Specifies the IP address of the Deployment Server that the client will connect to. Using this parameter causes the client to use TCP instead of multicasting to connect to the Server.
Example: To have the client connect to a Deployment Server using its IP address, type
TcpAddr=192.1.2.3
TcpPort
Function: Specifies the port number of the Deployment Server listening for requests. Using this parameter causes the client to use TCP to connect to the Server.
Example: To specify the port number of the Deployment Server to connect to, type
TcpPort=402
TTL
Function: Sets the maximum number of hops to multicast through.
Example: To limit the number of hops to 32, type
TTL=32
UpdateFileSystemSids
Function: Specifies if you want SIDgen to update permissions on any local NTFS volumes. This parameter only applies if you have domains and use SIDgen to manage the computer IDs.
Example: To update permissions on the local NTFS volume, type
UpdateFileSystemSids=Yes
The default is "No."
UseRCDrivers
Function: Specifies whether or not to install keyboard and mouse filter drivers that enable remote control on Windows NT and 2000 client computers. (The default is "No," so the drivers are not installed. This parameter is not necessary for Win 95/98 computers because they don't require Ctrl + Alt + Del input to log in.
Example: To install the drivers for remote control, type
UseRCDrivers=Yes
UserName
Function: Associates a computer with the primary user or users. This is used to target RIP deployments to a specific user or group of users. To assign more than one user, separate the names with semicolons.
Examples: To associate user Fred with the client being installed, type
UserName=Fred
To associate users Fred and Sam with the client, type
UserName=Fred;Sam
ServerName
Function: Specifies the computer name of the Deployment Server that you want the client to connect to. This is useful if you have multiple Deployment Servers on your network and you don't want the client to connect to the first server it finds.
The ServerName parameter is only valid if you are using multicasting (by setting MCastAddr and MCast Port parameters).
Note ServerName can only be set after the multicast parameters, MCastAddr and MCastPort, are set.
Example: To restrict client connection to a Server named "Server3," type
ServerName=Server3

The aclient removal with the switches /remove /silent does not remove the aclient directory.  It will remove the aclntuser.exe and the service but not the directory.

Using a batch file will remove it.   Batch file as follows:

Start /Wait "" "C:\program files\altiris\aclient\aclient.exe" /remove /silent

RD /s /q "C:\Program files\Altiris\aclient\"

This script will remove aclient service and the aclient directory.

Legacy ID



18245


Article URL http://www.symantec.com/docs/HOWTO1768


Terms of use for this information are found in Legal Notices