KACE Systems Management Appliance 14.1 Common Documents - KACE Service Desk Administrator Guide

Create Managed Installations for ZIP files

Deploying software using a ZIP file is a convenient way to package software when multiple files are required to deploy a title.

For example, a software title might require a setup.exe file, configuration files, and data files. If you have a CD-ROM that contains a group of files required to install a particular application, you can package them together in a ZIP file and upload them to the appliance for deployment.

NOTE: The KACE Agent automatically runs deployment packages with MSI and EXE extensions.

NOTE: In addition, you can create a ZIP archive that contains many files and direct the appliance to unpack the archive and run a specific file. Place the name of the file that you want to run in the command (executable) field within the deployment package (for example, runthis.exe).

To distribute applications to managed devices, you must attach the digital assets, which are the files required for installation, to applications. In addition, you must select the supported operating systems for applications. See Attach digital assets to applications and select supported operating systems.

Browse to the location that contains the necessary installation files, select all the files and create a ZIP file using a utility such as WinZIP®.

Log in to the appliance Administrator Console, https://appliance_hostname/admin. Or, if the Show organization menu in admin header option is enabled in the appliance General Settings, select an organization in the drop-down list in the top-right corner of the page next to the login information.

Create an inventory item for the target deployment.

You can do this manually from the Inventory > Software page or by installing the package on a device that regularly connects to the appliance. See About the Software page.

Associate the ZIP file with the inventory item and upload it to the appliance:

On the left navigation bar, click Distribution, then click Managed Installations.

Select Choose Action > New.

Select the application title that the ZIP file is associated with from the Software drop-down list. To see all application titles, clear the check box Only display records with an associated file.

In the Additional Parameters field, specify the complete command with arguments.

For example: setup.exe /qn

Specify additional settings as needed.

See Create Managed Installations for Windows devices.

Click Save.

Create Managed Installations for RPM files

You can create Managed Installations to deploy software on Linux-based devices using RPM files.

Go to the Managed Installation Detail page:

On the left navigation bar, click Distribution, then click Managed Installations.

Select Choose Action > New.

In the Software drop-down list, select a software title. To search for a title, begin typing in the Software field.

By default, the KACE Agent attempts to install the RPM file using the following command. In general, this command is sufficient to install a new package or update an existing one to a new version:

rpm -U packagename.rpm

If you select a ZIP, TGZ, or TAR.GZ file, the content is unpacked, and the root directory is searched for all RPM files. The installation command runs against each of these files. The appliance finds all RPM files at the top level of an archive automatically, so you can install more than one package at a time. You can also create an archive containing a shell script and then specify that script name as the full command. The appliance runs that command if it is found; otherwise, the appliance logs an error.

Default parameters are used unless you specify parameters in the Run Parameters field.

You can specify wildcards in the filenames you use. If the filename contains spaces, enclose it in single or double quotation marks. The files are extracted into a directory in /tmp and it becomes the current working directory of the command.

NOTE: On Red Hat Linux, if you only want to run your script, you do not need to include any other files in your archive.

If the path environment variable of your root account does not include the current working directory, and you want to run a shell script or other executable that you have included inside an archive, specify the relative path to the executable in the Full Command Line field. The command runs inside a directory alongside the files that have been extracted.

For example, to run a shell script called installThis.sh, package it alongside an RPM file, and then enter the command: ./installThis.sh in the Installation Command field. If you archive it inside another directory, the Installation Command field is:

./dir/filename.sh

Both these examples, as well as some other appliance functions, assume that sh is in the root's path. If you are using another scripting language, you might need to specify the full path to the command processor you want to run in the installation command, such as:

/bin/sh ./filename.sh

Include appropriate arguments for an unattended, batch script.

If you select the uninstall check box in the MI detail, the KACE Agent runs the following command on either your standalone RPM file or each RPM file it finds in the archive, removing the packages automatically:

//usr/sbin/rpm -e packagename.rpm

The package is removed only if the archive or package has been downloaded to the device. If you select the Uninstall Using Full Command Line check box, specify a full command line in the Installation Command field to ensure the correct removal command runs on the correct package. Because no package is downloaded in this case, specify the path in the installation database where the package receipt is stored.

If your package requires additional options, provide the following information:

Option

Description

Name

A name that identifies the Managed Installation. This name appears on the Managed Installations page.

Execution

Select the most appropriate time for this package to be deployed. For the Linux platform, the options are Anytime (next available) and Disabled.

Inventory

Indicate if you want to deploy the software title from Cataloged Software or all Software by selecting one of these options.

•

To search for a specific title, begin typing in the Software or Cataloged Software field.

NOTE: Reclaiming unused software licenses only. The name of the software that you want to uninstall appears in this field by default. For more information, see Reclaim unused software licenses.

•

If you want to display only the software that has one or more associated files, select Only Display Software With an Associated File.

Associated File

A Software and Cataloged Software title can have one or more files attached to them, as needed. Indicate if you want to select a specific file associated with the selected software title.

•

Choose associated file: Select this option if you want to associate a file. You can select a file in the list. If you know the file name, start typing it in the box, and select it from the available entries in the list.

•

Do not associate file: Select this option if you do not want to associate a file.

Alternate Location

Specify a location from which files can be downloaded for a specific Managed Installation.

Path: Enter the location where the KACE Agent can retrieve digital installation files.

Checksum: Enter an alternate checksum (MD5) that matches the MD5 checksum on the remote file share. If no checksum is entered, the digital asset on the file share must match the digital asset associated with the deployment package on the appliance. Also, the target path must include the complete filename (for example,\\fileserver_one\software\adobe.exe). You can create the checksum using any tool, including KDeploy.exe, which is installed with the KACE Agent.

To create the checksum using KDeploy.exe:

On a device with the KACE Agent installed, open a command prompt or terminal window.

Go to the Quest KACE installation directory. For example:

Windows 32-bit devices: C:\Program Files\Quest\KACE

Windows 64-bit devices: C:\Program Files (x86)\Quest\KACE

Mac OS X devices: /Library/Application Support/Quest/KACE/bin

Enter the following command: KDeploy -hash=filename

Where filename is the UNC path to the file. If the path contains spaces, enclose the entire path in double quotation marks.

Press Ctrl C or Command C to copy the MD5 checksum. You can then paste it into other files, such as Notepad.

Credential: The details of the service account required to connect to the device and run commands. Select existing credentials from the drop-down list, or select Add credential to add credentials not already listed. See Add and edit User/Password credentials.

NOTE: If the target device is part of a replication label, the appliance does not fetch applications from the alternate download location. You can edit an existing label or create a label to specify the alternate location globally. Because that label cannot be specific to any Managed Installation, you cannot specify an alternate checksum that matches the checksum on the remote file share.

See Distributing packages from alternate download locations and Replication Shares and Add or edit manual labels.

Installation Command

Installation command options.

Default Installation

Select this option if you have an RPM file and you want the appliance to run the default installation command. Linux devices use: rpm [-U | Run Parameters] "packagename.tgz"

Additional Parameters: (Optional) If you select Use Default, specify the parameters to use. Additional parameters are not required if you have an RPM file.

Enter a value to override (Default -U default).

For example, if you set Run Parameters to: -ivh --replacepkgs, then the command that runs on the device is:

rpm -ivh –replacepkgs package.rpm

Override Default Installation

Select this option to specify the complete command line here. If you are using an archive file, this command runs against all of the RPM files it finds.

Uninstall

Remove the package from the device using the command line. If you specified a command in the Full Command Line field, the command runs. Otherwise, the KACE Agent attempts to run the command, which is generally expected to remove the package.

Run Command Only (do not download file)

Run the command only. This does not download the actual digital asset.

Delete Downloaded Files

Delete the files when the deployment is complete.

ITNinja

Deployment tips from ITNinja. These tips are available only if you share usage data. See Configure data sharing preferences.

Specify deployment settings in the Deploy tab:

Option

Description

All Devices

Deploy to all devices. Clear the check box to limit the deployment to specific labels or devices.

Restrict to Labels

Limit deployment to devices that belong to specified labels. To select labels, click Edit, drag labels to the Limit Deployment to window, then click Save.

If you select a label that has a Replication Share or an alternate download location, the appliance copies digital assets from that Replication Share or alternate download location instead of downloading them directly from the appliance.

NOTE: The appliance uses a Replication Share before it uses the KACE Alt Location.

Devices

Limit deployment to specific devices. In the drop-down list, select the devices to which you want to deploy the application. To filter the list, type a few characters in the Devices field. The number next to the field indicates the number of devices available.

NOTE: Reclaiming unused software licenses only. Any devices from which you want to remove the applicable software are listed. You can edit the list of devices, as needed. To remove the software from all devices, simply select , as described above. For more information, see Reclaim unused software licenses.

Specify the user notification settings in the Notify tab:

Option

Description

Alert user before run

Display a message on managed devices before installation. When you select this option, the following fields appear:

•

Message: The message that appears on managed devices before installation begins. It starts with snooze options that allow the user to run the managed install at a later time.

•

Timeout: The length of time, in minutes, during which the message appears.

•

Action: The action that takes place at the end of the Initial Message Timeout period. Options include Install later or Install now. Select Install now to install the application immediately, or select Install later to postpone the installation until a user responds. Install later is useful when you want to notify users of an installation or reboot before it occurs.

Initial Message

Display a message on managed devices before installation. When you select this option, the following fields appear:

•

Message: The message that appears on managed devices before installation begins.

•

Timeout: The length of time, in minutes, during which the message appears.

•

Completion Message

Display a message on managed devices after the installation is complete. When you select this option, the following fields appear:

•

Message: The message that appears on managed devices when the installation is complete.

•

Timeout: The length of time, in minutes, during which the message appears.

Select appropriate options in the Schedule tab:

The time, in 24-hour clock format, for package deployment to start and end. The Deployment Window time affects all Action options. Also, the run intervals defined in the appliance Settings interact with or override the deployment window of specific packages.

Order

The order in which to install or uninstall applications. The lowest value is deployed first. If an install action and an uninstall action both have the same order value, the uninstall action is performed first.

NOTE: Managed Installations are always deployed in order, regardless of whether their specified software packages come from the Software Catalog or the Software list. Managed Installations with a lower deploy order always prevent other Managed Installations from running until they are successfully installed or exceed the specified retry times.

Maximum Attempts

The maximum number of attempts, between 0 and 99, to indicate the number of times the appliance tries to install the package. If you specify 0, the appliance attempts to install the package indefinitely.

Click Save.

Create Managed Installations for TAR.GZ files

Deploying software using a TAR.GZ file is a convenient way to package software when more than one file is required to deploy a particular software title.

For example, some applications require several files, such as RPM, configuration, and data files, for deployment. You can package these files together in a TAR.GZ file, upload them to your appliance, and create Managed Installations that use the TAR.GZ files.

Use the following two commands to create a TAR.GZ file:

tar –cvf filename.tar packagename.rpm

gzip filename.tar

This creates filename.tar.gz

Create an inventory item for the target deployment.

You can do this manually from the Inventory > Software page, or by installing the package on a managed device that regularly connects to the appliance. See About the Software page.

Associate the TAR.GZ file with the inventory item, and upload it to the appliance:

On the left navigation bar, click Distribution, then click Managed Installations.

Select Choose Action > New.

Select the application title with which the TAR.GZ file is associated from the Software drop-down list.

During installation, the file is uncompressed and the installation command runs against each of the RPM packages.

If no Additional Parameters are provided, -U is used.

You do not need to specify a full command line. The appliance runs the installation command by itself. The Linux device tries to install using:

rpm [-U | Run Parameters] "packagename.tgz"

Optional: If you have many files, create a ZIP archive that contains them, then direct the appliance to unpack the archive and run a specific file.

To do this, place the name of the file that you want to run in the command (executable) field within the deployment package (for example, runthis.exe). Provide additional package details. See Using Managed Installations.

Click Save.

The KACE Agent automatically runs deployment packages with RPM extensions.

Create Managed Installations for macOS X devices

You can create Managed Installations for macOS X devices as needed.

To distribute applications to managed devices, you must attach the digital assets, which are the files required for installation, to the application. In addition, you must select the supported operating systems for the application. See Attach digital assets to applications and select supported operating systems.

Go to the Managed Installation Detail page:

On the left navigation bar, click Distribution, then click Managed Installations.

Select Choose Action > New.

Select the application in the Software drop-down list.

By default, the KACE Agent attempts to install the PKG file using the following command:

installer -pkg packagename.pkg -target / [Run Parameters]

If you have selected a DMG, ZIP, or TGZ, the contents are unpacked and the root directory is searched for all PKG files. The installation command runs against each of these PKG files and processes them in alphabetical order.

Next, the appliance searches for all plain applications (APP) on the top level of the archive and copies them to the Applications folder using the following command:

ditto -rscs Application.app /Applications/Application.app

To run a script or change any of these command lines, you can specify the appropriate script invocation as the Full Command Line. You can specify wildcards in the filenames you use. Enclose the filename in single or double quotation marks if it contains spaces. The files are extracted into a directory in /tmp, and that becomes the current working directory of the command.

Tip:	TIP: If you only want to run your script on Mac OS X, you do not need to include any other files in your archive.

If the package requires additional options, provide the following information:

Option

Description

Name

A name that identifies the Managed Installation. This name appears on the Managed Installations page.

Execution

The package deployment setting. Options include:

•

Disabled: Do not deploy the package.

•

Anytime: Deploy the package at the next opportunity, such as the next time the KACE Agent reports inventory information to the appliance.

•

At bootup: Deploy the package the next time the device starts up.

NOTE: If a device has an Active Directory or Group Policy Object setting that displays a message that the user must acknowledge before logging on, packages are not deployed and scripts do not run until the message is acknowledged.

•

After login: Deploy the package after the user logs in but before the desktop loads.

•

With user logged in: Deploy the package while the user is logged on.

•

With user logged off: Deploy the package only when the device is running and the user is logged off.

Inventory

Indicate if you want to deploy the software title from Cataloged Software or all Software by selecting one of these options.

•

To search for a specific title, begin typing in the Software or Cataloged Software field.

NOTE: Reclaiming unused software licenses only. The name of the software that you want to uninstall appears in this field by default. For more information, see Reclaim unused software licenses.

•

If you want to display only the software that has one or more associated files, select Only Display Software With an Associated File.

Associated File

A Software and Cataloged Software title can have one or more files attached to them, as needed. Indicate if you want to select a specific file associated with the selected software title.

•

Do not associate file: Select this option if you do not want to associate a file.

Alternate Location

Specify a location from which files can be downloaded for a specific Managed Installation.

Path: Enter the location where the KACE Agent can retrieve digital installation files.

Checksum: Enter an alternate checksum (MD5) that matches the MD5 checksum on the remote file share. If no checksum is entered, the digital asset on the file share must match the digital asset associated with the deployment package on the appliance. Also, the target path must include the complete filename (for example, \\fileserver_one\software\adobe.exe). You can create the checksum using any tool, including KDeploy.exe, which is installed with the KACE Agent.

To create the checksum using KDeploy.exe:

On a device with the KACE Agent installed, open a command prompt or terminal window.

Go to the Quest KACE installation directory. For example:

Windows 32-bit devices: C:\Program Files\Quest\KACE

Windows 64-bit devices: C:\Program Files (x86)\Quest\KACE

Mac OS X devices: /Library/Application Support/Quest/KACE/bin

Enter the following command: KDeploy -hash=filename

Where filename is the UNC path to the file. If the path contains spaces, enclose the entire path in double quotation marks.

Press Ctrl C or Command C to copy the MD5 checksum. You can then paste it into other files, such as Notepad.