Chat now with support
Chat with Support

KACE Systems Management Appliance 14.0 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 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

Add and edit Secret Key credentials

Add and edit Secret Key credentials

To streamline the management of Secret Key credentials used in Inventory, Distribution, and Scripting, add those credentials to the Credentials Management page. Secret Key credentials can be created for devices managed using the KACE Cloud Mobile Device Manager.

•
You have the secret key from the KACE Cloud Mobile Device Manager.
•
You have administrator privileges in the Administrator Console.

After you add credentials, you can select them on configuration pages instead of entering the credentials manually each time. In addition, you can add credentials from any of the configuration pages that use them. Credentials added on configuration pages are automatically added to the Credentials Management page.

1.
Go to the Credentials Management page:
a.
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.
b.
On the left navigation bar, click Settings, then click Credentials.
2.
Select Choose Action > New.
3.
On the Add Credential form, specify credential properties:
* 
NOTE: You can also access this form from pages that use credentials, such as the Discovery Schedule Detail page. Credentials added on these pages are automatically added to the Credentials Management list.

Option

Description

Name

A unique name for the credential. This name appears on the Credentials Management list and in the credential selection drop-down lists in component sections, such as Scripting. This name is used for identification in Administrator Console, and it is not part of the actual credential on the target device.

Type

The classification of the credential. Select Secret Key to specify credentials that contain secret keys from the KACE Cloud Mobile Device Manager.

Secret

The secret key of the KACE Cloud Mobile Device Manager environment.

Show typing

Show the characters in the Password field on the Add Credential form. This option is available only when you are adding credentials. If you are editing existing credentials, the password characters cannot be displayed.

Notes

Any additional information you want to provide about the credential.

4.
Click Save.
The credential appears on the Credentials Management list and it is available for selection in components that use credentials.

Add and edit User/Password credentials

Add and edit User/Password credentials

To streamline the management of username and password credentials used in Inventory, Distribution, and Scripting, add those credentials to the Credentials Management page. User/Password credentials can be created for Mac, Windows, and Linux operating systems as well as VMware ESXi hosts and vCenter Servers.

•
You have the usernames and passwords of the credentials you want to manage.
•
You have administrator privileges in the Administrator Console.

After you add credentials, you can select them on configuration pages instead of entering the credentials manually each time. In addition, you can add credentials from any of the configuration pages that use them. Credentials added on configuration pages are automatically added to the Credentials Management page.

1.
Go to the Credentials Management page:
a.
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.
b.
On the left navigation bar, click Settings, then click Credentials.
2.
Select Choose Action > New.
3.
On the Add Credential form, specify credential properties:
* 
NOTE: You can also access this form from pages that use credentials, such as the Discovery Schedule Detail page. Credentials added on these pages are automatically added to the Credentials Management list.

Option

Description

Name

A unique name for the credential. This name appears on the Credentials Management list and in the credential selection drop-down lists in component sections, such as Scripting. This name is used for identification in Administrator Console, and it is not part of the actual credential on the target device.

Type

The classification of the credential. Select User/Password to specify credentials that have usernames and passwords.

User or Domain\User

The username required for the credential.

Tip:
 
TIP: The Domain\User format might be required for some Windows configurations.

Password

The password required for the credential.

Show typing

Show the characters in the Password field on the Add Credential form. This option is available only when you are adding credentials. If you are editing existing credentials, the password characters cannot be displayed.

Targets

The device types on which the credential can be used.

Tip:
 
TIP: You can select multiple device types, or operating systems, if the specified credentials can be used for authentication on multiple operating systems.

Notes

Any additional information you want to provide about the credential.

4.
Click Save.
The credential appears on the Credentials Management list and it is available for selection in components that use credentials.

Add and edit LDAP User/Password credentials

Add and edit LDAP User/Password credentials

To easily manage and password LDAP credentials, add those credentials to the Credentials Management page. LDAP User/Password credentials can be created for Mac, Windows, and Linux operating systems.

•
You have the LDAP user names and passwords of the credentials you want to manage.
•
You have administrator privileges in the Administrator Console.

After you add credentials, you can select them on configuration pages instead of entering the credentials manually each time. In addition, you can add credentials from any of the configuration pages that use them. Credentials added on configuration pages are automatically added to the Credentials Management page.

1.
Go to the Credentials Management page:
a.
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.
b.
On the left navigation bar, click Settings, then click Credentials.
2.
Select Choose Action > New.
3.
On the Add Credential form, specify credential properties:
* 
NOTE: You can also access this form from pages that use credentials, such as the Discovery Schedule Detail page. Credentials added on these pages are automatically added to the Credentials Management list.

Option

Description

Name

A unique name for the credential. This name appears on the Credentials Management list and in the credential selection drop-down lists on the LDAP Label Detail page. This name is used for identification in Administrator Console, and it is not part of the actual credential on the target device.

Type

The classification of the credential. Select LDAP User/Password to specify LDAP credentials that include user names and passwords.

User or Domain\User

The user name required for the credential.

Tip:
 
TIP: The Domain\User format is sometimes required for some Windows configurations.

Password

The password required for the credential.

Show typing

Show the characters in the Password field on the Add Credential form. This option is available only when you are adding credentials. If you are editing existing credentials, the password characters cannot be displayed.

Notes

Any additional information you want to provide about the credential.

4.
Click Save.
The credential appears on the Credentials Management list and it is available for selection in components that use credentials.

Add and edit Google Workspace credentials

Add and edit Google Workspace credentials

To streamline the management of Google Workspace credentials used in Inventory, Distribution, Scripting, and Service Desk, add the applicable credentials to the Credentials Management page.

The appliance can obtain access to a Google Workspace Domain using the Google APIs. The following appliance-managed components can be authenticated through Google API:

•
Google Workspace Device Discovery and Inventory: This includes both Chromebooks and mobile devices that are managed by a Google Workspace Domain (formerly G Suite). This type of authentication requires the following:
◦
You have a Google Workspace Domain with Chrome Device Management support.
◦
You have a Google User admin account that is a member of the domain. The account must be assigned the Super User role.
◦
You have a Google account that can be used as your developer account in this procedure. This account does not have to be the same as the Admin account, nor does it have to be a member of the business or education domain.
•
Service Desk Queue Inboud Email: This includes email accounts that are part of a Google Workspace or a public Gmail account. This type of authentication requires the following:
◦
You have a Gmail account.
◦
The following applies to your Service Account:
▪
The Gmail account belongs to a Google Workspace Domain.
▪
You have a Google User admin account that is a member of the domain, The account must be assigned the Super Admin role.
◦
You have a Google account that can be used as your developer account in this procedure. This account does not have to be the same as the admin account, nor does it have to be a member of the business or education domain.

For each of these component types, the appliance supports the following methods authentication by a Google API. The method you choose depends on the components using the Google Workspace credential and the preference or role of the appliance administrator.

•
Service Account authentication consists of a Service Account Key that is associated with a unique Client ID. A Google Workspace Super Admin can use the Client ID to grant the Service Account Domain Wide Access to a resource.
◦
This is a preferred method for Chromebook and Mobile Device Discovery and Inventory.
◦
It requires a configuration step using the Google Workspace Console by a Super Admin.
◦
It grants domain-wide access to a specific resource type. In the case of Service Desk Queue emails, this means the service account is granted access to any email inbox. It is up to the administrator to ensure that it is only used with the desired Service Desk email.
•
OAuth Client authentication consists of a OAuth Client ID that is used along with a Client Secret to request and grant access to a particular Google resource using a browser-based workflow.
◦
This is a preferred method for Service Desk Queue Inboud Email integration.
◦
It requires that the browser used to configure the credential in the Administrator Console connects to the appliance using a host name that is considered public (no private domains).
◦
It can be used with public Gmail accounts.

Start by creating one or more Google Workspace Service Account or OAuth credentials, as applicable. After you add credentials, you can select them on configuration pages instead of entering them manually each time. In addition, you can add credentials from any of the configuration pages that use them. Credentials added on configuration pages are automatically added to the Credentials Management page. The appliance does not validate stored Google OAuth credentials as you enter them, but attempting to save any changes using invalid credentials result in an error.

1.
Create and configure a Google Cloud Platform project.
a.
Sign in to your developer account at https://console.cloud.google.com.
b.
Assign a new name and ID to the project.
c.
Enable the desired Admin SDK API and/or Gmail API, as applicable.
2.
Service Account credentials only.
a.
While still logged in to the Google Cloud console, select IAM & Admin.
b.
Create a Service Account with a desired name and description.
c.
Add a Service Account Key and save the JSON key file.
d.
Record the OAuth 2 Client ID of the Service Account for later use.
3.
OAuth credentials only.
a.
While still logged in to the Google Cloud console, select APIs & Services, and go to the OAuth consent screen.
b.
If the developer account is part of the same Google Workspace domain as the resources being accessed, select Internal otherwise choose External.
c.
Create an app and specify its name, Support email address, and Developer contact email address.
d.
Add the following scopes:
▪
Device Discovery and Inventory only:
▪
https://www.googleapis.com/auth/admin.directory.device.chromeos
▪
https://www.googleapis.com/auth/admin.directory.device.mobile
▪
https://www.googleapis.com/auth/admin.directory.user
▪
Service Desk Queue email only:
▪
https://www.googleapis.com/auth/gmail.modify
e.
Create a credential and select OAuth Client ID.
f.
Choose Web Application as the Application type.
g.
Assign a name to the client.
h.
Provide the following URI: https://<appliance_hostname>/common/authorize.php, where appliance_hostname is the host name of the appliance Administrator Console.
i.
Record the Client ID and Client Secret for later use.
4.
Service Account credentials only (optional). Delegate a domain-wide authority to a Service Account. This step requires Super Admin access to the Google Workspace Admin console.
* 
NOTE: When authorizing the Gmail modify scope to a Service Account, access is granted to that service account for all mailboxes on the domain. Ensure that the Service Account Key credentials are protected accordingly.
a.
Sign in to the Google Admin console at https://admin.google.com/.
b.
Under Security > Access and data control > API Controls > Manage Domain Wide Delegation, create a new delegation and provide the Client ID of the Service Account that you created in 2.
c.
Add the following scopes:
▪
Device Discovery and Inventory only:
▪
https://www.googleapis.com/auth/admin.directory.device.chromeos
▪
https://www.googleapis.com/auth/admin.directory.device.mobile
▪
https://www.googleapis.com/auth/admin.directory.user
▪
Service Desk Queue email only:
▪
https://www.googleapis.com/auth/gmail.modify
5.
Go to the Credentials Management page:
a.
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.
b.
On the left navigation bar, click Settings, then click Credentials.
6.
Select Choose Action > New.
7.
On the Add Credential form, specify credential properties:

Option

Description

Name

A unique name for the credential. This name appears on the Credentials Management list and in the credential selection drop-down lists in component sections, such as Scripting. This name is used for identification in Administrator Console, and it is not part of the actual credential.

Type

The classification of the credential. Select Google Workspace or GMail, as applicable.

8.
Service Account credentials only. While still on the Add Credential form, specify the credential properties:

Option

Description

Service Account

Select this option.

Impersonation Account
•
Device Discovery and Inventory only: The email address of an administrator that has access to the devices in the Google Admin console.
•
Service Desk Queue email only: The email address from which you can receive inbound email.

Service Account Key

Navigate to the JSON file obtained in 2.

Notes

Any additional information you want to provide about the credential.

9.
OAuth credentials only. While still on the Add Credential form, specify the credential properties:

Option

Description

OAuth

Select this option.

Client ID

Your Google developer API Client ID obtained in 3.

Client Secret

Your Google developer API Client Secret obtained in 3.

Show typing

Show the characters in the Client Secret field on the Add Credential form. This option is available only when you are adding credentials. If you are editing existing credentials, the characters in the Client Secret field cannot be displayed.

Authorize Credential

Click, log in, and grant access to the desired Google account on the page that appears.

•
Device Discovery and Inventory only: The account of an administrator that has access to the devices in the Google Admin console.
•
Service Desk Queue email only: The email address from which you can receive inbound email.

Notes

Any additional information you want to provide about the credential.

10.
Click Save.
The credential is available for selection in components that use credentials.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating