Kyocera NET ADMIN User Guide
Legal Notes
Unauthorized reproduction of all or part of this guide is prohibited.
The information in this guide is subject to change without notice.
We cannot be held liable for any problems arising from the use of this product, regardless of the information herein.
Regarding Trademarks
KYOCERA Net Admin is a trademark of KYOCERA Document Solutions Inc.
Microsoft®, Windows®, and Internet Explorer are registered trademarks of Microsoft Corporation in the U.S. and/or other
countries.
All other brand and product names herein are registered trademarks or trademarks of their respective companies.
Examples of the operations given in this guide support the Microsoft Windows Server 2008 R2 printing environment.
Essentially the same operations are used for Microsoft Windows XP, Vista, and Windows 7 environments.
The features described in this guide vary depending on your device model.
© 2013 KYOCERA Document Solutions Inc.
Table of Contents
Chapter 1 Login and Consoles
KYOCERA Net Admin Login ......................................................................................................... 1-1
Starting and Logging In ........................................................................................................... 1-1
Log Off ..................................................................................................................................... 1-1
Consoles ....................................................................................................................................... 1-2
Choosing a Console ................................................................................................................ 1-2
Changing the Default Console ................................................................................................. 1-2
Chapter 2 Administration
Roles and Users ............................................................................................................................ 2-1
Adding a Role .......................................................................................................................... 2-1
Adding a User .......................................................................................................................... 2-1
User Properties ............................................................................................................................. 2-2
Changing the Password .......................................................................................................... 2-2
Unlocking a User ..................................................................................................................... 2-2
Subscriptions ................................................................................................................................ 2-3
Adding an Alert Subscription ................................................................................................... 2-3
Adding a Report Subscription .................................................................................................. 2-3
Copying or Moving a Subscription ........................................................................................... 2-4
Networks and Agents .................................................................................................................... 2-4
Adding Networks ..................................................................................................................... 2-5
Deleting a Network .................................................................................................................. 2-7
Network Properties .................................................................................................................. 2-7
Start/Stop Discovery ................................................................................................................ 2-8
USB Connections .......................................................................................................................... 2-8
Manage Installation Packages ...................................................................................................... 2-8
Uploading Installation Packages ............................................................................................. 2-9
Upgrading an Agent ................................................................................................................. 2-9
Mail Server .................................................................................................................................... 2-9
Selecting E-mail Settings ....................................................................................................... 2-10
Device Communication ............................................................................................................... 2-10
Database ..................................................................................................................................... 2-10
Backing Up a Database ......................................................................................................... 2-11
Restoring a Database ............................................................................................................ 2-11
Log View ..................................................................................................................................... 2-11
Creating a Log File ................................................................................................................ 2-12
Selecting Log File Storage .................................................................................................... 2-12
Exporting a Log File Manually ............................................................................................... 2-13
Scheduled Jobs ........................................................................................................................... 2-13
Security ....................................................................................................................................... 2-13
Chapter 3 Device Manager
Manage Groups ............................................................................................................................ 3-1
Add Group ............................................................................................................................... 3-1
Dynamic Groups ...................................................................................................................... 3-1
KYOCERA Net Admin 3.1 i
Manual Groups ........................................................................................................................ 3-2
Preferences ................................................................................................................................... 3-3
Polling Defaults ....................................................................................................................... 3-3
Alert Configuration ................................................................................................................... 3-4
Custom Properties ................................................................................................................... 3-5
List View ........................................................................................................................................ 3-5
User Preferences .................................................................................................................... 3-6
Global Characteristics ............................................................................................................. 3-6
Saving Changes ...................................................................................................................... 3-6
Scrolling and Resizing the Window ......................................................................................... 3-6
Set Rows per Page .................................................................................................................. 3-6
Edit Default List Views ............................................................................................................. 3-7
Add Tab ................................................................................................................................... 3-7
Import Default Tab ................................................................................................................... 3-8
Edit Tab ................................................................................................................................... 3-8
Deleting a Tab ......................................................................................................................... 3-9
Map View .................................................................................................................................... 3-10
Map View Toolbar .................................................................................................................. 3-10
Map Background ................................................................................................................... 3-10
Device Icon Properties .......................................................................................................... 3-12
Hide or View Waiting Area Icons ........................................................................................... 3-12
Links ...................................................................................................................................... 3-12
Saving Map Settings .............................................................................................................. 3-13
Subscriptions .............................................................................................................................. 3-13
Adding an Alert Subscription ................................................................................................. 3-14
Adding a Report Subscription ................................................................................................ 3-14
Adding Devices ........................................................................................................................... 3-15
Refresh ....................................................................................................................................... 3-15
Select All ..................................................................................................................................... 3-15
Open Device Home Page ............................................................................................................ 3-15
Status Filter ................................................................................................................................. 3-16
Setting a Status Filter ............................................................................................................ 3-16
Show or Hide Unmanaged Devices ....................................................................................... 3-16
Multi-Set ...................................................................................................................................... 3-16
Multi-Set Installation .............................................................................................................. 3-16
Configuring Selected Devices ............................................................................................... 3-17
Multi-Set Log File ................................................................................................................... 3-18
Device Applications ..................................................................................................................... 3-19
Installing an Application ......................................................................................................... 3-19
Activating an Installed Application ......................................................................................... 3-20
Firmware Upgrade ...................................................................................................................... 3-20
Risks and Recovery Options ................................................................................................. 3-21
Upgrading the Firmware ....................................................................................................... 3-22
Send Data ................................................................................................................................... 3-23
Sending Data by TCP or IPPS ............................................................................................... 3-24
Device Properties ........................................................................................................................ 3-24
Displaying Device Properties ................................................................................................. 3-24
Manage Reports .......................................................................................................................... 3-26
Creating a Device Manager Report ....................................................................................... 3-26
Editing Device IDs and Device Properties ............................................................................. 3-27
Selecting a Report Template ................................................................................................. 3-27
Create Report Subscriptions ................................................................................................. 3-28
Export a Report ........................................................................................................................... 3-29
Search ......................................................................................................................................... 3-29
ii User Guide
Searching for Printing Devices .............................................................................................. 3-29
Chapter 4 Multi-Set Template Editor
Creating New Settings .................................................................................................................. 4-1
Editing a Multi-Set Template ......................................................................................................... 4-1
Importing a CSV File ..................................................................................................................... 4-2
Adding an Existing Template File .................................................................................................. 4-2
Multi-Set Template Options ........................................................................................................... 4-3
KYOCERA Net Admin 3.1 iii
1 Login and Consoles
KYOCERA Net Admin is a Web-based application that is opened with
Microsoft Internet Explorer. You are required to log on to the application with a
User name and Password.
KYOCERA Net Admin Login
On the login page, you can use the following default login credentials:
Administrator
User name: admin
Password: admin
Read-only user
User name: guest
Password: guest
For greater security, we recommend changing the default passwords
immediately after the first login.
You will be automatically logged off after 30 minutes of inactivity.
Note: To prevent the browser from freezing, do not use the keyboard shortcut
Ctrl+N to open a new window while the application is running.
Starting and Logging In
You can start KYOCERA Net Admin from Internet Explorer 7 or higher.
In the browser, click the application’s address in the format: http://<computer
1
name or IP address>:<port number>/netadmin/ or find the URL in the Favorites
or browser history.
On the login page, type the User name and Password.
2
Choose a console to open from the list, or choose Default Console. You can
3
change the default console after logging in.
Click Log in.
4
Log Off
To log off from the application, in the navigation area, click Switch Console,
then select Log off.
A user is automatically logged off if the software is not used for 30 minutes.
1-1 User Guide
Consoles
Login and Consoles
You can choose a console when logging on to KYOCERA Net Admin, and you
can change to a different console at any time.
If you select Choose a console to open when logging on, the console you
select from the list is displayed.
The available consoles are:
Administration
A console for managing user accounts/roles, network/agent discovery, and
system settings.
Device Manager
A console for managing device data, polling, alerts, and preferences.
Choosing a Console
You can change to a different console at any time.
In any console, click Switch Console.
1
Select the desired console from the list.
2
Changing the Default Console
If you select Open the default console and log on, your preferred console is
displayed.
To change the default console:
Log on to KYOCERA Net Admin.
1
In the navigation area, click Switch Console, then select a console.
2
After the console has loaded, click Switch Console again and click Set As
3
Default Console.
KYOCERA Net Admin 3.1 1-2
Roles and Users
2 Administration
The Administration console lets you manage roles and users, set properties
and subscription views, and change network and discovery options. In this
console, e-mail settings, database backup schedules and the device
communication can be selected.
Your firewall must be properly configured to use these functions.
The navigation area lists all roles and the users that belong to each role. There
are several default roles and users created when the application is first installed.
These default roles are Administrators, Assistant Administrators, Help
Desk, Subscribers, and Read-only. The properties for the Administrators
role are unavailable and cannot be edited. All default roles can be renamed
except for Administrators and Subscribers. Privileges define what activities
each role is permitted. Privileges for all roles can be edited, except for the
Administrators role. The default users are Administrator and Guest.
There are different sets of privileges for each default role. The Administrators
role is assigned all privileges by default. These privileges include options to edit
Administration and Device Manager consoles.
Adding a Role
You can add new roles to the existing default roles.
In the navigation area, select a role or user.
1
Click the Add role icon.
2
In the Add role dialog box, type a Role name for the new role. Do not use
3
invisible Unicode or extended ASCII characters. The name must be unique.
For Based on, you can select a default role to base this new role on, or select
4
None. If you select an existing role, the Privileges for that role are displayed
below. You can modify these privileges for the new role you are adding.
Select the privileges to assign to the new role. Click the arrows next to the
5
check boxes under Privileges to expand the list for more options.
Click OK to finish adding the role.
6
You can delete any role except Administrators and Subscribers by selecting
the role, then clicking the Delete role icon.
Adding a User
You can add a new user.
2-1 User Guide
1
2
3
4
5
6
User Properties
Administration
In the navigation area, select a role or user.
Click the Add user icon.
In the Add user dialog box, under Select user type, select Login user or
Subscribers (for receiving alerts and reports only).
Administrators can set privileges, a login name, and contact information.
The contact information is used for alert and report subscriptions by e-mail.
Under Required Properties, enter information as defined by user type and
required by alerts. Do not use invisible Unicode or extended ASCII characters.
Under Optional Properties, enter optional user information.
Click OK.
User Properties displays and sets details about the user. You can view and
edit properties, change a password, unlock a user, and delete or disable an
account. An administrator or user must be selected in the navigation area.
Changing the Password
An administrator or a user with Modify Self privilege can change the password
used to log on to the application.
Select an administrator or user in the navigation area.
1
Select User properties.
2
Click Change password.
3
Type the new password, and type again to confirm.
4
Click OK.
5
Unlocking a User
An administrator or a user with Login users / Full Control privilege can unlock
login access for another user before the User locking time set in Security
expires.
Select an administrator or user in the navigation area.
1
Select User properties.
2
Click Unlock user.
3
KYOCERA Net Admin 3.1 2-2
Administration
Subscriptions
Click OK.
4
Subscriptions can be created for groups, and child groups inherit subscriptions
from parent groups. Inheritance is only available for dynamic groups, and not
for manual groups. A dynamic group is a device group established by userdefined device filters.
In the Alert Sets area, inherited subscriptions are shown in gray, and the parent
group from which the subscription is inherited is shown in parenthesis.
Alert e-mails can be sent to any user. The application allows Subscribers, as
well as Administrators and Help Desk users. Subscribers do not have access
to the application, but can receive e-mail alerts.
Reports are created in the Device Manager console. Subscriptions to reports
can be created in the Administration or Device Manager consoles.
Note: If pop-up blockers are enabled in your browser, Add Alert
Subscription, Add Report Subscription, Manage Reports, the About page,
and Help will not open.
Adding an Alert Subscription
You can manage alert subscriptions.
In the navigation area, select a user.
1
Select the User subscriptions icon in the toolbar.
2
Click the Add alert subscription icon.
3
In the Create Alert Subscription dialog box, under Groups, select a group of
4
devices.
Under Alert Sets, select the device status alerts.
5
Under Destinations, select at least one e-mail address. This address appears
6
on the e-mail to the user or users who receive the message about the alert.
Under Reply to, type the e-mail address of the user who will respond to an alert
7
e-mail. The e-mail will automatically be addressed to the Reply to address.
Multiple Reply to addresses can be entered when separated by semi-colons.
Click OK.
8
To make changes to the subscription, select it and click the Edit subscription
icon.
To delete a subscription, select it and click the Delete subscription icon.
Adding a Report Subscription
You can add a report subscription.
2-3 User Guide
Administration
In the navigation area, select a user.
1
Select the User subscriptions icon in the toolbar.
2
Click the Add report subscription icon.
3
In the Create Report Subscription dialog box, in the Groups area, select a
4
group of devices.
Under Reports, select from the reports list.
5
Select the file format for the report: PDF, HTML, XML, and CSV. File format
6
options are limited for some reports.
Under Destinations, select at least one e-mail address. Reports can be sent to
7
no more than two e-mail addresses.
Under Schedule, select an interval for receiving the subscription e-mail: Daily,
8
Weekly, Monthly, Quarterly, or Yearly.
Click OK.
9
To make changes to the subscription, select it and click the Edit subscription
icon.
To delete a subscription, select it and click the Delete subscription icon.
Copying or Moving a Subscription
Subscriptions can be copied or moved to another user's list of subscriptions.
In the navigation area, select a user.
1
Click the User subscriptions icon in the toolbar.
2
Under Alerts or Reports, select the subscription, and then click the Copy
3
subscription or Move subscription icon.
In the Copy Subscription or Move Subscription dialog box, select the
4
recipient of the subscription, then click OK.
Networks and Agents
Networks and Agents lets you create device networks on both IPv4 and IPv6.
(IPv4 is the default selection.) Properties can be displayed for the selected
network, and discovery of printing devices can be started or stopped for one or
more networks. Once multiple networks have been added, the Select All button
lets you remove or change the discovery mode for all networks at once.
For remote agents, install the agent remotely and save the agent details on the
server. Once installed and registered, the remote agent can be reused for other
KYOCERA Net Admin 3.1 2-4
Administration
networks and appears in the Add Network wizard. Network discovery is started
through the assigned agent.
To ensure secure communication, the time setting must be no more than 1
minute apart on server and agent computers. For computers in different time
zones, use a global time server or domain time server to ensure synchronized
time settings.
Adding Networks
The Add Network wizard provides a quick method for adding new networks.
In the navigation area, select Preferences > Networks and agents.
1
Click the Add Network icon.
2
In the Add Network wizard dialog box, type an alias for the network. If the Alias
3
text box is left blank, the network IP address is used as the alias. If the
application server is multihomed, you can choose and name a local network.
Type the Domain. This text box is available only if the Device Communication
4
option in the Administration console is set to Device IP addresses are
volatile and may change. When the device is first discovered, the network
domain is applied to the domain of the device.
Type the address for the IPv4 or IPv6 network.
5
Adding an IPv4 Network
You can add an IPv4 network. Editing the network address or subnet mask may
create an orphan device.
Type the IPv4 network IP Address. You can edit this field for all networks
1
except the local network, or local networks if the server is multihomed.
Select the Subnet Mask from the list. Devices belong to a network based on the
2
network range, not on the subnet of the device. For example, if the network
address is 10.10.8.0, then 255.255.252.0 will contain any device with an IP
address from 10.10.8.1 through 10.10.11.254. If you add a network address of
10.10.9.0 and a subnet mask of 255.255.255.0, then devices from 10.10.9.1
through 10.10.9.254 will appear on both networks.
Click Next to proceed to the Select an Agent page.
3
Adding an IPv6 Network
You can add an IPv6 network. IPv6 options are not available if the IPv6 protocol
is disabled or not supported on the server. Specify as much of the specific
address and prefix as necessary to discover your device. The application uses a
one-by-one discovery method for IPv6 addresses.
For example, in prefix 64 networks, to discover a device with the network
address fd80:39f0:a2ae:82a:0:0:0:0150, it is sufficient to type the address as
fd80:39f0:a2ae:82a:0:0:0:0100, and select 120 as the prefix. The discovery
process will cover the range of the following addresses, and the device will be
added:
Start IP: fd80:39f0:a2ae:82a:0:0:0:0100
2-5 User Guide
Administration
End IP: fd80:39f0:a2ae:82a:0:0:0:01FF
Type the IPv6 network IP Address, for example,
1
fd80:39f0:a2ae:82a:0:0:0:0100.
Select the Prefix for the network address. The prefix is an analog of the IPv4
2
subnet mask. Prefixes in the list range from 112 to 127. The default selection is
120.
For example, prefix 120 is selected. The first 120 bits then defines the subnet
mask of the network. (Prefix 120 is the same as the
ffff::fffff:fffff:fffff:fffff:fffff:ffff:ff00 IPv6 mask.)
Click Next to proceed to the Select an Agent page.
3
Installing an Agent
You can install an agent for the network.
On the Select an Agent page, select Local Agent, New Agent, or Remote
1
Agent. Remote Agent appears if it was previously created through New Agent.
Click Next.
On the Enter the Agent Details page, enter the required information for the
2
agent:
For a local agent or remote agent, accept the displayed agent details.
For a new agent, type the agent details.
Click Next to proceed to the Enter the SNMP Information page.
3
Specifying SNMP Information
You can select the SNMP settings for the network.
In the Enter the SNMP Information page, accept the defaults or type the
1
number of Retries and the Timeout (seconds) period for communication
between agents and devices. Under SNMP Version, select SNMP v1/2c, or
SNMP v3, or both. Click Next.
Depending on the SNMP version chosen in the previous page, select
2
Communication settings:
Communication settings SNMP v1/2c
Type the Read Community and the Write Community name of the device.
Write Community sets its Write Community value in the application
database when the device is first discovered. Click Next.
Communication settings SNMP v3
Select the desired Security level, Username, and Password. Depending
on the Security level, select from available Hash and Encryption options.
Click Next.
Note: When using an IB-23 network card, support is limited to the DES
privacy option. The password in Network Properties must match the device’s
SNMP v3 password.
KYOCERA Net Admin 3.1 2-6
Administration
Scheduling Discovery
After adding networks, you can schedule a device discovery.
To schedule device discovery, select Schedule automatic device discovery
1
on this network on the Activate Device Discovery page. Click Next.
Select a daily or monthly schedule. For a discovery interval of Days, you can set
2
up to three scheduled times. The list includes hours only. Click Next.
Confirm your selections and click Finish.
3
The server installs the agent on the remote computer, adds the new network,
assigns the selected agent to the network, and starts discovery through the
assigned agent.
Deleting a Network
You can delete a network. This does not delete devices.
In the navigation area, select Preferences > Networks and agents.
1
Select a network.
2
Click Delete Network.
3
Select Uninstall assigned agent from remote computer, if you wish to
4
suspend all polling of these devices by all consoles and delete the agent from
the remote computer.
Devices that do not belong to any registered network appear under All Devices
> Networks > Orphan Devices in the Device Manager console.
Click OK in the confirmation message.
5
Network Properties
You can view properties for the selected network by selecting a network from
the Networks and Agents list and clicking the Network Properties icon.
General
On the General tab, you can modify all properties for the selected managed
network except the network address and the subnet mask. If you clear the
Managed check box, click OK to confirm.
When a network is unmanaged:
Discovery is disabled.
You cannot modify any network property except for the alias.
You may create orphan devices.
Note: Devices that do not belong to any registered network will appear in the
All Devices\Networks\Orphan Devices folder.
Agent
The agent status is displayed as Connected or Not Connected.
2-7 User Guide
Administration
For Local Agent, you can only change the Agent Timeout.
For Remote Agent, you can change any property except Status and Agent
Port.
You can create a new agent by selecting New Agent and entering all
properties.
When there is no direct connection to a remote device, select Use Proxy
function to open Device Home Pages.
SNMP v1/v2c v3
Select the SNMP v1/v2c v3 tab to view and modify the SNMP options for the
selected network.
Discovery
Select the Discovery tab to view and modify the device discovery schedules for
the selected network.
Start/Stop Discovery
The Start Discovery icon is available on all tabs when you select a single
network or multiple managed networks. Discovery is a process for scanning a
network for IP addresses of network printers to identify what devices are
currently on the network. This function is independent from the discovery
selection in Network Properties, whether you select to enable or disable
discovery.
Start Discovery
Available when discovery is not in progress on any of the selected networks.
Stop Discovery
Available when discovery is in progress on any of the selected networks.
USB Connections
The Local Device Agent (LDA) discovers and manages USB-supported
Kyocera devices that are locally connected. USB connections require
KYOCERA Net Admin installed and operating on the server. TCP port numbers
9000 and 9072 should be free and not blocked by a firewall. Microsoft Windows
XP SP3 or higher with Microsoft .NET Framework 4.0 or higher must be
installed.
USB devices are displayed in the device list along with network-connected
devices.
Manage Installation Packages
You can view installation packages and upload available packages. Current
installation packages are displayed at the top of the Upgrade view.
Current versions
Displays the application and Local Agent versions.
Currently installed packages
Displays the Agent installation package, Agent version, Model update
package, and Model support version that are currently installed.
Under Available installation packages, you can upload, remove, and upgrade
installation packages.
KYOCERA Net Admin 3.1 2-8
Administration
Uploading Installation Packages
You can upload installation and update packages from the server and add them
to the Available installation packages list.
In the navigation area, select Preferences > Upgrade.
1
Click Upload package.
2
Browse to a valid file name with an extension of .ZIP or .KNALU.
3
Click OK to upload the file.
4
You can remove an installation package by selecting it from the list and clicking
Remove package.
Upgrading an Agent
You can upgrade an agent in the Available installation packages list.
In the navigation area, select Preferences > Upgrade.
1
Click Upload package.
2
Browse for a valid upgrade file with an extension of .ZIP or .KNALU.
3
Click OK to upload the file.
4
Select an agent from the Available installation packages list and click
5
Upgrade.
Current agent information is displayed. Click Next.
If the latest version is installed, a message appears. Click Close.
On the Authorization page, select an option for User login and Password.
6
Click Next.
If Use user login, password and domain from the KYOCERA Net Admin
7
server was selected, click Next.
If Manually enter user login, password and domain for each agent was
selected, type User Login, Password, and Domain for each agent.
If Manually enter the same user login, password and domain for all agents
was selected, type User Login, Password, and Domain for all agents.
Click Next.
On the Confirmation page, click Upgrade.
8
Mail Server
KYOCERA Net Admin communicates with a mail server to send e-mail alerts
and information to system administrators and subscribers.
2-9 User Guide
SMTP Server
Defines an SMTP server for sending notifications. This information must be
complete and correct for e-mail notifications to work. If alert e-mail fails to
arrive, check your antivirus software. Adding port 25 or java.exe to the
exception list in your antivirus software may resolve the issue.
Authentication
Specifies the User name and Password, if SMTP authentication is required.
E-mail setup
When alerts and status e-mails are sent out, the address entered in Sender
address will appear in the e-mail address line.
Selecting E-mail Settings
You can select settings for e-mail alerts and information to system
administrators and subscribers.
In the navigation area, select Preferences > Mail server.
1
Under SMTP Server, enter the server name and port number.
2
Administration
Under Authentication, enter the User name and Password, when a SMTP
3
server connection is required.
Under E-mail setup, enter the sender's e-mail address.
4
Click Test Email to make sure the e-mail feature works. In the Test Email
5
dialog box, enter the recipient's e-mail address, and click OK. A test e-mail will
be sent to the designated recipient.
Click Apply to save the e-mail settings, or click Reset to clear the settings.
6
Device Communication
Device Communication uses Host Name and Domain name, if entered.
Choose from a static or volatile IP address.
For DHCP, select Device IP addresses are volatile and may change. If this
option is chosen, communication with the devices is established by using the
host name rather than the IP address.
Note: After the Device Communication Mode is changed, KYOCERA Net
Admin will not work until after the next discovery. We strongly recommend
changing Device Communication Mode only at a time when the network is
not in use.
Database
KYOCERA Net Admin database backup compresses files into a zip file and
saves it to a folder called C:\KNetAdminBackup. The system administrator can
schedule a single backup, immediate or recurring backups.
KYOCERA Net Admin 3.1 2-10
Loading...