Agent > Deploy Agents
- This page applies to the following products: On Premises, Kaseya Advanced, Kaseya Essentials, IT Center, IT Workbench
The Deploy Agent page creates and distributes an agent install package to multiple machines.
- Use Agent > Create to create a machine ID account and agent install package in two separate steps and apply them to a single machine. You can also use Create to create machine ID templates or re-install an agent for an existing machine ID.
- Use Install Agents to install agents on remote systems.
Note: See System Requirements for a list of operating systems agents can be installed on.
Note: See the PDF quick start guide, Agent Configuration and Deployment. This and other resources are listed in the first topic of online help.
Note: An agent is automatically installed on the Kserver. You can click the check-in icon for this agent to initiate a Live Connect session with the Kserver.
Machine IDs vs. Agents
When discussing agents it is helpful to distinguish between the machine ID / group ID / organization ID and the agent. The machine ID / group ID / organization ID is the account name for a managed machine in the VSA database. The agent is the client software installed on the managed machine. A one-to-one relationship exists between the agent on a managed machine and its account name on the VSA. Tasks assigned to a machine ID by VSA users direct the agent's actions on the managed machine.
Machine ID Templates
Machine ID template is a machine ID record without an agent. Since an agent never checks into a machine ID template account, it is not counted against your total license count. You can create as many machine ID templates as you want without additional cost. When an agent install package is created, the package's settings are typically copied from a selected machine ID template. Machine ID templates are usually created and configured for certain types of machine. Machine type examples include desktops, Autocad, QuickBooks, small business servers, Exchange servers, SQL Servers, etc. A corresponding install package can be created based on each machine ID template you define.
- Create machine ID templates using Agent > Create.
- Import a machine ID template using Agent > Import/Export.
- Base an agent install package on a machine ID template using Agent > Deploy Agents.
- Copy selected settings from machine ID templates to existing machine ID accounts using Agent > Copy Settings.
- Identify the total number of machine ID template accounts in your VSA using System > Statistics.
- Configure settings for the machine ID template using the standard VSA functions, just as you would a machine ID account with an agent.
- Separate machine ID templates are recommended for Windows, Macintosh and Linux machines. Alternatively you can create a package that selects the appropriate OS automatically and copy settings from a template that includes an agent procedure that uses OS specific steps.
The full filename for a Windows agent install package is
KcsSetup.exe. The full filename for a Macintosh agent install package is
KcsSetup.app is downloaded as a
KcsSetup.zip which contains
KcsSetup.app inside a folder titled
Agent. Click the
KcsSetup.zip file to expand it, click the
Agent folder, then click the
KcsSetup.app file to execute it.
Using the Wizard
The Deploy Agents install package is created using a Configure Automatic Account Creation wizard. The wizard copies agent settings from an existing machine ID or machine ID template and generates an install package called
KcsSetup. All settings and pending agent procedures from the machine ID you copy from—except the machine ID, group ID, and organization ID—are applied to every new machine ID created with the package.
Including Credentials in Agent Install Packages
If necessary, an agent install package can be created that includes an administrator credential to access a customer network. Credentials are only necessary if users are installing packages on machines and do not have administrator access to their network. The administrator credential is encrypted, never available in clear text form, and bound to the install package.
Editing Existing Install Packages
Typically an existing Deploy Agents install package is edited just before re-distribution. The most common changes made to an install package are:
- Pre-selecting an organization ID, group ID or sub-group ID.
- Assigning a credential, if necessary.
Once edited, the install package can be re-created and distributed to the specific customer and location it is intended for.
Once created, you can use the following methods to distribute an agent install package:
- Windows - Set up an NT logon procedure to run the install package every time a user logs into the network. See ystem requirements.
- Macintosh - Set up an Mac OS X Login Hook Procedure to run the install package every time a user logs into the network. See Apple KB Article HT2420.
- Create the deployment package using the Agent > Deploy Agents wizard.
KcsSetup installer skips installation if it detects an agent is already on a machine if the
/e switch is present in the installer package.
- You will probably want to select the silent install option.
- It may be necessary to bind a administrator credential if users running the logon procedure don't have user rights.
- Download the appropriate
KcsSetup installer package using the
dl.asp page and copy it to a network share which users can execute programs from.
KcsSetup with its network path to the logon procedure.
- Email - Email
KcsSetup to all users on the network. Download the appropriate install package from the Deploy Agents page, then attach it to an email on your local machine. You can also copy and paste the link of the default install package into an email message. Include instructions for launching the package, as described in the Manual bullet below.
- LAN Watch - Users can discover newly added machines during a LAN Watch and subsequently install agents remotely using the Agent > Install Agents page.
- Active Directory - Run LAN Watch on an Active Directory machine. From then on, Windows agents can be installed automatically on Windows machines as soon as users logon using Active Directory. See View AD Computers and View AD Users. Macintosh and Linux are not supported.
- Manual - You can instruct users to download an install package agent from the
http://<VSA_Address>/dl.asp website to their target machines. If more than one install package is displayed on the website, instruct users which package should be selected. Users can execute the
KcsSetup installer using any of the following methods:
- Double click
KcsSetup to launch it.
- Open a command line window and type
KcsSetup followed by any desired command line switches.
- Select Run... from the Windows Start menu and type
KcsSetup followed by any desired command line switches.
- Macintosh and Linux
- Double click
KcsSetup to launch it.
- Open a terminal process, navigate to where
KcsSetup is located and launch
Note: For Macintosh, command line switches can only be used when creating the agent install package.
Note: For Linux, see Installing Linux Agents for more detailed instructions.
Default User Install Packages
Each user can specify their own default install package by selecting the Set Default radio button to the left of the package name. Users can download their own default agent immediately by selecting the Click to download default Agent link on the Deploy Agents page.
Unique ID Number
You can tell users which install package to download by referencing the install package's unique ID number. Example:
http://<VSA_Address>/dl.asp?id=123. The default install package is displayed with its unique ID number in the header of the Deploy Agents page.
Assigning New Machine IDs to Machine Group by IP Address
Maintaining multiple agent install packages in Agent > Deploy Agents, one for each organization, can be time consuming. Instead some server providers use a single agent package for the
unnamed organization and perform all installs using this package. System > Naming Policy can reassign new agents to the correct organization.group ID automatically—the first time the agents check in—based on each managed machine’s IP or connection gateway. Agent > Copy Settings may be used afterwards, to manually copy specific kinds of agent settings by machine ID template to the type of machine revealed by the initial audit.
Automatic Account Creation
You must have automatic account creation enabled using System > Check-in Policy to automatically create a machine ID account when a Deploy Agents package is installed.
Operating System Selection
Agent packages can be created to install agents on machines running either Windows, Macintosh, or Linux operating systems, or to automatically choose the type of operating system of the downloading computer.
Click Create Package to start a Configure Automatic Account Creation wizard where you can specify all configuration parameters for the install package. The wizard is a 7 step process.
- Define rules for naming the machine ID.
- Prompt the user to enter a machine ID.
- Use the computer name as the machine ID.
- Set the user name of the currently logged on user as the machine ID.
- Specify a fixed machine ID for this install package.
- Define rules for naming the group ID.
- Existing Group - Select an existing group ID from a drop-down list.
- Domain Name - Uses the user's domain name.
- New Group - Specify a new group ID. This option only displays for master role users.
- Prompt User - Asks user to enter a group ID. This option only displays for master role users.
- Specify agent install package command line switches including the ability to install silently without any task bars or dialog boxes.
- Specify the machine ID to copy settings and pending agent procedures from. All copied settings and pending agent procedures—except the organization ID, machine ID, and group ID—are applied to every new machine ID created with the package.
Note: The statement
Copy settings from unknown.root.unnamed if nothing selected is based on the machine ID or template selected by the Default Install package. See Editing the Default Install Package below.
- Select the operating system you are creating the install package for:
Automatically choose OS of downloading computer:
- Optionally bind a user logon credential to the install package. Fill in the Administrator Credential form to securely bind user rights to the install package.
- Users without administrator rights can install the package successfully without having to enter an administrator credential.
- If the administrator credential is left blank and the user does not have administrator rights to install software, the install package prompts the user to enter an administrator credential during the install. If the package is also silent
KcsSetup will fail without any dialog messages explaining this.
Note: Credentials are only necessary if users are installing packages on machines and do not have administrator access to their network.
- Name the install package for easy reference later. This name displays on the Deploy Agents page and the
dl.asp download page.
Install Issues and Failures
See Install Issues and Failures if an agent fails to install.
Editing the Default Install Package
Default Install package sets the default values displayed when you create a new package. Normally the
Default Install package cannot be modified. The Save button is disabled. To enable the Save button for the
Default Install package, do the following as a master role user:
- Click the Share button next to the
Default Install package in Agent > Deploy Agents.
- Click Take Ownership.
- Check Allow other users to modify.
- Click Save.
- Click the edit icon next to the
Default Install package.
The Save button will be enabled when you edit the
Default Install package.
Note: If you delete the
Default Install package, it is re-created immediately.
Click to download default Agent
Click this link to download the current VSA user's default package directly from this page.
Users can download agents from
Paste this hyperlink into an email message. The unique ID number ensures that when the link is clicked in the email message, the default install package is selected and downloaded. Set a different install package as the default to display the link for that install package.
Manage packages from all administrator
Check to display all packages created by all VSA users. Once a hidden package is displayed, you can use the package, make the package public or take ownership. This option only displays for master role users.
Specify your own default install package by selecting the radio button to the left of the package name in the Set Default column.
Click the delete icon to remove a package from the paging area. If you created the package, then this also deletes the package from the system and removes it for all VSA users.
Click the edit icon next to a package to change parameters for that package using the Configure Automatic Account Creation wizard.
Lists the name of the package.
Public package rows display with a brown background. Private package rows display with a gray background.
Click Share to share a private package with other users, user roles or to make the package public.
List on dl.asp
Click the dl.asp link in the column header to display the web page machine users see when they install an agent on their machine. Check a box in this column to include its package in the list of available download packages on the dl.asp page.
Displays the description of the package.