Chat now with support
Chat with Support

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

About the KACE Service Desk 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 Managing user notifications Enable Two-Factor Authentication for all users Verifying port settings, NTP service, and website access Configuring network and security 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 Configuring Content Security Policy
Setting up and using labels to manage groups of items Configuring user accounts, LDAP authentication, and SSO Deploying the KACE Agent to managed devices 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 Registering KACE Agent with the appliance Provisioning the KACE Agent Manually deploying the KACE Agent Using Agentless management Adding devices manually in the Administrator Console or by using the API Forcing inventory updates About Remote Control 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 Using Task Chains
Patching devices and maintaining security
Using the Security Dashboard About patch management Subscribing to and downloading patches Creating and managing patch schedules Managing patch inventory Managing Windows Feature Updates Managing Dell devices and updates Managing Linux package upgrades Manage quarantined file attachments
Using reports and scheduling notifications Monitoring devices
Getting started with 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 appliance
Appendixes Glossary About us Legal notices

Change appliance network settings

Change appliance network settings

You can change the appliance network settings to meet the needs of your environment any time after the initial configuration.

For virtual versions of the appliance, network settings are initially configured during the first login to the Administrator Console or the Command Line Console. See Change appliance network settings.

For K1 as a Service, the appliance is preconfigured with a static IP address, subnet mask, and default gateway. For configuration information, see the KACE as a Service Setup Guide. Go to https://support.quest.com/k1000-as-a-service/release-notes-guides.

Changing the majority of appliance network settings requires that you reboot the appliance. Total reboot downtime is one to two minutes, provided that the changes result in a valid configuration.

Tip:
 
1.
Go to the appliance Control Panel:
If the Organization component is enabled on the appliance, log in to the appliance System Administration Console, https://appliance_hostname/system, or select System in the drop-down list in the top-right corner of the page, then select Settings > Control Panel.
2.
Under the Network Settings section, click Configure DNS to display the General tab on the Network Settings page.
3.
On the Network Settings page, in the Geneal section, provide the following information:

Option

Description

DNS Hostname

Enter the hostname of the appliance. The default is k1000.

Web Server Name

Enter the fully-qualified domain name of the appliance. This is the Hostname concatenated with Domain. For example: k1000.example.com. Devices connect to the appliance using this name. Quest recommends that you add a static IP address entry for the appliance to your DNS server. If you use an SSL certificate, the hostname must be fully qualified and it must match the name on the certificate.

Automatically generate server name

Select this check box to enable the system to generate the appliance web server name using this format: Hostname.Domain. For example: k1000.example.com. Clear this check box to enter a custom web server name.

4.
In the IPv4 Configuration tab, provide the following information:

Option

Description

Configure Network Using DHCP

Select this option if you want to use DHCP (Dynamic Host Configuration Protocol) to automatically obtain the IPv4 address and other network configuration information for the appliance.

Configure Network Manually

Select this option if you want to manually specify the IPv4 address, domain, subnet mask, default gateway, and DNS settings for the appliance:

IP Address: Enter the static IP address of the appliance.
CAUTION:
 
CAUTION: If the IP address is incorrect, you cannot access the appliance through the web interfaces (Administrator Console and User Console). If this happens, open the appliance Command Line Console, and use the konfig login to enter the correct IP address.
Domain: Enter the domain that the appliance is on. For example, example.com.
Subnet Mask: Enter the subnet (network segment) that the appliance is on. The default is 255.255.255.0.
Default Gateway: Enter the network gateway for the appliance.
Primary DNS: Enter the IP address of the primary DNS server the appliance uses to resolve host names.
Secondary DNS: (Optional) Enter the IP address of the secondary DNS server the appliance uses to resolve host names.
5.
In the IPv6 Configuration tab, provide the following information:

Option

Description

Configure Network Using SLAAC

Select this option if you want to use the SLAAC (stateless address auto-configuration), offered by IPv6, to configure the appliance's network settings. SLAAC allows devices to select their own IPv6 addresses based on the prefix that is advertised from their connected interface.

Configure Network Manually

Select this option if you want to manually specify the IPv6 address, prefix length, and default gateway for the appliance:

IPv6 Address: Enter the static IPv6 address of the appliance.
CAUTION:
 
CAUTION: If the IP address is incorrect, you cannot access the appliance through the web interfaces (Administrator Console and User Console). If this happens, open the appliance Command Line Console, and use the konfig login to enter the correct IP address.
Prefix Length: Enter the number of bits in the IPv6 address prefix. An IPv6 prefix typically consists of 64 bits.
Default Gateway: Enter the network gateway for the appliance.

Disable IPv6

Select this option if you want to disable an IPv6 address for the appliance. This is the default setting.

6.
Optional: To set a proxy server, select the Enable Proxy Server in the Proxy Configuration tab, then specify proxy server settings:

Option

Description

Type

Enter the proxy type, either HTTP or SOCKS5.

Server

Enter the name of the proxy server.

Port

Enter the port for the proxy server. The default port is 8080.

Enable Basic Proxy Authentication

Select the check box to use the local credentials for accessing the proxy server.

Login

Enter the username for accessing the proxy server.

Password and Confirm Password

Enter the password for accessing the proxy server.

7.
To use an external SMTP server, select Enable SMTP Remote Server (Outbound Relay) in the SMTP tab, then specify SMTP server options:

Option

Description

Server

Specify the hostname or IP address of an external SMTP server, such as smtp.gmail.com. External SMTP servers must allow anonymous (non-authenticated) outbound email transport. Ensure that your network policies allow the appliance to contact the SMTP server directly. In addition, the mail server must be configured to allow the relaying of email from the appliance without authentication. If you specify an IP address, enclose the address in brackets. For example [10.10.10.10].

Port

Enter the port number to use for the external SMTP server. For standard SMTP, use port 25. For secure SMTP, use port 587.

Login

Enter the username of an account that has access to the external SMTP server, such as your_account_name@gmail.com.

Password and Confirm Password

Enter the password of the specified server account.

a.
Click Test Connection.
b.
In the Connection Test SMTP dialog box that appears, type the email address to which you want to send a test email using the newly configured SMTP server, and click Send Test Email.
The Connection Test SMTP dialog box refreshes, showing the test results. status of the email operation. If the test fails, verify your configuration, and try again.
9.
Click Save.

Configure local routing tables

Configure local routing tables

Configure local routing tables to enable the appliance to route traffic through multiple gateways on a network.

Local routing tables are useful when the physical appliance is located in one office, and managed devices are located in a different location. For example, if the appliance is located in Texas, and managed devices are located in California, the appliance would serve devices on the Texas subnet. Using the a local routing table, the appliance could be pointed to the network in California, so that it could host the California devices as well as the Texas devices.

1.
Go to the appliance Control Panel:
If the Organization component is enabled on the appliance, log in to the appliance System Administration Console, https://appliance_hostname/system, or select System in the drop-down list in the top-right corner of the page, then select Settings > Control Panel.
2.
Click Local Routing Table to display the Local Routing Table Settings page.
3.
Click the Add button to add an entry: .

Option

Description

Name

Enter a name for the route.

Destination

Enter the IP address or network for the destination with which you want your appliance to communicate.

Subnet Mask or CIDR

Enter the subnet mask of the specified network. For example: 24, 255.255.240.0. This is applied to the host.

Gateway

Enter the IP address of the router that routes traffic between the appliance and the destination network.

5.
Click Add at the end of the row to save the entry.
6.
Click Save and Reboot at the bottom of the page to save all changes.
7.
Click OK to continue.

Configure local web server settings and allow access to hosts

Configure local web server settings and allow access to hosts

You can configure local web server settings to specify an allow list of hosts that are allowed to access the Administrator Console, System Administration Console, and the User Console. After you create the allow list, access is restricted to the hosts on the allow list.

NOTE: After an IP address or domain name is added to the Allow List, only that IP address or domain has access. All others are blocked.
1.
Go to the appliance Control Panel:
If the Organization component is enabled on the appliance, log in to the appliance System Administration Console, https://appliance_hostname/system, or select System in the drop-down list in the top-right corner of the page, then select Settings > Control Panel.
2.
In the Access Control List section, click the Limit appliance access to acceptable networks option to display the Access Control List Details page.

Option

Description

No access restrictions

Select this option to allow access from any web address.

Restrict access as specified below

Select this option to restrict access to web addresses on the Allow List. To enable access to IP addresses on the appliance’s subnet in addition to the specified destinations, select Allow all IP addresses in the same subnet as the appliance.

4.
In the Allow List section, click the Add button to add an entry: .

Option

Description

Destination

Specify the destination:

adminui: This is the Administrator Console, Admin level. An allow list of IP addresses and/or host names who can log in to http://appliance_hostname/admin.
userui: This is the User Console. An allow list of IP addresses and/or host names who can log in to http://appliance_hostname/user.
systemui: This is the System Administration Console (available only if the Organization component is enabled on the appliance). An allow list of IP addresses and/or host names who can log in to http://appliance_hostname/system.
api: This is the appliance API. An allow list of IP addresses and/or host names who can access the appliance using its API, including the KACE GO app.

IP Address/Domain Name

Provide the address to be allowed. This can be either:

Subnet Mask/CIDR/Prefix Length

Provide a subnet mask/CIDR (Classless Inter-Domain Routing) to be allowed. This enables a finer-grained subnet control.

6.
Click Save at the end of the row to save the entry.
7.
Click Save at the bottom of the page to save all changes.
8.
Click OK to continue.
NOTE: After an IP address or domain name is added to the Allow List, only that IP address or domain can access that page. All others are blocked.

Configure security settings for the appliance

Configure security settings for the appliance

You must configure appliance security settings to enable certain capabilities such as Samba share, SSL, SNMP, SSH, database access, and FTP access.

To enable SSL, you need to have the correct SSL private key file and a signed SSL certificate. If your private key has a password, the appliance cannot restart automatically. If you have this issue, contact Quest Support at https://support.quest.com/contact-support.

In some cases, the Firefox® browser does not display the Administrator Console login page correctly after you enable access to port 443 and restart the appliance. If that happens, clear the Firefox browser cache and cookies, then try again.
1.
Go to the appliance Control Panel:
If the Organization component is enabled on the appliance, log in to the appliance System Administration Console, https://appliance_hostname/system, or select System in the drop-down list in the top-right corner of the page, then select Settings > Control Panel.
2.
In the Security Settings section, click Configure network security and accessibility to display the Security Settings page.

Option

Description

Enable SSH

Permit SSH logins to the appliance. When SSH is enabled, SSH encrypted communications are permitted over port 22.

Enable SNMP READ access

Enable unidirectional (read-only) SNMP access to managed devices on the network through port 199 using SMUX, an SNMP multiplexing protocol. See Verify port settings.

SNMP Community String

The SNMP community string that enables read-only SNMP access. The default value is public.

Enable SNMP Trap monitoring

Enable SNMP (Simple Network Management Protocol), a protocol for monitoring managed devices on a network. SNMP is supported by Dell Open Manage and many third-party products. If you do not want to receive SNMP traps from network devices, clear this option.

When you enable this feature on the appliance, and the related devices are also enabled for monitoring, the appliance can receive SNMP traps from the monitored network devices such as printers, projectors, and routers. This feature only applies to network devices managed through the SNMP-managed devices, such as agentless devices using SNMP connections.

For information on how to enable device monitoring, see Enable monitoring for one or more devices.

SNMP traps are messages initiated by network devices and sent to the trap receiver on the appliance. For example, a router can send a message when its power supply fails. Or, a printer initiates a message when it runs out of paper. The appliance receives these traps and generates alerts when certain pre-defined thresholds are reached.

SNMP version 1 or 2: This version only requires a valid community string. A community string is required to allow the appliance to receive SNMP trap messages from monitored network devices. The appliance supports multiple security strings. To add a community string, open the v1/v2 tab, click , type the community string, and click Save.
SNMP version 3: This version implements enhanced security and remote configuration features and requires a valid user name and encryption information. To add a security name, open the v3 tab, click , and provide the following information:
Security Name: The name of the User-based Security Model (USM) account that sends the SNMP trap.
Engine ID: The ID of the SNMP application engine that sends the SNMP trap.
Authentication Password: The password associated with the Security Name.
Authentication Protocol: The protocol used for authenticating the user: MD5 or SHA.
Privacy Password: The encryption key for the data packet.
Privacy Protocol: The encryption protocol: AES or DES.
Security Level: Indicates the level of security:
authPriv: The identity of the sender is verified and the information is encrypted.
authNoPriv: The identity of the sender is verified, but the information is not.
noAuthNoPriv: The identity of the sender is not verified and the information is not encrypted.

MIB Files

Upload vendor-specific MIB (management information base) files. A MIB file allows the trap receiver on the appliance to translate SNMP traps into human-readable messages. These files are optional.

To upload a MIB file, on the Security Settings page, under MIB Files, in the Upload MIB area, click Browse, and select a MIB file.
A MIB file must meet certain standards. The appliance validates every MIB file that you upload. If you upload an invalid MIB file, an error message appears along the top of the Security Settings page. If you do not want to validate the contents of the MIB file, select the Skip MIB validation check box.

Enable Secure backup files

Require username and password authentication for access to appliance backup files, which are available by entering a URL in a browser.

Clear this option to enable access to backup files through a URL without username or password authentication. This is useful for external process that require access. See About appliance backups.

Enable backup via FTP

Enable access to the database backup files through a read-only FTP server. This enables you to create a process on another server to access the backup files.

If you do not need this access, clear this option.

Make FTP writable

Enable the upload of backup files using FTP. FTP is useful for backup files that are too large for the default HTTP mechanism and cause browser timeouts.

New FTP user password

Require a password for FTP access to the backup files.

Enable mDNS

Enable the appliance to respond to multicast Domain Name System (mDNS) and DNS Service Discovery (DNS-SD) requests. This option makes it easier for users and administrators to locate the Administrator Console and User Console. If you do not need the appliance to respond to these requests, clear this option.

Enable Munin access

Enable the appliance to view server usage and metrics over time.

Secure Service Desk Attachments

Choose whether to add security for files that are attached to Service Desk tickets:

Enable database access

Enable users to run reports on the appliance database using an external tool, such as Microsoft Access or Excel, over port 3306. If you do not need to expose the database in this way, clear this option.

Enable secure database access (SSL)

Enable SSL access to the database and access additional SSL options.

Enable remote syslog

Enable the appliance to send limited server log data to a remote Syslog server.

Remote Syslog Server

Specify the fully qualified domain name (FQDN) or IP address and the port number of the remote Syslog server. IPv4 and IPv6 addresses are supported. If you do not provide a port number, the appliance uses 514 (UDP), the default port number for Syslog traffic.

4.
In the Two-Factor Authentication tab, configure the Two-Factor Authentication (2FA) feature. 2FA provides stronger security for users logging into the appliance by adding an extra step to the login process. It relies on the Google Authenticator app to generate verification codes. The app generates a new six-digit code at regular intervals. When enabled, end users will be prompted for the current verification code each time they log in.
Enable Two-Factor Authentication for the System Portal: Select this check box if you want to use 2FA for the System Administration Console. To enable 2FA for all users, select Required for all Users.
Enable Two-Factor Authentication for the Admin Portal: This option only appears if you enabled 2FA for the System Administration Console, or if your appliance has only one organization. Select this check box if you want to use 2FA for the Administrator Console. Next, specify the users that will require 2FA during login by selecting one of the following options:
Required for all Users: Appliances with one organization only. To enable 2FA for all users, select this option.
Defined by Organization: Appliances with multiple organizations only. Apply the same 2FA configuration to all users in each Organization in the Administrator Console, as applicable.
Required for all Users: Appliances with multiple organizations only. Enable 2FA for all users in the Administrator Console.
Not required: Appliances with multiple organizations only. Disable 2FA for all users in the Administrator Console.
Enable Two-Factor Authentication for the User Portal: This option only appears if you enabled 2FA for the Administrator Console. Select this check box if you want to use 2FA for the User Console. Next, specify the users that will require 2FA during login by selecting one of the following options:
Defined by Organization: Apply the same 2FA configuration to all users in each Organization in the User Console, as applicable.
Required for all Users: Enable 2FA for all users in the User Console.
Not required: Disable 2FA for all users in the User Console.
b.
Under Transition Window, specify the amount of time during which users who require 2FA will be able to bypass the 2FA configuration step.
5.
Use the settings in the Brute Force Prevention area to prevent multiple consecutive attacks from obtaining access to the appliance using false credentials. You can configure the number of failed authentication attempts within a specified time frame, after which the appliance prevents any logins for that user.
6.
Optional: In the Appliance Encryption Key section, click Generate Key to generate a new encryption key. This key is used to enable Quest Support to access your appliance for troubleshooting using a tether. It is not necessary to generate a new key unless you believe that the current key has been compromised. See Enable a tether to Quest KACE Support.
7.
In the Single Sign On tab, specify authentication settings:

Option

Description

Disabled

Prevent the appliance from using single sign on. Single sign on enables users who are logged on to the domain to access the appliance Administrator Console and User Console without having to re-enter their credentials on the appliance login page.

Active Directory

Use Active Directory for authentication. Active Directory uses the domain to authenticate users on the network. See Using Active Directory for single sign on.

8.
In the Samba tab, specify the following settings:

Option

Description

For appliances with the Organization component enabled:

Enable Organization File Shares

For appliances without the Organization component:

Enable File Sharing

Use the appliance's client share to store files, such as files used to install applications on managed devices.

The appliance’s client share is a built-in Windows file server that can be used by the provisioning service to assist in distributing the Samba client on your network. Quest recommends that this file server only be enabled when you perform application installations on managed devices.

Samba minimum protocol, Samba maximum protocol

Select the minimum and maximum Samba protocol, as required. The following options are available in each setting:

SMB2: Re-implementation of the SMB protocol. Used by Windows Vista and later versions of Windows. SMB2 has sub protocols available. By default SMB2 selects the SMB2_10 variant.
SMB2_02: The earliest SMB2 version.
SMB2_10: Windows 7 SMB2 version.
SMB2_22: Early Windows 8 SMB2 version.
SMB2_24: Windows 8 beta SMB2 version.
SMB3: Re-implementation of the SMB2 protocol. Used by Windows 8. SMB3 has sub protocols available. By default SMB3 uses the SMB3_11 variant.
SMB3_00: Windows 8 SMB3 version (similar to SMB2_24).
SMB3_02: Windows 8.1 SMB3 version.
SMB3_10: Early Windows 10 technical preview version.
SMB3_11: Windows 10 technical preview version.

Require signing

Enables signing in for the Samba protocol.

Disable Guest Access

Disables Samba guest access.

Require NTLMv2 to appliance file shares

Enable NTLMv2 authentication for the appliance files shares. When this is enabled, managed devices connecting to the appliance File Shares require support for NTLMv2 and they authenticate to the appliance using NTLMv2. Although NTLMv2 is more secure than NTLM and LANMAN, non-NTLMv2 configurations are more common and this option is usually turned off. Enabling this option disables lanman auth and ntlm auth on the Samba server. NTLMv2 Levels 1-4 are supported. If you need NTLM v2 Level 5, consider manually provisioning the KACE Agent. See Manually deploying the KACE Agent.

Require NTLMv2 to off-board file shares

Force certain appliance functions that are supported through the Samba client, such as Agent Provisioning, to authenticate to off-board network file shares using NTLMv2. Even though NTLMv2 is more secure than NTLM and LANMAN, non-NTLMv2 configurations are more common and this option is usually disabled. Enabling this option enables the client ntlmv2 auth option for Samba client functions.

9.
Optional: In the SSL tab, specify SSL settings:
Important:
 

Option

Description

Enable Port 80 access

Enable access to the appliance over port 80.

If you disable port 80 access, contact Quest Support to adjust the Agent deployment scripts to handle SSL.

Enable Forward port 80 to port 443

When you verify that SSL is working as expected, you can enable the forwarding of all communication from port 80 to port 443. To do that, select this check box.

Enable SSL

Enable managed devices to connect to the appliance using SSL (HTTPS).

Enable this setting only after you have properly deployed the appliance on your LAN in non-SSL mode.

To enable SSL, you need to load an SSL certificate as described in step 10.

1.
Select Upload PEM SSL Certificate.
2.
In the SSL Private Key File and SSL Certificate File fields, select the private key and certificate files.
3.
If you want to enable and upload intermediate SSL certificates (also in PEM format), select Enable Intermediate SSL Certificate. Intermediate SSL certificates are signed certificates provided by certificate issuers as proxies for root certificates.
1.
Select Upload PKCS-12 SSL Certificate.
2.
In the PKCS-12 File field, select the file.
3.
In the Password for PKCS-12 file field, type the password for the PKCS-12 file.
1.
Click Apply Let's Encrypt SSL Certificate. Let’s Encrypt is a free, automated, and open certificate authority (CA). When you get a certificate from Let’s Encrypt, their servers validate that you control the domain names in that certificate using a challenge.
2.
In the Email Address field, provide an email address. While Let's Encrypt certificates periodically expire, the appliance uses an automated process to update the certificate before its expiration. The address is used for communication with Let's Encrypt in an unlikely event the certificate expires. You must have a Let's Encrypt account registered using this email address.
1.
Click Generate CSR (Certificate Signing Request) or Self-Signed SSL Certificate.
2.
In the area that appears, click SSL Certificate Form. Follow the instructions in Generate an SSL certificate.
11.
In the CSP tab, select the Enable CSP checkbox to enable CSP (Content Security Policy). Enabling the checkbox adds list of KACE trusted domains automatically.
If you want to add domains or URLs in the list, then in the Additional Allowed Domains section, click +, and specify the Directive and the Domain/URL. For more details, Configuring Content Security Policy
12.
In the Secure Attachments in Service Desk section, choose whether to add security for files that are attached to Service Desk tickets:
13.
Click Save and Restart Services to save changes and restart the appliance.
NOTE: In some cases, the Firefox browser does not display the Administrator Console login page correctly after you enable access to port 443 and restart the appliance. If that happens, clear the Firefox browser cache and cookies, then try again.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating