Question: object

Answer:
7 Restart the NX Unit with unit 0x74 0x01 0x35 0x01
number 1. NX Configuration Restart NX unit
object
8 Restart the NX Unit with unit 0x74 0x01 0x35 0x02
number 2. NX Configuration Restart NX unit
object
A-8-3 Initializing the Unit Operation Settings for Singe NX Unit
Initialize the Unit operation settings for a single NX Unit mounted to the Controller. In this example, the
unit number of the NX Unit is 1.
The following table gives the setting procedure.
CIP Object to use
Step Description Unit
Class ID Instance ID Service code
number
1 Change the parameter write 0x74 0x01 0x37 0x01
mode of the NX Unit to Write NX Configuration Switch parameter
mode. object write mode
2 Initialize the Unit operation 0x74 0x01 0x3D 0x01
settings for the NX Unit with NX Configuration Initialize unit opera-
unit number 1. object tion parameter
3 Restart the NX Unit with unit 0x74 0x01 0x35 0x01
number 1. NX Configuration Restart NX unit
object
A-66 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
A-9 Tag Data Link Settings with Generic
Devices
Use the Generic Device if you want to perform tag data links with a device that does not have an EDS
file.
Create a Generic Device with the Network Configurator to use a Generic Device.
The procedures to create a Generic Device and the procedures to create a tag or tag set are shown
below.
Additional Information
The procedures after creating a tag or tag set are the same as for devices that have EDS files.
Refer to 6-2 Setting Tag Data Links on page 6-21.
A-9-1 Creating Generic Devices
1
Select Create Generic Device from the EDS File Menu.
The Create Generic device EDS Dialog Box is displayed.
2
Set the information for the device and click the Create Button.
A confirmation dialog to install an icon is displayed.
3
Set a device icon.
• If you click the Yes Button:
The Install Icon (EDS file name) Dialog Box is displayed.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-67
A-9
Tag
Data
Link
Settings
with
Generic
Devices
A
A-9-1
Creating
Generic
Devices
Appendices
• If you click the No Button:
A default icon for the Network Configurator is set.
4
Select the icon file (*.ico) to set as the EDS file and click the Open Button.
The created Generic Device is added to the hardware list.
A-9-2 Creating a Tag or Tag Set for Generic Device
This section describes two types of methods for creating a tag or tag set: tag type and instance ID
type. Each procedure is described below.
The type is what you select in Connection I/O Type when you create a Generic Device.
Creation Procedure for Tag Type
1
Add the Generic Device that you created to the network window.
2
Double-click the device icon.
The Edit Device Parameters Dialog Box is displayed.
A-68 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
3
Select the slot number 00 in the Configuration from the Module Tab Page and then click the
Edit Button.
The Edit Module Parameters Dialog Box is displayed.
4
Select Input Only (Tag type) or Input & Output (Tag type) from Type and click the New But-
ton.
The Edit Variable Dialog Box is displayed.
5
Set the following parameters for the variable.
• Name
Enter the name of the network variable. (Example: VarInputOnly)
• Size
Enter the size of the tag in bytes.
• I/O Type
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-69
A-9
Tag
Data
Link
Settings
with
Generic
Devices
A
A-9-2
Creating
a
Tag
or
Tag
Set
for
Generic
Device
Appendices
If Type is Input & Output (Tag type), select Out or In.
6
Click the OK Button.
The Edit Module Parameters Dialog Box is displayed, and the added variable is displayed.
7
Repeat steps 4 through 6 to register the required variables. Click the OK Button when the reg-
istration is complete.
Creation Procedure for Instance ID Type
1
Add the Generic Device that you created to the network window.
2
Double-click the device icon.
The Edit Device Parameters Dialog Box is displayed.
3
Click the New Button from the I/O Configuration Tab Page.
The Edit I/O Instance Dialog Box is displayed.
A-70 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
4
Enter the following parameters.
• Instance No.
Enter the instance ID for the I/O instance.
• Size
Enter the size of the tag in bytes.
• I/O Type
Select Out or In.
5
Click the OK Button.
The Edit Device Parameters Dialog Box is displayed, and the added I/O instance is displayed
in the I/O Configuration Tab Page.
6
Repeat steps 3 through 5 to register the required I/O instances. Click the OK Button when the
registration is complete.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-71
A-9
Tag
Data
Link
Settings
with
Generic
Devices
A
A-9-2
Creating
a
Tag
or
Tag
Set
for
Generic
Device
Appendices
A-10 Procedure to Use Secure Socket
Service with Secure Socket Configu-
ration Commands
This section describes the procedure to use secure socket services for the following use cases.
• Starting to use secure socket services
Refer to A-10-1 Settings for Starting Secure Socket Services on page A-72.
• Replacing CPU Units
Refer to A-10-2 Procedure for Replacing the CPU Unit on page A-74.
A-10-1 Settings for Starting Secure Socket Services
The following two procedures describe how to set up a new configuration.
• If you do not use a client certificate and a client private key
• If you use a client certificate and a client private key
For details on Secure Socket Configuration commands that are used in the procedures, refer to
A-11 Secure Socket Configuration Commands on page A-79.
If you do not use a client certificate and a client private key
The setting procedure to start secure socket services when the client certificate and client private key
are not used is as follows.
As a prerequisite, set the built-in EtherNet/IP of the CPU Unit as follows.
• If the server is on the Internet, configure the default gateway and routing table.
If the server is specified by an item other than the IP address, such as "xxx.com", configure the DNS
server settings.
• Configure NTP settings.
The NTP settings are optional. It is recommended for matching with the server time.
Check with the network administrator of the installation site for the settings of the default gateway,
routing table, DNS server, and NTP server.
The options for Secure Socket Configuration commands in this procedure are described in the follow-
ing example.
• To connect the computer to the CPU Unit, an EtherNet/IP port is used. They are connected through
Ethernet connection via a Hub or remote connection via USB.
• The IP address of the built-in EtherNet/IP Port 1 of the CPU Unit is set to 192.168.250.1.
• Set the session ID to 0 in the secure socket setting.
1
Configure the server and check the server's IP address, HOST name, and other settings.
Check with the server installer for details on how to check.
2
Configure the secure socket setting.
Use the Secure Socket Configuration commands to configure secure socket setting for the ses-
sion ID. Set different session IDs for all connected destinations.
A-72 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
tlsconfig setSessionInfo /id 0 /ip:192.168.250.1
To enable secure socket communications log, execute the following command.
tlsconfig setLogLevel /enable /ip:192.168.250.1
3
Create a user program.
Create a session for secure socket communications with SktTCPConnect instruction to the
server in step 1. Set the TLS session name for the session ID to TLSSessionName, which is
the input variable of SktTLSConnect instruction. If "N" is 0, TLS session name is TLSSession0.
Use SktTLSRead and SktTLSWrite instructions to process data communication with the server.
4
Download the user program using the synchronization function.
Download the user program from the computer to the CPU Unit.
After sufficiently confirming that the connection destination is correct, start operation.
If you use a client certificate and a client private key
The setting procedure to start secure socket services when the client certificate and client private key
are used is as follows.
As a prerequisite, set the built-in EtherNet/IP of the CPU Unit as follows.
• If the server is on the Internet, configure the default gateway and routing table.
If the server is specified by an item other than the IP address, such as "xxx.com", configure the DNS
server settings.
• Configure NTP settings.
The NTP settings are optional. It is recommended for matching with the server time.
Check with the network administrator of the installation site for the settings of the default gateway,
routing table, DNS server, and NTP server.
The options for Secure Socket Configuration commands in this procedure are described in the follow-
ing example.
• To connect the computer to the CPU Unit, an EtherNet/IP port is used. They are connected through
Ethernet connection via a Hub or remote connection via USB.
• The IP address of the built-in EtherNet/IP Port of the CPU Unit is set to 192.168.250.1.
• The session ID set in the secure socket setting is 0.
1
Prepare the client private key, client certificate, and CA certificate.
In this procedure, the path and filename of the prepared client certificate is “C:\dir1\dir2\0\cli-
ent.cert”. The path and filename of the client private key is “C:\dir1\dir2\0\client.key”.
Note that the prepared client certificate and client private key must be stored and managed by
the customer.
2
Install the client certificate and CA certificate on the server.
Check with the server administrator for details such as whether installation on the server is re-
quired.
3
Configure the server and check the server's IP address, HOST name, and other settings.
Check with the server installer for details on how to check.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-73
A-10
Procedure
to
Use
Secure
Socket
Service
with
Secure
Socket
Configuration
Commands
A
A-10-1
Settings
for
Starting
Secure
Socket
Services
Appendices
4
Configure the secure socket setting.
Use the Secure Socket Configuration commands to configure session information for the ses-
sion ID.
tlsconfig setLogLevel /enable /ip:192.168.250.1
To enable secure socket communications log, execute the following command.
tlsconfig setLogLevel /enable /ip:192.168.250.1
5
Create a user program.
Create a session for secure socket communications with SktTCPConnect instruction to the
server confirmed in step 3. Set the TLS session name for the session ID to TLSSessionName,
which is the input variable of SktTLSConnect instruction. If "N" is 0, TLS session name is
TLSSession0.
Use SktTLSRead and SktTLSWrite instructions to process data communication with the server.
6
Download the user program using the synchronization function.
Download the user program from the computer to the CPU Unit.
After sufficiently confirming that the connection destination is correct, start operation.
A-10-2 Procedure for Replacing the CPU Unit
This section describes the following three procedures for replacing the CPU Unit.
• If you do not use a client certificate and a client private key
• If you have stored the client certificate and client private key
• If you have not stored the client certificate and client private key
When you replace the CPU Unit, be sure to perform the following steps before proceeding to the re-
placement procedure.
For more information about Secure Socket Configuration commands, refer to A-11 Secure Socket
Configuration Commands on page A-79.
The options for Secure Socket Configuration commands in this procedure are described in the follow-
ing example.
• To connect the computer to the CPU Unit, an EtherNet/IP port is used. They are connected through
Ethernet connection via a Hub or remote connection via USB.
• The IP address of the built-in EtherNet/IP Port of the CPU Unit is set to 192.168.250.1.
• The session ID set in the secure socket setting is 2.
1
Back up the data in the Controller.
Refer to the NJ/NX-series CPU Unit Software User's Manual (Cat. No. W501) for details on
Controller backups.
2
Read the secure socket setting.
Use the Secure Socket Configuration commands to save the secure socket setting to
<PC_Folder>.
tlsconfig getAllSessionInfo /f /o <PC_Folder> /ip:192.168.250.1
Read and confirm the enable/disable status of the secure socket communications log.
A-74 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
tlsconfig getLogLevel /ip:192.168.250.1
3
Check that the client certificate and client private key are stored.
Check the read secure socket seting to ensure that the required client private key is stored.
If you do not use a client certificate and a client private key
The procedure for replacing the CPU Unit when the client certificate and client private key are not
used is as follows.
The options for the Secure Socket Configuration commands in the replacement procedure are descri-
bed in the following example.
• To connect the computer to the CPU Unit, an EtherNet/IP port is used. They are connected through
Ethernet connection via a Hub or remote connection via USB.
• The IP address of the built-in EtherNet/IP Port of the CPU Unit is set to 192.168.250.1.
• The session ID in the secure socket setting before replacement is set to 2.
1
Replace to a new CPU Unit.
2
Check the secure socket setting.
Confirm the session ID that is being used by the secure socket setting before replacing the
CPU Unit. Read the session ID with Secure Socket Configuration commands.
3
Configure the secure socket setting.
tlsconfig setLogLevel /enable /ip:192.168.250.1
To enable secure socket communications log, execute the following command.
tlsconfig setLogLevel /enable /ip:192.168.250.1
4
Check the secure socket setting.
Use the Secure Socket Configuration commands to view the secure socket setting and verify
that it matches the session ID set in the <PC Folder> read in step 2 of A-10-2 Procedure for
Replacing the CPU Unit on page A-74. In this procedure, the /o option is not used.
tlsconfig getLogLevel /ip:192.168.250.1
Read and confirm the enable/disable status of the secure socket communications log.
tlsconfig getLogLevel /ip:192.168.250.1
5
Restore data to the Controller.
Restore is performed using the backed up data.
Refer to the NJ/NX-series CPU Unit Software User's Manual (Cat. No. W501) for details on re-
storation on the Controller.
6
Check the operation.
Verify that the program and settings are restored and the Controller is working correctly.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-75
A-10
Procedure
to
Use
Secure
Socket
Service
with
Secure
Socket
Configuration
Commands
A
A-10-2
Procedure
for
Replacing
the
CPU
Unit
Appendices
If you have stored the client certificate and client private key
The procedure for replacing the CPU Unit when the client certificate and client private key have been
stored is as follows.
The options for the Secure Socket Configuration commands in the replacement procedure are descri-
bed in the following example.
• To connect the computer to the CPU Unit, an EtherNet/IP port is used. They are connected through
Ethernet connection via a Hub or remote connection via USB.
• The IP address of the built-in EtherNet/IP Port of the CPU Unit is set to 192.168.250.1.
• The session ID in the secure socket setting before replacement is set to 2.
• The file name and path in the computer that stores the client certificate file used in the secure socket
setting of session ID=2 is "C:\dir1\dir2\2\client.cert".
• The path and file name of the client private key file stored on the computer used in the secure client
setting of session ID=2 is “C:\dir1\dir2\2\client.key”.
1
Replace to a new CPU Unit.
2
Check the secure socket setting.
Confirm the session ID that is being used by the secure socket setting before replacing the
CPU Unit. Read the session ID with Secure Socket Configuration commands.
Prepare the client certificate and client private key for each session ID that are stored in the
computer.
3
Configure the secure socket setting.
Use the Secure Socket Configuration commands to configure session information for each ses-
sion ID.
tlsconfig setSessionInfo /id 2 /cert C:\dir1\dir2\2\client.cert /key C:\dir1
\dir2\2\client.key /ip:192.168.250.1
To enable secure socket communications log, execute the following command.
tlsconfig setLogLevel /enable /ip:192.168.250.1
4
Check the secure socket setting.
Use the Secure Socket Configuration commands to view the secure socket setting and verify
that it matches the session ID set in the <PC Folder> read in step 2 of A-10-2 Procedure for
Replacing the CPU Unit on page A-74. In this procedure, the /o option is not used.
tlsconfig getLogLevel /ip:192.168.250.1
Read and confirm the enable/disable status of the secure socket communications log.
tlsconfig getLogLevel /ip:192.168.250.1
5
Restore data to the Controller.
Restore is performed using the backed up data.
Refer to the NJ/NX-series CPU Unit Software User's Manual (Cat. No. W501) for details on re-
storation on the Controller.
A-76 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
6
Check the operation.
Verify that the program and settings are restored and the Controller is working correctly.
If you have not stored the client certificate and client private key
The procedure for replacing the CPU Unit when the client certificate and client private key have not
been stored is as follows.
1
Create a client certificate and client private key.
Depending on whether you are creating a client certificate and client private key on the server
or preparing the client private key and client certificate yourself, the procedures are different as
follows.
Creating a client certificate and client private key on the server
1) Create a client certificate and client private key on the server and download them to the
computer.
In this procedure, the path and filename of the downloaded client certificate is
“C:\dir1\dir2\2\client.cert”. The path and filename of the client private key is
“C:\dir1\dir2\2\client.key”.
Note that the prepared client certificate and client private key must be stored and managed
by the customer.
Creating a client certificate and client private key yourself
1) Prepare the client certificate, client private key, and CA certificate.
In this procedure, the path and filename of the prepared client certificate is
“C:\dir1\dir2\2\client.cert”. The path and filename of the client private key is
“C:\dir1\dir2\2\client.key”.
Note that you must store and manage the prepared client certificate, client private key, and
CA certificate yourself.
2) Install the client certificate and CA certificate on the server.
Check with the server administrator for details such as whether installation on the server is
required.
2
Check the secure socket setting.
Confirm the session ID that is being used by the secure socket setting before replacing the
CPU Unit. Read the session ID with Secure Socket Configuration commands.
Prepare the client certificate and client private key for each session ID that are stored in the
computer.
3
Configure the secure socket setting.
Use the Secure Socket Configuration commands to configure session information for each ses-
sion ID.
tlsconfig setSessionInfo /id 2 /cert C:\dir1\dir2\2\client.cert /key C:\dir1
\dir2\2\client.key /ip:192.168.250.1
To enable secure socket communications log, execute the following command.
tlsconfig setLogLevel /enable /ip:192.168.250.1
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-77
A-10
Procedure
to
Use
Secure
Socket
Service
with
Secure
Socket
Configuration
Commands
A
A-10-2
Procedure
for
Replacing
the
CPU
Unit
Appendices
4
Restore data to the Controller.
Restore is performed using the backed up data.
Refer to the NJ/NX-series CPU Unit Software User's Manual (Cat. No. W501) for details on re-
storation on the Controller.
5
Check the operation.
Verify that the program and settings are restored and the Controller is working correctly.
A-78 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
A-11 Secure Socket Configuration Com-
mands
Secure Socket Configuration commands are command line tools.
When a command is entered on the command line, the CPU Unit is temporarily connected online and
the secure socket setting in the CPU Unit is updated.
Precautions for Correct Use
To reduce the risk of unauthorized access by a third party using the Secure Socket Configura-
tion commands, consider setting operation authority verification on the CPU Unit. You can re-
strict the use of Secure Socket Configuration commands to administrators only.
Use of the Secure Socket Configuration commands is not subject to user authentication. Even if
user authentication is enabled in the CPU Unit of unit version 1.50 or later, please consider set-
ting operation authority verification.
For details on how to set operation authority verification, refer to Operation Authority Verification
on the .
Refer to Operation Authority Verification on page A-81 for operating specifications of Secure
Socket Configuration commands when operation authority verification is set.
The functions of the Secure Socket Configuration commands are described in the table below.
Function Description
TLS session setting • You can register the TLS session information to the secure socket setting in
the CPU Unit. You can also read and delete the registered TLS session in-
formation.
Set one TLS session for one socket used in the secure socket communica-
tions.
• You can transfer the client certificate and client private key as required.
Secure socket communica- You can set to enable or disable the secure socket communications log. You
tions log setting can also read the set enable or disable status of secure socket communica-
tions log.
A-11-1 Operating Environment for Secure Socket Configuration Com-
mands
The operating environment of the Secure Socket Configuration Commands on the computer is as fol-
lows.
Item System requirement
Communications port USB 2.0 port or Ethernet port
The operating environment other than above, such as the operating system, is the same as that for
the Sysmac Studio. Refer to the Sysmac Studio Version 1 Operation Manual (Cat. No. W504) for de-
tails on the operating environment of the Sysmac Studio.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-79
A-11
Secure
Socket
Configuration
Commands
A
A-11-1
Operating
Environment
for
Secure
Socket
Configuration
Commands
Appendices
A-11-2 Location and Starting Procedure of Secure Socket Configuration
Commands
Location
The Secure Socket Configuration Commands are stored in the following folder under the Sysmac Stu-
dio installation folder.
.\TLSSettingTool\tlsconfig.exe
Procedure
To start the Secure Socket Configuration commands, proceed as follows.
1
From Windows Start menu, select OMRON – Sysmac Studio – Tools – Secure Socket
Configuration Command.
The command prompt starts in the folder where tlsconfig.exe is located.
2
From the command line, run tlsconfig.exe.
A-11-3 Command and Option Formats
The table below describes the meaning of command and option symbols that are used in each com-
mand.
Symbol Meaning
£ (square) Indicates single-byte space.
| (stroke) Indicates separation between items for multiple items.
E.g. "A|B|C" means that "A, B, or C".
{} (wave brackets) An item must be selected out of ones within this symbol. Separation of items is in-
dicated by "|".
E.g. “{A|B|C}” indicates that "one of the A, B, or C must be specified".
[] (square brackets) Item enclosed in this symbol can be omitted.
E.g. "[A]" indicates that "A is specified as needed".
... (dot line) More than one item of the previous one described before this symbol can be speci-
fied.
When more than one item is specified, a single-byte space is used to separate the
items.
E.g. "A B..." indicates "A can be followed by several B".
A-80 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
Symbol Meaning
_ (underline) Indicates the default values when items are omitted.
E.g.: “A|B” indicates that when neither A nor B was specified, A was specified.
The format of the command to be entered is as follows.
a. The order of the options is random.
b. A single-byte space is entered as an separator of options.
c. Case-sensitive for both commands and options.
d. Specify an option with "/" (slash).
e. An error occurs in the following cases:
• You specified a command that does not exist.
• You specified an option that does not exist.
• You specified the same option.
• The number of options does not match.
• When there is an option to specify one from more than one, you specified more than one.
A-11-4 Common Specifications to All Commands
The function, specification of connection method and execution result displays that are common to all
commands and options are described below.
<TLSSettingTool Folder> in the execution example indicates the <Sysmac Studio Installed Folder>
\TLSSettingTool folder.
Operation Authority Verification
If the CPU Unit was configured to be operated with different operation authorities, the user is prompted
to enter the password before the command is executed.
If the password is correct, the command is executed. If the password is wrong, an error is displayed.
The following dialog to enter password is displayed.
Operation authority: Administrator
Password:
An example is shown below.
• When operation authority is set
• If the password is correct
<TLSSettingTool Folder>>tlsconfig setSessionInfo /id 1 /key C:\private\foo.private.key /cert
C:\certs\foo.cert.pem /ip:192.168.250.1
Operation authority: Administrator
Password:******
000: Success
<TLSSettingTool Folder>>
• If the password is correct and the command execution result is displayed
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-81
A-11
Secure
Socket
Configuration
Commands
A
A-11-4
Common
Specifications
to
All
Commands
Appendices
<TLSSettingTool Folder>>tlsconfig getSessionInfo /id 0 /ip:192.168.250.1
Operation authority: Administrator
Password:******
Id=0
PrivateKey=private.key
Certificate=client.crt
Description=
000: Success
<TLSSettingTool Folder>>
• If the password is incorrect
<TLSSettingTool Folder>>tlsconfig setSessionInfo /id 1 /key C:\private\foo.private.key /cert
C:\certs\foo.cert.pem /ip:192.168.250.1
Operation authority: Administrator
Password:******
13: Operation authority verification error
<TLSSettingTool Folder>>
• When operation authority is not set
<TLSSettingTool Folder>>tlsconfig setSessionInfo /id 1 /key C:\private\foo.private.key /cert
C:\certs\foo.cert.pem /ip:192.168.250.1
000: Success
<TLSSettingTool Folder>>
Specifying Connection Method
You can specify the method to connect to the CPU Unit with the command option.
Use either one of the command options below to specify.
• /usb
Specify this option for connecting to the USB port of the CPU Unit through direct connection via
USB.
If the CPU Unit does not support USB connection, an error occurs.
• /ip:xxx.xxx.xxx.xxx
The xxx.xxx.xxx.xxx is the IP address of the connected CPU Unit.
Specify this option for connecting to an Ethernet port of the CPU Unit through Ethernet connection
via a hub or remote connection via USB.
Precautions for Correct Use
Direct connection via Ethernet is not supported.
Execution Result Displays
The execution results of the command are displayed as follows.
• Normal operation
Commands that have functions to show the execution results display the results.
000: Success
• Abnormal operation
A-82 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
Commands display the error code and error message.
The error code display format is as follows.
[error code]:[error message]
The [error code] is stored in the Windows environment variable ERRORLEVEL. ERRORLEVEL can
be checked with echo %ERRORLEVEL%.
The error codes and error messages are given in the following table.
Error code Error message Description
1 Undefined command ; type "tlsconfig help" Command that does not exist
2 Illegal argument Incorrect argument
3 Communication error Communication error with CPU Unit
4 Operating mode error Command not permitted in RUN mode
5 Session setting already exists Session setting already exists.
6 Session setting does not exist Session setting does not exist.
7 Non-supported session ID Session ID is not supported by the connect-
ed CPU Unit.
8 Invalid target file path/name The path/file name of the specified file is in-
valid.
9 Target file not found The specified file does not exist.
10 Output folder already exists The specified destination folder already ex-
ists.
11 Can not create output file File output failed.
12 Controller execution error Execution error of CPU Unit processing for
the command
13 Operation authority verification error Operation authority verification error
14 Too large file The specified file exceeded the maximum
file size
15 Client certificate and key do not match or The client certificate and the private key do
are broken not match, or one or both of them are cor-
rupted.
A-11-5 Command Specifications
The specifications of the Secure Socket Configuration commands are described below.
Command Function Reference
setSessionInfo Sets the TLS session information of the specified session ID and page A-84
registers it to the secure socket setting in the CPU Unit.
delSessionInfo Deletes the TLS session information of the specified session ID page A-86
from the secure socket setting in the CPU Unit.
delAllSessionInfo Deletes the TLS session information of all session IDs from the page A-86
secure socket setting in the CPU Unit.
getSessionInfo Reads the TLS session information of the specified session ID page A-87
from the CPU Unit and displays it.
Alternatively, reads the TLS session information and client certifi-
cate files from the CPU Unit and saves them in the computer.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-83
A-11
Secure
Socket
Configuration
Commands
A
A-11-5
Command
Specifications
Appendices
Command Function Reference
getAllSessionInfo Reads the TLS session information of all session IDs from the page A-89
CPU Unit, and displays it in order from the smallest session ID
number.
Alternatively, reads the TLS session information and client certifi-
cate files from the CPU Unit and saves them in the computer.
setLogLevel Enables or disables the secure socket communications log. page A-91
getLogLevel Reads the enable or disable state of the secure socket communi- page A-92
cations log.
clearAllSettings Initializes the secure socket setting. page A-92
help Displays the version of the Secure Socket Configuration com- page A-93
mands and how they are used.
setSessionInfo
• Format
setSessionInfo£/id£n£[/key£xxxx£/cert□xxxx]£[/desc£xxxx]£[/f]£{/usb|/ip:xxx.xxx.xxx.xxx}
• Functions
You can set TLS session information of the specified session ID to the secure socket setting in the
CPU Unit.
The TLS session information includes the TLS session name, the file name of the client certificate,
the file name of the client private key, and a description of the session.
The TLS session name is automatically set with the session ID specified in the /id option. “TLSSes-
sion” + ”session ID” is the session name. If 5 is specified for session ID, the TLS session name is
“TLSSession5”.
You must set client private keys and client certificates only when a server performs client authentica-
tion with the X.509 public key certificates.
When the files of the client certificate and the client private key are specified in the /cert and /key
options, the files are transferred from the computer to the CPU Unit.
You can use the /f option to overwrite and update the client certificate and client private key for the
session ID that is already set in the TLS session information.
Additional Information
a) The TLS session name is used as the input variable of SktTLSConnect (Establish TLS Ses-
sion) instruction.
b) As an alternative method, you can also update the client certificate and client private key by
deleting the registered session with the delSessionInfo command and then setting the ses-
sion again with the setSessionInfo command.
• Restrictions
This command can be used only when the CPU Unit is in PROGRAM mode. An error occurs when it
is used in RUN mode.
• Option details
• /id n
n: Session ID
This option specifies the session ID in TLS session information to register.
A-84 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
Specify a value from 0 to 59 for an NX502 CPU Unit or an NX102 CPU Unit. For other models,
specify 0 to 29.
If the /f option is not specified and the specified session ID is already registered, an error occurs.
• /key xxxx
xxxx: Path to the client private key file and file name
Specify the path to the folder on the computer where the client private key file is located. The path
also has a file name.
You can specify either with a relative or an absolute path to the folder.
If you do not want to set the client private key in the TLS session information, specify "none" in the
path or omit the option.
The TLS session information contains only the file name of the client private key and does not
contain any path information.
An error occurs in the following cases:
• The client private key file does not exist at the specified location.
• When the file size of the client private key exceeds 10KB
• /cert xxxx
xxxx: Path to the client certificate file and the file name
Specify the path to the folder on the computer where the client certificate file is located. The path
also has a file name.
You can specify either with a relative or an absolute path to the folder.
If you do not want to set the client certificate in the TLS session information, specify “none” in the
path or omit the option.
The TLS session information contains only the file name of the client certificate and does not con-
tain any path information.
An error occurs in the following cases:
• The client certificate file does not exist at the specified location.
• The size of client certificate file exceeds 10 KB.
• /f
Even when the client private key and client certificate are already set in the TLS session informa-
tion of the session ID specified with the /id, they are overwritten with the client private key and
client certificate that are specified with the /key and /cert.
If both of the /key and /cert are not specified, the set client private key and client certificate are
deleted.
If the /desc is not specified, the comments set with the /desc will be cleared.
• /desc
Description of the session
You can comment on TLS session information.
The following characters can be used in comments: 0-9, A-Z, a-z, - (hyphen), _ (underscore),
( (parenthesis), and ) (closing parenthesis).
The maximum length is 32 characters.
• Execution results
None
• Execution examples
a) When session ID=1, and client certificate and client private key are not set in TLS session infor-
mation
<TLSSettingTool Folder>>tlsconfig setSessionInfo /id 1 /key none /cert none /ip:192.168.250.1
<\TLSSettingTool Folder>>
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-85
A-11
Secure
Socket
Configuration
Commands
A
A-11-5
Command
Specifications
Appendices
b) When session ID=1, and client certificate = client.crt and client private key = private.key are set
in the TLS session information
<TLSSettingTool Folder>>tlsconfig setSessionInfo /id 1 /key C:\privates\private.key /cert C:\certs
\client.crt /ip:192.168.250.1
<TLSSettingTool Folder>>
delSessionInfo
• Format
delSessionInfo□/id□n□{/usb|/ipxxx.xxx.xxx.xxx}
• Functions
You can delete TLS session information of the specified session ID from the secure socket setting in
the CPU Unit.
• Restrictions
This command can be used only when the CPU Unit is in PROGRAM mode. An error occurs when it
is used in RUN mode.
• Option details
• /id n
n: Session ID
This option specifies the session ID of TLS session to delete.
Specify a value from 0 to 59 for an NX502 CPU Unit or an NX102 CPU Unit. For other models,
specify 0 to 29.
If the specified session ID is not already registered in the secure socket setting, an error occurs.
• Execution results
None
• Execution examples
When you want to delete TLS session information of session ID=1
<TLSSettingTool Folder>>tlsconfig delSessionInfo /id 1 /ip:192.168.250.1
<TLSSettingTool Folder>>
delAllSessionInfo
• Format
delAllSessionInfo□{/usb|/ip:xxx.xxx.xxx.xxx}
• Functions
You can delete TLS session information of all session IDs from the secure socket setting in the CPU
Unit.
The secure socket communications log enable or disable setting will not be changed.
When you execute the command, the warning message "This command deletes all session settings
of destination Controller. Confirm the settings to be deleted first, and enter "Yes”.[Enter]" is dis-
played.
If you enter "Yes", all TLS session information is deleted and the message "All settings are deleted."
is displayed.
If an entry other than “Yes” is made, the message "Operation is canceled.” is displayed and TLS
session information will not be deleted from the secure socket setting in the CPU Unit.
Yes is case sensitive. An entry of yes, YES, etc. will cause an error.
A-86 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
• Restrictions
This command can be used only when the CPU Unit is in PROGRAM mode. An error occurs when it
is used in RUN mode.
• Option details
None
• Execution results
None
• Execution examples
In the examples below, what it displayed by the command is underlined.
a) When you delete all TLS session information from the secure socket setting of the CPU Unit (if
operation authority is not set)
<TLSSettingTool Folder>>tlsconfig delAllSessionInfo /ip:192.168.250.1
This command deletes all session settings of destination Controller.
Confirm the settings to be deleted first, and enter "Yes".
>Yes
All settings are deleted.
000: Success
<TLSSettingTool Folder>>
b) When you cancel the command execution (if operation authority is not set)
<TLSSettingTool Folder>>tlsconfig delAllSessionInfo /ip:192.168.250.1
This command deletes all session settings of destination Controller.
Confirm the settings to be deleted first, and enter "Yes".
>No
Operation is canceled.
000: Success
<TLSSettingTool Folder>>
getSessionInfo
• Format
getSessionInfo□/id□n□[/o□path_to_SessionInfo]□[/f]□ {/usb|/ip:xxx.xxx.xxx.xxx}
• Functions
You can read TLS session information (TLS session name, client certificate file name, client private
key file name, and a description of the session) of the specified session ID from the CPU Unit and
display it.
If you specify the /o option, you can save the TLS session information and client certificate file in the
specified folder in the computer, instead of displaying them. However, the client private key files can-
not be saved.
The TLS session information is saved in “TLSSessionN.txt” text file (N is the specified session ID).
The client certificate file is saved with the file name specified when the TLS session information is
set.
The files of TLS session information and client certificate are saved in the folder with the session ID
name in the specified folder.
• Restrictions
None
• Option details
• /id n
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-87
A-11
Secure
Socket
Configuration
Commands
A
A-11-5
Command
Specifications
Appendices
n: Session ID
Specify the session ID of the TLS session information to be read.
Specify a value from 0 to 59 for an NX502 CPU Unit or an NX102 CPU Unit. For other models,
specify 0 to 29.
• /o path_to_SessionInfo
path_to_SessionInfo: Path to the folder to save the read TLS session information and client certifi-
cate files
If this option is specified, TLS session information is not displayed.
The path of the folder can be either a relative path or an absolute path.
Characters and formats that can be used for the specified folder path conform to Windows specifi-
cations.
• The drive letter ("D:" or the like) can be used for the pathname.
• You must specify the path to the storage in the computer. UNC (Universal Naming Convention)
cannot be used.
An error occurs in the following cases:
• The specified folder already has a folder with the same name as the session ID specified.
• You do not have the access right to the specified folder.
You should be given the appropriate authority or an appropriate folder with the right to access
should be specified.
• /f
If the folder specified with the /o option exists, files in the folder will be deleted, and then the files
of TLS session information and client certificate will be saved.
If the /o option is not specified, specification for this option is ignored.
• Execution results
TLS session information of the specified session ID is output.
If the client private key and client certificate are not set, "none" is output.
• Normal operation
Id = session ID
PrivateKey=File name of the private key file
Certificate=File name of the certificate file
Description= Description of the session
(Blank line)
• Abnormal operation
The following message is output.
[error code]:[error message]
The [error code] is stored in the Windows environment variable ERRORLEVEL.
• Execution examples
a) When you want to display TLS session information of session ID=0
<TLSSettingTool Folder>>tlsconfig getSessionInfo /id 0 /ip:192.168.250.1
Id=0
PrivateKey=private.key
Certificate=client.crt
Description=
000: Success
<TLSSettingTool Folder>>
A-88 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
b) When you want to save TLS session information of session ID=2 in C:\Dir1\Dir2 folder
<TLSSettingTool Folder>>tlsconfig getSessionInfo /id 2 /o C:\Dir1\Dir2 /ip:192.168.250.1
000: Success
<TLSSettingTool Folder>>
TLSSension2.txt and client.crt are saved in C:\Dir1\Dir2\2 folder.
The contents of TLSSession2.txt are as follows.
Id=2
PrivateKey=private.key
Certificate=client.crt
Description=
getAllSessionInfo
• Format
getAllSessionInfo□[/o□path_to_SessionInfo]□[/f]□ {/usb|/ip:xxx.xxx.xxx.xxx}
• Functions
You can read TLS session information (TLS session name, client certificate file name, and client pri-
vate key file name) of all session IDs from the CPU Unit and display it in order from the smallest
session ID number.
If session ID of 1, 3, 10 and 20 are registered in the TLS session information in the CPU Unit, the
TLS session information is displayed in the order of 1, 3, 10 and 20.
If you specify the /o option, you can save the TLS session information and client certificate file in the
specified folder in the computer, instead of displaying them. However, the client private key files can-
not be saved.
The TLS session information is saved in “TLSSessionN.txt” text file (N is the specified session ID).
The client certificate file is saved with the file name specified when the TLS session information is
set.
The files of TLS session information and client certificate are saved in the folder for each Session ID
in the specified folder.
• Restrictions
None
• Option details
• /o path_to_SessionInfo
path_to_SessionInfo: Path to the folder to save the read TLS session information and client certifi-
cate files
TLS session information and client certificate files are stored in the folder with the folder name
that has the Session ID followed by the above path.
If this option is specified, TLS session information is not displayed.
The path of the folder can be either a relative path or an absolute path.
Characters and formats that can be used for the specified folder path conform to Windows specifi-
cations.
• The drive letter ("D:" or the like) can be used for the pathname.
• You must specify the path to the storage in the computer. UNC (Universal Naming Convention)
cannot be used.
An error occurs in the following cases:
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-89
A-11
Secure
Socket
Configuration
Commands
A
A-11-5
Command
Specifications
Appendices
• The specified folder already has a folder with the same name as the session ID specified.
• You do not have the access right to the specified folder.
You should be given the appropriate authority or an appropriate folder with the right to access
should be specified.
• /f
If the folder specified with the /o option exists, files in the folder will be deleted, and then the files
of TLS session information and client certificate will be saved.
• Execution results
In normal operation, all of the registered TLS session information is output.
Count=Serial number
Id = session ID
PrivateKey=”File name of the private key file”
Certificate=”File name of the certificate file”
Description=”Description of the session”
(Blank line)
Count=Serial number
Id = session ID
PrivateKey=”File name of the private key file”
Certificate=”File name of the certificate file”
Description=”Description of the session”
(Blank line)
:
• Serial number
Outputs the serial number of 1, 2, 3, and… in the order of the session to be output.
• Session ID
Outputs session ID (decimal).
• File name of the private key file
Outputs the file name set by the setSessionInfo command. The path is not included in file name.
If it is not set, “none” is output.
• File name of the certificate file
Outputs the file name set by the setSessionInfo command. The path is not included in file name.
If it is not set, “none” is output.
• Execution examples
a) When you want to display TLS session information of all session IDs
An example when two sessions of session ID=0 and 1 are registered
<TLSSettingTool Folder>>tlsconfig getAllSessionInfo /ip:192.168.250.1
Count=1
Id=0
PrivateKey=private0.key
Certificate=client0.crt
Description=
Count=2
Id=1
PrivateKey=private1.key
Certificate=client1.crt
Description=
000: Success
<TLSSettingTool Folder>>
b) When you want to save TLS session information of all session IDs in C:\Dir1\Dir2 folder
A-90 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
<TLSSettingTool Folder>>tlsconfig getAllSessionInfo /o C:\Dir1\Dir2 /ip:192.168.250.1
000: Success
<TLSSettingTool Folder>>
The read TLS session information and client certificate files are saved in two separate folders:
TLSSession0.txt and client0.crt are saved in C:\Dir1\Dir2\0\ folder and TLSSession1.txt and cli-
ent1.crt are saved in C:\Dir1\Dir2\1\ folder.
The image of the folder is as follows.
C:\Dir1\Dir2\
0\
TLSSession0.txt
client0.crt
1\
TLSSession1.txt
client1.crt
The contents of TLSSession0.txt are as follows.
Id=0
PrivateKey=private0.key
Certificate=client0.crt
The contents of TLSSession1.txt are as follows.
Id=1
PrivateKey=private1.key
Certificate=client1.crt
setLogLevel
• Format
setLogLevel□{/enable|/disable}□{/usb|/ip:xxx.xxx.xxx.xxx}
• Functions
You can set to enable or disable the secure socket communications log.
Enable: Starts output of secure socket communications log.
Disable: Stops output of secure socket communications log.
• Restrictions
This command can be used only when the CPU Unit is in PROGRAM mode. An error occurs when it
is used in RUN mode.
• Option details
/enable: Enables secure socket communications log
/disable: Disables secure socket communications log
Specify either of enable or disable.
Selecting neither or both of the two will result in an error.
• Execution results
None
• Execution examples
a) When you enable secure socket communications log
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-91
A-11
Secure
Socket
Configuration
Commands
A
A-11-5
Command
Specifications
Appendices
<TLSSettingTool Folder>>tlsconfig setLogLevel /enable /ip:192.168.250.1
000: Success
<TLSSettingTool Folder>>
b) When you disable secure socket communications log
<TLSSettingTool Folder>>tlsconfig setLogLevel /disable /ip:192.168.250.1
000: Success
<TLSSettingTool Folder>>
getLogLevel
• Format
getLogLevel□{/usb|/ip:xxx.xxx.xxx.xxx}
• Functions
You can read the enable or disable status of secure socket communications log.
disable: Secure socket communications log is disabled
enable: Secure socket communications log is enabled
• Restrictions
None
• Option details
None
• Execution results
None
• Execution examples
a) When the result of reading secure socket communications log status was enable
<TLSSettingTool Folder>>tlsconfig getLogLevel /ip:192.168.250.1
enable
000: Success
b) When the result of reading secure socket communications log status was disable
<TLSSettingTool Folder>>tlsconfig getLogLevel /ip:192.168.250.1
disable
000: Success
clearAllSettings
• Format
clearAllSettings□{/usb|/ip:xxx.xxx.xxx.xxx}
• Functions
You can initialize the secure socket setting.
• This command clears all TLS session information.
• This command disables secure socket communications log (stops output).
• Restrictions
This command can be used only when the CPU Unit is in PROGRAM mode. An error occurs when it
is used in RUN mode.
• Option details
None
• Execution results
A-92 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
None
• Execution examples
In the examples below, what it displayed by the command is underlined.
a) To execute the command
<TLSSettingTool Folder>>tlsconfig clearAllSettings /ip:192.168.250.1
This command clears all settings of destination Controller.
Confirm the settings to be cleared first, and enter "Yes".
>Yes
All settings are cleared.
000: Success
<TLSSettingTool Folder>>
b) To cancel command execution
<TLSSettingTool Folder>>tlsconfig clearAllSettings /ip:192.168.250.1
This command clears all settings of destination Controller.
Confirm the settings to be cleared first, and enter "Yes".
>No
Operation is canceled.
000: Success
<TLSSettingTool Folder>>
help
• Format
help
• Functions
You can display the version information and how to use the commands.
• Restrictions
None
• Option details
None
• Execution results
None
• Execution examples
<TLSSettingTool Folder>>tlsconfig help
Secure Socket Configuration Tool
tlsconfig.exe Version 1.00.00
Copyright (c) OMRON Corporation 2021. All Rights Reserved.
Usage: tlsconfig command [option1,option2....]
command:
setSessionInfo /id n [/key KEY_FILE_NAME /cert CERT_FILE_NAME] /desc [DESCRIPTION] [/f]
{/usb|/ip:IP_ADDRESS}
delSessionInfo /id n {/usb|/ip:IP_ADDRESS}
delAllSessionInfo {/usb|/ip:IP_ADDRESS}
getSessionInfo /id n [/o path_to_SessionInfo] [/f] {/usb|/ip:IP_ADDRESS}
getAllSessionInfo [/o path_to_SessionInfo] [/f] {/usb|/ip:IP_ADDRESS}
setLogLevel {/enable|/disable} {/usb|/ip:IP_ADDRESS}
getLogLevel {/usb|/ip:IP_ADDRESS}
clearAllSettings {/usb|/ip:IP_ADDRESS}
help
<TLSSettingTool Folder>>
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-93
A-11
Secure
Socket
Configuration
Commands
A
A-11-5
Command
Specifications
Appendices
When Commands are Omitted
• Format
None
• Functions
Same as the help command.
• Restrictions
None
• Option details
None
• Execution results
None
• Execution examples
A-94 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
A-12 TCP/ UDP Port Numbers Used for the
Built-in EtherNet/IP Port
The following table shows the applications that the built-in EtherNet/IP port of the NJ/NX-series CPU
Unit uses TCP/UDP ports, port numbers, port types, protocols used, default port states, usages, and
how to change from open to close.
TCP/UDP ports (servers) other than those shown below are not used.
UDP TCP De-
How to change
Applica- port port Port Protocol fault
CPU Unit model Usage from open (de-
tion num- num- type used port
fault) to close
ber ber state
FTP server All models --- 20 Sys- FTP Close Used when us- ---
tem ing the FTP
port server.
--- 21 User Close ---
port
SSH/SFTP All models --- 22 Sys- SSH/SFTP Close For mainte- ---
tem nance
port
DNS client All models 53 --- Sys- DNS Close Used when us- ---
tem ing the DNS cli-
port ent.
BOOTP cli- All models 68 --- Sys- BOOTP Close Used when us- ---
ent tem ing the BOOTP
port client.
DHCP cli- All NX502 CPU Unit DHCP Used when us-
ent models ing the DHCP
client.
HTTP serv- All models --- 80 Sys- HTTP Close Used for com- ---
er tem munications
port with the Sys-
mac Studio.
NTP client All models 123 --- User NTP Close Used when us- ---
port ing the NTP cli-
ent.
SNMP All models 161 --- User SNMP Close Used when us- ---
port (SNMPv1, ing the SNMP
SNMPv2C) agent.
SNMP trap All models 162 --- User Close Used when us- ---
port ing the SNMP
trap.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-95
A-12
TCP/
UDP
Port
Numbers
Used
for
the
Built-in
EtherNet/IP
Port
A
Appendices
UDP TCP De-
How to change
Applica- port port Port Protocol fault
CPU Unit model Usage from open (de-
tion num- num- type used port
fault) to close
ber ber state
HTTPS All models --- 443 Sys- HTTPS Open Used for com- Make one of the
server tem munications following set-
port with the Sys- tings.
mac Studio. • Use the
Packet Filter.
*1
• Set the DIP
switch to
enable
connections
to the
Sysmac
Studio and
NA that are
not
supporting
secure
communicati
on. *1*6
EtherNet/IP All models 2222 --- Sys- CIP Open Used for the Set Built-in
tag data tem EtherNet/IP tag EtherNet/IP
links port data links. Port Settings -
All NJ-series models 2223 --- Sys- Open CIP Settings -
tem CIP Message
port Server to Do
not use on the
Sysmac Studio.
A-96 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
UDP TCP De-
How to change
Applica- port port Port Protocol fault
CPU Unit model Usage from open (de-
tion num- num- type used port
fault) to close
ber ber state
FINS/UDP • All NJ-series 9600 --- User FINS (OM- Open Used for the Set Built-in
models port RON proto- FINS/UDP. EtherNet/IP
• All NX1P2 CPU col) Port Settings -
Unit models FINS Settings -
• All NX102 CPU FINS/UDP to
Unit models*2 Do not use on
the Sysmac
• NX701-1£20*2
Studio.
• All NX502 CPU
Unit models*2
FINS/TCP • All NJ-series --- 9600 User Open Used for the Set Built-in
models port FINS/TCP. EtherNet/IP
• All NX102 CPU Port Settings -
Unit models*2 FINS Settings -
FINS/TCP to
• NX701-1£20*2
Do not use on
• All NX502 CPU
the Sysmac
Unit models*2
Studio.
Sysmac All models 9600 --- Sys- Open Used for com- Use the Packet
Studio tem munications Filter.*1
port with the Sys-
CPU Unit with a 2224 --- Sys- Close* mac Studio. ---
USB port tem
4
• All NJ-series port
models
• All NX701 CPU
Unit models*3
Mainte- All models --- 9610 Sys- TCP (OM- Close For mainte- ---
nance tem RON proto- nance
port col)
CIP mes- All models 44818 44818 Sys- CIP Open Used for the Set Built-in
sages tem CIP messages. EtherNet/IP
port Port Settings -
CIP Settings -
CIP Message
Server to Do
not use on the
Sysmac Studio.
OPC UA CPU Units that sup- --- 4840 User OPC UA Close Used when us- ---
port OPC UA port ing the OPC
• NJ501-1£00 UA.
• All NX102 CPU
Unit models*5
• NX701-1£££*5
• All NX502 CPU
Unit models*5
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-97
A-12
TCP/
UDP
Port
Numbers
Used
for
the
Built-in
EtherNet/IP
Port
A
Appendices
UDP TCP De-
How to change
Applica- port port Port Protocol fault
CPU Unit model Usage from open (de-
tion num- num- type used port
fault) to close
ber ber state
TCP/UDP CPU Units that sup- 64000 64000 User TCP/UDP Close Used when us- ---
message port TCP/UDP mes- port ing the
service sage service TCP/UDP mes-
• All NX102 CPU sage service.
Unit models
• All NX502 CPU
Unit models
X Bus CPU Units that sup- 67 --- Sys- DHCP Close* Used for com- ---
port X Bus Units tem munications
7
• All NX502 CPU port with the X Bus
Unit models 520 --- Sys- RIP Close* Units.
tem
7
port
44819 --- Sys- CIP Close*
tem
7
port
--- 9910 Sys- TCP (OM- Close*
tem RON proto-
7
port col)
SECS/GE CPU Units that sup- --- 9700 Sys- TCP/UDP Open Used when us- Use the Packet
M connec- port SECS/ GEM tem (OMRON ing the Filter.
tion service • NJ501-1340 port protocol) SECS/GEM
--- 5000 User SECS-II Close connection ---
port service.
DB con- CPU Units that sup- --- 9800 Sys- TCP (OM- *8 Used when us- Use the Packet
nection port DB connection tem RON proto- ing the DB con- Filter.
service • NJ501-££20 port col) nection service.
• NJ101-££20 --- 9801 Sys- Open
• NX102-££20 tem
• NX701-1£20 port
• All NX502 CPU --- 9810 Sys- *8
Unit models tem
port
--- 9811 Sys- Open
tem
port
A-98 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
UDP TCP De-
How to change
Applica- port port Port Protocol fault
CPU Unit model Usage from open (de-
tion num- num- type used port
fault) to close
ber ber state
Robot inte- CPU Units that sup- 1989 --- Sys- UDP (OM- Open Used for com- • Use the
grated port Robot Integrat- tem RON proto- munications Packet Filter.
ed Controller port col) with the ACE • To close the
• NJ501-R£££ 1992 --- Sys- Open (including Appli- ports on the
tem cation Manag- left at once,
port er) or Sysmac remove the
Studio. SD Memory
1997 1997 Sys- TCP/UDP Open
Card, exe-
tem (OMRON
cute clear all
port protocol)
memory op- 65533 --- Sys- UDP (OM- Open
eration, then
tem RON proto-
restart the
port col)
Controller.
65534 --- Sys- Open
tem
port
1990 --- Sys- Close
tem
port
1993 --- Sys- Close
tem
port
69 --- Sys- TFTP Close
tem
port
--- 43234 Sys- TCP (OM- Close
tem RON proto-
port col)
--- 48987 Sys- Close
tem
port
*1. Closing the port may prevent communications with the Sysmac Studio. Refer to Troubleshooting When You Cannot Go
Online from the Sysmac Studio in the NJ/NX-series Troubleshooting Manual (Cat. No. W503) on how to make correc-
tions.
*2. This port number is supported only on Port 2. It cannot be used on Port 1.
*3. Only if the CPU Unit with a USB port.
*4. Always closed for the built-in EtherNet/IP port. Opened for the USB port only.
*5. This port number is supported only on Port 1. It cannot be used on Port 2.
*6. The NX502 CPU Units do not have this setting.
*7. Always closed for the built-in EtherNet/IP port. Opened for the X Bus only.
*8. Closed for the NX502 CPU Units. Opened for the CPU Units other than the NX502 CPU Units.
Precautions for Correct Use
When using socket service instructions, specify the port number so that the port numbers used
do not overlap. If the port numbers used are duplicated, an error will occur during instruction
execution.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-99
A-12
TCP/
UDP
Port
Numbers
Used
for
the
Built-in
EtherNet/IP
Port
A
Appendices
A-13 Version Information
This appendix shows the supported functions which have been changed or added through version up-
grades of the CPU Units.
 Additions and Changes to Functional Specifications
The following table lists additions and changes to the functional specifications, each with the corre-
sponding CPU unit version and Sysmac Studio version.
Addition/ Unit ver- Sysmac Studio
Function Reference
Change sion version
CIP routing Addition page 1-21 1.01 1.02
Packet Filter (Simple) Addition page 4-10 1.30 1.23
Packet Filter Addition/ page 4-8 *1 1.50
Change
Support for mounting a CJ1W-EIP Ether- Addition page 1-6 1.01 1.02
Net/IP Unit
Offsets for struc- Optional Addition page A-58
ture members CJ Addition page A-58 1.02 1.03
CIP objects Identity object Change page 7-49 1.01 ---
NX Configuration ob- Addition page 7-53 1.30 ---
ject
TCP/IP Interface ob- Change page 7-74 1.02 ---
ject
Tag data links Packet intervals (RPI) Change page 6-6 1.03 1.04
Permissible communi- Change
cations band
CIP message com- CIPOpenWithData- Addition page 7-4 1.06 1.07
munications Size instruction
Client function Addition*2 page 7-16 1.11 1.15
Socket services Number of supported Change page 8-10 1.03 1.04
sockets
SktSetOption instruc- Addition page 8-13 1.12 1.16
tion
TCP/UDP message Addition page 8-33 1.30 1.23
Secure socket serv- Addition page 8-36 *3 1.46
ices
FTP client Addition page 11-1 1.08 1.09
Troubleshooting Tag Data Link Con- Addition *4 1.04 1.05
nection Timeout
Number of Tag Sets Addition *4 1.30 1.23
for Tag Data Links Ex-
ceeded
Connection settings Addition page A-5 1.09 1.10
TCP/IP settings Operation for an IP Addition page 4-2 *5
address conflict
Modbus TCP Master Function Addition page 9-1 1.30 1.23
A-100 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Appendices
Addition/ Unit ver- Sysmac Studio
Function Reference
Change sion version
DHCP client Addition page 5-5 1.60 1.54
*1. Refer to Packet Filter on page 4-8 for the CPU Unit models and unit versions that support the Packet
Filter.
*2. An extension structure is supported as the data type of variables to contain the request path (IOI).
*3. Refer to 8-9 Secure Socket Services on page 8-36 for the CPU Unit models and unit versions that sup-
port the secure socket services.
*4. Refer to NJ/NX-series Troubleshooting Manual (Cat. No. W503).
*5. This function can be used with the Sysmac Studio and CPU Units which support OPC UA. Refer to the
NJ/NX-series CPU Unit OPC UA User’s Manual (Cat. No. W588) for information on the models and unit
versions of the CPU Units that support OPC UA, and the corresponding Sysmac Studio versions.
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) A-101
A-13
Version
Information
A
Appendices
A-102 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
I
Index
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) I-1
I
Index
Index
Numerics _EIP1_DhcpErr (Port1 DHCP Server Error)...........3-14, 3-48
_EIP1_EstbTargetSta (CIP Communications1 Normal Target
_EIP_BootpErr (BOOTP Server Error)...................3-13, 3-47 Node Information)...............................................3-26, 3-58
_EIP_CipErr (CIP Communications Error)...............3-7, 3-41 _EIP1_EtnCfgErr (Port1 Basic Ethernet Setting Error)...........
_EIP_DhcpErr (DHCP Server Error)......................3-14, 3-48 ............................................................................3-11, 3-44
_EIP_DNSCfgErr (DNS Setting Error)...................3-13, 3-47 _EIP1_EtnOnlineSta (Port1 Online).......................3-23, 3-55
_EIP_DNSSrvErr (DNS Server Connection Error).3-20, 3-54 _EIP1_IdentityErr (CIP Communications1 Identity Error).......
_EIP_ErrSta (EtherNet/IP Error)..............................3-3, 3-39 ............................................................................3-15, 3-49
_EIP_EstbTargetSta (Normal Target Node Information)......... _EIP1_IPAdrCfgErr (Port1 IP Address Setting Error).............
............................................................................3-26, 3-58 ............................................................................3-12, 3-45
_EIP_EtnCfgErr (Basic Ethernet Setting Error)......3-11, 3-44 _EIP1_IPAdrDupErr (Port1 IP Address Duplication Error)......
_EIP_EtnOnlineSta (Online)...................................3-23, 3-55 ............................................................................3-12, 3-46
_EIP_IdentityErr (Identity Error).............................3-14, 3-49 _EIP1_LanHwErr (Port1 Communications Controller Error)...
_EIP_IPAdrCfgErr (IP Address Setting Error).........3-11, 3-45 ............................................................................3-10, 3-44
_EIP_IPAdrDupErr (IP Address Duplication Error).3-12, 3-46 _EIP1_MacAdrErr (Port1 MAC Address Error)......3-10, 3-43
_EIP_IPRTblErr (IP Route Table Error)..................3-14, 3-48 _EIP1_MultiSwONErr (CIP Communications1 Multiple
_EIP_LanHwErr (Communications Controller Error).............. Switches ON Error).............................................3-19, 3-54
............................................................................3-10, 3-43 _EIP1_PortErr (Communications Port1 Error).........3-5, 3-40
_EIP_MacAdrErr (MAC Address Error)....................3-9, 3-43 _EIP1_RegTargetSta (CIP Communications1 Registered
_EIP_MultiSwONErr (Multiple Switches ON Error)3-19, 3-53 Target Node Information)....................................3-25, 3-57
_EIP_NTPResult (NTP Operation Information)......3-33, 3-62 _EIP1_TagAdrErr (CIP Communications1 Tag Name Reso-
_EIP_NTPResult.ExecNormal (NTP Operation Result)......... lution Error).........................................................3-18, 3-53
............................................................................3-34, 3-63 _EIP1_TargetNodeErr (CIP Communications1 Target Node
_EIP_NTPResult.ExecTime (NTP Last Operation Time)........ Error Information)................................................3-32, 3-62
............................................................................3-34, 3-63 _EIP1_TargetPLCErr (CIP Communications1 Target PLC
_EIP_NTPSrvErr (NTP Server Connection Error)..3-20, 3-54 Error Information)................................................3-29, 3-60
_EIP_PortErr (Communications Port Error).............3-4, 3-40 _EIP1_TargetPLCModeSta (CIP Communications1 Target
_EIP_RegTargetSta (Registered Target Node Information).... PLC Operating Mode).........................................3-28, 3-59
............................................................................3-25, 3-57 _EIP1_TDLinkAllRunSta (CIP Communications1 All Tag Da-
_EIP_TagAdrErr (Tag Name Resolution Error).......3-18, 3-52 ta Link Communications Status).........................3-24, 3-57
_EIP_TargetNodeErr (Target Node Error Information)............ _EIP1_TDLinkCfgErr (CIP Communications1 Tag Data Link
............................................................................3-31, 3-61 Setting Error)......................................................3-15, 3-50
_EIP_TargetPLCErr (Target PLC Error Information)............... _EIP1_TDLinkErr (CIP Communications1 Tag Data Link
...................................................................3-29, 3-60, 6-11 Communications Error).......................................3-17, 3-52
_EIP_TargetPLCModeSta (Target PLC Operating Mode)...... _EIP1_TDLinkOpnErr (CIP Communications1 Tag Data Link
...................................................................3-27, 3-59, 6-11 Connection Failed)..............................................3-16, 3-51
_EIP_TcpAppCfgErr (TCP Application Setting Error)............. _EIP1_TDLinkRunSta (CIP Communications1 Tag Data Link
............................................................................3-20, 3-54 Communications Status).....................................3-24, 3-56
_EIP_TcpAppErr (TCP Application Communications Error)... _EIP1_TDLinkStartCmd (CIP Communications1 Tag Data
..............................................................................3-9, 3-42 Link Communications Start Switch)...........3-36, 3-63, 6-73
_EIP_TDLinkAllRunSta (All Tag Data Link Communications _EIP1_TDLinkStopCmd (CIP Communications1 Tag Data
Status)................................................................3-24, 3-56 Link Communications Stop Switch)...........3-37, 3-64, 6-73
_EIP_TDLinkCfgErr (Tag Data Link Setting Error).3-15, 3-49 _EIP2_BootpErr (Port2 BOOTP Server Error).......3-13, 3-47
_EIP_TDLinkErr (Tag Data Link Communications Error)........ _EIP2_CipErr (CIP Communications2 Error)...........3-9, 3-42
............................................................................3-17, 3-51 _EIP2_DhcpErr (Port2 DHCP Server Error)...........3-14, 3-48
_EIP_TDLinkOpnErr (Tag Data Link Connection Failed)........ _EIP2_EstbTargetSta (CIP Communications2 Normal Target
............................................................................3-16, 3-50 Node Information)...............................................3-27, 3-59
_EIP_TDLinkRunSta (Tag Data Link Communications Sta- _EIP2_EtnCfgErr (Port2 Basic Ethernet Setting Error)...........
tus)......................................................................3-24, 3-56 ............................................................................3-11, 3-45
_EIP_TDLinkStartCmd (Tag Data Link Communications _EIP2_EtnOnlineSta (Port2 Online).......................3-23, 3-55
Start Switch)..............................................3-36, 3-63, 6-73 _EIP2_IdentityErr (CIP Communications2 Identity Error).......
_EIP_TDLinkStopCmd (Tag Data Link Communications ............................................................................3-15, 3-49
Stop Switch)..............................................3-36, 3-64, 6-73 _EIP2_IPAdrCfgErr (Port2 IP Address Setting Error).............
_EIP1_BootpErr (Port1 BOOTP Server Error).......3-13, 3-47 ............................................................................3-12, 3-46
_EIP1_CipErr (CIP Communications1 Error)...........3-8, 3-42
I-2 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Index
_EIP2_IPAdrDupErr (Port2 IP Address Duplication Error)...... broadcasting......................................................................8-9
............................................................................3-12, 3-46 built-in EtherNet/IP port specifications...............................1-9
_EIP2_LanHwErr (Port2 Communications Controller Error)... bye.................................................................................10-16
............................................................................3-10, 3-44
_EIP2_MacAdrErr (Port2 MAC Address Error)......3-10, 3-43 C
_EIP2_MultiSwONErr (CIP Communications2 Multiple
Switches ON Error).............................................3-20, 3-54 calculating the number of connections............................14-4
_EIP2_PortErr (Communications Port2 Error).........3-6, 3-41 cd...................................................................................10-14
_EIP2_RegTargetSta (CIP Communications2 Registered changing devices.............................................................6-81
Target Node Information)....................................3-26, 3-58 changing the RPI...........................................................14-11
_EIP2_TagAdrErr (CIP Communications2 Tag Name Reso- changing Windows firewall settings................................A-46
lution Error).........................................................3-19, 3-53 checking bandwidth usage for tag data links...................14-8
_EIP2_TargetNodeErr (CIP Communications2 Target Node checking connections......................................................6-80
Error Information)................................................3-33, 3-62 checking the current IP address......................................5-11
_EIP2_TargetPLCErr (CIP Communications2 Target PLC CIDR..................................................................................5-4
Error Information)................................................3-30, 3-61 CIP Communications.......................................................1-20
_EIP2_TargetPLCModeSta (CIP Communications2 Target CIP Communications Error.......................................3-7, 3-41
PLC Operating Mode).........................................3-28, 3-60 CIP communications instructions......................................7-4
_EIP2_TDLinkAllRunSta (CIP Communications2 All Tag Da- CIP Communications1 All Tag Data Link Communications
ta Link Communications Status).........................3-25, 3-57 Status..................................................................3-24, 3-57
_EIP2_TDLinkCfgErr (CIP Communications2 Tag Data Link CIP Communications1 Error.....................................3-8, 3-42
Setting Error)......................................................3-15, 3-50 CIP Communications1 Identity Error......................3-15, 3-49
_EIP2_TDLinkErr (CIP Communications2 Tag Data Link CIP Communications1 Multiple Switches ON Error................
Communications Error).......................................3-17, 3-52 ............................................................................3-19, 3-54
_EIP2_TDLinkOpnErr (CIP Communications2 Tag Data Link CIP Communications1 Normal Target Node Information........
Connection Failed)..............................................3-17, 3-51 ............................................................................3-26, 3-58
_EIP2_TDLinkRunSta (CIP Communications2 Tag Data Link CIP Communications1 Registered Target Node Information..
Communications Status).....................................3-24, 3-56 ............................................................................3-25, 3-57
_EIP2_TDLinkStartCmd (CIP Communications2 Tag Data CIP Communications1 Tag Data Link Communications Error
Link Communications Start Switch)...........3-36, 3-64, 6-73 ............................................................................3-17, 3-52
_EIP2_TDLinkStopCmd (CIP Communications2 Tag Data CIP Communications1 Tag Data Link Communications Start
Link Communications Stop Switch)...........3-37, 3-64, 6-73 Switch........................................................3-36, 3-63, 6-73
CIP Communications1 Tag Data Link Communications Sta-
A tus.......................................................................3-24, 3-56
CIP Communications1 Tag Data Link Communications Stop
address............................................................................4-17 Switch........................................................3-37, 3-64, 6-73
adjusting device bandwidth usage.................................14-10 CIP Communications1 Tag Data Link Connection Failed.......
adjusting packet interval (RPI) according to the task period... ............................................................................3-16, 3-51
...................................................................................14-26 CIP Communications1 Tag Data Link Setting Error................
adjusting the communications load.................................14-7 ............................................................................3-15, 3-50
All Tag Data Link Communications Status.............3-24, 3-56 CIP Communications1 Tag Name Resolution Error................
append...........................................................................10-14 ............................................................................3-18, 3-53
application example from a host computer....................10-20 CIP Communications1 Target Node Error Information...........
array variables for inputting and outputting service data and ............................................................................3-32, 3-62
response data..............................................................7-20 CIP Communications1 Target PLC Error Information.............
Auto Connection Configuration........................................6-46 ............................................................................3-29, 3-60
automatic clock adjustment.............................................12-2 CIP Communications1 Target PLC Operating Mode..............
procedure.....................................................................12-4 ............................................................................3-28, 3-59
required settings..........................................................12-4 CIP Communications2 All Tag Data Link Communications
specifications...............................................................12-2 Status..................................................................3-25, 3-57
Automatic Clock Adjustment............................................1-26 CIP Communications2 Error.....................................3-9, 3-42
automatically setting connections....................................6-45 CIP Communications2 Identity Error......................3-15, 3-49
automatically starting tag data links.................................6-72 CIP Communications2 Multiple Switches ON Error................
............................................................................3-20, 3-54
B CIP Communications2 Normal Target Node Information........
............................................................................3-27, 3-59
Basic Ethernet Setting Error...................................3-11, 3-44 CIP Communications2 Registered Target Node Information..
binary format..................................................................10-19 ............................................................................3-26, 3-58
BOOTP client...................................................................1-24
BOOTP Server Error..............................................3-13, 3-47
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) I-3
I
Index
CIP Communications2 Tag Data Link Communications Error default gateway.................................................................4-4
............................................................................3-17, 3-52 delete.............................................................................10-16
CIP Communications2 Tag Data Link Communications Start destination IP address.......................................................4-7
Switch........................................................3-36, 3-64, 6-73 destination mask IP address.............................................4-7
CIP Communications2 Tag Data Link Communications Sta- detailed descriptions of MIB objects................................13-5
tus.......................................................................3-24, 3-56 Device Connection Structure Tree...................................6-47
CIP Communications2 Tag Data Link Communications Stop Device Monitor.................................................................15-3
Switch........................................................3-37, 3-64, 6-73 DHCP client.....................................................................1-25
CIP Communications2 Tag Data Link Connection Failed....... DHCP Server Error.................................................3-14, 3-48
............................................................................3-17, 3-51 dir...................................................................................10-13
CIP Communications2 Tag Data Link Setting Error................ displaying device status...................................................6-83
............................................................................3-15, 3-50 DNS...................................................................................4-5
CIP Communications2 Tag Name Resolution Error................ DNS Server Connection Error................................3-20, 3-54
............................................................................3-19, 3-53 DNS Setting Error...................................................3-13, 3-47
CIP Communications2 Target Node Error Information........... domain names...................................................................4-6
............................................................................3-33, 3-62
CIP Communications2 Target PLC Error Information............. E
............................................................................3-30, 3-61
CIP Communications2 Target PLC Operating Mode.............. EDS file management.....................................................A-42
............................................................................3-28, 3-60 effect of tag data link on task period..............................14-26
CIP message communications service specifications.......7-3 Ethernet connectors........................................................2-13
CIP message server........................................................4-21 Ethernet Information Tab Page......................................15-10
CIP safety communications.............................................4-21 Ethernet Link Object........................................................7-77
CIP Settings Display........................................................4-21 Ethernet switch..................................................................1-6
CIPClose...........................................................................7-5 types..............................................................................2-3
CIPOpen............................................................................7-5 Ethernet switches
CIPOpenWithDataSize......................................................7-5 connection methods.....................................................2-11
CIPRead............................................................................7-5 functions.........................................................................2-3
CIPSend............................................................................7-5 installation precautions.................................................2-11
CIPUCMMRead.................................................................7-4 selection precautions.....................................................2-4
CIPUCMMSend.................................................................7-4 EtherNet/IP Error......................................................3-3, 3-39
CIPUCMMWrite.................................................................7-4
F
CIPWrite............................................................................7-5
clearing device parameters.............................................6-75
FTP client........................................................................1-25
client function of CIP message communications ..............7-4
FTP server..............................................................1-25, 4-14
close..............................................................................10-16
FTP server application example......................................10-9
Communications Controller Error...........................3-10, 3-43
FTP server application procedure...................................10-7
Communications Port Error......................................3-4, 3-40
FTP server overview and specifications..........................10-2
Communications Port1 Error....................................3-5, 3-40
FTP settings display........................................................4-14
Communications Port2 Error....................................3-6, 3-41
function
community name....................................................4-18, 4-20
functional comparison with other series........................A-3
Connection I/O Type...............................................6-41, 6-43
Connection Name...................................................6-42, 6-43
G
connection settings
editing all connections..................................................6-42
gateway address...............................................................4-7
editing individual connections......................................6-40
General Status.................................................................7-37
Register Device List.....................................................6-38
general status code.........................................................7-35
connection status codes and troubleshooting................15-11
get..................................................................................10-15
Connection Tab Page......................................................15-7
global addresses..............................................................5-11
Connection Type....................................................6-41, 6-43
global broadcast................................................................8-9
Controller Log Tab Page..................................................15-8
Controller Object..............................................................7-83
H
Controller status..............................................................6-10
creating tags and tag sets...............................................6-25
Host Name.........................................................................4-5
host names..........................................4-6, 4-15, 4-18 – 4-20
D
I
data processing time calculation example.....................14-25
data processing time overview......................................14-24
Identity Error...........................................................3-14, 3-49
I-4 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Index
Identity Object..................................................................7-48 importing to Network Configurator...............................6-35
indicator (LED).................................................................1-17 Normal Target Node Information............................3-26, 3-58
indicators.........................................................................1-17 NTP Last Operation Time.......................................3-34, 3-63
input ON response time.................................................14-28 NTP Operation Information....................................3-33, 3-62
interval.............................................................................4-15 NTP Operation Result............................................3-34, 3-63
IP Address.........................................................................4-3 NTP operation timing.......................................................4-15
IP address allocation.........................................................5-2 NTP server clock information..........................................4-15
IP address configuration....................................................5-2 NTP Server Connection Error................................3-20, 3-54
IP Address Duplication Error..................................3-12, 3-46 NTP Settings Display.......................................................4-15
IP Address Setting Error.........................................3-11, 3-45 NX Configuration Object..................................................7-53
IP address setting method..........................................4-3, 4-4
IP addresses..........................4-3, 4-4, 4-6, 4-15, 4-18 – 4-20 O
IP Route Table Error...............................................3-14, 3-48
IP router table setting example..........................................4-7 Online.....................................................................3-23, 3-55
IP routing.........................................................................1-22 open...............................................................................10-11
Originator Variable...........................................................6-43
K output ON response time...............................................14-29
output variable operation and timing......................7-34, 8-16
Keep Alive.........................................................................4-6 overview of built-in EtherNet/IP port socket services......8-10
Keep Alive monitoring time................................................4-6 overview of the CIP message communications service....7-3
L P
Linger option......................................................................4-7 Packet Filter.....................................................................1-23
LINK settings..........................................................4-12, 4-13 Packet Filter (Simple)......................................................1-24
LINK/ACT........................................................................1-18 packet interval (RPI)......................................................14-29
LLDP................................................................................4-13 Packet Interval (RPI)................................................6-9, 6-42
local broadcast..................................................................8-9 packet interval (RPI) accuracy.........................................14-5
location............................................................................4-17 passwords ......................................................................4-14
ls....................................................................................10-12 PING Command..............................................................5-18
port numbers........................................4-14, 4-15, 4-17, 4-19
M Port Numbers for Socket Services....................................8-2
Port1 Basic Ethernet Setting Error..........................3-11, 3-44
MAC address........................................................1-13 – 1-17 Port1 BOOTP Server Error.....................................3-13, 3-47
MAC Address Error..................................................3-9, 3-43 Port1 Communications Controller Error.................3-10, 3-44
Mask..................................................................................4-4 Port1 DHCP Server Error.......................................3-14, 3-48
maximum tag data link I/O response time.....................14-27 Port1 IP Address Duplication Error........................3-12, 3-46
mdelete..........................................................................10-16 Port1 IP Address Setting Error...............................3-12, 3-45
mdir................................................................................10-13 Port1 MAC Address Error.......................................3-10, 3-43
message service transmission delay.............................14-30 Port1 Online...........................................................3-23, 3-55
mget...............................................................................10-15 Port2 Basic Ethernet Setting Error..........................3-11, 3-45
MIB groups......................................................................13-5 Port2 BOOTP Server Error.....................................3-13, 3-47
MIB system diagram........................................................13-4 Port2 Communications Controller Error.................3-10, 3-44
mkdir..............................................................................10-13 Port2 DHCP Server Error.......................................3-14, 3-48
mls.................................................................................10-12 Port2 IP Address Duplication Error........................3-12, 3-46
mput...............................................................................10-16 Port2 IP Address Setting Error...............................3-12, 3-46
multi-cast and unicast communications.............................6-9 Port2 MAC Address Error.......................................3-10, 3-43
multicast filtering................................................................2-3 Port2 Online...........................................................3-23, 3-55
Multiple Switches ON Error....................................3-19, 3-53 precautions in using socket services...............................8-31
precautions when accessing external outputs................A-62
N
priority DNS server............................................................4-6
private addresses.............................................................5-11
NET ERR.........................................................................1-18
procedure to use socket services....................................8-14
NET RUN.........................................................................1-18
procedure to use the SNMP agent................................13-28
Network Configurator.........................................................1-7
put..................................................................................10-15
connecting through CPU Unit’s USB port....................6-58
pwd................................................................................10-14
connecting through Ethernet........................................6-55
direct connections via Ethernet....................................6-60 Q
network transmission delay time...................................14-29
network variables...............................................................6-8 quit.................................................................................10-17
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) I-5
I
Index
R SNMP Trap Settings Display...........................................4-19
SNMP traps...................................................1-29, 4-19, 13-3
reading network configuration file....................................6-78 socket................................................................................8-2
receive data processing time.........................................14-29 socket service..................................................................1-26
Recognition 1 settings.....................................................4-18 socket service communications
Recognition 2 settings.....................................................4-18 data receive processing.................................................8-6
recognition method..........................................................4-18 fragmenting of send data...............................................8-4
recommended clamp core and attachment method........2-10 TCP communications.....................................................8-3
Registered Target Node Information......................3-25, 3-57 TCP communications procedures..................................8-4
registering devices...........................................................6-23 UDP communications....................................................8-3
relationship between task periods and packet intervals socket service instruction................................................8-13
(RPIs).........................................................................14-26 specifying host names.....................................................1-28
rename..........................................................................10-13 specifying method..................................................4-19, 4-20
reponse code...................................................................7-35 starting and stopping tag data links.................................6-10
Requested Packet Interval (RPI) and bandwidth usage starting and stopping tag data links for individual devices......
(PPS)...........................................................................14-3 .....................................................................................6-74
Requested Packet Interval (RPI) settings........................14-2 starting and stopping tag data links for the entire network.....
rmdir..............................................................................10-14 .....................................................................................6-73
route path..........................................................................7-6 Status 1 Tab Page...........................................................15-3
RPI...................................................................................6-43 Status 2 Tab Page...........................................................15-6
structure variables for input request paths......................7-17
S subnet mask........................................................4-3, 4-4, 5-3
Sysmac Studio...................................................................1-7
sample program system-defined variables...................................................3-2
ladder programming for tag data links.........................6-85
sample programming T
CIP message communications....................................7-22
socket service.....................................................8-18, 8-23 table of commands.........................................................10-11
saving network configuration file.....................................6-77 tag data link bandwidth usage and RPI...........................14-9
SD Memory Card functions Tag Data Link Communications Error.....................3-17, 3-51
file types.....................................................................10-18 tag data link communications method.............................14-2
format of variable data ..............................................10-19 Tag Data Link Communications Start Switch3-36, 3-63, 6-73
initializing...................................................................10-19 Tag Data Link Communications Status..................3-24, 3-56
types..........................................................................10-18 Tag Data Link Communications Stop Switch3-36, 3-64, 6-73
secondary DNS server......................................................4-6 Tag Data Link Connection Failed...........................3-16, 3-50
secure socket service......................................................1-27 tag data link parameters
send a recognition trap....................................................4-17 downloading.................................................................6-62
send data processing time.............................................14-28 Tag Data Link Setting Error....................................3-15, 3-49
server specifying method.................................................4-15 tag data links
setting and downloading tag data link parameters............6-8 data areas......................................................................6-3
setting IP addresses..........................................................5-5 data concurrency.........................................................6-14
Settings required for the SNMP agent...........................13-28 functions and specifications...........................................6-6
settings required for the socket services.........................8-12 introduction....................................................................6-2
SktClearBuf.....................................................................8-13 settings.........................................................................6-21
SktClose..........................................................................8-13 tag data links with other models than NJ-series CPU Units
SktGetTCPStatus............................................................8-13 .................................................................................6-91
SktSetOption...................................................................8-13 Tag Data Links (Cyclic Communications)........................1-20
SktTCPAccept..................................................................8-13 Tag Name Resolution Error....................................3-18, 3-52
SktTCPConnect...............................................................8-13 tag sets..............................................................................6-3
SktTCPRcv......................................................................8-13 Tag Status Tab Page.......................................................15-9
SktTCPSend....................................................................8-13 tags....................................................................................6-3
SktUDPCreate.................................................................8-13 Target Device...................................................................6-43
SktUDPRcv......................................................................8-13 Target Node Error Information................................3-31, 3-61
SktUDPSend...................................................................8-13 Target PLC Error Information.........................3-29, 3-60, 6-11
SNMP agent...........................................................1-28, 13-2 Target PLC Operating Mode..........................3-27, 3-59, 6-11
SNMP messages.............................................................13-3 Target Variable.................................................................6-43
SNMP service..................................................................4-17 TCP Application Communications Error...................3-9, 3-42
SNMP Settings Display...................................................4-17 TCP Application Setting Error................................3-20, 3-54
SNMP specifications........................................................13-3 TCP/IP function.................................................................5-1
I-6 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)
Index
TCP/IP Interface Object...................................................7-74
TCP/IP Settings Display....................................................4-2
TCP/UDP message service.............................................1-29
time..................................................................................4-15
timeout time.....................................................................4-16
Timeout Value.........................................................6-42, 6-43
timing of data transmissions..........................................14-23
Trap 1 settings.................................................................4-19
Trap 2 settings.................................................................4-20
twisted-pair cable...............................................................1-6
connection methods.....................................................2-13
installation precautions..................................................2-7
other precautions for cable installation........................2-10
type................................................................................10-15
U
uploading tag data link parameters
uploading all.................................................................6-66
uploading from individual devices................................6-67
USB port..........................................................................1-17
Use of duplicated IP address.............................................4-5
user................................................................................10-12
using CIP communications instructions.............................7-5
V
verifying device parameters.............................................6-70
verifying tag data link parameters....................................6-68
version................................................................................22
versions...........................................................................4-20
NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506) I-7
I
Index
I-8 NJ/NX-series CPU Unit Built-in EtherNet/IP Port User’s Manual (W506)

OMRON Corporation Industrial Automation Company
Authorized Distributor:
Kyoto, JAPAN Contact : www.ia.omron.com
Regional Headquarters
OMRON EUROPE B.V. OMRON ELECTRONICS LLC
Wegalaan 67-69, 2132 JD Hoofddorp 2895 Greenspoint Parkway, Suite 200
The Netherlands Hoffman Estates, IL 60169 U.S.A.
Tel: (31) 2356-81-300 Fax: (31) 2356-81-388 Tel: (1) 847-843-7900 Fax: (1) 847-843-7787
OMRON ASIA PACIFIC PTE. LTD. OMRON (CHINA) CO., LTD. ©OMRON Corporation 2011-2025 All Rights Reserved.
438B Alexandra Road, #08-01/02 Alexandra Room 2211, Bank of China Tower, In the interest of product improvement,
Technopark, Singapore 119968 200 Yin Cheng Zhong Road, specifications are subject to change without notice.
Tel: (65) 6835-3011 Fax: (65) 6835-3011 PuDong New Area, Shanghai, 200120, China
Tel: (86) 21-6023-0333 Fax: (86) 21-5037-2388 Cat. No. W506-E1-37 0225