Chat now with support
Chat with Support

KACE Systems Deployment Appliance 9.2 Common Documents - Administrator Guide

About the KACE Systems Deployment Appliance Getting started Using the Dashboard Configuring the appliance Setting up user accounts and user authentication Configuring security settings Preparing for deployment Managing device inventory Using labels Creating a Windows or Linux Boot Environment Managing drivers Capturing images Capturing user states Creating scripted installations Creating a task sequence Automating deployments Performing manual deployments Managing custom deployments Managing offline deployments About the Remote Site Appliance Importing and exporting appliance components Managing disk space Troubleshooting appliance issues Updating appliance software Glossary About us Legal notices

Add Naming Rule

Add Naming Rule

You can create a naming rule to obtain a computer name as a pre-installation task, or name a device during mid- or post-installation. To automatically assign device names, you can use a text file and attach it to the task, or use the appliance database. Additional options for specifying the computer name are available.

The appliance includes two scripts to obtain or assign computer names: getcomputername and setcomputername. Each script has a 32- and 64-bit version. For more information about these scripts, visit https://www.itninja.com/blog/view/get-set-computername.

By default, the /log switch is added to the script command line, allowing the appliance to create a log file each time the script runs. You can also use the /debug switch if you want to see messages from the script at runtime.

These tasks work with sysprepped images (where an unattend file is specified) and with scripted Windows installations.

1.
Complete one of the following steps:
a.
On the left navigation pane, click Library to expand the section, then click Pre-installation Tasks to display the Pre-installation Tasks page.
b.
On the left navigation pane, click Library to expand the section, then click Mid-level Tasks to display the Mid-Level Tasks page.
c.
On the left navigation pane, click Library to expand the section, then click Post-installation Tasks to display the Post-installation Tasks page.
2.
Select Choose Action > Add Naming Rule to display the task detail page.
3.
In Name, enter a logical name for the task, such as Assign name to workstation.
4.
Under Select Architecture, choose the architecture of the device OS to which the naming rule applies: x64 (64-bit) or x86 (32-bit).
5.
Obtaining computer name in pre-installation tasks only.
a.
Observe the contents of the Full Command Line.
The specified command collects the computer name from the device's Windows registry and stores it in a text file, next to the computer's MAC address. To prompt the user for a different name, use the /dialog switch.
6.
Assigning computer name in mid-level or post-installation tasks only. The options provided in each task type are identical with the exception of the \in_windows switch, that only appears in post-installation tasks.
a.
Click Select Method of Naming and choose one of the following options:
▪
Set computer name to the current computer name: Leaves the computer name unchanged.
▪
Prompt for the computer name: The /dialog switch is added to the contents of the Full Command Line, causing a dialog box to appear, prompting the user to specify the computer name.
▪
Rename using variable replacement: The /name switch is added to the contents of the Full Command Line. Replace <TEXT_AND_VARIABLES> as needed, using a combination of text and the following variables, as required:
▪
$Serial: The serial number of the client device.
▪
$Make: The manufacturer of the client device or motherboard.
▪
$Model: The model of the client device or motherboard.
▪
$Chassis: The chassis type of the client device.
▪
$FormFactor: The device type: D for Desktop, L for Laptop, VM for a VMware virtual machine.
▪
$Asset: The asset tag of the client device.
▪
$OS: The OS version of the client device (such as W7, WXP, W2K8, and so on).
▪
$Arch: The OS architecture of the client device.
▪
$Mac: The MAC address of the active NIC.
For example:
setcomputername_x64.exe /name:$OS$Arch-$Serial
▪
Rename using a data file: Uses a data file to rename devices.
1.
Create a text file and list the entries using the following syntax:
<mac_address|serial_number> = <device_name>
For example:
001122334455 = workstation55
001122334456 = workstation56
001122334457 = workstation57
2.
Attach the file to the task. Click Select file and specify the file, or drag and drop the file in the Drop file here area.
3.
Configure the contents of the Full Command Line field:
▪
/rdf: The name of the newly created file. This switch automatically displays the name of the attached file.
▪
/dfk: The type of device identifier used in the file: $Serial or $Mac.
For example:
setcomputername_x64.exe /log /rdf:my_file.txt /dfk:$Mac
▪
Rename using the SMA/K1 database: Uses the KACE Systems Management Appliance database to retrieve the contents of the host_name field for each device. This is indicated by the /k1mysql switch in the Full Command Line field. Additional identifiers are required.
1.
Verify that the access to the KACE Systems Management Appliance database is enabled. On the KACE Systems Management Appliance, go to Settings > Control Panel > Security Settings, and ensure Enable database access is selected. If the option is disabled and you enable it, you must reboot the KACE Systems Management Appliance before this change can take effect. For more information, see the KACE Systems Management Appliance Administrator Guide.
2.
In the Full Command Line field, supply information to the following switches:
▪
/k1ipaddress: The IP address of the machine on which the KACE Systems Management Appliance is running.
▪
/k1dbname: The name of the organization on the appliance. The default is ORG1.
▪
/k1dbuser: The name of the user account on the appliance. The default is R1.
▪
/k1dbpass: The user password. The default is box747.
For example:
setcomputername_x64.exe /log /k1mysql /k1ipaddress:192.0.2.0 /k1dbname:ORG1
/k1dbuser:R1 /k1dbpass:box747
▪
Rename using the SDA/K2 database: Uses the KACE Systems Deployment Appliance database to retrieve device names. This is indicated by the /k2mysql switch in the Full Command Line field.
▪
Verify that the access to the KACE Systems Deployment Appliance database is enabled. On the KACE Deployment Appliance, go to Settings > Security , and ensure Enable database access is selected.
7.
Post-installation tasks only. Select the Reboot Required check box to reboot the appliance and run the next task in the sequence.
8.
In Expected Return Code, enter a code that the task should return, if applicable. Otherwise, leave the default value of zero '0'.
In general, most tasks exit with a zero '0' code, indicating success, but you can set it to any positive value, as applicable. Some installers exit with a different code, even when the install is successful. For example, anti-virus installers are typically successfully installed but exit with a different return code because they require a device reboot.
9.
Click Save.
The task is now available to assign to scripted installations, sysprepped system images, and non-sysprepped system image deployments.
See Assign tasks to scripted installation deployment or Assign tasks to system deployment.

Add PowerShell Script

Add PowerShell Script

You can run PowerShell script as a pre-installation, mid-level, or post-installation task in the KACE Boot Environment (Windows) runtime environment or the Windows runtime environment.

1.
Complete one of the following steps:
a.
On the left navigation pane, click Library to expand the section, then click Pre-installation Tasks to display the Pre-installation Tasks page.
b.
On the left navigation pane, click Library to expand the section, then click Mid-level Tasks to display the Mid-Level Tasks page.
c.
On the left navigation pane, click Library to expand the section, then click Post-installation Tasks to display the Post-installation Tasks page.
2.
On the list page that appears, select Choose Action > Add Powershell Script.
3.
On the page that appears, in Name, enter a logical name for the task, such as My PowerShell script.
4.
Under Upload File, click Select File, and navigate to the PowerShell script.
5.
Select the Reboot Required check box to reboot the appliance and run the next task in the sequence.
6.
In Expected Return Code, enter a code that the task should return, if applicable. Otherwise, leave the default value of zero '0'.
In general, most tasks exit with a zero '0' code, indicating success, but you can set it to any positive value, as applicable. Some installers exit with a different code, even when the install is successful. For example, anti-virus installers are typically successfully installed but exit with a different return code because they require a device reboot.
7.
In Notes, add a note to identify the task.
8.
Click Save.
The task is now available to assign to scripted installations, sysprepped system images, and non-sysprepped system image deployments.
9.
On the list page, click the task name.
10.
On the task detail page that appears, review the contents of the Full Command Line field, and make any changes, as required.
11.
If you made any changes to the command line, click Save, or click Cancel to return to the list page.

Add Provisioning Package

Add Provisioning Package

Provisioning packages contain collections of configuration settings. You can use them to quickly configure a Windows device without having to install a new image. You can run a provisioning package as a post-installation task in the Windows runtime environment.

1.
On the left navigation pane, click Library to expand the section, then click Post-installation Tasks to display the Post-installation Tasks page.
2.
On the list page that appears, select Choose Action > Add Provisioning Package to display the Post-installation Task Detail page.
3.
On the page that appears, in Name, enter a logical name for the task, such as My Provisioning Package.
4.
Under Upload File, click Select File, and navigate to the Provisioning Package file.
The Reboot Required option is selected by default and cannot be disabled. This is because a device reboot occurs each time this task runs.
5.
In Expected Return Code, enter a code that the task should return, if applicable. Otherwise, leave the default value of zero '0'.
In general, most tasks exit with a zero '0' code, indicating success, but you can set it to any positive value, as applicable. Some installers exit with a different code, even when the install is successful. For example, anti-virus installers are typically successfully installed but exit with a different return code because they require a device reboot.
6.
In Notes, add a note to identify the task.
7.
Click Save.
The task is now available to assign to scripted installations, sysprepped system images, and non-sysprepped system image deployments.
8.
On the list page, click the task name.
9.
On the task detail page that appears, review the contents of the Full Command Line field, and make any changes, as required.
10.
If you made any changes to the command line, click Save, or click Cancel to return to the list page.

Add Service Pack

Add Service Pack

You can install service packs automatically as they become available for the operating system to devices on local and remote networks. If you have a service pack stored at a different location, you can browse to and upload that service pack manually.

The Service pack task runs in the Windows environment after booting in to the operating system.

1.
On the left navigation pane, click Library to expand the section, then click Post-installation Tasks to display the Post-installation Tasks page.
2.
Select Choose Action > Add Service Pack to display the Post-installation Task Detail page.
3.
In Name, enter a logical name to identify the task.
4.
Download the service pack automatically or manually.
◦
From the Service Pack drop-down list, select the service pack, and click Download Service Pack automatically.

The Command Line field is automatically populated with the recommended parameters based on the service pack selection. If you modify this line, include the service pack filename.

◦
Select Upload Service Pack manually, and click Browse to upload the file. For more information, see About uploading files.
* 
NOTE: When you upload the service pack manually, in Parameters, enter the command-line parameters to run the service pack.
5.
In Full Command Line, enter the command-line parameters for the task.
6.
Select the Reboot Required check box to reboot the appliance and run the next task in the sequence.
7.
In Expected Return Code, enter a code that the task should return, if applicable. Otherwise, leave the default value of zero '0'.
In general, most tasks exit with a zero '0' code, indicating success, but you can set it to any positive value, as applicable. Some installers exit with a different code, even when the install is successful. For example, anti-virus installers are typically successfully installed but exit with a different return code because they require a device reboot.
8.
In Notes, add a note to identify the task.
9.
Click Save.
The task is now available to assign to scripted installations, sysprepped system images, and non-sysprepped system image deployments.
See Assign tasks to scripted installation deployment or Assign tasks to system deployment.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating