Chat now with support
Chat with Support

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

Adding steps to task sections of scripts

Adding steps to task sections of scripts

You can add steps to scripts in the Scripting component.

The following tables detail the steps that can be added to the task sections of scripts. Task sections are available on the Script Detail page when you add a task. See Adding and editing scripts.

The column headings V, OS, R, ORS, and ORF indicate whether a particular step is available in the corresponding task sections: Verify, On Success, Remediation, On Remediation Success, and On Remediation Failure.

Steps for Windows devices

Table 34. Adding steps to scripts used on Windows devices

Step

Description

V

OS

R

ORS

ORF

Always fail

X

X

Call a custom DLL function

Call function "%{procName}" from "%{path}\%{file}".

X

X

X

Create a custom DLL object

Create object "%{className}" from "%{path}\%{file}".

X

X

X

Create a message window

Create a message window named "%{name}" with title "%{title}", message "%{message}" and timeout "%{timeout}" seconds.

X

X

X

X

X

Delete a registry key

Delete "%{key}" from the registry. See Specifying Windows registry paths.

X

X

Delete a registry value

Delete "%{key}!%{name}" from the registry. See Specifying Windows registry paths.

X

X

Destroy a message window

Destroy the message window named "%{name}".

X

X

X

X

X

Install an application package

Install "%{name}" with arguments "%{install_cmd}".

X

X

Kill a process

Kill the process "%{name}".

X

X

X

X

X

Launch a program

Launch "%{path}\%{program}" with params "%{parms}".

X

X

X

X

X

Log a registry value

Log "%{key}!%{name}".

X

Log file information

Log "%{attrib}" from ""%{path}\%{file}".

X

X

X

Log message

Log "%{message}" to "%{type}".

X

Restart a service

Restart service "%{name}"

X

Run a batch file

Run the batch file "%{_fake_name}" with params "%{parms}".

X

X

X

Set a registry key

Set "%{key}".

X

X

Set a registry value

Set "%{key}!%{name}" to "%{newValue}".

X

X

Start a service

Restart service "%{name}".

X

Stop a service

Stop service "%{name}"

X

Unzip a file

Unzip "%{path}\%{file}" to "%{target}".

X

X

X

X

Update message window text

Set the text in the message window named "%{name}" to "%{text}".

X

X

X

X

Update policy and job schedule

Update policy and job schedule from the appliance.

X

Upload a file

Upload "%{path}\%{file}" to the server.

X

X

Verify a directory exists

Verify that the directory "%{path}" exists.

X

Verify a file exists

Verify that the file "%{path}\%{file}" exists.

X

Verify a file version is exactly

Verify that the file "%{path}\%{file}" has version "%{expectedValue}".

X

Verify a file version is greater than

Verify that the file "%{path}\%{file}" has version greater than "%{expectedValue}".

X

Verify a file version is greater than or equal to

Verify that the file "%{path}\%{file}" has version greater than or equal to "%{expectedValue}".

X

Verify a file version is less than

Verify that the file "%{path}\%{file}" has version less than "%{expectedValue}".

X

Verify a file version is less than or equal to

Verify that the file "%{path}\%{file}" has version less than or equal to "%{expectedValue}.

X

Verify a file version is not

Verify that the file "%{path}\%{file}" does not have version "%{expectedValue}".

X

Verify a file was modified since

Verify that the file "%{path}\%{file}" was modified since "%{expectedValue}".

X

Verify a process is not running

Verify the process "%{name}" is not running.

X

Verify a process is running

Verify the process "%{name}" is running.

X

Verify a product version is exactly

Verify that the product "%{path}\%{file}" has version "%{expectedValue}".

X

Verify a product version is greater than

Verify that the product "%{path}\%{file}" has version greater than "%{expectedValue}".

X

Verify a product version is greater than or equal to

Verify that the product "%{path}\%{file}" has version greater than or equal to "%{expected-Value}".

X

Verify a product version is less than

Verify that the product "%{path}\%{file}" has version less than "%{expectedValue}".

X

Verify a product version is less than or equal to

Verify that the product "%{path}\%{file}" has version less than or equal to "%{expectedValue}".

X

Verify a product version is not

Verify that the product "%{path}\%{file}" does not have version "%{expectedValue}".

X

Verify a registry key does not exist

Verify that "%{key}" does not exist.

X

Verify a registry key exists

Verify that "%{key}" exists.

X

Verify a registry key’s subkey count is exactly

Verify that "%{key}" has exactly "%{expectedValue}" subkeys.

X

Verify a registry key’s subkey count is greater than

Verify that "%{key}" has greater than "%{expectedValue}" subkeys.

X

Verify a registry key’s subkey count is greater than or equal to

Verify that "%{key}" has greater than or equal to "%{expectedValue}" subkeys.

X

Verify a registry key’s subkey count is less than

Verify that "%{key}" has less than "%{expectedValue}" subkeys.

X

Verify a registry key’s subkey count is less than or equal to

Verify that "%{key}" has less than or equal to "%{expectedValue}" subkeys.

X

Verify a registry key’s subkey count is not

Verify that "%{key}" does not have exactly "%{expectedValue}" subkeys.

X

Verify a registry key’s value count is exactly

Verify that "%{key}" has exactly "%{expectedValue}" values.

X

Verify a registry key’s value count is greater than

Verify that "%{key}" has greater than "%{expectedValue}" values.

X

Verify a registry key’s value count is greater than or equal to

Verify that "%{key}" has greater than or equal to "%{expectedValue}" values.

X

Verify a registry key’s value count is less than

Verify that "%{key}" has less than "%{expectedValue}" values.

X

Verify a registry key’s value count is less than or equal to

Verify that "%{key}" has less than or equal to "%{expectedValue}" values.

X

Verify a registry key’s value count is not

Verify that "%{key}" does not have exactly "%{expectedValue}" values.

X

Verify a registry pattern doesn’t match

Verify that "%{key}!%{name}=%{expectedValue}" doesn't match.

X

Verify a registry pattern match

Verify that "%{key}!%{name}=%{expectedValue}" matches.

X

Verify a registry value does not exist

Verify that "%{key}!%{name}" does not exist.

X

Verify a registry value exists

Verify that "%{key}!%{name}" exists.

X

Verify a registry value is exactly

Verify that "%{key}!%{name}" is equal to "%{expectedValue}".

X

Verify a registry value is greater than

Verify that "%{key}!%{name}" is greater than "%{expectedValue}".

X

Verify a registry value is greater than or equal to

Verify that "%{key}!%{name}" is greater than or equal to "%{expectedValue}" .

X

Verify a registry value is less than

Verify that "%{key}!%{name}" is less than "%{expectedValue}".

X

Verify a registry value is less than or equal to

Verify that "%{key}!%{name}" is less than or equal to "%{expectedValue}".

X

Verify a registry value is not

Verify that "%{key}!%{name}" is not equal to "%{expectedValue}".

X

Verify a service exists

Verify the service "%{name}" exists.

X

Verify a service is running

Verify the service "%{name}" is running.

X

Specifying Windows registry paths

When specifying Windows registry paths, use the base key and specify whether the registry is on a device with 32-bit or 64-bit operating system and hardware.

For example, specify the path for HKEY_LOCAL_MACHINE for 32- and 64-bit Windows devices as follows:

Steps for Mac OS X devices

Table 35. Adding steps to scripts used on Mac OS X devices

Step

Description

V

OS

R

ORS

ORF

Always fail

X

X

Create a message window

Create a message window named "%{name}" with title "%{title}", message "%{message}" and timeout "%{timeout}" seconds.

X

X

X

X

X

Destroy a message window

Destroy the message window named "%{name}".

X

X

X

X

X

Kill a process

Kill the process "%{name}".

X

X

X

X

X

Launch a program

Launch "%{path}\%{program}" with params "%{parms}".

X

X

X

X

X

Log a plist value

Log "%{key}!%{name};"

X

Log message

Log "%{message}" to "%{type}".

X

Search file system

Search for "%{name}" in "%{startingDirectory}" on "%{drives}" and "%{action}".

X

Unzip a file

Unzip "%{path}\%{file}" to "%{target}".

X

X

X

X

Update message window text

Set the text in the message window named "%{name}" to "%{text}".

X

X

X

X

Update policy and job schedule

Update policy and job schedule from the appliance.

X

Upload a file

Upload "%{path}\%{file}" to the server.

X

X

Verify a directory exists

Verify that the directory "%{path}" exists.

X

Verify a file exists

Verify that the file "%{path}\%{file}" exists.

X

Verify a file was modified since

Verify that the file "%{path}\%{file}" was modified since "%{expectedValue}".

X

Verify a process is not running

Verify the process "%{name}" is not running.

X

Verify a process is running

Verify the process "%{name}" is running.

X

Verify a plist value equals

X

Verify a plist value exists

Verify that "%{key}" exists.

X

Verify a plist value greater than

X

Verify a plist value less than

X

Verify an environment variable equals

X

Verify an environment variable exists

X

Verify an environment variable greater than

X

Verify an environment variable less than

X

Verify at least one file matching regex exists

X

Verify count of filenames matching regex is greater than

X

Verify count of filenames matching regex is less than

X

Verify count of filenames matching regex

X

Verify file info equals

X

Verify file info greater than

X

Verify file info less than

X

Steps for Red Hat Enterprise Linux devices

Table 36. Adding steps to scripts for RHEL

Step

Description

V

OS

R

ORS

ORF

Always fail

X

X

Kill a process

Kill the process "%{name}".

X

X

X

X

X

Launch a program

Launch "%{path}\%{program}" with params "%{parms}".

X

X

X

X

X

Log message

Log "%{message}" to "%{type}".

X

Search file system

Search for "%{name}" in "%{startingDirectory}" on "%{drives}" and "%{action}".

X

Unzip a file

Unzip "%{path}\%{file}" to "%{target}".

X

X

X

X

Update policy and job schedule

Update policy and job schedule from the appliance.

X

Upload a file

Upload "%{path}\%{file}" to the server.

X

X

Verify a directory exists

Verify that the directory "%{path}" exists.

X

Verify a file exists

Verify that the file "%{path}\%{file}" exists.

X

Verify a file was modified since

Verify that the file "%{path}\%{file}" was modified since "%{expectedValue}".

X

Verify a process is not running

Verify the process "%{name}" is not running.

X

Verify a process is running

Verify the process "%{name}" is running.

X

Verify an environment variable less than

X

Verify at least one file matching regex exists

X

Verify count of filenames matching regex is greater than

X

Verify count of filenames matching regex is less than

X

Verify count of filenames matching regex

X

Verify file info equals

X

Verify file info greater than

X

Verify file info less than

X

LDAP variables

LDAP variables

The KACE SMA supports variables for use in LDAP Labels and database queries.

Device or machine variables

Device or machine variables can be used in LDAP Labels and queries to automatically group devices by name, description, and other LDAP criteria. During LDAP Label processing, the KACE SMA replaces all KBOX_ defined variables with their respective runtime values. The following table shows supported device or machine variables and their mapping to columns in the MACHINE database table and LDAP attributes.

Table 37. Device or machine variables and mappings

 

KACE SMA variable

 

KACE SMA MACHINE database table column

 

LDAP attribute mapping

KBOX_COMPUTER_NAME

NAME

cn | name

KBOX_COMPUTER_DESCRIPTION

SYSTEM_DESCRIPTION

description

KBOX_COMPUTER_MAC

MAC

macAddress

KBOX_COMPUTER_IP

IP

ipHostNumber

KBOX_USERNAME

USER_NAME

KBOX_USER_DOMAIN

USER_DOMAIN

KBOX_DOMAINUSER

USER

KBOX_CUSTOM_INVENTORY_*

CUSTOM_INVENTORY

The KBOX_CUSTOM_INVENTORY_* variable can be used to check a custom inventory value. The * is replaced with the Display Name of the custom inventory rule. Allowed characters are [a-z0-9.-]. Any other characters are replaced with an underscore (_).

User variables

User variables can be used in LDAP Labels and queries to automatically group users by domain, location, budget code, or other LDAP criteria. During LDAP Label processing, the KACE SMA replaces all KBOX_ defined variables with their respective runtime values. The following table shows supported user variables and their mapping to columns in the USER database table and LDAP attributes.

Table 38. User variables and mappings

 

KACE SMA variable

 

KACE SMA USER database table column

 

LDAP attribute mapping

KBOX_USER_NAME

USER_NAME

samAccountName

KBOX_FULL_NAME

FULL_NAME

cn | name

KBOX_EMAIL

EMAIL

mail

KBOX_DOMAIN

DOMAIN

KBOX_BUDGET_CODE

BUDGET_CODE

KBOX_LOCATION

LOCATION

1

KBOX_WORK_PHONE

WORK_PHONE

telephoneNumber

KBOX_HOME_PHONE

HOME_PHONE

homePhone

KBOX_MOBILE_PHONE

MOBILE_PHONE

mobile

KBOX_PAGER_PHONE

PAGER_PHONE

pager

KBOX_CUSTOM_1

CUSTOM_1

KBOX_CUSTOM_2

CUSTOM_2

KBOX_CUSTOM_3

CUSTOM_3

KBOX_CUSTOM_4

CUSTOM_4

KBOX_ROLE_ID

ROLE_ID

KBOX_API_ENABLED

API_ENABLED

KBOX_AMS_ID

AMS_ID

No value. This variable is not used in the KACE SMA 6.4 release.

KBOX_LOCALE_BROWSER_ID

LOCALE_BROWSER_ID

KBOX_HD_DEFAULT_QUEUE_ID

HD_DEFAULT_QUEUE_ID

KBOX_LDAP_UID

LDAP_UID

objectGUID

Glossary

Glossary

The Administrator Console is the web-based interface used to control the KACE SMA. To access the Administrator Console, go to http://<KACE_SMA_hostname>/admin where <KACE_SMA_hostname> is the hostname of your appliance. If the Organization component is enabled, you can access the System-level settings of the Administrator Console at http://<KACE_SMA_hostname>/system. To view the full path of URLs in the Administrator Console, which can be useful when searching the database or sharing links, add ui to the URL you use to log in. For example: http://<KACE_SMA_hostname>/admin.

Monitoring alerts are messages that are generated on supported server devices and sent to the KACE SMA to alert staff about errors and issues being reported in the event and system logs of the devices. See Monitoring servers.

AMP (Agent Messaging Protocol) is the communications protocol used for communication between the KACE SMA Agent, which is installed on Agent-managed devices, and the KACE SMA. AMP provides optimized real-time communications for system-management operations. See Provisioning the KACE SMA Agent.

Appliance linking enables you to log in to one appliance and access all linked appliances from the drop-down list in the top-right corner of the Administrator Console, without having to log in to each appliance separately. You can link all of the Quest K-Series appliances you manage. See Linking Quest KACE appliances.

A

Glossary

The Administrator Console is the web-based interface used to control the KACE SMA. To access the Administrator Console, go to http://<KACE_SMA_hostname>/admin where <KACE_SMA_hostname> is the hostname of your appliance. If the Organization component is enabled, you can access the System-level settings of the Administrator Console at http://<KACE_SMA_hostname>/system. To view the full path of URLs in the Administrator Console, which can be useful when searching the database or sharing links, add ui to the URL you use to log in. For example: http://<KACE_SMA_hostname>/admin.

Monitoring alerts are messages that are generated on supported server devices and sent to the KACE SMA to alert staff about errors and issues being reported in the event and system logs of the devices. See Monitoring servers.

AMP (Agent Messaging Protocol) is the communications protocol used for communication between the KACE SMA Agent, which is installed on Agent-managed devices, and the KACE SMA. AMP provides optimized real-time communications for system-management operations. See Provisioning the KACE SMA Agent.

Appliance linking enables you to log in to one appliance and access all linked appliances from the drop-down list in the top-right corner of the Administrator Console, without having to log in to each appliance separately. You can link all of the Quest K-Series appliances you manage. See Linking Quest KACE appliances.
Related Documents