KACE Systems Management Appliance 9.1 Common Documents - Administrator Guide

About the KACE Systems Management Appliance (SMA) Getting started
Configuring the appliance
Requirements and specifications Power-on the appliance and log in to the Administrator Console Access the Command Line Console Tracking configuration changes Configuring System-level and Admin-level General Settings Configure appliance date and time settings Enable Two-Factor Authentication for all users Verifying port settings, NTP service, and website access Configuring network and security settings Configuring Agent settings Configuring session timeout and auto-refresh settings Configuring locale settings Configuring the default theme Configure data sharing preferences About DIACAP compliance requirements Configuring Mobile Device Access Enable fast switching for organizations and linked appliances Linking Quest KACE appliances Configuring history settings
Setting up and using labels to manage groups of items Configuring user accounts, LDAP authentication, and SSO Using Replication Shares Managing credentials Configuring assets
About the Asset Management component Using the Asset Management Dashboard About managing assets Adding and customizing Asset Types and maintaining asset information Managing Software assets Managing physical and logical assets Maintaining and using manual asset information Managing locations Managing contracts Managing licenses Managing purchase records
Setting up License Compliance Managing License Compliance Setting up Service Desk Configure the Cache Lifetime for Service Desk widgets Creating and managing organizations Importing and exporting appliance resources
Managing inventory
Using the Inventory Dashboard Using Device Discovery Managing device inventory
About managing devices Features available for each device management method About inventory information Tracking changes to inventory settings Managing inventory information Finding and managing devices Provisioning the KACE SMA Agent Manually deploying the KACE SMA Agent Using Agentless management Adding devices manually in the Administrator Console or by using the API Forcing inventory updates Managing MIA devices Obtaining Dell warranty information
Managing applications on the Software page Managing Software Catalog inventory
About the Software Catalog Viewing Software Catalog information Adding applications to the Software Catalog Managing License assets for Software Catalog applications Associate Managed Installations with Cataloged Software Using software metering Using Application Control Update or reinstall the Software Catalog
Managing process, startup program, and service inventory Writing custom inventory rules
Deploying packages to managed devices
Distributing software and using Wake-on-LAN Broadcasting alerts to managed devices Running scripts on managed devices Managing Mac profiles Using Task Chains
Patching devices and maintaining security
About patch management Subscribing to and downloading patches Creating and managing patch schedules Managing patch inventory Managing Dell devices and updates Maintaining device and appliance security
Using reports and scheduling notifications Monitoring servers
Getting started with server monitoring Working with monitoring profiles Managing monitoring for devices Working with alerts
Using the Service Desk
Configuring Service Desk Using the Service Desk Dashboard Managing Service Desk tickets, processes, and reports
Overview of Service Desk ticket lifecycle Creating tickets from the Administrator Console and User Console Creating and managing tickets by email Viewing tickets and managing comments, work, and attachments Merging tickets Using the ticket escalation process Using Service Desk processes Using Ticket Rules Run Service Desk reports Archiving, restoring, and deleting tickets Managing ticket deletion
Managing Service Desk ticket queues About User Downloads and Knowledge Base articles Customizing Service Desk ticket settings Configuring SMTP email servers
Maintenance and troubleshooting
Maintaining the appliance Troubleshooting the KACE SMA
Appendixes Glossary About us Legal notices

Obtaining Agent installation files

Obtaining Agent installation files

Agent installation files are available on the appliance.

You can find the KACE SMA Agent installers for Windows, Mac OS X, and Linux devices on the KACE SMA in the following directory:

\\KACE_SMA_hostname\client\agent_provisioning

* 
NOTE: File sharing must be enabled to access the installers. See Enable file sharing at the System level.

Manually deploying the KACE SMA Agent on Windows devices

Manually deploying the KACE SMA Agent on Windows devices

Manually deploy the KACE SMA Agent on Windows devices using the installation wizard
Manually deploy the KACE SMA Agent on Windows devices using the Command line
Manage the KACE SMA Agent on Windows devices using the Windows system tray

You can manually deploy the KACE SMA Agent on Windows devices using the installation wizard or from the command line on devices.

When you install the Agent manually, the Agent executable files must be installed in the following locations:

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

The Agent configuration files, logs, and other data are stored in:

•
Windows 32-bit devices: C:\Documents and Settings\All Users\Quest\KACE
•
Window 64-bit devices: C:\ProgramData\Quest\KACE
Manually deploy the KACE SMA Agent on Windows devices using the installation wizard

You can manually deploy the KACE SMA Agent on Windows devices by running the installation wizard on devices.

1.
Go to the shared directory of the appliance:
\\KACE_SMA_hostname\client\agent_provisioning\windows_platform
2.
Copy the ampagent-6.x.xxxxx-x86.msi file to the device.
3.
Double-click the file to start the installation and follow the instructions in the installation wizard.

The device information appears in the appliance Inventory within a few minutes. See Managing applications on the Software page.

Manually deploy the KACE SMA Agent on Windows devices using the Command line

There are several ways to deploy the Agent from the command line on Windows devices.

For example:

•
In a batch file as part of a logon script that runs the installer (msiexec) and sets various parameters, such as the value of the host.
•
Set an environment variable for the server name then run the installer.
•
Change name of the installer, which automatically sets the server name during the installation.

The following table shows command line parameters used to deploy the Agent.

Table 20. Command line parameters for the Agent

Description

Parameter

Windows Installer Tool

msiexec or msiexec.exe

Install flag

/i

Example:

msiexec /i ampagent-6.x.xxxxx-x86

Uninstall flag

/x

Example:

msiexec /x ampagent-6.x.xxxxx-x86

Silent install

/qn

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86

Log verbose output

/L*v log.txt

Example:

msiexec /qn /L*v C:\temp\log.txt /i ampagent-6.x.xxxxx-x86

Auto set hostname: Rename the installation file to the name of the server name, which automatically sets the hostname

rename agent_installer.msi_hostname.msi

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86_kace_sma.example.com.msi

Set properties

PROPERTY=value (Must use ALL CAPS)

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com

Set server name

set KACE_SERVER=kace_sma_name

Must be followed by an msiexec call to install

Example:

set KACE_SERVER=kboxmsiexec /i ampagent-6.x.xxxxx-x86

Prevent the installation of logon or bootup hooks, and preserve existing userinit.exe files

NOHOOKS=1

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com NOHOOKS=1

Install the Agent but do not start the service. This enables the Agent to be imaged and cloned to other devices

CLONEPREP=yes/no

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com CLONEPREP=yes

Set the debug level for the Agent when it generates logs

DEBUG=true/all

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com DEBUG=true

Force the Agent to communicate through HTTPS only. It cannot fall back to HTTP if HTTPS is unavailable

SSLREQUIRED=true

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com SSLREQUIRED=true

The system looks for the value of host in these locations in the order shown:

1.
The installer file
2.
The HOST property value
3.
KACE_SERVER (environment variable)
4.
The amp.conf file
* 
CAUTION: If you leave the host value empty, you must set the environment variable. Otherwise, the Agent will not connect to the appliance. Quest recommends that you use the fully qualified domain name as the hostname.
Manage the KACE SMA Agent on Windows devices using the Windows system tray

You can view the status of the KACE SMA Agent, force inventory, and display agent information using the Windows system tray.

To access the KACE SMA Agent status using the system tray, you must enable the Agent Status On Device option in the Communication Settings section. For more information, see Configure Agent communication and log settings.

1.
On the Windows device where KACE SMA Agent is running, in the Windows system tray, click .
The agent menu appears.
2.
To find out if the agent is connected to the appliance, observe the icon on the right of the Status option in the menu.
3.
To run the device inventory, click Inventory in the menu.
4.
To find out more information about the agent application in the system tray, click About.

Manually deploy the KACE SMA Agent on Windows devices using the installation wizard

Manually deploying the KACE SMA Agent on Windows devices

Manually deploy the KACE SMA Agent on Windows devices using the installation wizard
Manually deploy the KACE SMA Agent on Windows devices using the Command line
Manage the KACE SMA Agent on Windows devices using the Windows system tray

You can manually deploy the KACE SMA Agent on Windows devices using the installation wizard or from the command line on devices.

When you install the Agent manually, the Agent executable files must be installed in the following locations:

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

The Agent configuration files, logs, and other data are stored in:

•
Windows 32-bit devices: C:\Documents and Settings\All Users\Quest\KACE
•
Window 64-bit devices: C:\ProgramData\Quest\KACE
Manually deploy the KACE SMA Agent on Windows devices using the installation wizard

You can manually deploy the KACE SMA Agent on Windows devices by running the installation wizard on devices.

1.
Go to the shared directory of the appliance:
\\KACE_SMA_hostname\client\agent_provisioning\windows_platform
2.
Copy the ampagent-6.x.xxxxx-x86.msi file to the device.
3.
Double-click the file to start the installation and follow the instructions in the installation wizard.

The device information appears in the appliance Inventory within a few minutes. See Managing applications on the Software page.

Manually deploy the KACE SMA Agent on Windows devices using the Command line

There are several ways to deploy the Agent from the command line on Windows devices.

For example:

•
In a batch file as part of a logon script that runs the installer (msiexec) and sets various parameters, such as the value of the host.
•
Set an environment variable for the server name then run the installer.
•
Change name of the installer, which automatically sets the server name during the installation.

The following table shows command line parameters used to deploy the Agent.

Table 20. Command line parameters for the Agent

Description

Parameter

Windows Installer Tool

msiexec or msiexec.exe

Install flag

/i

Example:

msiexec /i ampagent-6.x.xxxxx-x86

Uninstall flag

/x

Example:

msiexec /x ampagent-6.x.xxxxx-x86

Silent install

/qn

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86

Log verbose output

/L*v log.txt

Example:

msiexec /qn /L*v C:\temp\log.txt /i ampagent-6.x.xxxxx-x86

Auto set hostname: Rename the installation file to the name of the server name, which automatically sets the hostname

rename agent_installer.msi_hostname.msi

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86_kace_sma.example.com.msi

Set properties

PROPERTY=value (Must use ALL CAPS)

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com

Set server name

set KACE_SERVER=kace_sma_name

Must be followed by an msiexec call to install

Example:

set KACE_SERVER=kboxmsiexec /i ampagent-6.x.xxxxx-x86

Prevent the installation of logon or bootup hooks, and preserve existing userinit.exe files

NOHOOKS=1

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com NOHOOKS=1

Install the Agent but do not start the service. This enables the Agent to be imaged and cloned to other devices

CLONEPREP=yes/no

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com CLONEPREP=yes

Set the debug level for the Agent when it generates logs

DEBUG=true/all

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com DEBUG=true

Force the Agent to communicate through HTTPS only. It cannot fall back to HTTP if HTTPS is unavailable

SSLREQUIRED=true

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com SSLREQUIRED=true

The system looks for the value of host in these locations in the order shown:

1.
The installer file
2.
The HOST property value
3.
KACE_SERVER (environment variable)
4.
The amp.conf file
* 
CAUTION: If you leave the host value empty, you must set the environment variable. Otherwise, the Agent will not connect to the appliance. Quest recommends that you use the fully qualified domain name as the hostname.
Manage the KACE SMA Agent on Windows devices using the Windows system tray

You can view the status of the KACE SMA Agent, force inventory, and display agent information using the Windows system tray.

To access the KACE SMA Agent status using the system tray, you must enable the Agent Status On Device option in the Communication Settings section. For more information, see Configure Agent communication and log settings.

1.
On the Windows device where KACE SMA Agent is running, in the Windows system tray, click .
The agent menu appears.
2.
To find out if the agent is connected to the appliance, observe the icon on the right of the Status option in the menu.
3.
To run the device inventory, click Inventory in the menu.
4.
To find out more information about the agent application in the system tray, click About.

Manually deploy the KACE SMA Agent on Windows devices using the Command line

Manually deploying the KACE SMA Agent on Windows devices

Manually deploy the KACE SMA Agent on Windows devices using the installation wizard
Manually deploy the KACE SMA Agent on Windows devices using the Command line
Manage the KACE SMA Agent on Windows devices using the Windows system tray

You can manually deploy the KACE SMA Agent on Windows devices using the installation wizard or from the command line on devices.

When you install the Agent manually, the Agent executable files must be installed in the following locations:

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

The Agent configuration files, logs, and other data are stored in:

•
Windows 32-bit devices: C:\Documents and Settings\All Users\Quest\KACE
•
Window 64-bit devices: C:\ProgramData\Quest\KACE
Manually deploy the KACE SMA Agent on Windows devices using the installation wizard

You can manually deploy the KACE SMA Agent on Windows devices by running the installation wizard on devices.

1.
Go to the shared directory of the appliance:
\\KACE_SMA_hostname\client\agent_provisioning\windows_platform
2.
Copy the ampagent-6.x.xxxxx-x86.msi file to the device.
3.
Double-click the file to start the installation and follow the instructions in the installation wizard.

The device information appears in the appliance Inventory within a few minutes. See Managing applications on the Software page.

Manually deploy the KACE SMA Agent on Windows devices using the Command line

There are several ways to deploy the Agent from the command line on Windows devices.

For example:

•
In a batch file as part of a logon script that runs the installer (msiexec) and sets various parameters, such as the value of the host.
•
Set an environment variable for the server name then run the installer.
•
Change name of the installer, which automatically sets the server name during the installation.

The following table shows command line parameters used to deploy the Agent.

Table 20. Command line parameters for the Agent

Description

Parameter

Windows Installer Tool

msiexec or msiexec.exe

Install flag

/i

Example:

msiexec /i ampagent-6.x.xxxxx-x86

Uninstall flag

/x

Example:

msiexec /x ampagent-6.x.xxxxx-x86

Silent install

/qn

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86

Log verbose output

/L*v log.txt

Example:

msiexec /qn /L*v C:\temp\log.txt /i ampagent-6.x.xxxxx-x86

Auto set hostname: Rename the installation file to the name of the server name, which automatically sets the hostname

rename agent_installer.msi_hostname.msi

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86_kace_sma.example.com.msi

Set properties

PROPERTY=value (Must use ALL CAPS)

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com

Set server name

set KACE_SERVER=kace_sma_name

Must be followed by an msiexec call to install

Example:

set KACE_SERVER=kboxmsiexec /i ampagent-6.x.xxxxx-x86

Prevent the installation of logon or bootup hooks, and preserve existing userinit.exe files

NOHOOKS=1

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com NOHOOKS=1

Install the Agent but do not start the service. This enables the Agent to be imaged and cloned to other devices

CLONEPREP=yes/no

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com CLONEPREP=yes

Set the debug level for the Agent when it generates logs

DEBUG=true/all

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com DEBUG=true

Force the Agent to communicate through HTTPS only. It cannot fall back to HTTP if HTTPS is unavailable

SSLREQUIRED=true

Example:

msiexec /qn /i ampagent-6.x.xxxxx-x86.msi HOST=kace_sma.example.com SSLREQUIRED=true

The system looks for the value of host in these locations in the order shown:

1.
The installer file
2.
The HOST property value
3.
KACE_SERVER (environment variable)
4.
The amp.conf file
* 
CAUTION: If you leave the host value empty, you must set the environment variable. Otherwise, the Agent will not connect to the appliance. Quest recommends that you use the fully qualified domain name as the hostname.
Manage the KACE SMA Agent on Windows devices using the Windows system tray

You can view the status of the KACE SMA Agent, force inventory, and display agent information using the Windows system tray.

To access the KACE SMA Agent status using the system tray, you must enable the Agent Status On Device option in the Communication Settings section. For more information, see Configure Agent communication and log settings.

1.
On the Windows device where KACE SMA Agent is running, in the Windows system tray, click .
The agent menu appears.
2.
To find out if the agent is connected to the appliance, observe the icon on the right of the Status option in the menu.
3.
To run the device inventory, click Inventory in the menu.
4.
To find out more information about the agent application in the system tray, click About.
Documents connexes