How to create a device walk file for EcoStruxure IT Gateway and Data Center Expert

This tool can walk SNMP1, SNMP3, Modbus, Redfish, NetBotz, and FTP devices, gathering current values or files to facilitate DDF development or debugging for Data Center Expert or EcoStruxure IT Gateway.

Specific information about how to create a walk file for different DCE versions is here.

Modbus.org announced it is expunging all occurrences of inappropriate language of the query and response paradigm of Modbus communications. This tool was updated to comply as of version 1.9.1. More...

Requirements

• Windows 10+ or Windows Server 2012+
• Admin access to Command Line or Windows PowerShell

Getting started

1. Unzip the file walker_version_Windows.zip

2. Navigate to the folder you unzipped in step 1.  There should be a file called "walk.bat" in the folder.
3. Right click the folder and click Open.

How to run your first command

The general usage is:

<protocol> -ip <ip> <options>

Example: snmp -ip 192.169.0.10

Note: To read more about each command while you run the program, type help followed by the command you need help for. Example: help snmpv3

There are several example commands below. Make sure to follow the structure carefully.

Running a command generates a walk file that is named using the IP address and a *.walk, *.json, *.txt", or *.xml extension. The file is saved to the folder where you ran the .bat script. If you are running a walk that retrieves raw files, such as FTP, these are saved as files.zip.

Example output: 192.169.0.10.xml
Example with file retrieval: 192.169.0.10.txt and files.zip

Troubleshooting

If you're having trouble connecting to a physical device, check with your network administrator to confirm that the device is enabled for the protocol and login credentials (if applicable) you are using to connect.

Device walks can take a long time to complete. A walk usually completes within 20 minutes for a slow connection.

If your walk fails to complete, it might be worth taking a break. Many protocols struggle to handle excessive repeated requests. If the walk seems to be hanging, try waiting a few hours and try again; this gives the device time to discard any old sessions and start accepting new ones. If the walk still fails, contact support for assistance.

Usage details

SNMP V1

Defaults

- ip: REQUIRED

- port: 161

- file: <ip>.walk
- read: public
- write: private
- retries: 2
- timeout: 5

- enableBulkRequest: false

Examples

snmp -ip 192.169.0.10

snmp -ip 192.169.0.10 -port 8161

snmp -ip 192.169.0.10 -read pass

 

SNMP V3

Argument valid values

- authType: MD5, SHA
- encType: DES, DES3, AES128, AES192, AES256

Defaults

- ip: REQUIRED

- port: 161

- file: <ip>.walk

- username: REQUIRED

- authType:

- authPassword:

- encType:

- encPassword:

- retries: 2

- timeout: 5

- enableBulkRequest: false

Examples

snmpv3 -ip 192.169.0.10 -port 161 -username XXXX -authType MD5 -authPassword XXXX -encType DES -encPassword XXXX

snmpv3 -ip 192.169.0.10 -port 161 -username XXXX -authType SHA -authPassword XXXX -encType AES128 -encPassword XXXX 

snmpv3 -ip 192.169.0.10 -port 161 -username XXXX 

snmpv3 -ip 192.169.0.10 -port 161 -username XXXX -authType SHA -authPassword XXXX 

 

Modbus

This requires a separate text file specifying which registers to read. See input.txt for formatting and examples.

WARNING: Excessive Modbus requests can overwhelm the device. Keep the number of selected registers as small as possible.

Defaults

- <ip>: REQUIRED

- port: 502

- file:
- server: 1
- input: input.txt

- maxReads: 100

- walk: true

- function:

- start: 1

- count:

- print:

Examples

modbus -ip 192.169.0.10

modbus -ip 192.169.0.10 -port 5020 -server 2 -input registers.txt

 

Redfish

Defaults

- ip: REQUIRED
- port: 443
- file: <ip>.json
- username: REQUIRED
- password: REQUIRED

Example

redfish -ip 192.168.0.10 -username user1 -password pass

 

NetBotz

Defaults

- ip: REQUIRED
- port: 80
- file: <ip>.json
- username: 
- password: 

- useSSL: false

Examples

netbotz -ip 192.168.0.10 -username user1 -password pass

netbotz -ip 192.168.0.10 -username user1 -password pass -useSSL

 

FTP

Defaults

- ip: REQUIRED
- port: 21
- file: <ip>.json
- username: 
- password:
- walk: true
- download_file:

Examples