®
SOTI
™
™
MobiControl Connector
User Guide
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
3
Apache Tomcat Copyright © 1999-2014, The Apache Software Foundation
Sun, Sun Microsystems, Solaris, Java and JavaServer Pages are trademarks or registered trademarks of Oracle Corporation. UNIX
is a registered trademark in the United States and other countries, exclusively licensed through 'The Open Group'. Microsoft,
Windows, WindowsNT, and Win32 are registered trademarks of Microsoft Corporation. Linux is a registered trademark of Linus
Torvalds. All other product names mentioned herein and throughout the entire web site are trademarks of their respective owners.
"Apache Tomcat" and "Tomcat" are trademarks of the Apache Software Foundation. Use of these trademarks is subject to the
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
4
Notes • ___________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Contents
About This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
What SOTI MobiControl Connector Does . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Supported Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Installing in a Windows Operating System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Configuring Printers with WebLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Configuring Weblink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Installation Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Restarting the SOTI MobiControl Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Locating the SOTI MobiControl Connector Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
SSL/TLS Certificate Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Other Typical Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
HTTP Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Contents
6
WebLink Set/Get/Do Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Introduction to SGD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
weblink.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
weblink.ip.conn[1|2].authentication.entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
weblink.ip.conn[1|2].authentication.remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
weblink.ip.conn[1|2].enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
weblink.ip.conn[1|2].retry_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
weblink.ip.conn[1|2].test.location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
weblink.ip.conn[1|2].test.retry_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
weblink.ip.conn[1|2].test.test_on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
weblink.logging.clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
weblink.logging.entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
weblink.logging.max_entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
weblink.printer_reset_required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
weblink.restore_defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
About This Document
This section provides you with contact information, document structure and organization, and
additional reference documents.
Contents
Who Should Use This Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
About This Document
Who Should Use This Document
8
Who Should Use This Document
This User Guide is intended for use by any person who needs to install, perform routine
maintenance, upgrade, or troubleshoot problems with the SOTI MobiControl Connector
software.
How This Document Is Organized
The User Guide is set up as follows:
Section
Description
This section outlines the system requirements for
This section describes basic, network, and firewall
This section describes the Set/Get/Do commands,
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
About This Document
Document Conventions
9
Document Conventions
The following conventions are used throughout this document to convey certain information.
Alternate Color (online only) Cross-references contain hot links to other sections in this
guide. If you are viewing this guide online in .pdf format, you can click the cross-reference
(blue text) to jump directly to its location.
Command Line Examples Command line examples appear in CourierNew font. For
example, type ZToolsto get to the Post-Install scripts in the bindirectory.
Files and Directories File names and directories appear in Courier Newfont. For
example, the Zebra<version number>.tarfile and the /root directory.
Icons Used
Important • Advises you of information that is essential to complete a task.
Note • Indicates neutral or positive information that emphasizes or supplements important
points of the main text.
Example • Provides an example, often a scenario, to better clarify a section of text.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
About This Document
Document Conventions
10
Notes • ___________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Introduction
This section provides general information about the SOTI MobiControl Connector.
Contents
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
What SOTI MobiControl Connector Does . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Supported Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Supported Operating Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Introduction
Overview
12
Overview
The Zebra SOTI MobiControl Connector partners with the SOTI MobiControl server to
™
manage your Zebra Link-OS printers.
SOTI MobiControl Connector will:
• Monitor printers and report issues to the SOTI system
• Monitor printer alerts
• Enable administrators to send files and operating system updates to the printer via the
MobiControl server console
What SOTI MobiControl Connector Does
SOTI MobiControl Connector sends alerts to the SOTI MobiControl server, watches printers
coming online, monitors the status of the printers, and sends files and settings to the printers.
Supported Printers
™
• QLn320 Ethernet and Wi-Fi
™
• QLn220 Ethernet and Wi-Fi
™
• QLn420 Ethernet and Wi-Fi
™
• iMZ320 Wi-Fi
™
• iMZ220 Wi-Fi
™
• ZT200 Series Ethernet and Wi-Fi
™
• ZT400 Series Ethernet and Wi-Fi
™
• ZD500R Ethernet and Wi-Fi
™
• ZD500 Ethernet and Wi-Fi
™
• ZQ500 Series Ethernet and Wi-Fi
Supported Operating Systems
The SOTI MobiControl Connector supports the 64-bit versions of the following:
®
• Windows Server 2008
• Windows Server 2008 R2 (also known as Windows 7 Server)
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
This section outlines the system requirements for installation and provides specific details for
the installation of SOTI MobiControl Connector.
Contents
Installing in a Windows Operating System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Minimum System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Step 1: Install a MobiControl Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Step 2: Install Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Step 3: Test a Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Step 4: Set Up Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Discover Your Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installing in a Windows Operating System
14
Installing in a Windows Operating System
Minimum System Requirements
The SOTI MobiControl Connector supports the 64-bit version of the following:
• Windows Server 2008
• Windows Server 2008 R2 (also known as Windows 7 Server)
Note • This system should be installed on a “clean” Windows Server. A clean system is one
™
that does not already include Apache Tomcat or any other server software installation.
Tomcat will be installed as part of this installation procedure and must be the only Tomcat
version resident on this system. Multiple versions of Tomcat will encounter conflicts.
The PC must have direct access (not through a proxy) to the Internet to complete the
Connector installation. Once the installation is complete, the PC and the SOTI MobiControl
Connector may be configured for internal access only, if needed.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
15
Installation Steps
Step 1: Install a MobiControl Server
1. Contact SOTI.
a. Contact SOTI Customer Support to obtain an MobiControl version 12.0 or later
installation.
2. Log in to the SOTI MobiControl Console using the username and password provided by
the SOTI Customer Support.
3. Click on the All Platforms tab.
4. At the bottom of the screen, click on Servers.
5. Right-click on Printer Administration Servers, and then click Create PAS Interface.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
17
7. In Step 1a, click Download (highlighted in the red box below) to start generating the
MobiControl Root Certificate.
8. When prompted, select Save As to save the certificate to the following directory:
My Documents\zebra_certs\
Note • You may have to create the directory for the certificate.
9. In Step 1b, click Download (highlighted in the orange box below) to start generating the
PAS Client Certificate.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
18
10. Create a password to proceed with the download process.
Be sure to note the password for future reference.
11. Click Download.
12. Download the PAS Client Certificate and save it in the following directory:
My Documents\zebra_certs\
13. Click Finish.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
20
3. Click Next.
4. Click I Agree to accept the terms of the License Agreement.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
21
5. Fill in all of the open fields in this form.
a. The Server Name (FQDN) is the domain name of the computer where the software is
being installed.
Example • Listed below are examples of possible FQDN server names:
mypasserver.com
mypc.company.lan
Note • Zebra licensing of this product is currently free of charge; however, we use this
information to create security certificates to enable communication to Zebra printers.
b. Click Next after completing the form.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
22
6. Fill in all of the open fields in this form.
The MobiControl Server Location is the Deployment Server End Point to which SOTI
MobiControl Connector is connected.
a. The MobiControl Server location is usually going to have the format of your
MobiControl Server DNS name followed by mc/pas (see the example below).
directory:
My Documents\zebra_certs\
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
23
7. Click Next.
8. Choose the location where you wish to install the SOTI MobiControl Connector software.
9. Click Install to proceed.
10. Wait for the installation process to complete, and then click Next.
11. Click Finish to close the Setup Wizard.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
24
Step 3: Test a Printer
Enable Printer Discovery
In this section, you must create a “rule” in the SOTI MobiControl Console in order to discover
your printers.
1. Click on the Printer tab on the SOTI MobiControl Console.
2. Click Rules in the task bar on the bottom of the screen.
3. To create a new Add Devices rule:
a. Right-click on Add Devices.
b. Click on Create Add Devices Rule.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
25
4. Enter the name of the rule.
Important • A best practice is to create a default rule to enroll devices automatically. For
example, you might choose “Discover Printers” or “Auto Enroll” as the rule name.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
26
5. Select the top level Device Group.
6. Click Next.
7. Click Next on the Blacklist/Whitelist dialog box.
8. Click Next on the Filter dialog box.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
27
9. To change the device name to show the serial number of the printer, click on the gear icon
and select Device Serial Number.
10. Click Next.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
28
11. Review the Create Add Devices Rule information, and click Finish.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
29
Step 4: Set Up Printers
1. Set up your printers to communicate with SOTI:
b. Using the ZDownloader Utility, install the firmware on your Zebra printers.
(To obtain a copy of the ZDownloader Utility, go to
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Installation
Installation Steps
30
Discover Your Printers
1. Click the Printer tab and Devices in the taskbar (at the bottom of the screen).
2. Select the top level Device Group in the left pane.
Note • If you don’t see your printer listed after several minutes, reset the printer.
3. Select one of the printers in the center pane.
4. Click Information in the right pane to see more detailed information about the selected
printer.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Configuring Printers
with WebLink
This section describes basic, network, and firewall configurations for printers connected to
SOTI MobiControl Connector.
Contents
Configuring Weblink. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Basic Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
When a Proxy Server is Part of the Network Configuration. . . . . . . . . . . . . . . . . . . . . 32
When HTTP Authentication is Necessary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Additional Firewall Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Difference Between Conn1 and Conn2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Enable Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Navigating the Log Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Configuring Printers with WebLink
Configuring Weblink
32
Configuring Weblink
When any WebLink setting (with the exception of the logging settings) is adjusted either via
SNMP, SGD, or JSON it is required that the printer be reset before the new value takes effect.
The weblink.printer_reset_required setting will be set to "yes" if there are any settings
that have been modified that require a printer reset.
Basic Configuration
To determine how much configuration is necessary, consider the following
questions:
• Is the remote server that the printer is attempting to connect to outside of the corporate
firewall?
• Does the firewall require a username and password to access the remote server?
• Does the printer require a proxy server to access the remote server?
• Does the firewall permit HTTPS connections initially, or does the printer need to connect
via HTTP first?
If the answer to any of these questions is ‘yes’, then more than the basic configuration may be
necessary. Depending upon the network environment that the printer is in, accessing the
remote server may only require that a few settings be set.
The minimum requirement is that the URL for the remote server be set. For simplicity, assume
To configure the printer to connect to the remote server:
1. Set weblink.ip.conn1.location to the URL of the remote server.
Configure the location setting as follows:
! U1 setvar "weblink.ip.conn1.location"
"https://www.examplecorpinc.com/zebra/weblink/"
2. Reset the printer.
When the printer has an IP address, it will attempt to connect to the remote server. In the
event that the remote server does not indicate that the printer has connected, logging may
need to be enabled in order to determine the failure.
When a Proxy Server is Part of the Network Configuration
If a proxy server must be used to access the remote server, the printer’s proxy setting must be
set to connect to the server. There are typically four properties associated with a proxy server:
• The proxy server scheme: HTTP or HTTPS
• The proxy server address
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Configuring Printers with WebLink
33
Configuring Weblink
• The proxy server port (optional)
• The username and password for the proxy (optional)
To supply the address of the proxy server (assuming a default port and no
username/password), configure the proxy setting as follows:
! U1 setvar "weblink.ip.conn1.proxy" "https://my.internal.proxy/"
In this scenario, the proxy address is my.internal.proxy and the scheme is HTTPS. The default
port (1080) will be used. No username or password will be used to authenticate with the proxy.
To specify an alternate port, configure the proxy as follows:
! U1 setvar "weblink.ip.conn1.proxy" "https://my.internal.proxy:3128/"
To specify a username and password configure the proxy as follows:
! U1 setvar "weblink.ip.conn1.proxy" "https://user:[email protected]/"
The proxy username, password, and the rest of the URL must follow the rules specified in
When HTTP Authentication is Necessary
Use this configuration when, for example, a firewall requires a username and/or password.
It may be necessary to specify a username and password to various routers and servers along
the path to the remote server. Typically, when using a browser to access the server, the
authentication request will be presented in the form of a dialog window that asks for the
username and password.
Because the printer’s connection to the remote server is headless and non-interactive, the
Weblink configuration allows a user to enter in a server name/username/password triplet. The
triplet will be used in the event that the printer is presented with an authentication request (for
example, this typically is requested via the HTTP/1.1 401 Unauthorized request).
To specify authentication credentials, issue the following:
! U1 setvar "weblink.ip.conn1.authentication.add" "servername.com username
password"
In this scenario, the server requesting authentication is servername.com. The username and
password to be supplied are ‘username’ and ‘password’. The server name can be either a DNS
name or an IP address. The username and password cannot be retrieved from SGD, SNMP, or
JSON once added. Only the server name will be returned.
More than one set of authentication triplets can be added. The printer will only use the
credentials as they are needed. In other words, the printer will only use the credentials for
servername.com if it receives a HTTP/1.1 401 Unauthorized request from servername.com.
To see what authentication triplets are specified issue:
! U1 getvar "weblink.ip.conn1.authentication.entries"
To remove authentication credentials issue the following:
! U1 setvar "weblink.ip.conn1.authentication.remove" "servername.com"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Configuring Printers with WebLink
Configuring Weblink
34
Additional Firewall Configuration
Some firewalls do not allow the first connection attempt for a device to be HTTPS, or they
require newconnections to be made periodically in order to keep the initial connections intact.
The weblink test branch was provided to address issues that typically arise because the printer
is an unattended device.
To configure the printer to attempt an HTTP connection anytime that the HTTPS connection
drops, issue the following commands:
! U1 setvar "weblink.ip.conn1.test.location"
"http://www.zebra.com/apps/linktest"
! U1 setvar "weblink.ip.conn1.test.test_on" "failure"
The weblink.ip.conn1.test.location can be any valid HTTP address. The default uses a
link provided by Zebra that exists for no other purpose than to help developers test their
connections to the internet. Setting weblink.ip.conn1.test.test_on to interval or both will
force the printer to attempt a connection to the URL in location every
weblink.ip.conn1.test.retry_interval seconds (default is 900 seconds/15 minutes).
To configure the printer to try an HTTP connection periodically, independent of the HTTPS
success, issue the following commands:
! U1 setvar "weblink.ip.conn1.test.location"
"http://www.zebra.com/apps/linktest"
! U1 setvar "weblink.ip.conn1.test.test_on" "interval"
! U1 setvar "weblink.ip.conn1.test.retry_interval" "900"
Difference Between Conn1 and Conn2
The printer has the ability to connect to two different servers. Connection 1 (conn1) and
Connection 2 (conn2) are identical in every way in terms of their configuration. It is expected
that conn2 will typically be left unmodified unless a user has an alternate server that they wish
to use to configure the printer.
A typical scenario in which both connections would be used is if a user wishes to have the
printer connect to both a configuration server and a data source.
Enable Logging
If your printer has trouble connecting, you may wish to enable logging. By default, logging is
not enabled in order to reduce the amount of memory consumed when the Weblink feature is
enabled. It is recommended that, once the Weblink feature is configured properly and is
performing as expected, the logging be disabled or that a very small (less than 100) number of
logging entries be permitted.
To enable logging, weblink.logging.max_entries needs to be modified. By default, it is set
to zero (0), which indicates that no messages are logged. When attempting to troubleshoot
connection issues, it is recommended that max_entries be set to at least 100 entries. Setting
max_entries to 100 means that the 100 newest logging entries will be present in
weblink.logging.entries. Older entries are discarded when the maximum number of entries
is reached.
! U1 setvar "weblink.logging.max_entries" "100"
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Configuring Printers with WebLink
35
Configuring Weblink
The logging settings are atypical to the Weblink settings as they do not require the printer to be
reset before taking effect. This does not mean that previous logging messages that would have
been logged will appear when the max_entries setting is changed from zero (0) to a greater
value. It means that any new logging messages will be logged from that point forward.
Issue the following command to clear any log entries currently in the
weblink.logging.entries buffer.
! U1 do "weblink.logging.clear" ""
Navigating the Log Output
The log will contain useful information, even in the scenario where the printer successfully
connects to the remote server. This section explains how to read the log and highlights some of
the key entries that will help to determine if the connection was successful.
A typical log entry looks as follows:
[12‐04‐2012 14:57:10.625] [conn1.1] Attempting connection to
The first column is the date and time that the event occurred. The format of the date and time
matches the format of rtc.date and rtc.time. The time, however, also includes the
milliseconds to aid in troubleshooting network latency concerns.
Note • For printers that do not have a battery to store the Real Time Clock (RTC) value, the
date will be restored to the default value upon a power cycle. The default value depends upon
how the rtc.date Set/Get/Do (SGD) is managed. If it has never been set, then it will default to
the firmware build date (the value in appl.date). Otherwise, the value in rtc.date will default
to the value that it was last set to. This does not mean the value of the rtc.date when it was
power cycled – it means that when a user sets rtc.date, that value becomes the new default
value. If the printer has a battery, then the rtc.date never defaults and continues to track the
date as expected.
The second column indicates the connection name and channel that the entries are associated
with. The connection name will match the weblink branch that was configured with the
respective URL (for example, conn1 or conn2). The channel number indicates which channel
on the respective connection that the entries corresponds to.
Note • Channels are additional connections that are requested by the server when the server
needs to perform a specific operation that cannot be done on the channel(s) currently open.
Typically only the RAW channel is open, which operates similar to the RAW TCP port. It is
typical to see two channels opened—the main channel and the RAW channel.
The third column is the actual message, which contains information about what occurred in the
printer at the corresponding time in column one. In the above example, the printer was
initiating the connection to the URL specified in weblink.ip.conn1.location.
when certain logging messages/errors appear in the log.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Configuring Printers with WebLink
Configuring Weblink
36
Notes • ____________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Troubleshooting
This section provides troubleshooting information about the SOTI MobiControl Connector.
Contents
Installation Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
SSL/TLS Certificate Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Other Typical Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
HTTP Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Troubleshooting
Installation Errors
38
Installation Errors
Issue
Reason
Solution
Error when starting Tomcat
Various reasons can cause this
error.
See Apache Tomcat website —
Tomcat Port conflict error
There is another server trying to
use the same port as SOTI
MobiControl Connector on the
computer. The default port is 443.
Choose one of the following:
•
Stop the other servers using
Windows services.
•
Change the port in Tomcat.
Important • If you change
the port, you must change
the “weblink.location” on
the printer. From the
Control Panel, open
Windows Firewall,
Advanced settings, and
manually add the Port to
the allowed
Inbound/Outbound list.
SOTI MobiControl server restarts Communication is dropped.
and the SOTI MobiControl
Connector fails to reconnect.
•
•
Create a batch file with the
string: NET STOP "SOTI
MobiControl
Connector" && NET
START "SOTI
MobiControl
Connector"
Create a Windows task to run
this batch file approximately 20
minutes after the SOTI
MobiControl server restarts.
Restarting the SOTI MobiControl Connector
1. Navigate to the Control Panel > Administrative Tools.
2. Start the Services application.
3. Click on the SOTI MobiControl Connector service.
4. In the left pane of the screen, click on Restart the service.
Locating the SOTI MobiControl Connector Log File
The SOTI MobiControl Connector Log File is located in the following directory:
%install directory%\logs\zsoticonnector.log
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Troubleshooting
SSL/TLS Certificate Errors
39
SSL/TLS Certificate Errors
Secure connections to the remote server present the opportunity for several errors when
attempting to connect. The errors typically involve the certificates used when connecting via
SSL or TLS. This section highlights some of the most common issues involving the
certificates.
Error
Cause / Solution
"SSL certificate problem: self
signed certificate in certificate
chain"
One of the situations that prevent a successful connection is not
having the correct Certificate Authority certificates installed on
the remote server. Zebra requires that the Zebra Root Certificate
Authority and the Zebra Subordinate Certificate Authority be
installed on the remote server. This error typically indicates that
only one of the Zebra Certificate Authority certificates is
installed on the remote server.
"SSL certificate problem: unable to
get local issuer certificate"
One of the situations that prevent a successful connection is not
having the correct Certificate Authority certificates installed on
the remote server. Zebra requires that the Zebra Root Certificate
Authority and the Zebra Subordinate Certificate Authority be
installed on the remote server. This error typically indicates that
neither of the Zebra Certificate Authority certificates are
installed on the remote server.
"SSL certificate problem:
certificate has expired"
This error indicates that the remote server’s certificate has
expired. This is typically an indication that the printer’s date
and/or time are incorrect as the Zebra certificates are typically
issued for long durations. Check that rtc.date and rtc.time
are set correctly.
Note • For printers that do not have a battery to store the
Real Time Clock (RTC) value, the date will be restored
to the default value upon a power cycle. The default
value depends upon how the rtc.date SGD is managed.
If it has never been set then it will default to the
firmware build date (the value in appl.date).
Otherwise, the value in rtc.date will default to the
value that it was last set to. This does not mean the value
of the rtc.date when it was power cycled. It means that
when a user sets rtc.date that becomes the new default
value.
If the printer has a battery, then the rtc.date is never
default and continues to track the date as expected.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Troubleshooting
SSL/TLS Certificate Errors
40
Error
Cause / Solution
"SSL certificate problem:
certificate is not yet valid"
This error indicates that the remote server’s certificate was
incorrectly issued or that the printer’s date and/or time are
incorrect. Check that the printer’s date and time (rtc.date and
rtc.time) are set correctly and that the certificate’s start and
expiration date are valid.
Note • For printers that do not have a battery to store the
Real Time Clock (RTC) value, the date will be restored
to the default value upon a power cycle. The default
value depends upon how the rtc.date SGD is managed.
If it has never been set then it will default to the
firmware build date (the value in appl.date).
Otherwise, the value in rtc.date will default to the
value that it was last set to. This does not mean the value
of the rtc.date when it was power cycled. It means that
when a user sets rtc.date that becomes the new default
value.
If the printer has a battery then the rtc.date is never
default and continues to track the date as expected.
"subjectAltName does not match
1.2.3.4"
Part of the certificate validation process involves making sure
that the remote server is who it claims to be. A certificate can be
created to validate against several aliases/DNS names. Typically
the certificate will not contain the IP address of the server as IP
addresses are subject to change. When specifying the remote
server’s URL via weblink.ip.conn1.location be sure to
specify one of the DNS aliases listed in the certificate. The valid
names will be listed either under the Common Name (CN) field
and/or the subjectAltName (SAN or Subject Alternate Name)
field within the certificate. For example, the certificate may
have the CN set to 'examplecorpinc' and the SAN set to
'examplecorpinc.com' or 'alias.for.examplecorpinc.com'.
Any of the CN or SAN names can be used, but, as the IP address
is not listed in the CN or SAN it cannot. It is not recommended
that the IP address be part of the SAN if a DNS name is
available to avoid connection issues that may arise due to subnet
change or DHCP lease expirations, etc.
"SSL certificate subject name
'examplecorpinc.com' does not match
target host name '1.2.3.4'"
"Unknown SSL protocol error in
connection to ...”
When this message is seen it means that the remote server’s
SSL/TLS configuration is incorrect. Refer to Troubleshooting
on page 42 to ensure the server and printer are both configured
correctly.
I do not see any of these errors, but the
printer still does not connect.
printer are both configured correctly.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Troubleshooting
Other Typical Errors
41
Other Typical Errors
While SSL/TLS connection errors are the most common, there are issues that can arise that
prevent a successful connection. This section highlights the most common issues.
Error
Cause / Solution
"Read failed with an unexpected
error"
This message typically indicates that connection to the remote
server was lost. The connection can either be lost due to the
server powering off or resetting, the firewall or proxy server
shutting down the connection, or because the remote server
gracefully requests that the connection be discontinued.
Note • After 60 seconds of inactivity on the connection
the printer will attempt to contact the server via a TCP
Keepalive. If the connection is still present the server
will respond and the connection will remain open. After
10 successive failed attempts to contact the remote the
printer will assume the connection is severed and close
the connection. The printer will resume it's attempt to
connect to the remote server so that when the server
comes back online the printer will re-establish
communication.
"Failed to connect (SP = #, CI = #,
UW = #, AC = #, PC = #)"
If this error is seen one or more of the ‘#’ values will be set to 0.
This is an indication of an incorrect configuration of the remote
server. Ensure that the remote server is setup according to the
Servlet configuration in the Zebra Link-OS SDK
documentation.
This typically indicates an incorrect version of the remote
Application Server (for example, Apache/Tomcat version may
be incorrect). If this issue persists contact Zebra Technical
Support.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Troubleshooting
Troubleshooting
42
Troubleshooting
Whenever troubleshooting a connection issue, the following questions should be answered to
ensure the configuration is correct.
1. Is the printer connected correctly via Wireless or Ethernet?
2. Does the printer have a valid IP address?
3. Can I ping the printer’s IP address from a device on the same network as the printer?
4. Is the remote server URL in weblink.ip.conn1.location correct and does it point to the
remote server that is configured for weblink functionality?
5. Can you connect to the location defined in the weblink.ip.conn1.location setting via a
browser?
6. Is the remote server I am attempting to connect to outside the corporate firewall?
7. Can the URL specified in weblink.ip.conn1.test.location be accessed?
If this is the case, talk with your administrator about altering restrictions for accessing
HTTPS connections.
8. Does the firewall require a username and password to access the remote server?
9. Do I require a proxy server to access the remote server?
10. Is the proxy server port the default (1080) or another port (for example, 3128 for the Linux
Squid proxy)?
Note • If using the Linux Proxy Server Squid, and you are having trouble connecting, note
that it may be configured to:
a. disallow POST messages
b. only operate in HTTP/1.0 mode 3
c. disallow SSL connections.
Refer to your Linux Squid documentation for complete details.
11. Does the firewall permit HTTPS connections initially or do I need to connect via HTTP
first?
12. Is the remote server configured to use SSL v3.0 or TLS 1.0?
TLS1.0 is recommended, but SSL v3.0 is also supported. Versions prior to SSL v3.0 and
later than TLS v1.0 are not currently supported.
13. Are the Zebra Certificate Authority Certificates correctly installed on the remote server?
14. Was the server’s certificate issued by Zebra and is it signed by the Zebra Certificate
Authority?
15. Has the server’s certificate expired?
16. Is the printer’s date and time within the issue and expired period of the server’s certificate?
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
Troubleshooting
HTTP Messages
43
17. Does the value in weblink.ip.conn1.location match either the Common Name or one of
the names listed in the Subject Alternate Name of the remote server’s certificate?
18. Is the proxy server configured correctly and does the respective proxy server allow
HTTPS connections via the HTTP CONNECT method?
19. Are there any HTTP authentication attempts when trying to connect that fail?
20. Are there any HTTP/1.1 4xx messages in the log?
If your connection issues persist and the solutions in this document do not help, contact Zebra
Tech Support and provide the output of the following command. Ensure that logging is
enabled and that the error(s) appear within the entries)
! U1 getvar "weblink"
HTTP Messages
Message
Cause / Solution
HTTP/1.1 100 Continue
This indicates that the server and printer have begun
communicating and is often seen in place of HTTP/1.1 200 OK.
HTTP/1.1 101 Switching Protocols
This indicates that the basic connection to the server worked
and the protocol is being switched to a more efficient protocol
for data transfer.
HTTP/1.1 200 OK
This indicates that an HTTP GET or HTTP POST was successful.
HTTP/1.1 30x Moved/Redirect/etc
This indicates that the URL specified has moved or that the
firewall redirected the printer to another location (typically this
is done to authenticate a user in a transparent proxy
configuration).
HTTP/1.1 401 Unauthorized
HTTP/1.1 403 Forbidden
HTTP/1.1 404 Not Found
This indicates that the printer either needs to authenticate with
the server or failed to authenticate with the remote server (or
server/router along the route to the server).
This typically means that the authentication was provided and
valid; however, the user does not have access to the requested
resource.
This indicates that the remote URL provided points to an invalid
location on the server. This does indicate, however, that the
server name is valid. Just the path after the domain name is
invalid.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Troubleshooting
HTTP Messages
44
Notes • ____________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do
Commands
This section describes the Set/Get/Do commands, parameters, and values that are available
with SOTI MobiControl Connector.
Contents
Introduction to SGD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
weblink.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
weblink.ip.conn[1|2].authentication.add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
weblink.ip.conn[1|2].authentication.entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
weblink.ip.conn[1|2].authentication.remove. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
weblink.ip.conn[1|2].enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
weblink.ip.conn[1|2].location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
weblink.ip.conn[1|2].proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
weblink.ip.conn[1|2].retry_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
weblink.ip.conn[1|2].test.location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
weblink.ip.conn[1|2].test.retry_interval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
weblink.ip.conn[1|2].test.test_on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
weblink.logging.clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
weblink.logging.entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
weblink.logging.max_entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
weblink.printer_reset_required. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
weblink.restore_defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
Introduction to SGD Commands
46
Introduction to SGD Commands
For more specific information about SGD syntax and structure, see the Zebra Programming
Guide section on Set/Get/Do Command Structure.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
47
weblink.enable
weblink.enable
Description This command indicates if one or more of the weblink connections are active.
If there is more than one connection under the weblink branch (for example,
weblink.ip.conn1) and if any of the .location values are set, then this SGD will be set to
"on". If all connections are disabled (all connection .location values set to ""), then this
value will be set to "off".
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type getvar
Commands
Details
This command indicates if one or more of the weblink connections are active.
getvar
Format: ! U1 getvar "weblink.enable"
Result:
•
•
"yes" if any of the .location values are set
"off" if all connections are disabled
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].authentication.add
48
weblink.ip.conn[1|2].authentication.add
Description This command allows the user to add a single server/username/password
triplet into the list of authentication entries.
When the printer attempts to connect to the server (url specified in
weblink.ip.conn[1|2].location) the server may require HTTP authentication (e.g. digest,
basic, DNS, etc.). There may be multiple authentication requests along the route to the
destination (e.g. a local server first requires HTTP authentication as well as on the remote
server).
For each HTTP authentication request received while attempting to connect, the printer will
enumerate the authentication entries and attempt to satisfy the request with the
username/password pair provided for the respective server. The server name in the entry is
what determines which username/password pair should be used for which authentication
request. Both DNS names and IP addresses are acceptable. The server, username, and
password are separated by a single space (not a tab or other white space character). The server
name is the only required field. If no username is supplied, but a password is, there must be
two spaces between the server and the password fields. If there is a username but no password,
or simply just the servername, no space is required at the end of the entry.
"on"), it will not take effect until the connection is disabled, and then re-enabled.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].authentication.add
49
Commands
Details
This command adds a single server/username/password triplet to the list of authentication
entries.
setvar
Format:
•
! U1 setvar "weblink.ip.conn1.authentication.add" "servername[ username][
password]"
•
! U1 setvar "weblink.ip.conn2.authentication.add" "servername[ username][
password]"
Values: servername [username][ password] has a maximum length of string is 2048
characters
Default: NA
Example 1 • In this example, a username and a password is supplied:
! U1 setvar "weblink.ip.conn1.authentication.add" "my.server.lan johndoe
password"
Example 2 • In this example, no password is supplied
! U1 setvar "weblink.ip.conn1.authentication.add" "my.server.lan johndoe"
Example 3 • In this example, no username is supplied (note the double space)
! U1 setvar "weblink.ip.conn1.authentication.add" "my.server.lan password"
Example 4 • In this example, no username or password is supplied
! U1 setvar "weblink.ip.conn1.authentication.add" "my.server.lan"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].authentication.entries
50
weblink.ip.conn[1|2].authentication.entries
Description This command lists the server names added to the authentication entries list.
Only the server names will be shown. The username and passwords will not be shown.The
server names are separated by a \r\n so that each shows up on its own line.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type getvar
Commands
Details
This command lists the server names for the specified connection.
getvar
Format:
•
•
! U1 getvar "weblink.ip.conn1.authentication.entries"
! U1 getvar "weblink.ip.conn2.authentication.entries"
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].authentication.remove
51
weblink.ip.conn[1|2].authentication.remove
Description This command allows the user to remove a single server/username/password
triplet from the list of authentication entries.
To remove an entry only the server name is supplied. If an invalid entry is supplied no action is
taken. If the SGD is changed when the connection is enabled
(weblink.ip.conn[1|2].enable), it will not take effect until the connection is disabled, and
then re-enabled. It is therefore recommended that this setting only be changed when
weblink.ip.conn[1|2].enable is set to "off".
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar
Commands
Details
This command removes a single server/username/password triplet from the list of
authenticaiton entries.
setvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.authentication.remove" "servername"
! U1 setvar "weblink.ip.conn2.authentication.remove" "servername"
Values: servername has a maximum length of string is 2048 characters.
Default: NA
Example • In this example, a username and a password is supplied
! U1 setvar "weblink.ip.conn1.authentication.remove" "my.server.lan"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].enable
52
weblink.ip.conn[1|2].enable
Description This command enables or disables the weblink IP connection #1.
A side effect of setting this SGD to "on", the weblink.enable will also be set to "on".
When this setting is set to "off", if the weblink.ip.conn2.enable is also "off", the
weblink.enable will be set to "off".
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, getvar
Commands
Details
This command enables/disables the weblink IP connection.
setvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.enable" "value"
! U1 setvar "weblink.ip.conn2.enable" "value"
Values: "on", "off"
Default: "off"
This command retrieves the current setting.
getvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.enable"
! U1 setvar "weblink.ip.conn2.enable"
Result:
•
•
"on" if the connection is enabled
"off" if the connection is disabled
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
SGD Wireless Commands
weblink.ip.conn[1|2].location
53
weblink.ip.conn[1|2].location
Description This command assigns the URL of the server for this connection. The URL
must follow the URL rules for the HTTP[S] protocol outlined in RFC2396
(http://www.ietf.org/rfc/rfc2396.txt).
The setting will not take effect until the printer is reset. Changing this setting will set
weblink.printer_reset_required to "yes".
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMz™ series
• QLn™ series
• ZT200™ series
• ZD500R™ series
Type setvar, getvar
Commands
Details
This command sets the server URL for the specified connection.
setvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.location" "value"
! U1 setvar "weblink.ip.conn2.location" "value
Values: any HTTPS URL up to 2048 characters
Default: ""
This command returns the server URL currently assigned to the connection.
getvar
Format:
•
•
! U1 getvar "weblink.ip.conn1.location"
! U1 getvar "weblink.ip.conn2.location"
Example •
! U1 setvar "weblink.ip.conn2.location"
"https://my.linkos.server.com:8080/link/os"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
SGD Wireless Commands
weblink.ip.conn[1|2].maximum_simultaneous_ connections
54
weblink.ip.conn[1|2].maximum_simultaneous_
connections
Description This command indicates the maximum number of simultaneous connections
that can be initiated by the printer.
Via the main connection (the original connection initiated by the printer to the remote server),
the remote server can request that additional connetions from the printer be initated (e.g. a
connection that supports only JSON SGDs, one that behaves similar to the RAW TCP port.
The server is free to request as many as it thinks it needs, but the printer will prevent more than
N number of connections, where N is the value of this command.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, getvar
Commands
Details
This command sets the maximum number of connections.
setvar
Format:
•
! U1 setvar "weblink.ip.conn1.maximum_simultaneous_connections"
"value"
•
! U1 setvar "weblink.ip.conn2.maximum_simultaneous_connections"
"value"
Values: Any integer from 1-100
Default: "10"
This command retrieves the maximum set number of connections.
getvar
Format:
•
•
! U1 getvar "weblink.ip.conn1.maximum_simultaneous_connections"
! U1 getvar "weblink.ip.conn2.maximum_simultaneous_connections"
Example • This example sets the conn1 maximum connections to 3.
! U1 setvar "weblink.ip.conn1.maximum_simultaneous_connections" "3"
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
55
weblink.ip.conn[1|2].proxy
weblink.ip.conn[1|2].proxy
Description This command assigns the URL of the proxy for the connection.
The proxy server protocol, port, domain, username, and password are all encoded into the
URL via the format outlined in RFC2396 (http://www.ietf.org/rfc/rfc2396.txt).
The username and password must avoid the invalid characters listed in RFC2396 (e.g. ':', '@',
'/', etc). If an invalid character must be used it needs to be escaped using '%' as described in
RFC2396.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, getvar, do
Commands
Details
This command assigns the URL of the connection proxy.
setvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.proxy" "url"
! U1 setvar "weblink.ip.conn2.proxy" "url"
Values:
•
•
•
Any valid URL up to 2048 characters
Expected URL format: [http|https]://[user:pass@]domain[:port]/[path]
The URL will need to be built according to the server/proxy environment the printer is
running within.
Default: ""
•
•
•
•
The user:pass, port, and path are all optional.
The default scheme must be either HTTPS or HTTP. The default is HTTP.
The default port is 1080.
The default is to omit the username and password.
This command retrieves the URL of the connection proxy.
getvar
Format:
•
•
! U1 getvar "weblink.ip.conn1.proxy"
! U1 getvar "weblink.ip.conn2.proxy"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].proxy
56
Commands
Details
This command assigns the URL of the connection proxy.
do
Format:
•
•
! U1 do "weblink.ip.conn1.proxy" "url"
! U1 do "weblink.ip.conn2.proxy" "url"
Values:
•
•
•
Any valid URL up to 2048 characters
Expected URL format: [scheme://][user:pass@]domain[:port]/[path]
The URL will need to be built according to the server/proxy environment the printer is
running within.
Default: ""
•
•
•
•
The scheme, user:pass, port, and path are all optional.
The default scheme is http.
The default port is 1080.
The default is to omit the username and password.
Example • Examples of how to connect to various proxy servers:
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].retry_interval
57
weblink.ip.conn[1|2].retry_interval
Description This command sets the number of seconds between attempts to connect to the
server URL provided in weblink.ip.conn1.location. If an attempt is unsuccessful or the
connection is lost, the printer will wait 'retry_interval' seconds before attempting to
connect again.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, getvar, do
Commands
Details
This command sets the number of seconds to wait before attempting to reconnect to the
server.
setvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.retry_interval" "value"
! U1 setvar "weblink.ip.conn2.retry_interval" "value"
Values: 1 ‐ 600
Default: "10"
This command returns the number of seconds to wait between connection attempts.
getvar
Format:
•
•
! U1 getvar "weblink.ip.conn1.retry_interval"
! U1 getvar "weblink.ip.conn2.retry_interval"
This command sets the number of seconds to wait before attempting to reconnect to the
server.
do
Format:
•
•
! U1 do "weblink.ip.conn1.retry_interval" "value"
! U1 do "weblink.ip.conn2.retry_interval" "value"
Values: 1 ‐ 600
Default: "10"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].test.location
58
weblink.ip.conn[1|2].test.location
Description This command holds the URL for testing a connection to the internet. This is
meant to assist users in debugging their printer's connection to remote servers when there are
issues with the main weblink connection (conn1 or conn2).
The URL must follow the URL rules for the HTTP[S] protocol outlined in RFC2396
(http://www.ietf.org/rfc/rfc2396.txt).
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, getvar, do
Commands
Details
This command sets the URL to hold for testing a connection.
setvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.test.location" "url"
! U1 setvar "weblink.ip.conn2.test.location" "url"
Values: Any HTTPS URL up to 2048 characters
Default: "http://www.zebra.com/apps/linktest"
This command retrieves the printer's test connection URL.
getvar
Format:
•
•
! U1 getvar "weblink.ip.conn1.test.location"
! U1 getvar "weblink.ip.conn2.test.location"
This command sets the URL to hold for testing a connection.
do
Format:
•
•
! U1 do "weblink.ip.conn1.test.location" "url"
! U1 do "weblink.ip.conn2.test.location" "url"
Values: Any HTTPS URL up to 2048 characters
Default: "http://www.zebra.com/apps/linktest"
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].test.location
59
Example • The test connection can assist the user in several ways/scenarios:
1. If the test.test_on value is set to "failure", any time the main weblink
(conn[1|2].location) connection fails to connect then the test.location URL will be
used. In this situation, an attempt will be made to contact the remote URL in
test.location, using authentication and proxy configuration that is specified by the main
connection.
2. If the test.test_on value is set to "interval" an attempt will be made to contact the
remote URL in test.location every test.retry_interval seconds, using authentication
and proxy configuration that is specified by the main connection.
3. If the test.test_on value is set to "both", then scenario 1 and 2 will both occur. This is
useful for users who will use an HTTP connection to move through their firewall - and
thereafter frequently refresh the connection to indicate to their firewall that there is still
activity for the purpose of keeping the connection alive.
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].test.retry_interval
60
weblink.ip.conn[1|2].test.retry_interval
Description This command determines how often, in seconds, a connection to the
test.location URL should be attempted. This setting is only applicable when the test.test_on
SGD is set to "interval" or "both".
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setevar, getvar, do
Commands
Details
This command sets the interval for how often a connection to the test.location URL should
be attempted.
setvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.test.retry_interval" "value"
! U1 setvar "weblink.ip.conn2.test.retry_interval" "value"
Values: 0‐1800 (in seconds, providing 0 second ‐ 30 minute interval)
Default: "900"
This command retrieves the retry interval.
getvar
Format:
•
•
! U1 getvar "weblink.ip.conn1.test.retry_interval"
! U1 getvar "weblink.ip.conn2.test.retry_interval"
This command sets the interval for how often a connection to the test.location URL should
be attempted.
do
Format:
•
•
! U1 do "weblink.ip.conn1.test.retry_interval" "value"
! U1 do "weblink.ip.conn2.test.retry_interval" "value"
Values: 0‐1800
Default: "900"
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].test.test_on
61
weblink.ip.conn[1|2].test.test_on
Description This command determines when the test connection should be attempted. This
assists in debugging the printer's connection to remote servers when there are issues with the
main weblink connection (conn1 or conn2).
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, getvar, do
Commands
Details
This command indicate when the test connection should be attempted.
setvar
Format:
•
•
! U1 setvar "weblink.ip.conn1.test.test_on" "value"
! U1 setvar "weblink.ip.conn2.test.test_on" "value"
Values: off,failure,interval,both
Default: "failure"
This command retrieves the test connection setting.
getvar
Format:
•
•
! U1 getvar "weblink.ip.conn1.test.test_on"
! U1 getvar "weblink.ip.conn2.test.test_on"
This command sets when the test connection should be attempted.
do
Format:
•
•
! U1 do "weblink.ip.conn1.test.test_on" "value"
! U1 do "weblink.ip.conn2.test.test_on" "value"
Values: off,failure,interval,both
Default: "failure"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.ip.conn[1|2].test.test_on
62
Example • The test connection can assist the user is several ways/scenarios:
1. If the test.test_on value is set to "failure", any time the main weblink
(conn[1|2].location) connection fails to connect then the test.location URL will be
used. An attempt will be made to contact the remote URL in test.location, using
authentication and proxy configuration that is specified by the main connection.
2. If the test.test_on value is set to "interval" an attempt will be made to contact the
remote URL in test.location every test.retry_interval seconds, using authentication
and proxy configuration that is specified by the main connection.
3. If the test.test_on value is set to "both", then scenario 1 and 2 will both occur. This is
useful for users who will use an HTTP connection to move through their firewall - and
thereafter frequently refresh the connection to indicate to their firewall that there is still
activity for the purpose of keeping the connection alive.
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
63
weblink.logging.clear
weblink.logging.clear
Description This command clears the weblink log. Setting this value to anything will clear
it, including an empty string.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, do
Commands
Details
This command clears the weblink log entires.
Format: ! U1 setvar "weblink.logging.clear" "value"
Values: Any string value, including an empty string.
setvar
Default: NA
This command clears the weblink log entires.
do
Format: ! U1 do "weblink.logging.clear" "value"
Values: Any string value, including an empty string.
Default: NA
Example • This example clears the weblink log entries with an empty string value.
! U1 setvar "weblink.logging.clear" ""
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.logging.entries
64
weblink.logging.entries
Description This command returns the N number of entries in the weblink log, where N has
a maximum value that is set by weblink.logging.max_entries.
The weblink log is a collection of events related to connecting to a remote Link-OS™ server.
The log entries range anywhere from general status to errors that prevented a successful
connection. The log contains entries from all connections and are labeled so that it is clear
which log entries are for which connection. Each log entry also contains a timestamp for when
it was logged by the system. The newest events will appear at the bottom of the list.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type getvar
Commands
Details
This command returns a lists of entries in the weblink log.
getvar
Format: ! U1 getvar "weblink.logging.entries"
Values: NA
Default: ""
Example • This example shows the result from weblink.logging.entries:
[01‐04‐2013 08:40:45.655] [conn1.1] HTTP/1.1 404 Not Found
[01‐04‐2013 08:40:45.659] [conn1.1] Received HTTP code 404 from proxy after
CONNECT
[01‐04‐2013 08:40:45.660] [conn1.1] Closing connection
[01‐04‐2013 08:40:45.662] [conn1.1] Failed to connect (SP = 0, CU = 0, UW = 0, AC
= 0, PC = 0)
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
65
weblink.logging.max_entries
weblink.logging.max_entries
Description This command specifies the maximum number of individual log entries that
will be stored in the weblink.logging.entries command.
Important • Changes to this command are immediate and may result in some log entries being
lost. If there are N log entries currently in the log, the user sets the max_entires to M, where
M is less than N, the oldest (N-M) log entries will be removed.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, getvar, do
Commands
Details
This command sets the maximum number of log entires that will be stored.
Format: ! U1 setvar "weblink.logging.max_entries" "value"
setvar
Values: 0 ‐ 10000
Note • Setting the value to 0 disables logging.
Default: "0"
This command returns the setting for the maximum number of log entries that will be stored.
getvar
do
Format: ! U1 getvar "weblink.logging.max_entries"
This command sets the maximum number of log entires that will be stored.
Format: ! U1 do "weblink.logging.max_entries" "value"
Values: 0 ‐ 10000
Note • Setting the value to 0 disables logging.
Default: "0"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.logging.max_entries
66
Example 1 • In this example, weblink.logging.max_entries is set to 3:
[01‐04‐2013 08:40:45.659] [conn1.1] Received HTTP code 404 from proxy after
CONNECT
[01‐04‐2013 08:40:45.660] [conn1.1] Closing connection
[01‐04‐2013 08:40:45.662] [conn1.1] Failed to connect (SP = 0, CU = 0, UW = 0, AC
= 0, PC = 0)
Example 2 • In this example, weblink.logging.max_entries is set to 2:
weblink.logging.entries becomes:
[01‐04‐2013 08:40:45.660] [conn1.1] Closing connection
[01‐04‐2013 08:40:45.662] [conn1.1] Failed to connect (SP = 0, CU = 0, UW = 0, AC
= 0, PC = 0)
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
67
weblink.printer_reset_required
weblink.printer_reset_required
Description This command retrives a "yes" or "no" value indicating whether any of the
weblink settings have been modified.
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type getvar
Commands
Details
This command retrieves whether any of the weblink settings are modified.
Format: ! U1 getvar "weblink.printer_reset_required"
Values: "yes" or "no"
getvar
Default: "no"
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
WebLink Set/Get/Do Commands
weblink.restore_defaults
68
weblink.restore_defaults
Description This command defaults, and saves, the weblink branch settings. Any value,
including an empty string, will default the weblink branch settings.
Note • The entire weblink branch of settings will be defaulted and the settings are saved;
however, the weblink connections will not use the new settings until the printer is restarted
(e.g. the weblink.printer_reset_required SGD will be "yes" after a default).
^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this
setting.
Supported Devices
• iMZ 220™, iMZ 320™
• QLn220™, QLn320™, QLn420™
• ZT210™, ZT220™, ZT230™
Type setvar, do
Commands
Details
This command defaults the weblink branch settings.
Format: ! U1 setvar "weblink.restore_defaults" "value"
Values: Any value, including an empty string, will default the branch
setvar
Default: NA
This command defaults the weblink branch settings.
do
Format: ! U1 do "weblink.restore_defaults" "value"
Values: Any value, including an empty string, will default the branch
Default: NA
Example • These all default the branch:
! U1 setvar "weblink.restore_defaults" ""
! U1 setvar "weblink.restore_defaults" "foo"
! U1 do "weblink.restore_defaults" ""
! U1 do "weblink.restore_defaults" "foo"
P1071336-002
1/20/15
Download from Www.Somanuals.com. All Manuals Search And Download.
69
1/20/15
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
Zebra Technologies Corporation
Zebra Technologies Corporation
475 Half Day Road, Suite 500
Lincolnshire, IL 60069 USA
T: +1 847 634 6700
Toll-free +1 866 230 9494
F: +1 847 913 8766
Zebra Technologies Europe Limited
Dukes Meadow
Millboard Road
Bourne End
Buckinghamshire, SL8 5XF, UK
T: +44 (0)1628 556000
F: +44 (0)1628 556001
Zebra Technologies Asia Pacific, LLC
120 Robinson Road
#06-01 Parakou Building
Singapore 068913
T: +65 6858 0722
F: +65 6885 0838
© 2015 ZIH Corp.
P1071336-002
Download from Www.Somanuals.com. All Manuals Search And Download.
|