|
Toll Free: (866) 407-5279 Direct: (651) 407-5279 |
|
This describes proper use of command line options, several examples, and related notes. This supports the scripting of remote installs, for example, leaf agents to multiple targets.
A note on scripted installs: Currently, the Agent-Installer from the command line provides little or no feedback on an installation failure. If Leaf-Agents do not appear in the console after a reasonable amount of time has elapsed when running a script or batch file, you may want to interactively install the Leaf-Agents to see what is happening. For example, an "out of licenses" condition, or a "registration" problem between Leaf and Master may be far more evident on an interactive install than a scripted install. There are a number of issues that can affect a Leaf Agent install, whether interactive or scripted.
ueagentinstaller [-s] [-h machinename] [-p port] [-l] [-m] [-r serialnumber][-d description] [-mh masteragentname][-mp masteragentport][-in instance][-mc mastercredentialfile][-lc leafcredentialfile][-up][-u]
|
-s (silent) |
Silent install. This switch suppresses the GUI dialogue boxes, and causes the Agent-Installer to use all user supplied, valid command line switches as listed below. Note that omitting "-s" simply launches the GUI, and that the GUI does not and will not use any of the command line switches below. Effectively, "-s" is mandatory for command line operations, and it's absence simply launches the GUI. Note: The command line cannot be "verified" by removing the -s. Users sometimes try to verify if the command line is correct by removing the -s, thinking they'll get feedback. Instead, the GUI launches, and the screens are not filled out. "-s" just means suppress the GUI, and run silently with supplied valid switch options. |
|
-h (host) |
Host (name or IP) on which you are installing Master or Leaf agent. |
|
-p (port) |
Port number to be used for this agent install (defaults to 9968). Valid port numbers are 1025 - 65535. 1024 or lower are "reserved" for internet services. |
|
-m (master) |
Install a Master-Agent. NOTE: If -m is NOT set, a Leaf Agent will be installed by default. |
|
-l (local) |
Install Agent Locally. NOTE: If -l is NOT set, the installation is assumed to be a remote install. |
|
-r (registration) |
Serial Number used when installing the product. Entering this enables the agent being installed. |
|
-d (description) |
Description for this agent, as seen in the agent settings window in UpdateEXPERT Console. The -d is required because you don't want to have a blank line for the leaf agent under File Agent Settings. The GUI provides the default of "hostname | agent-type", but the command-line needs the switch. NOTE: If description includes spaces, wrap with quotes, ie., "Agent on HostA" |
|
-in (MSDE instance) |
Added in UpdateEXPERT Premium. Specifies the MSDE instance name, SBSDB is default if no name supplied. |
|
-lc (leaf credentials) |
Added in UpdateEXPERT Premium to provide local or domain administrative credentials for agent installation on the target machine, on a per-machine basis. This can help with mass deployments of Leaf-Agents, or deployments of Master-Agents, or both, where needed administrative credentials vary. Note: if -lc is not specified, the current login account is used as the credential for Agent installation. If all targeted machines can be administratively accessed with the current login account, you can deploy agents without using the -lc switch, and possibly without using the -mc switch assuming the current login account is assigned a "role" in UpdateEXPERT with agent installation rights. Bottom Line: The options -lc and -mc may not be needed if the current login account is an UpdateEXPERT role with agent install rights, and has administrative rights to the agent installation targets. One or more agent credentials files can be created with the Agent Installer GUI "Store Credentials" option, then used from the command line. See Credentials Management in UpdateEXPERT Premium which includes links to a vb script mass deployment example and an example of creating credentials files with the Agent Installer GUI. |
|
-mc (master credentials) |
Added in UpdateEXPERT Premium to allow target machines to securely register with a Master-Agent during agent installation. This occurs toward the end of the agent installation procedure. The credentials in this file should be an UpdateEXPERT "role" where the associated account has agent installation rights. By default, the SuperUser role (and it's affiliated account) will have agent installation rights. Other role/account pairs can be created and assigned the agent installation right. Note: if -mc is not specified, the current login account is used as the credential for Master-Agent registration. If all targeted machines can register with the current login account, you may also be able to deploy agents without using the -lc switch assuming the current login account has administrative rights for agent installation. Bottom Line: The options -lc and -mc may not be needed if the current login account is an UpdateEXPERT role with agent install rights, and has administrative rights to the agent installation targets. One or more agent credentials files can be created with the Agent Installer GUI "Store Credentials" option, then used from the command line. See Credentials Management in UpdateEXPERT Premium which includes links to a vb script mass deployment example and an example of creating credentials files with the Agent Installer GUI. |
|
-mh (master host) |
Leaf Agent installations must identify the name of the Master Agent to register with. |
|
-mp (master port) |
Leaf Agent installations must identify the port that the Master Agent will be listening on. NOTE: Essentially, -mh and -mp allow the leaf agent to point back at the Master Agent it needs to communicate with. |
|
-u (uninstall) |
Typically used for Leaf Agent un-installs. |
|
-up (upgrade) |
Used to indicate that you want to upgrade the existing Leaf Agent. |
See Agent Installer in the User Manual for additional notes, details, and examples.
http://www.stbernard.com/products/manuals/UpdateEXPERT_Premium/updateexpert/introduction_and_setup/agent_installation.htm
UEAgentInstaller -s -h Server01 -p 9968 -l -m -r 01-123-45678-98765-19283 -d "Sample Master"
Note: This installs a Master Agent locally on host "Server01" that listens on port 9968.
Important: All switch options shown in the example are required. The values can be tailored to your machines, but you cannot omit the options. This is important if you are attempting to create a script.
UEAgentInstaller -s -h Leaf01 -p 5555 -l -r 01-123-45678-98765-19283 -d "Sample Leaf" -mh Server01 -mp 9968
Note: This installs a Leaf Agent locally on Leaf01 that listens on port 5555. This Leaf Agent will register itself with the Master Agent that is installed on the server Server01 and listening on port 9968.
Important: All switch options shown in the example are required. The values can be tailored to your machines, but you cannot omit the options. This is important if you are attempting to create a script.
UEAgentInstaller -s -h w2kp1en -p 5555 -r 01-123-45678-98765-19283 -mh Server01 -mp 9968
Note: The ABSENSE of the "-l" and "-m" options implies a "remote leaf" install, rather than a "local master" install. The leaf must always point back to a master with -mh, -mp.
Important: All switch options shown in the example are required. The values can be tailored to your machines, but you cannot omit the options. This is important if you are attempting to create a script.
UEAgentInstaller –s –h LEAF2 –p 9968 –l –r 01-123-4567-8901 –lc LeafCredentialFile.crd –mc MasterCredentialFile.crd –d "Leaf Installed using credential files" –mh MASTER01 –mp 9968
A rewrite of the previous example, running from the master machine, installing to Leaf3 using credential files and defaults.
UEAgentInstaller –s –h LEAF3 –lc LeafCredentialFile.crd –mc MasterCredentialFile.crd
See our discussion and example VB scripts for deploying Leaf Agents with Active Directory.
If you get the dialogue box message above, click here to solve your problem.