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

•

Steps for Mac OS X devices

•

Steps for Red Hat Enterprise Linux devices

Steps for Windows devices

NOTE: For the syntax to use when specifying registry paths, see Specifying Windows registry paths.

Table 38. Adding steps to scripts used on Windows devices

Call a custom DLL function

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

Create a custom DLL object

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

Create a message window

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

Delete a registry key

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

Delete a registry value

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

Destroy a message window

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

Install an application package

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

NOTE: This step requires you to choose from a list of application packages already uploaded using the functionality in the Inventory > Software page. See Adding and deleting applications in Software page inventory.

Stop a process

Stop the process "%{name}".

Launch a program

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

Log a registry value

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

Log file information

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

Log message

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

Restart a service

Restart service "%{name}"

Run a batch file

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

NOTE: In this step, you do not need to upload the batch file. You create the batch file by pasting the script in the space provided.

Set a registry key

Set "%{key}".

Set a registry value

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

Start a service

Restart service "%{name}".

Stop a service

Stop service "%{name}"

Unzip a file

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

Update message window text

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

Update policy and job schedule

Update policy and job schedule from the appliance.

Upload a file

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

Verify a directory exists

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

Verify a file exists

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

Verify a file version is exactly

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

Verify a file version is greater than

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

Verify a file version is greater than or equal to

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

Verify a file version is less than

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

Verify a file version is less than or equal to

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

Verify a file version is not

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

Verify a file was modified since

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

Verify a process is not running

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

Verify a process is running

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

Verify a product version is exactly

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

Verify a product version is greater than

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

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}".

Verify a product version is less than

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

Verify a product version is less than or equal to

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

Verify a product version is not

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

NOTE: For the syntax to use when specifying registry paths, see Specifying Windows registry paths.

Verify a registry key does not exist

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

Verify a registry key exists

Verify that "%{key}" exists.

Verify a registry key’s subkey count is exactly

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

Verify a registry key’s subkey count is greater than

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

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

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

Verify a registry key’s subkey count is less than

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

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

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

Verify a registry key’s subkey count is not

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

Verify a registry key’s value count is exactly

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

Verify a registry key’s value count is greater than

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

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

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

Verify a registry key’s value count is less than

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

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

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

Verify a registry key’s value count is not

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

Verify a registry pattern doesn’t match

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

Verify a registry pattern match

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

Verify a registry value does not exist

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

Verify a registry value exists

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

Verify a registry value is exactly

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

Verify a registry value is greater than

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

Verify a registry value is greater than or equal to

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

Verify a registry value is less than

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

Verify a registry value is less than or equal to

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

Verify a registry value is not

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

Verify a service exists

Verify the service "%{name}" exists.

Verify a service is running

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

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:

•

HKLM\Software\32BitProgramA\installDate

•

HKLM64\Software\64BitProgramB\installDate

Steps for Mac OS X devices

Table 39. 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
Stop a process	Stop 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 40. Adding steps to scripts for RHEL
Step	Description	V	OS	R	ORS	ORF
Always fail		X		X
Stop a process	Stop 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

The appliance 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 appliance 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 41. Device or machine variables and mappings
Appliance variable	Appliance 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_USER	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 appliance 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 42. User variables and mappings

Appliance variable

Appliance USER database table column

LDAP attribute mapping

•

No value: Disable user access to the KACE GO app

KBOX_AMS_ID

AMS_ID

No value. This variable is not used.

KBOX_LOCALE_BROWSER_ID

LOCALE_BROWSER_ID

KBOX_HD_DEFAULT_QUEUE_ID

Glossary

Acceptable Use Policy

A statement or policy that is displayed to users when they log in to the Administrator Console, Command Line Console, or User Console. See Enable or disable the Acceptable Use Policy.

add to catalog request

A cataloging request is a form you can submit to request that an application that is not included in the Software Catalog (Uncataloged) be added to the public Software Catalog. When Quest receives a cataloging request, that request is evaluated to determine whether or not the application should become part of the public Software Catalog. In addition, applications are automatically added to the local version of the Software Catalog on the appliance when cataloging requests are submitted. See Adding applications to the Software Catalog.

Administrator Console

The Administrator Console is the web-based interface used to control the appliance. To access the Administrator Console, go to http://<appliance_hostname>/admin where <appliance_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://<appliance_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://<appliance_hostname>/admin.

Agent

The KACE Agent is an application that can be installed on devices to enable device management through the appliance. Agents that are installed on managed devices communicate with the appliance through the agent messaging protocol. Agents perform scheduled tasks, such as collecting inventory information from, and distributing software to, managed devices. Agentless management is available for devices that cannot have Agent software installed, such as printers and devices with operating systems that are not supported by the Agent. See Provisioning the KACE Agent.

Agentless management

Agentless device management is a method of managing devices without the need to deploy and maintain the KACE Agent software on those devices. Agentless management uses SSH, SNMP, and other methods to connect to Agent-intolerant devices, such as printers, network devices, and storage devices, and report inventory in the appliance Administrator Console. This is useful for operating system versions and distributions that are not supported by the KACE Agent, and where Agentless management is preferred over installing the Agent. See Managing Agentless devices.

alerts

Broadcast alerts are messages, such as pop-ups, that can be broadcast from the appliance to be displayed on Agent-managed devices. Displaying alerts is useful when you need to communicate urgent information, or notify users before running actions or scripts on their devices. See Broadcasting alerts to managed devices.

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

alternate download location

An alternate download location can be any network location that has all the files required to install a particular application. You can distribute packages from alternate download locations including a UNC address or DFS source. The CIFS and SMB protocols, Samba servers, and file server appliances are supported. You specify the location when you create a Managed Installation. See Using Managed Installations.

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.

appliance or virtual appliance

The appliance is available as a physical or hardware-based appliance, and as a virtual appliance. The virtual appliance uses a VMware infrastructure. The same system management features are available on both the physical and virtual appliances. See About the appliance components.

Application Control

Application Control enables you to mark applications as Not Allowed and block them or prevent them from running on Agent-managed Windows and Mac devices. This is useful if you want to restrict specific applications from running in your environment. See Apply the Application Control label to devices.

Asset Management

Support for complex license compliance reporting, building on the framework of data collected through the appliance Inventory process. Asset Management also enables you to track additional data about managed devices, including purchase dates, support contracts, asset tags, and so on. See About the Asset Management component.

assets, Asset Types, and Asset Subtypes used in the Asset Management component

Assets and Asset Types used in the Asset Management component include physical and logical items, such as devices, applications, printers, licenses, departments, locations, and vendors. The Asset Management component enables you to build relationships between assets, track inventory data, view records of changes, and report on changes to assets. Assets are based on Asset Types. You can modify default Asset Types, create custom Asset Types, and import asset information as needed. See About Asset Types. Asset Subtypes are subcategories of assets that you can add to any Asset Type, including custom Asset Types. This enables you to identify and manage subtypes of assets, such as Device assets that are computers, printers, or routers, and Software assets that run on Windows, Mac, or Linux systems in the appliance inventory. See About Asset Subtypes, custom fields, and device detail preferences.

Assets that count toward your appliance license limit

Your appliance license agreement entitles you to manage a specified number of devices that are categorized as Assets, and these Assets differ from assets used in the Asset Management component. Assets that count toward your are license limit include devices that 1) have been added to the appliance inventory but do not meet the definition of Managed Computers or Monitored Servers and 2) were not added to inventory manually, through the WSAPI, or through mobile management. Examples of Assets include printers, projectors, network gear, and storage devices.

NOTE: The assets you create and manage using the Asset Management component do not count toward the license limit.

See View product licensing information.

AUP

See Acceptable Use Policy .

automatic labels

Labels that are applied automatically, such as Smart Labels. See Setting up and using labels to manage groups of items.

A

Glossary

Acceptable Use Policy

A statement or policy that is displayed to users when they log in to the Administrator Console, Command Line Console, or User Console. See Enable or disable the Acceptable Use Policy.

add to catalog request

Administrator Console

Agent

Agentless management

alerts

alternate download location

appliance or virtual appliance

Application Control

Asset Management

assets, Asset Types, and Asset Subtypes used in the Asset Management component

Assets that count toward your appliance license limit

NOTE: The assets you create and manage using the Asset Management component do not count toward the license limit.

See View product licensing information.

AUP

See Acceptable Use Policy .

automatic labels

Labels that are applied automatically, such as Smart Labels. See Setting up and using labels to manage groups of items.

Base key	Short version
HKEY_CLASSES_ROOT	HKCR
HKEY_CURRENT_USER	HKCU
HKEY_LOCAL_MACHINE	HKLM
HKEY_USERS	HKU
HKEY_PERFORMANCE_DATA	HKPD
HKEY_PERFORMANCE_TEXT	HKPT
HKEY_PERFORMANCE_NLSTEXT	HKPN
HKEY_CURRENT_CONFIG	HKCC
HKEY_DYN_DATA	HKDD

製品を選択してください:

サービス向上のために、「Purpose of your Chat（チャットの目的）」を記入してください。

お客様の不具合に推奨されるソリューション

KACE Systems Management Appliance 14.1 Common Documents - Administration Guide

Adding steps to task sections of scripts

LDAP variables

Glossary

A