KYOCERA Fleet Services KFS Connection Method Guide

Introduction

KFS can connect to devices in a variety of ways. This document will help you find the best connection method for customer requirements.

Revision history

Connection method

List of Connection Methods

The following outlines a list of device connection methods.

Diagram Description: A network diagram illustrates the connection architecture. It shows a central KFS Manager connected to a NetGateway, which then connects to devices via a Customer Intranet. Devices can be KFS Direct (via Proxy Server in NetGateway), USB-connected Devices, or Legacy & Competitor Devices. The diagram also depicts a Firewall and a Proxy Server.

Recommended Connection Method

The recommended connection method for customer requirements is as follows:

NetGateway connected USB Device Settings

Add a device connected to the NetGateway PC (Local Agent PC) with a USB cable.

NetGateway Settings

Install the local agent (KyoceraAgent.msi) on the PC that will be USB connected to the device.

Screenshot Description: A screenshot shows the NetGateway interface with options for Monitoring, Settings, and Admin. Under Settings, a dropdown menu includes 'Proxy settings', 'KFS device connection mode', 'Task execution setting', 'Download local agent', 'Copy local agent URL', 'Automatic upgrade', 'Update interval', and 'Logs'.

NetGateway - Add devices

Screenshot Description: A dialog box for adding devices shows 'Discovery Settings' with 'Discovery method' set to 'By local network'. Target options include IPv4 and IPv6. A checkbox for 'USB devices' is present, with an option to 'Discover USB-connected devices'.

Trouble shooting flow:

• Wait a few minutes after completion of Install Target device USB driver on the PC. Then, check after device discovery.
• Check if the device state is in ready state.
• Check if device discovery settings are ok.
• Uninstall device USB drivers not used on the PC, and install only the target USB driver, if possible.

Check (Things to Check) details one by one:

Connection setting

Checklist Overview for Device Discovery/Registration/Online

Model Compatibility

The following tables list models compatible with different settings. √1 indicates models requiring specific settings, √2 indicates legacy models, and a checkmark indicates compatibility with all models.

Examples with Screenshots

Device - Security Settings

Certificate Verification: HASH: SHA2 Enabled

Screenshot Description: Security Settings: Network Security interface showing 'Certificate Verification' with 'Validity Period' set to 'On' and 'Hash' set to 'SHA2(256/384)'.

Server-side Settings

TLS Version: TLS1.2 Enabled HASH: SHA2 Enabled

Screenshot Description: Security Settings: Network Security interface showing 'Secure Protocol Settings'. 'TLS Version' is set to 'TLS1.2', and 'Hash' is set to 'SHA2(256/384)'. 'Effective Encryption' options like AES and AES-GCM are visible.

Client-side Settings

TLS Version: TLS1.2 Enabled HASH: SHA2 Enabled

Screenshot Description: Security Settings: Network Security interface showing 'Client-side Settings' with 'TLS Version' set to 'TLS1.2'. 'REST Security' is set to 'Secure Only (REST over SSL)'. 'Effective Encryption' options are listed.

Device - Device Settings

Date/Time: Within valid date/time range of certificate in KFS Server

Screenshot Description: Device Settings: Date/Time interface showing fields for Year, Month, Day, and Time. It displays 'Current Local Time' and 'Current Universal Time (UTC/GMT)'. A certificate information pop-up shows it is valid from 3/25/2020 to 6/24/2022.

Device - Network Settings

Protocol: Enhanced WSD and Enhanced WSD over SSL should be enabled.

HTTP/HTTPS: Enabled

Screenshot Description: Network Settings: Protocol interface showing 'Universal Print', 'SOAP', 'Enhanced WSD', and 'Enhanced WSD over SSL' settings, all enabled. It also shows 'Enhanced WSD over SSL Certificate' and 'LDAP' settings.

Device - Management Settings

Remote Services: Correct information e.g. Access Code, Server URL etc. (Insufficient characters like a “blank-space” were removed)

Screenshot Description: Management Settings: Remote Services interface showing 'Server Settings'. Fields include 'Registration By' (dropdown 'Use Access Code'), 'URL' (input field), 'Proxy' (input field with 'Settings' button), 'Proxy Authentication' (User Name, Password), 'Access Code', and 'Description'.

SNMP

SNMPv1/v2c: Enabled. Read Community: Compatible with NetGateway Discovery and Communication Settings. Write Community: Compatible with NetGateway Discovery and Communication Settings.

When SNMP v3: Enabled. Compatible with NetGateway Discovery and Communication Settings.

Screenshot Description: Two screenshots of Management Settings: SNMP. The first shows SNMPv1/v2c settings with 'Read Community' and 'Write Community' fields. The second shows SNMPv3 settings with options for 'Authentication' (MD5, SHA1), 'Privacy' (DES, AES), 'Read Only User', and 'Read/Write User'.

NetGateway - Discovery Settings

Communication Settings

SNMP Type: Compatible with Device Settings. Secure protocol (SSL): Compatible with Device Settings. Device login: Compatible with Device Settings, valid User/PW info.

Screenshot Description: Two screenshots of 'Communication settings'. The first shows 'SNMP type', 'Read community name', 'Write community name', 'SNMP authentication', 'SNMP privacy', and 'Context name'. The second shows 'Secure protocol (SSL)' enabled and 'Device login' with 'Authentication type' as 'Local authentication' and fields for 'User name' and 'Password'.

PC computer - for Single Point Connection (SPC) Enabled case.

Proxy settings

Screenshot Description: Screenshot of 'Proxy settings' dialog. Options include 'Direct connection' and 'Use HTTP Proxy'. If 'Use HTTP Proxy' is selected, fields for 'Host name', 'Port', and 'Enable authentication' (User name, Password) are shown. A checkbox for 'Use Gateway as a single point of communication' is present.

Network environment

Confirm that Name resolution works fine in network environment. (Register devices with proxy settings "NetGateway installed computer name" as Hostname) or Set actual IP address without hostname.

Screenshot Description: Screenshot of 'Register your devices' section. Fields for 'Access code', 'KFS Manager authentication' (Host name, User name, Password, Description), and 'Do not use proxy settings for the following domains' are shown. A warning about proxy settings overwriting Remote Services firmware is displayed.

Firewall Inbound Rule:

Permit specified Port (8081 as default - Possible to change it when NetGateway is first installed).

Screenshot Description: Screenshot of Windows Defender Firewall with Advanced Security, showing 'Inbound Rules' and 'Outbound Rules'.

Notes for success of Device Discovery/Registration/Online

• Check whether or not the previous registered device still shows in KFS Manager:
• When Remote Services settings is turned OFF, via U520 or CCRX without deleting the device in KFS Manager, then the previous registered device remains in KFS Manager.
• You must search KFS Manager with both "Serial number" and "MAC address" on the device and delete the previous remaining device in KFS Manager. If not deleted, then device registration will fail with error code 403.
• When you have Unstable SNMP responses, a good way to prevent this issue is to make the NetGateway Timeout setting longer
• Confirm that no problems are found in network environment

Additional information on NetGateway

Device information polling

NetGateway periodically polls Alert data, Counter data and Consumable data from each device. This is because NetGateway to Device communication is uni-directional which means there is no Device to NetGateway communication. The polling interval for each device can be changed depending on the number of managed devices (displayed devices) on the NetGateway device list. The more devices you have on KFS, the longer the interval will be between polling. If your NetGateway has a lot of devices, the polling interval can be longer. Also, if the device data (toner level or counter value) is not frequently updated, the priority category will be lower. As a result, the polling interval will be longer and your device will be put into the category depending on the devices registered.

If the target device is turning ON only for a specific time period, normal work hours and the polling interval by NetGateway is longer for the device, the device information polling can fail. In this case, you can solve the problem in two ways:

• Having multiple NetGateways to separate managed devices.
• Turning on the device for longer hours.

Authentication type/Authentication information

Authentication type/Authentication information is used for Enhanced WSD communication with the device. Enhanced WSD communication is TCP based communication and can have more stable communication with the device, unlike SNMP (UDP based communication).

To use Enhanced WSD communication, you need to enable Enhanced WSD and/or Enhanced WSD over SSL on the device as shown below (under Network Settings in Command Center).

Screenshot Description: Network Settings: Protocol interface showing 'Universal Print', 'SOAP', 'Enhanced WSD', and 'Enhanced WSD over SSL' settings, all enabled. It also shows 'Enhanced WSD over SSL Certificate' and 'LDAP' settings.

When using Enhanced WSD over SSL, “Secure Only” should be selected as Enhanced WSD Security. You can see the setting on the device shown below (under Security Settings on Command Center).

Screenshot Description: Security Settings: Network Security interface showing 'TLS Version', 'Effective Encryption', 'Hash', 'HTTP Security', 'IPP Security', 'Enhanced WSD Security' (set to 'Secure Only (Enhanced WSD over SSL)'), 'eSCL Security', and 'REST Security'.

If you want to use Enhanced WSD communication for communication with the device, you need to use the same Username and Password with it on the device.

Screenshot Description: Screenshot showing 'Authentication type' options: 'Local authentication' and 'Device settings'. 'Authentication information' fields for 'User name' and 'Password' are displayed.

You can view Authentication type and related Username and Password under Management Settings on Command Center.

Screenshot Description: Management Settings: Authentication interface showing 'Settings' and 'Local User List' with columns for 'Select', 'User Name', and 'Login User Name'. An 'Add User' button is visible.

Also, if Enhanced WSD communication with the device is NOT available, you can check if there is a "Warning” WSD status on NetGateway device list page.

If there is an “OK” WSD status, you can enter correct information on Communication settings for target device, and then click “Refresh” button on NetGateway UI. This "Refresh" feature checks NetGateway to see if Enhanced WSD communication is available, based on the configured Communication settings.

Screenshot Description: NetGateway UI showing navigation buttons: 'Add devices', 'Excluded devices', 'Register devices', 'Communication settings', 'Device home', 'Refresh', 'View tasks', 'Manage Device settings', 'Computers'.