impinj RShell Reference Manual

Command-line interface for speedway revolution octane 4.2.0

Advertisement

Speedway® Revolution – Octane 4.2.0
RShell Reference Manual
Proprietary and Confidential
www.impinj.com
REV 4.2 2009-08-27
Copyright © 2009, Impinj, Inc.
Impinj, Octane, and Speedway are either
registered trademarks or trademarks of Impinj, Inc.
For more information, contact rfid_info@impinj.com

Advertisement

Table of Contents
loading

Summary of Contents for impinj RShell

  • Page 1 Speedway® Revolution – Octane 4.2.0 RShell Reference Manual Proprietary and Confidential www.impinj.com REV 4.2 2009-08-27 Copyright © 2009, Impinj, Inc. Impinj, Octane, and Speedway are either registered trademarks or trademarks of Impinj, Inc. For more information, contact rfid_info@impinj.com...
  • Page 2: Table Of Contents

    4.2.6.4.1 Config SNMP EPCG Device Command... 22 4.2.7 Config System Command ...23 4.2.8 Config System Time Command...23 Show Command ...25 4.3.1 Show Image Command...25 4.3.2 Show Logging Commands...31 Revision 4.2, Copyright © 2009, Impinj, Inc. Proprietary and Confidential RShell Reference Manual...
  • Page 3 Show Network Command...32 4.3.4 Show RFID Command...38 4.3.4.1 Show RFID Stat ...39 4.3.4.2 Show RFID LLRP Commands...41 4.3.5 Show SNMP Command...42 4.3.6 Show System Command ...44 Revision History ...47 Notices:...47 Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 4: Introduction

    > show network show network > For machine execution, all commands can be called from the root menu. For example: > show network show network> dns Revision 4.2, Copyright © 2009, Impinj, Inc. Proprietary and Confidential RShell Reference Manual...
  • Page 5: Help

    ) will list all the commands available from the keyword (or ) can be combined on the same line to list all the Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 6: Response Format

    The error codes are defined in Table 3-1 Revision 4.2, Copyright © 2009, Impinj, Inc. command or prior to a command or menu, will return a short...
  • Page 7 The command was rejected because a previous command is still in progress such that this one could not be processed. The command cannot be finished right away; it is being processed. Proprietary and Confidential Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 8: Compatibility

    The Speedway Revolution CLI is designed to be both a machine and human interface. As such, Impinj strives to maintain backward compatibility within the Speedway Revolution product line. For Octane versions v4.x.x, existing command inputs and outputs should be relatively stable.
  • Page 9: Config Access Command

    Speedway Revolution reader. Speedway Revolution readers have the default password set to ‘impinj’, other reader types may use alternative default passwords. The user account name and password are used to access the command line interface via serial, telnet or ssh.
  • Page 10: Config Image Default Command

    Upon receiving this command, the reader updates its local upgrade configuration URI. It then retrieves the (new) upgrade configuration metafile, and performs the upgrade in accordance with Revision 4.2, Copyright © 2009, Impinj, Inc. show image summary config image default...
  • Page 11: Config Image Retrievemode Command

    , or a change of manual auto Proprietary and Confidential , the retrieval period as auto config image upgrade while the retrieve-period Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 12: Config Logging Command

    Figure 4-1 illustrates a configuration where the reader management category of logs set to critical (and above), the RFID related logs set to warning (and above) and lastly the system logs set to alert (and above). Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 13 Figure 4-1 Severity Level Logging Categories The command parameters are shown in Table 4-5. The command sets the logging level for a log category to one of a set of pre-defined severity levels. Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 14: Config Network Command

    The config network command parameters are shown in Table 4-6. Revision 4.2, Copyright © 2009, Impinj, Inc. Format address Add a new Syslog server with given address or hostname.
  • Page 15: Config Network Hostname Command

    Configure the current state of the LLA service. LLA, when enabled, is only used if the network IP is set to dynamic and DHCP is unable to obtain an IP address. parameters. Proprietary and Confidential Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 16: Config Network Dhcp Command

    DNS servers. These config network dns servers are in addition to any provisioned through DHCP. The command’s parameters are shown in Table 4-11. Revision 4.2, Copyright © 2009, Impinj, Inc. Format enum Configure the current state of the mDNS service. When enabled mDNS is always active and can be used to both resolve addresses in the .local domain as well as provide...
  • Page 17: Config Network Dns Domain Command

    Add a static domain name to the list of domain names. string Delete a static domain name from the list of domain names. Delete all static domain names from the list of domain names. Proprietary and Confidential Description Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 18 Revision 4.2, Copyright © 2009, Impinj, Inc. Format Description Configure the reader to use DHCP to obtain IP address parameters. Configure the reader to use statically configured IP address parameters. The following combinations of parameters are valid: <ip address>...
  • Page 19: Config Network Ntp Command

    Delete a statically configured server (identified by either an IP address or hostname) from the list of current NTP servers. Delete all the statically configured NTP servers from the current list. Description Proprietary and Confidential Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 20: Config Rfid Llrp Inbound Commands

    4.2.5.2.2 Config RFID LLRP Outbound Commands command leads to a submenu of reader-initiated connection config rfid llrp outbound configuration commands, as shown in Table 4-18. Revision 4.2, Copyright © 2009, Impinj, Inc. Description subcommand is supported, which has its Format...
  • Page 21 Disabling this service will cause all future connection attempts to be cancelled. Enabling this service will cause the reader to begin connection attempts to any configured remote hosts. Current LLRP connections are unaffected by this command. Proprietary and Confidential Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 22: Config Snmp Command

    SNMP read and write access config snmp access settings for the reader. The config snmp access command parameters are shown Table 4-21. Revision 4.2, Copyright © 2009, Impinj, Inc. integer Configure the timeout (in seconds) for LLRP reader- initiated connections before declaring failure.
  • Page 23: Config Snmp Write Command

    SNMP. Format string Enable SNMP writes on all writeable objects. string Disable SNMP writes on all writeable objects. Proprietary and Confidential Description Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 24: Config System Command

    Time MMDDhhmmCCYY MM.DD-hh:mm:ss CCYY.MM.DD-hh:mm:ss CCYY.MM.DD-hh:mm hh:mm:ss hh:mm Revision 4.2, Copyright © 2009, Impinj, Inc. Format string The string that should be reported for device role Description Description Configure the system time. Time must be entered in one of the given formats.
  • Page 25 MMDDhhmmCCYY Configure the system time. Time must be entered in one of the given MM.DD-hh:mm:ss formats. CCYY.MM.DD-hh:mm:ss See Note CCYY.MM.DD-hh:mm hh:mm:ss hh:mm Proprietary and Confidential Description below. 1:11:00 Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 26: Show Command

    Following an upgrade command, For each abnormal status, a reason parameter is given to indicate the reason for the status. The reason values are also given in Table 4-28 Revision 4.2, Copyright © 2009, Impinj, Inc. Description Description can take any of the values shown in Table 4-28.
  • Page 27 For fixed-delay this is a constaint offset. For random-delay this is the maximum value for a randomly chosen offset. URI from which the file image is retrieved. Proprietary and Confidential Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 28 This supplements the UpgradeStatus field to give a reason for the status. Only displayed/provided in conjunction with next line (LastOperationStatus). Typically these are provided when additional information is required, for example under Revision 4.2, Copyright © 2009, Impinj, Inc. Format The upgrade status of the last executed upgrade.
  • Page 29 Failed to write the flash memory. The current image has been invalidated by a previous “fallback” command. This reason applies to the rejection of multiple commands following a “fallback” command. Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 30 RShell Reference Manual Generic Error Download error other than those specified above. Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 31 The version of the primary image’s custom application partition. Only displayed if CAP is present. If the secondary image is not valid this argument is not shown. Table 4-31 Image State Values Meaning Proprietary and Confidential Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 32: Show Logging Commands

    4-32. Log entries are in chronological order, the most recent being the last displayed. Response parameters for the are shown in Table 4-33. Response parameters for the show logging events command are shown in Table 4-34. show logging summary Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 33: Show Network Command

    Log severity level for Management Alert | Critical | Log severity level for RFID Error | Warning | Log severity level for System Notice | Info | Debug ) Proprietary and Confidential Description Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 34 Argument Format SendHostname ( on | off ) UserClass string Revision 4.2, Copyright © 2009, Impinj, Inc. Description Description Indicates the current setting for sending the hostname during DHCP negotiation. This controls whether or not the reader includes its hostname when communicating with the DHCP server.
  • Page 35 Address of the Nth dynamic DNS server Format Description integer See MIB-2 RFC 1213 integer integer integer integer integer integer integer integer integer integer integer integer integer integer integer integer integer integer integer integer integer Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 36 IpReasmOKs IpReasmFails ipFragOKs ipFragFails ipFragCreates IpRoutingDiscards Revision 4.2, Copyright © 2009, Impinj, Inc. integer integer integer integer Format Description integer See MIB-2 RFC 1213 integer integer integer integer integer integer integer...
  • Page 37 The currently active network device e.g. ‘eth0’. string The current hostname of the reader. Format (Init | Current state of the ethernet interface. Connected | Disconnected) Proprietary and Confidential Description Description Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 38 IpMask gatewayAddress broadcastAddress Revision 4.2, Copyright © 2009, Impinj, Inc. ( Dynamic | If configuration is currently dynamic, the Static ) dynamic values returned by DHCP are given. If a value is currently not set (such as the...
  • Page 39: Show Rfid Command

    Format Description integer See MIB-2 RFC 1213 integer integer integer Description Display RFID statistics for reader. Leads to submenu of LLRP status statistics Proprietary and Confidential Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 40: Show Rfid Stat

    RShell Reference Manual 4.3.4.1 Show RFID Stat command displays the RFID statistics for that reader. show rfid stat Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 41 Number of tags written at Antenna <n> that matched the configured filters; <n> is 1–4 Integer Number of tags where a write was attempted at Antenna <n> because the tag matched the configured Proprietary and Confidential Description Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 42: Show Rfid Llrp Commands

    LLRP interface and has the subcommands show rfid llrp listed in Table 4-49. Revision 4.2, Copyright © 2009, Impinj, Inc. filters, but the write failed; <n> is 1–4 Integer Number of tags locked at Antenna <n> that matched the configured filters;...
  • Page 43: Show Snmp Command

    Display information about LLRP client-initiated connections. Display information about LLRP reader-initiated connections. Display the LLRP region and Impinj sub-region at which the reader is currently operating. Also will display sub- regulatory region information when configured by LLRP extensions Display the XML text of a specified ROSpec.
  • Page 44 EpcgReadPointOperNotifyStateLevel EpcgSrcOperStatusNotifEnable EpcgSrcOperStatusNotifyLevel EpcgNotifChanOperNotifEnable EpcgNotifChanOperNotifLevel Revision 4.2, Copyright © 2009, Impinj, Inc. Format The status of the SNMP service The value of the read-only community string The value fo the read-write community string Indicates whether SNMP writes are enabled or...
  • Page 45: Show System Command

    CPU utilization in percent integer Total configuration/persistent partition space in bytes integer Free configuration/persistent partition space in bytes integer Total application partition space in bytes integer Free application partition space in bytes Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 46 Fallback ) PowerFailTime integer ActivePowerSource ( poe | jack ) Revision 4.2, Copyright © 2009, Impinj, Inc. Description Internal ‘Boot Environment’ data version Returns the hardware version information for the reader and internal hardware. Returns the reader’s hardware serial number for thr reader and internal hardware.
  • Page 47 The system contact information. Defaults to ‘unknown’. The system name. Defaults to hostname of the reader. The system location. Defaults to ‘unknown’. The current time on the reader in UTC. Proprietary and Confidential Revision 4.2, Copyright © 2009, Impinj, Inc.
  • Page 48: Revision History

    Impinj and the authorized recipient hereof.
  • Page 49 RShell Reference Manual...

Table of Contents