background image

FCA Utilities Reference Manual

Page 8

reset_link <wwpn,0> - Resets the link of a specified FC device.
reset_hard - Reset the HBA.
reset_hard_core - Reset the HBA firmware core.
diag <test> - Perform a diagnostic test on the HBA.
ns - Performs a complete query of the fabric name server.
parm_get_num - Returns the total number of configurable parameters.
parm_get_list - Returns a list of configurable parameters.
parm_get <label> - Gets the value of a specified parameter in the driver.
parm_set <label> <val> - Sets the value of a specified parameter in the driver.
msgbuf all or <number> [-i interval] - Returns the driver's internal message log.
get_host_attrs - Returns the host adapter and port attributes.
get_port_attrs <index>, <wwn> or all - Returns the port attributes.
get_path <index> - Returns the adapter path.
q - Exits this program.
h - Returns this help screen.
hba - Select another hba.
p - Repeat previous command.
emlxadm>

At the bottom of the command list is an 

emlxadm>

 prompt. From this point, the utility is prompt driven. 

When the prompt is displayed, you must enter one of the commands in the list. The list is displayed 
automatically only once, but you can display it again by entering 

h

 at the prompt. To exit the program, 

enter 

q

.

Some commands require additional arguments, such as a Fibre Channel World Wide Port Name 
(WWPN) or a Fibre Channel port address (D_ID). To display the available arguments for a command, 
enter the command without any arguments.

For example, the command 

get_state

 requires a WWPN for the target device. If only the command 

without the argument is entered, the following statement appears to indicate that the command requires 
an argument to be executed. For example:

emlxadm> get_state

Usage: get_state <wwpn>

emlxadm> get_state 21000020371938fa

State: PORT_DEVICE_LOGGED_IN

For a detailed explanation of each command and its arguments, see 

Command Descriptions (emlxadm)

 on 

page 8.

CLI Mode (emlxadm)

The emlxadm utility program can be run in CLI mode by typing the name of the program, followed by the 
full device name of the desired HBA, followed by a valid command and any required command 
arguments. For example:

# emlxadm /devices/pci@1e,600000/SUNW,emlxs@2/fp@0,0:devctl get_state 
21000020371938fa

State: PORT_DEVICE_LOGGED_IN

#

This mode of operation enables you to use the emlxadm utility as part of a script or another program 
capable of executing system level calls. For a detailed explanation of each command and its arguments, 
see 

Command Descriptions (emlxadm)

 on page 8.

Command Descriptions (

emlxadm)

This section provides a list of commands that can be issued with the emlxadm utility program.

Summary of Contents for elmxdrv

Page 1: ...FCA Utilities Reference Manual Version 1 00m for use with the Emulex Sun LightPulse Fibre Channel Adapter Driver emlxs...

Page 2: ...FibreSpy HBAnyware InSpeed MultiPulse SLI and SBOD are trademarks of Emulex Corporation All other brand or product names referenced herein are trademarks or registered trademarks of their respective c...

Page 3: ...get_dev_list 9 get_logi_params wwpn 9 get_host_params 11 get_sym_pname 11 set_sym_pname string 11 get_sym_nname 11 set_sym_nname string 11 dev_login wwpn 12 dev_logout 12 get_state wwpn 12 dev_remove...

Page 4: ...26 Modes of Operation emlxdrv 26 Interactive Mode emlxdrv 26 CLI Mode emlxdrv 27 Command Descriptions emlxdrv 28 set_emlxs alias 28 set_emlxs_sun 28 set_emlxs_all 28 set_lpfc alias 29 set_lpfc_nonsun...

Page 5: ...e are referring to the particular SCSI properties within FCP or to the original SCSI protocol For networking Fibre Channel provides an encapsulation of IP Internet Protocol referred to in this documen...

Page 6: ...Software Stack 6eea XVi dc 6eea XVi dc ZgcZa ZgcZa I8E E BdYjaZ 9AE BdYjaZ HdaVg h HigZVbh HiVX HE6G8 hidgV Z H8H Yg kZg hhY 8 E JAE 9g kZg 8E JAE 9g kZg 8 IgVchedgi AVnZg 8IA 9g kZg 8 Edgi E 9g kZg...

Page 7: ...rred to here as directory The utilities kit is a tar file named something similar to emlxu_kit 1 00x sparc tar 3 Change to the directory where you put the kit tar file by typing cd directory 4 Extract...

Page 8: ...ove script If you do not have the emlxu_remove script and you do not have the original emlxu utilities kit tar file you must uninstall the emlxu package manually follow the instructions in Removing th...

Page 9: ...by typing tar xvf emlxu_kit 1 00x sparc tar 5 install the EMLXemlxu utilities package by typing pkgadd d EMLXemlxu 6 The package is prepared for installation and you are prompted to confirm the insta...

Page 10: ...uccessful The utilities package has been removed For additional information on installing and removing packages see the Solaris system administration documentation and the pkgadd 1M and pkgrm 1M manua...

Page 11: ...ailable HBAs in the list by entering the appropriate number In this example if you enter 2 the utility displays the HBA device name selected and presents a list of command options HBA devices pci 1e 6...

Page 12: ...ter q Some commands require additional arguments such as a Fibre Channel World Wide Port Name WWPN or a Fibre Channel port address D_ID To display the available arguments for a command enter the comma...

Page 13: ...0371938fa Device 1 Dtype 0 FC4_type proto 0x0100 0 0 0 0 0 0 0 State PORT_DEVICE_LOGGED_IN D_id 113e2 LILP 0 Hard Addr e2 WWPN 21000020371939a2 WWNN 20000020371939a2 Device 2 Dtype 0 FC4_type proto 0x...

Page 14: ...2 00 00 01 f4 21 00 00 20 37 19 38 fa 20 00 00 20 37 19 38 fa 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 80 00 00 00 00 00 08 00 00 ff 00 00 00 01...

Page 15: ...sym_pname string Sets the symbolic FC port name of the HBA to the string provided This operation is currently not supported by the Solaris Leadville stack Example emlxadm set_sym_pname Emulex Corporat...

Page 16: ...PORT_DEVICE_LOGGED_IN dev_remove wwpn Removes the specified FC device from Leadville management link_status d_id Requests and returns the current link error status from the FC device specified by the...

Page 17: ...ple emlxadm download_fw LP10000DC S fw Image Components NOP type AWC file KERN version ff801315 1 30a5 DWC file SLI2 version 07831914 1 90a4 DWC prog TEST version 00f51010 1 00a0 DWC prog STUB version...

Page 18: ...e dump buffer Example emlxadm force_dump Done get_dump t filename txt or b filename bin Returns a copy of the HBA s firmware core dump buffer to the specified file in the specified text t or binary b...

Page 19: ...e7 e8 e9 ea eb ec ed ee ef 000000f0 f0 f1 f2 f3 f4 f5 f6 f7 f8 f9 fa fb fc fd fe ff 00000100 get_topology Returns the FC network topology of the HBA port Example emlxadm get_topology Topology PRIVATE_...

Page 20: ...16 0x10 ns Performs and returns a complete query of the fabric name server Example emlxadm ns Nameserver TYPE 02 PID 0113E1 WWPN 21000020371938fa PORT_NAME SEAGATE ST39103FC 0004 WWNN 20000020371938fa...

Page 21: ...0 00000000 00000000 00000000 00000000 00000000 00000000 00000000 parm_get_num Returns the total number of configurable parameters Example emlxadm parm_get_num Result There are 18 configurable paramete...

Page 22: ...g errors min 0x0 current 0xffffffff max 0xffffffff default 0xffffffff dynamic yes desc Verbose mask for error messages to the messages file label num iocbs min 128 current 1024 max 10240 default 1024...

Page 23: ...an interrupt response is generated label cr count min 1 current 1 max 255 default 1 dynamic no desc A count of I O completions after which an interrupt response is generated label assign alpa min 0x0...

Page 24: ...nterval seconds if desired To stop the program from updating the screen press Ctrl C to break If no interval is provided the current message log is displayed with no additional updates and the emlxadm...

Page 25: ...0 Port Type Nport Port State Online Port Supported COS Class 3 Port Supported Fc4 Types 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Port Active Fc4...

Page 26: ...00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Port Active Fc4 Types 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00...

Page 27: ...rt Supported COS Unknown Port Supported Fc4 Types 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Port Active Fc4 Types 00 00 01 20 00 00 00 00 00 00 00...

Page 28: ...a device dev_login wwpn Performs an FC login to a device dev_logout wwpn Performs an FC logout to a device get_state wwpn Returns current Leadville state of a specified device dev_remove wwpn Remove...

Page 29: ...revious command hba Allows you to select another HBA to interface with This prevents you from having to exit and reenter the program Example emlxadm hba Available HBA s 1 devices pci 1e 600000 SUNW ql...

Page 30: ...e consisting of bindings associations between the emlxs and lpfc drivers and a list of Emulex Fibre Channel HBA models After the table is prepared the utility displays the following EMLXDRV Driver Man...

Page 31: ...pecific adapter alias and not with a specific adapter model After the driver configuration table is a list of available commands For a detailed explanation of each command and its arguments see Comman...

Page 32: ...ly with an adapter alias and not with a specific adapter model You may see the message Cannot unload module This indicates that you must reboot the system to get a driver to unbind from that adapter a...

Page 33: ...Cannot unload module This indicates that you must reboot the system to get a driver to unbind from that adapter alias emlxdrv only updates the system configuration for the next boot Example emlxdrv s...

Page 34: ...iguration for the next boot Example emlxdrv clear_emlxs Cannot unload module emlxs Will be unloaded upon reboot Updating fc00 Cannot unload module emlxs Will be unloaded upon reboot Done clear_sun Cle...

Page 35: ...annot unload module This indicates that you must reboot the system to get a driver to unbind from that adapter alias emlxdrv only updates the system configuration for the next boot Example emlxadm cle...

Page 36: ...Done q Exits the program If changes were made to the driver bindings a system reboot is usually required in order for all the changes to take effect Example emlxdrv q Exiting NOTE If changes were mad...

Reviews: