Mass Deployment Tool User’s Guide ENG Version K
Copyright © 2022 Brother Industries, Ltd. All rights reserved. Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement. The software may be used or copied only in accordance with the terms of those agreements. No part of this publication can be reproduced in any form or by any means without prior written permission of Brother Industries, Ltd.
Table of Contents 1 Introduction............................................................................................................................................. 1.1 Overview .................................................................................................................................. 1.2 System Requirements .............................................................................................................. 1.3 Preparation............................................
1 Introduction 1.1 Overview The Mass Deployment Tool provides a configuration interface to help you manage a variety of Brother device settings, and allows users to install and manage multiple USB-connected or network-connected devices, without having to install any additional software.
1.2 System Requirements Windows 10 (32-bit and 64-bit) Operating Systems Windows 11 (64-bit) Windows Server 2012 or later (64-bit) Additional Software .NET Framework 4.8 or later 1.3 Preparation 1. Download the latest version of the Mass Deployment Tool from the Brother support website at support.brother.com. 2. Copy the contents of the downloaded file into the folder you want. Make sure you know which schema file is supported by your Brother model.
2 Main Functions of the Mass Deployment Tool (GUI) Use the Mass Deployment Tool's Graphical User Interface (GUI) to: - Prepare and manage deployment profiles for multiple Brother devices. - Deploy settings or send instructions to multiple Brother devices using deployment profiles. - Change the Mass Deployment Tool's settings. 2.1 Update the Device List No devices are displayed upon startup. Search for target devices first, and then add them to the list: 1.
The following functions are available in the tool’s main window. - Select the Setting File Select one or more devices, click the Set file button, and then select the file you want. - Enter a Password for Password-Protected Devices Select one or more devices that use the same password, click the Input device password button, type the password, and then click OK. - Refresh the Device List Select one or more devices and then click the Refresh button.
2.2 Check Device Notifications The Notification column of the Device List notifies you of the results of the last-performed task of the listed devices. The following notifications are available: Not found This device was offline when the deployment profile was imported into the tool. Check the device's connection status. (For more information, see 2.3.1 Import Deployment Profiles.) Completed This device completed the last-performed task successfully.
2.3 Use Deployment Profiles Deployment profiles contain paths to settings files, such as JSON files, and let you assign specific settings files to multiple Brother devices. This feature allows you to: - Import deployment profiles to restore specific settings files for specific devices. - Export and save deployment profiles to let others use them to import settings from multiple Brother devices and then send them to other devices. Deployment profiles contain only the relative paths for settings files.
2.3.2 Export Deployment Profiles Create and export customized deployments and use them to manage multiple devices. 1. Make sure the device list contains all the devices you want. Add more devices if needed. 2. Click and select Export profile…, or Export profile (with password)… If you select Export Profile… and any of the target devices is password-protected, the tool notifies you that the profile will be saved without encryption.
c * For monochrome devices: Press Start. * For color devices: Press either Black Start or Color Start. - Scanners a Select Program Update. b The USB flash drive details appear. Select the “write_xxx.edpk” file. 4. Your selected settings will be applied to the device. The output log file will be automatically created. 5. The Send files dialog box shows the sending progress. To stop this operation, click the Stop button. 6. When completed, the summary results appear.
2.6 Back Up Settings You can retrieve Brother device settings to back them up and use them later for applying the same settings to a different device. 1. Make sure the device list contains all the devices you want. 2. Select Back up settings from the drop-down list on the upper left. 3. The Back up settings screen appears. The devices whose settings cannot be retrieved are shown as “Not supported”. 4. Enter the device password in the Device password column, if needed. 5.
- Scanners a Select Program Update. b The USB flash drive details appear. Select the “read_xxx.edpk” file. 5. The settings you want will be extracted from the device and saved as a new file in the following format: [settings file name]_[model name]_[serial number]_[index].edpk The output log file will be automatically created. 9. The Back up Settings dialog box shows the backup progress. To stop this operation, click the Stop button. 10. When completed, the summary results appear.
d) Click Apply. - When you select the Set a password for unconfigured devices menu, the Input device password button and the Device password fields are disabled. - Avoid using the following passwords as your administrator password: • access • initpass • The “Pwd” located on the back of your machine - It can also be used with USB-connected devices. 3. The Password settings dialog box shows the password setting progress. To stop this operation, click the Stop button. 4.
3 Additional Functions of the Mass Deployment Tool (GUI) Additional advanced functions are available to help you manage your devices. 3.1 Application Settings Click in the top bar to configure the tool's settings. 3.1.1 Configure the Network Settings To configure the device’s Network settings, do the following: 1. Click Network. 2. Click the SNMP tab. 3. Select the settings you want. 4. (Optional) Click the Proxy tab and configure proxy settings. - The default setting is Auto.
3.1.2 Configure the Device Discovery Settings To discover the target devices you want, configure the Device discovery settings below: To search for devices on your network 1. Select Device discovery. 2. Select the IP broadcast: check box or the IP unicast: check box in the Network: tab. 3. Click to add a new address. 4. When finished, click the OK button. To search for devices on a different local network 1. Select Device discovery. 2. Select the Agent broadcast: check box.
3.2 Activate Solutions You can send license files to activate custom software solutions on the target devices. A valid license file is necessary for this task. A license file can contain many activation codes, allowing solutions to be activated on many devices simultaneously. If you do not have one, contact your local Brother office. 1. Make sure the device list contains all the devices you want. 2. Select Activate solutions from the drop-down list in the top bar. 3. The Activate solutions screen appears.
4 Command Line Interface (CLI) The tool’s Command Line Interface (CLI) allows you to configure devices remotely using the Command Prompt. The CLI automatically converts settings files to an appropriate format and sends them to the device you want. It then retrieves the settings data and verifies whether the settings have been applied correctly. 4.
4.2 Commands and Options 4.2.1 Commands The following commands can be combined with one or more options to perform specific device configuration tasks. Command Option Description send Either “Device identifier”* or “profile” is required.
Command Option Description (m)apply Either “Device identifier” or “profile” is required.
Command Option Description activate Either “Device identifier” or “profile” is required. 1 ● Device identifier Required: ● networksettingpath ● activateresult ● licensecode Optional: ● password ● profile Required: ● networksettingpath ● activateresult Optional: ● profilepassword ● csvdelim Available in both, if needed: ● dkeypassword ● dkeyfile ● log ● communitynameset ● communitynameget Allows you to activate a custom software solution for the specified target device.
Command Option Description unpack Required: ● file ● unpackdir Optional: ● password ● log Extracts the settings file from the specified settings package file. If the package file is password-protected, it is decrypted with the password specified by the “--password” option and the setting file is extracted. Required: ● source ● destination Optional: ● password ● version Converts schema files created in an earlier version to a format compatible with the specified version.
Command Option Description (m)listactivefunc Either “Device identifier” or “profile” is required. 1 ● Device identifier ● profile Required: ● result Optional: ● profilepassword ● csvdelim Available in both, if needed: ● networksettingpath ● log ● communitynameset ● communitynameget Displays all solutions enabled for the specified device.
Command Option Description applyup Required: ● profile ● result Optional: ● networksettingpath ● dkeypassword ● dkeyfile ● log ● communitynameset ● communitynameget ● profilepassword ● csvdelim Allows you to register the target devices specified using a deployment profile for Microsoft Universal Print. When you set Microsoft Universal Print registration, the device connects to the Microsoft Azure Portal and registers itself for Microsoft Universal Print.
Command Option Description listfilter Either “Device identifier” or “profile” is required. 1 ● Device identifier ● profile Required: ● result Optional: ● profilepassword ● csvdelim Available in both, if needed: ● networksettingpath ● communitynameset ● communitynameget Allows you to display the registered filter names for the specified device. Example: settingcmd.exe listfilter --ip IP_address -networksettingpath (network communications settings file name) settingcmd.
4.2.3 Options Options can be used together with commands to modify their operation. See each command description in section 4.2.1 Commands to learn which options you can use. Option Description --file filename Specify the file you want to use. --output filename Specify the path to save the acquired settings file. --password password Specify the administrator password for the target device. --newpassword password Specify a new administrator password for the target device.
Option Description --csvdelim Specify one of the following as a CSV delimiter: - colon - comma - equal - semicolon - space - tab If you do not specify a delimiter, the delimiter will be based on your region or location. --createfileonly Create the intermediate file without applying it to the target device when using the “(m)apply” command. If you use this option, you must also use the “--outputdir” option. --result Specify the path for saving the executing result.
4.2.4 Deployment Profile A deployment profile contains device information, setting files, and the unique setting value for each device, if needed.
Deployment Item Definitions: Item Definition Serial Number The serial number of the device. If the number you type into this field does not match the serial number identified using the IP Address or Node Name, the “Serial number mismatch error” occurs. Interface (USB/ NETWORK_IPV4) Connection Interface. This is generated by the “exportprofile” command, and is ignored if you use any command other than the “exportprofile” command with a profile that contains this item.
- Setting file A JSON file located in C:\tmp\brother.edpk: - Intermediate file The 00001_10.1.2.146.json file for the device 10.1.2.146, where 00001 is the line number in your CSV file where the target device is listed with one subtracted (five digits, zero padding): 4.2.5 Deploy Key File A Deploy KEY file (DKEY file) is used for encrypting and using passwords related to device settings. DKEY file contains the encrypted device password and the EDPK file password (the EDPK file password is optional).
4.2.6 Create the ETKN File Create an ETKN file from the Microsoft Azure portal, using the UniversalPrintTokenGenerator.exe file. At your Command Prompt, run the UniversalPrintTokenGenerator.exe file in the “UniversalPrintTokenGenerator” folder. The ETKN file is encrypted with the password specified in the “--filepass” option and saved to the file specified in the “--output” option. You can specify if you want to sign out of the Microsoft Azure Portal after getting the token.
5 Create Settings Files Refer to this section when creating settings files used by this tool. 5.1 Settings Files The settings files are model-independent. If a customer replaces an existing device, settings files may be reused if they are compatible with the new device. The tool uses the following file types and extensions to store device settings: ● JSON Files JSON (JavaScript Object Notation) files allow you to configure device settings without having to understand PCL or PJL commands.
There are three ways to create and edit JSON settings files: Method Description Using text editors Edit the settings files you want in a text editor. We recommend using JSON-supported text editors such as Notepad++, because they allow for greater control when viewing, editing, and formatting JSON files. Edit settings files using a third-party editor that supports JSON-schemas.
6 Setting File Editor Use the Setting File Editor to: ● Remove all device-specific settings from the settings file (.json, .dpk, .edpk) at once, or remove only unnecessary device settings, and save them. ● Create the setting files (.json, .dpk, .edpk) and profiles (.csv) necessary to run the Mapply command. - Add dynamic (Mapply) keywords to the settings file (.json, .dpk, .edpk) and save them. - Use an existing profile or create a new profile (.
4. Do one of the following: a) Remove items from the settings tree. After saving the settings file, the deselected items are deleted from the file and are no longer displayed on the settings tree. b) Use dynamic (Mapply) keywords. Change or add a value in the settings file to a dynamic (mapply) keyword by selecting Create dynamic referencing in the Advanced menu. Type the keyword in the Dynamic (Mapply) keyword field. c) Set a dynamic (Mapply) keyword for keys in an array. 1.
• Remove all device-specific settings at once by selecting Unselect device specific settings in the Advanced menu. • A settings file with the Mapply keywords can be used only with the “mapply” command. For more information, see 4.2 Commands and Options. • The Export… menu and button appear when Create dynamic referencing is selected. For more information about deployment profiles, see 4.2.4 Deployment Profile.
7 Troubleshooting If you have any problems using the Mass Deployment Tool, check the table below. If the problem persists, contact your local Brother office’s technical support team. Error Solution Admin account locked The admin password for the target device was entered incorrectly too many times. Wait until the password lock of the target device is released. Already activated The function you want to activate on the device has already been activated.
Error Solution Solution not supported/already activated Some of the deployed solutions are either not supported or are already activated. Check the CSV file stored at the path specified in Save the result file to: on the Activate solutions screen for more information. The license code was entered incorrectly too many times. Unauthorized access error Wait until the lock of the license server is released. Make sure your license code is in the correct format (20 digits) and has not been used yet.
Appendix The exit codes provided by the Mass Deployment Tool (CLI) allow you to identify deployment errors. GUI/CLI Errors For more information and help, see section 7 Troubleshooting. GUI: Error CLI: Exit Code Description Admin account locked 80009 The administrator password for the target device was entered incorrectly too many times. Already activated 80023 The device has already been activated. Already set 80054 The password has already been changed.
GUI: Error CLI: Exit Code Description Universal Print Internal error – Unsupported 80204 The device is not supported by Microsoft Universal Print. Universal Print Registration Refused 80202 The device is unable to register for Microsoft Universal Print. Initial Password Error 80071 You must change the default password to change the device settings. Initial Password Reboot Error 80083 Failed to reboot after resetting back to the default password.
