main.doxygen

Go to the documentation of this file.

/** 
 * @file main.doxygen
 * @brief Overview page for the elxsdkutil
 *
/

/** @mainpage Overview
 *
 * The Emulex SDK Utility (elxsdkutil)
 * provides a working example of a management utility, including reference code.
 * This utility can be used to incorporate similar functionality into an existing product or
 * to develop a custom utility.
 * The elxsdkutil is applicable to the Emulex Service Level Interface - 4
 * (SLI-4) family of products (for example, Emulex LightPulse® LPe16000/LPe16002 16GFC host bus adapters).
 * 
 * The following figure shows  the high-level relationship between the elxsdkutil, a OneCore Storage driver
 * (kernel space or user space), and an SLI-4 product.
 *
 * @image html elxsdkutil_basic.jpg "Relationship of the elxsdkutil with a OneCore Storage Driver"
 * 
 * For detailed information about the elxsdkutil commands and design, also see
 * the <i><a href="../../../../../doc/ocs_utilities_manual.pdf" target="_blank">OneCore Storage Utilities Manual</a></i>.
 *
 * <h2><a href="elxsdkutil_commands.html">Commands and Their Usage</a></h2>
 *
 * <h2><a href="elxsdkutil_structure.html">Main Components of the elxsdkutil Structure</a></h2>
 * \li <a href="cmd_line_parsing.html">Command Line Parsing and Execution</a>
 *      <ul><li>@ref cmd_handler</li></ul> 
 * \li <a href="dev_enum.html">Device Enumeration</a>
 * \li <a href="flash_parsing.html">Flash File Parsing (Using “file-info”)</a>
 * \li <a href="flash_access.html">Flash Access</a>
 * \li <a href="mbox_cmd.html">Mailbox Command Construction</a>
 * \li <a href="dev_mgmt.html">Device Management API</a>
 *      <ul><li>@ref mgmt_status</li>
 *      <li>@ref mgmt_config</li>
 *      <li>@ref mgmt_actions</li>
 *      <li>@ref data_formats</li>
 *      <li>@ref list_properties</li>
 *      <li>@ref ident_indiv_prop</li>
 *      <li>@ref data_structures</li></ul> 
 *
 *
 * <h2><a href="elxsdkutil_oce11102.html">OCe14000-series Adapters</a></h2>
 * \li \ref oce11102_fw_download
 * \li \ref oce11102_fat
 * \li \ref oce11102_efd
 * \li \ref oce11102_flash
 *
 *
 * <h2><a href="elxsdkutil_lpe1600x.html">LPe16000-series Adapters</a></h2>
 * \li \ref lpe1600x_obj_mgmt
 * \li \ref lpe1600x_obj_groups
 *
 */
 
/**
* @page elxsdkutil_structure.html Main Components of the elxsdkutil Structure
*
* \li <a href="cmd_line_parsing.html">Command Line Parsing and Execution</a>
*       <ul><li>@ref cmd_handler</li></ul> 
* \li <a href="dev_enum.html">Device Enumeration</a>
* \li <a href="flash_parsing.html">Flash File Parsing (Using “file-info”)</a>
* \li <a href="flash_access.html">Flash Access</a>
* \li <a href="mbox_cmd.html">Mailbox Command Construction</a>
* \li <a href="dev_mgmt.html">Device Management API</a>
*       <ul><li>@ref mgmt_status</li>
*       <li>@ref mgmt_config</li>
*       <li>@ref mgmt_actions</li>
*       <li>@ref data_formats</li>
*       <li>@ref list_properties</li>
*       <li>@ref ident_indiv_prop</li>
*       <li>@ref data_structures</li></ul> 
*
* The following figure shows the structure of the elxsdkutil.
*
* @image html elxsdkutil_structure.jpg "Structure of the elxsdkutil"
* 
*/

/**
* @page elxsdkutil_commands.html CLI Commands and Their Usage
* This section describes the elxsdkutil’s command usage and details.
* The elxsdkutil provides a simple command line interface (CLI) to perform
* various functions, such as downloading firmware to the flash and retrieving dump files
* for debugging purposes.
* 
* @section commands_usage_list List of Commands
*
* <table class="dashboard">
* <tr><th>Command</th><th>Name</th><th>Restrictions</th></tr>
* <tr><td>@ref cmd_add_ip "add-ip"</td><td>Add IP</td><td>iSCSI only</td></tr>
* <tr><td>@ref cmd_compare "cmp"</td><td>Compare</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_connection_info "connection-info"</td><td>Connection Information</td><td>Linux and iSCSI only</td></tr>
* <tr><td>@ref cmd_create_vport "create-vport"</td><td>Create VPort</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_driver_dump "driver-dump"</td><td>Driver Dump</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_driver_info "driver-info"</td><td>Driver Information</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_dump "dump"</td><td>Firmware Dump</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_dump_to_host "dump-to-host"</td><td>Generate Dump to Host</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_efdc "efdc"</td><td>EFD Capabilities</td><td>OCe11102 adapters only</td></tr>
* <tr><td>@ref cmd_file_info "file-info"</td><td>File Information of UFI</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_gendump "gendump"</td><td>Generate Dump</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_help "help"</td><td>Help</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_linkcfg_get "linkcfg-get"</td><td>Get Link Configuration</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_linkcfg_set "linkcfg-set"</td><td>Set Link Configuration</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_list "list"</td><td>List Adapters</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_mgmt_info "mgmt-info"</td><td>Management Information</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_objenum "objenum"</td><td>Objects Enumerate</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_read "read"</td><td>Read Object File</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_read_link_status "read-link-status"</td><td>Read Link Status</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_read_rev "read-rev"</td><td>Read Adapter Version</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_read_status "read-status"</td><td>Read Device Status</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_remove_vport "remove-vport"</td><td>Remove VPort</td><td>LPe1600x HBAs only</td></tr>
* <tr><td>@ref cmd_set_mac "set-mac"</td><td>Set MAC Address</td><td>iSCSI only</td></tr>
* <tr><td>@ref cmd_sfp "sfp"</td><td>SFP EEPROM Data</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_show_ips "show-ips"</td><td>Show IPs</td><td>iSCSI only</td></tr>
* <tr><td>@ref cmd_show_mac "show-mac"</td><td>Show MAC</td><td>iSCSI only</td></tr>
* <tr><td>@ref cmd_version "version"</td><td>Version of Program</td><td>&nbsp;</td></tr>
* <tr><td>@ref cmd_write "write"</td><td>Write Firmware Image</td><td>&nbsp;</td></tr>
* </table>
*
*
*
* @section cmd_usage Command Usage
*
* <div class="util">
*
* @subsection cmd_syntax Syntax Information
* To invoke the CLI and run the elxsdkutil commands, use the following syntax:<br>
* <tt>elxsdkutil [command] [option(s)]</tt>

* For example, to compare the data in the flash on device 2 to the data in the “myfile” file,
* use the following command:<br>
* <tt>elxsdkutil cmp -d 2 -f myfile</tt>
* 
* <b>Syntax Notes</b>
* <ul><li>Angled brackets, “< >”, indicates a specific value to include with the option.</li>
* <li>Square brackets, “[]”, indicate optional parameters.</li></ul>
*
* @subsection cmd_options Common Command Options
*
* The Device Number, Filename, and Host options are used by multiple commands.
*
* @subsubsection dev_number Device Number (--device, -d)
* The Device Number option indicates the device number of the adapter’s port(s). The
* command line syntax is:<br>
* <tt>--device <devicenum></tt><br>
* -or-<br>
* <tt>-d <devicenum></tt><br>
* Where <devicenum> is a non-negative integer (0, 1, 2, and so on).
*
* @b Note: The default device number is 0. That is, if the devicenum is not specified for a
* command, it is assumed that the devicenum is 0.
*
* @subsubsection filename Filename (--file, -f)
* The Filename option indicates the filename for downloads, compares, saving dump
* information, and so on. The command line syntax is:<br>
* <tt>--file <filename></tt><br>
* -or-<br>
* <tt>-f <filename></tt><br>
*
* @subsubsection host_option Host (--host)
* The Host option is used with the OneCore Storage user space drivers. When using one
* of the user space drivers, this option specifies the host name or IP address of the system
* on which the user space driver is running. This option is required on all commands that
* access a device. The command line syntax is:<br>
* <tt>--host <hostname></tt><br>
*
* For details on the user space drivers (Uspace ocs_fc_ramd and Uspace ocs_iscsi_ramd),
* see the latest <i>OneCore Storage Reference Driver Manual</i>.
*
*
* @subsection cmd_help_menu Help Menu
*
* See @ref cmd_help
* <br><br>
* </div>
*
* @section cmd_details Command Details
*
*
*
* <div class="util">
*
* @subsection cmd_add_ip add-ip (Add IP)
* This command adds an additional Internet Protocol (IP) address to an iSCSI adapter.
* The IP address (<ip&nbsp;address>) and network mask (<net&nbsp;mask>) values must be in the
* same IP version format, either IPv4 (###.###.###.###) or IPv6
* (####:####:####:####:####:####:####:####). Also see @ref cmd_show_ips,
* 
* @b Note: This command is applicable to iSCSI adapters only.
* 
* @b Syntax
* @n <tt>add-ip <ip&nbsp;address> <net&nbsp;mask> [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Add an additional IP address of 20.0.0.120 and net mask of 255.255.255.0 to device 2:
* <tt>elxsdkutil add-ip 20.0.0.120 255.255.255.0 -d 2</tt>
* 
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_compare cmp (Compare)
* This command compares the adapter flash data with the specified file data. The output
* indicates that the “Firmware verification was successful!” or the “Firmware verification
* failed,” including a list of the mismatched sections.
*
* @b Syntax
* @n <tt>cmp [-d <devicenum>] -f <filename> [--host <hostname>]</tt>
* 
* @b Example
* @n Compare the data stored in the device 2 flash to the data in the “myfile” file:
* @n <tt>elxsdkutil cmp -d 2 -f myfile</tt>
* 
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_connection_info connection-info (Connection Information)
* If a connection handle is provided, this command reports information on that
* Transmission Control Protocol (TCP) connection. If no connection handle is provided,
* this command displays a list of open TCP connections.
*
* @b Note: This command is applicable to Linux and iSCSI only.
*
* @b Syntax
* @n <tt>connection-info [-d <devicenum>] [--host <hostname>]</tt>
* @n <tt>[--connection-handle <handle>]</tt>
* 
* @b Example
* @n Display information on TCP connections for device 1:
* @n <tt>elxsdkutil connection-info -d 1</tt>
* 
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_create_vport create-vport (Create Vport)
* This command creates a virtual port (Vport). The WWNN and WWPN values are in the
* format of eight pairs of hexadecimal digits separated by colons (for example,
* 10:00:00:00:c9:01:02:03).
*
* @b Notes
* <ul><li>If values for WWNN and WWPN are not specified, then the SLI Port will assign
* the appropriate WWNN/WWPN values.
* <li>The syntax must include an “--initiator” or “--target,” or both.
* <li>This command is applicable to LPe16000/LPe16002 HBAs only
* <li>For the OneCore Storage SCST driver (ocs_fc_scst), this elxsdkutil command
* has no effect. To create a vport for the ocs_fc_scst driver, see section “3.2.7.1
* Creating a Virtual Port (vport)” in the <i>OneCore Storage SCST Driver Guide</i>,
* Revision 1.5 or later.</li></ul>
*
* @b Syntax
* @n <tt>create-vport [<WWNN>] [<WWPN>] [--initiator] [--target]</tt>
* @n <tt>[-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Create a Vport on device 0:
* @n <tt>elxsdkutil create-vport 20:00:00:00:c9:01:02:03 10:00:00:00:c9:01:02:03 --target</tt>
* 
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_driver_dump driver-dump (Driver Dump)
* This command dumps the internal driver information.
*
* @b Options
* @n The following options are available for the driver-dump command.
* <ul><li>If values for WWNN and WWPN are not specified, then the SLI Port will assign
* the appropriate WWNN/WWPN values.
* <li>bufsize <buffer&nbsp;size> – specifies the size of the memory buffer used to retrieve
* the dump. The <size> is specified in units of bytes in the form of <number>
* [k, M]. The default is “4M” (4 megabytes).</li>
* <li>saved – dumps the contents from a previously-saved driver dump capture.</li>
* <li>clrsaved – clears the previously-saved driver dump capture, so that a new one
* driver dump snapshot can be saved.</li></ul>
*
* Contents of various queue entries can be included in the driver dump by specifying
* the following queue options:
* <ul><li>cqes – includes the contents of the completion queues entries (CQEs). It is
* dumped automatically when no queue options are specified. If other queue
* options are specified, then it is not dumped automatically.</li>
* <li>eqes – includes the contents of the event queue entries (EQEs).</li>
* <li>mqes – includes the contents of the mailbox queues entries (MQEs).</li>
* <li>rqes – includes the contents of the receive queues entries (RQEs).</li>
* <li>wqes – includes the contents of the work queues entries (WQEs). It is
* dumped automatically when no queue options are specified. If other queue
* options are specified, then it is not dumped automatically.</li></ul>
*
* The number of the latest queue entries can be specified using the following option:
* <ul><li>qentries <entries&nbsp;to&nbsp;dump> – specifies the number of the most recent queue
* entries to dump. To dump the entire queue, <entries&nbsp;to&nbsp;dump> is “-1”. The
* default of <entries&nbsp;to&nbsp;dump> is “32”.</li></ul>
*
* @b Syntax
* @n <tt>driver-dump [-d <devicenum>] [--wqes] [--cqes] [--mqes] [--rqes]</tt>
* @n <tt>[--eqes] [--qentries <entries&nbsp;to&nbsp;dump>] [--host <hostname>]</tt>
* @n <tt>[--bufsize <buffer&nbsp;size>] [--saved] [--clrsaved]</tt>
* 
* @b Examples
*
* Dump the internal driver information, including the latest 32 queue entries of the CQ
* and WQ:
* @n <tt>elxsdkutil driver-dump</tt>
*
* Dump the internal driver information, including all of the CQ and WQ entries:
* @n <tt>elxsdkutil driver-dump --qentries -1</tt>
*
* Dump the internal driver information, including the latest twelve queue entries of the
* CQ, EQ, and MQ:
* @n <tt>elxsdkutil driver-dump --cqes --eqes --mqes --qentries 12</tt>
* 
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_driver_info  driver-info (Driver Information)
* This command displays the parameters used when the driver was loaded (which may
* not be the current ones).
* 
* @b Syntax
* @n <tt>driver-info [-d <devicenum>] [--host <hostname>]<filename></tt>
* 
* @b Example
* @n Retrieve the module parameter values for a Linux target loaded with the ocs_fc_ramd
* driver:
* @n <tt>elxsdkutil driver-info</tt>
*
* @b Output<br>
* <tt>ramdisc_size: 50m<br></tt>
* <tt>ramdisc_blocksize: 512<br></tt>
* <tt>num_luns: 1<br></tt>
* <tt>initiator: false<br></tt>
* <tt>target: true<br></tt>
* <tt>logmask: 0x0<br></tt>
* <tt>ctrlmask: 0x0<br></tt>
* <tt>wwn_bump: 0<br></tt>
* <tt>topology: 0<br></tt>
* <tt>speed: 0<br></tt>
* <tt>p_type: 0<br></tt>
* <tt>holdoff_link_online: false<br></tt>
* <tt>enable_hlm: false<br></tt>
* <tt>hlm_group_size: 8<br></tt>
* <tt>logdest: 1<br></tt>
* <tt>ramlog_size: 1048576<br></tt>
* <tt>hal_war_version: 0<br></tt>
* <tt>num_scsi_ios: 8192<br></tt>
* <tt>dif_separate: false<br></tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_dump dump (Firmware Dump)
* For LPe16000/LPe16002 HBAs, this command retrieves the dump.bin file for
* debugging purposes. The dump.bin file is generated by the @ref cmd_gendump command.
*
* For OCe11102 adapters, this command includes four dump options:
* <ul><li>ecd – this Emulex core dump (ECD) option uses the XE4310R template to
* retrieve the XE4310R controller core dump diagnostic information from a device
* to a specified file. This is the default option.</li>
* <li>ecdtest – this option creates an ECD test file that is used to verify the core dump
* operation. The result is a binary file that needs to be verified by Emulex.</li>
* <li>efd – this option retrieves enhanced failure dump (EFD) data from the adapter
* to a specified file.</li>
* <li>fat – this option retrieves failure analysis tool (FAT) data from the adapter to a
* specified file.</li></ul>
*
* @b Syntax
* @n <tt>dump [--fat | --efd | --ecd | --ecdtest ] [-d <devicenum>]</tt>
* @n <tt>[--host <hostname>] [-f <filename>]</tt>
* 
* @b Examples
*
* For LPe16000/LPe16002 HBAs, the following example retrieves the dump.bin file from
* device 2 and saves it to the myfile file:
* @n <tt>elxsdkutil dump --ecd -f myfile</tt>
*
* For the OCe11102 adapters, the following examples show some of the command’s
* various options:
* <ul><li>Use the ECD option from device 0, and save the data to the “myfile” file:</li>
* @n <tt>elxsdkutil dump --ecd -f myfile</tt>
* @n Or since “ecd” is the default, you can simply use:
* @n <tt>elxsdkutil dump -f myfile</tt></ul>
*
* <ul><li>Save the EFD data of device 1 to the myfile file:</li>
* @n <tt>elxsdkutil dump --efd -d 1 -f myfile</tt></ul>
*
* <ul><li>Save the FAT data of device 3 to the myfile file:</li>
* @n <tt>elxsdkutil dump --fat -d 3 -f myfile</tt></ul>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_dump_to_host dump-to-host (Generate Dump to Host)
* Enables a device to generate a dump and transfer it directly to host memory. This
* command combines the “gendump” and “dump” commands into a single operation. If
* a filename is not specified, the dump is written to the dump.bin file.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
*
* @b Syntax
* @n <tt>dump-to-host [-d <devicenum>] [--host <hostname>] [-f <filename>]</tt>
* 
* @b Example
* @n The following example generates a dump from device 2, saves it to the “myfile” file,
* and transfers this file to the host:
* @n <tt>elxsdkutil dump-to-host -d 2 -f myfile</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_efdc efdc (EFD Capabilities)
* This command reports the EFD capabilities (firmware log settings) from the adapter.
*
* @b Note: This command is applicable to OCe11102 adapters only
*
* @b Syntax
* @n <tt>efdc [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Display the EFD capabilities of device 0:
* @n <tt>elxsdkutil efdc</tt>
* 
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_file_info file-info (File Information of UFI) 
* This command provides information for an Emulex unified firmware image (.UFI),
* including the file signature, the version, file length, and other information.
* 
* @b Syntax
* @n <tt>file-info -f <filename></tt>
* 
* @b Example
* @n Display the UFI file and image information for the myfile file:
* @n <tt>elxsdkutil file-info -f myfile</tt>
* 
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_gendump gendump (Generate Dump)
* This command instructs the adapter to generate a dump file. The dump file is stored on
* the adapter as the /dbg/dump.bin object. Once the dump file has been generated, it
* can be retrieved from the adapter using the dump command
* (@ref cmd_dump). Also see @ref cmd_dump_to_host.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
*
* @b Syntax
* @n <tt>gendump</tt>
* 
* @b Example
* @n Generate a dump:
* @n <tt>elxsdkutil gendump</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_help help
* This command displays a list of the elxsdkutil commands with several examples.
* To get the syntax and usage for a particular command, add the command name.
*
* @b Syntax
* @n <tt>help [<command>]</tt>
*
* @b Example
* @n List the usage information for connection-info:
* @n <tt>elxsdkutil help connection-info</tt>
*
* @b Output
* @n <tt>Command: connection-info [-d <devicenum>] [--host <hostname>]<br></tt>
* <tt>[--connection-handle <handle>]<br><br></tt>
* <tt>Usage: If a connection handle is provided, reports information on<br></tt>
* <tt>that connection. If no connection handle is provided, displays a<br></tt>
* <tt>list of open connections.</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_linkcfg_get linkcfg-get (Get Link Configuration)
* This command displays the link configuration. Also see @ref cmd_linkcfg_set.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
*
* @b Syntax
* @n <tt>linkcfg-get [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Display the link configuration on device 0:
* @n <tt>elxsdkutil linkcfg-get</tt>
*
* @b Output
* @n <tt>Link config: FC_2x16G</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_linkcfg_set linkcfg-set (Set Link Configuration)
* This command sets the Fibre Channel and Ethernet link configuration.
*
* The possible <link&nbsp;config> values are:
* <ul><li>FC_2x16G</li>
* <li>FC_4x1G</li>
* <li>FC_4x8G</li>
* <li>ETH_1x40G</li>
* <li>ETH_2x10G</li>
* <li>ETH_2x10G_FC_2x8G</li>
* <li>ETH_4x10G</li></ul>
* Also see @ref cmd_linkcfg_get.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
*
* @b Syntax
* @n <tt>linkcfg-set [-d device] [--host <hostname>] --linkcfg <link&nbsp;config></tt>
* 
* @b Example
* @n Set the link configuration on device 1 for two FC ports running at 16G each:
* @n <tt>elxsdkutil link-set -d 1 --linkcfg FC_2x16G</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_list list (List Adapters)
* This command displays a list of the Emulex adapters installed in the system. This
* includes the model number, number of ports, firmware version, and serial number.
* 
* @b Syntax
* @n <tt>list [--host <hostname>]</tt>
* 
* @b Example
* @n List the Emulex adapters that are installed in a system:
* @n <tt>elxsdkutil list</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_mgmt_info mgmt-info (Management Information)
* This command uses the management API (as described in @ref dev_mgmt)
* to retrieve all available status values, configuration
* values, and actions from the driver. For status, each property is displayed along with its
* current value. For actions, only the name of the action is displayed.
* 
* @b Syntax
* @n <tt>mgmt-info [-d <devicenum>] [--host <hostname>]</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_objenum objenum (Objects Enumerate)
* This command enumerates the device file system objects.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
* 
* @b Syntax
* @n <tt>objenum [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n List device file system objects on device 0:
* @n <tt>elxsdkutil objenum</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_read read (Read Object File)
* This command reads an object file from an adapter’s flash.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
* 
* @b Syntax
* @n <tt>read [objname] [-d <devicenum>] [-f <filename>] [--host <hostname>]</tt>
* 
* @b Example
* @n Read firmware dump file from device 0 into the “myfile” file:
* @n <tt>elxsdkutil read /dbg/dump.bin –d 0 –f myfile</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_read_link_status read-link-status (Read Link Status)
* This command reads the status of the link. Using the “--clof” option clears the overflow
* flags and the “--clrc” option clears all counters.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
* 
* @b Syntax
* @n <tt>read-link-status [-d <devicenum>] [--clof] [--clrc]</tt>
* 
* @b Example
* @n Read the status of the link for device 0:
* @n <tt>elxsdkutil read-link-status</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_read_rev read-rev (Read Adapter Version)
* This command reads the version of the adapter.
*
* @b Syntax
* @n <tt>read-rev [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Read the version of device 2:
* @n <tt>elxsdkutil read-rev -d 2</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_read_status read-status (Read Device Status)
* This command reads the status of the device. Using the “--cc” option clears the
* counters.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
* 
* @b Syntax
* @n <tt>read-status [-d <devicenum>] [--cc] [--host <hostname>]</tt>
* 
* @b Example
* @n Read the status of device 0:
* @n <tt>elxsdkutil read-status</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_remove_vport remove-vport (Remove Vport)
* This command removes a Vport. The WWNN and WWPN values are in a format of
* eight pairs of hexadecimal digits separated by colons (for example,
* 10:00:00:00:c9:01:02:03).
*
* If the WWNN and WWPN values were assigned by the SLI Port (for example, through
* @ref cmd_create_vport), these values can be found in
* /var/log/messages.
*
* @b Note: This command is applicable to LPe16000/LPe16002 HBAs only.
* 
* @b Syntax
* @n <tt>remove-vport <WWNN> <WWPN> [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Remove a Vport from device 0:
* @n <tt>elxsdkutil remove 20:00:00:00:c9:01:02:03 10:00:00:00:c9:01:02:03</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_set_mac set-mac (Set MAC Address)
* This command “soft” assigns a MAC address to a device. The MAC address is in a
* format of six pairs of hexadecimal digits separated colons, for example,
* 01:23:45:67:89:ab.
*
* @b Note: This command is applicable to iSCSI only.
* 
* @b Syntax
* @n <tt>set-mac ##:##:##:##:##:## [-d <devicenum>]</tt>
* 
* @b Example
* @n Assign a MAC address to device 0:
* @n <tt>elxsdkutil set-mac 00:00:C9:D5:6A:A3</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_sfp sfp (SFP EEPROM Data)
* This command retrieves the SFP serial EEPROM data. For OCe11102 adapters, the SFP
* pages A0 and A2 are returned. For LPe16000/LPe16002 HBAs, the SFP page A0 is
* returned.
*
* @b Syntax
* @n <tt>sfp [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Print hexadecimal diagnostic information from the transceiver (device 0):
* @n <tt>elxsdkutil sfp -d 0</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_show_ips show-ips (Show IPs)
* Show the IP addresses, in IPv4 or IPv6 format, that are assigned to an iSCSI adapter.
* The <ip&nbsp;version&nbsp;4/6> value is either 4 (IPv4) or 6 (IPv6). Also see
* @ref cmd_add_ip.
*
* @b Note: This command is applicable to iSCSI only.
* 
* @b Syntax
* @n <tt>show-ips <ip&nbsp;version&nbsp;4/6> [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n The following sequence first shows the current IPs in IPv4 format on device 2; adds an
* additional IP address; and then shows the IPs again:
* @n <tt>elxsdkutil show-ip 4 -d 2</tt>
* @n <tt>IP addresses on device 2:</tt>
* @n <tt>20.0.0.108 255.255.255.0</tt>
*
* <tt>elxsdkutil add-ip 20.0.0.120 255.255.255.0 -d 2</tt>
*
* <tt>elxsdkutil show-ips 4 -d 2</tt>
* @n <tt>IP addresses on device 2:</tt>
* @n <tt>20.0.0.108 255.255.255.0</tt>
* @n <tt>20.0.0.120 255.255.255.0</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_show_mac show-mac (Show MAC)
* This command displays the MAC address of a device.
*
* @b Note: This command is applicable to iSCSI only.
* 
* @b Syntax
* @n <tt>show-mac [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Display the MAC address of device 3:
* @n <tt>elxsdkutil show-mac -d 3</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_version version (Version of Program)
* This command prints the program version and exits.
*
* @b Syntax
* @n <tt>version [--host <hostname>]</tt>
* 
* @b Example
* @n Print the program version:
* @n <tt>elxsdkutil version</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* @subsection cmd_write write (Write Firmware Image)
* This command downloads firmware from a file to the adapter’s flash.
*
* @b Syntax
* @n <tt>write -f <filename> [-d <devicenum>] [--host <hostname>]</tt>
* 
* @b Example
* @n Write firmware image to device 0:
* @n <tt>elxsdkutil write -f myfile -d 0</tt>
*
* @ref commands_usage_list "Back to List of Commands"
*
*
*
* <br><br>
* </div>
*
*/