Syntax and Keywords, Command | Q-Logic 5602 specification

13 – Command Reference Syntax and Keywords

S

13.2

Syntax and Keywords

The Syntax paragraph defines the command syntax using the following convention:

command

keyword keyword [value] keyword [value1] [value2]

The Command is followed by one or more keywords. Consider the following rules and conventions:

Commands and keywords are case insensitive.

Required keyword values appear in standard font: [value]. Optional values

are shown in italics: [value].

Underlined portions of the keyword in the command format indicate the abbreviated form that can be used. For example, the delete keyword can be abbreviated del.

The Keywords paragraph lists and describes each keyword and any applicable values.

13.3

Notes and Examples

The Notes paragraph presents useful information about the command and its use, including special applications or effects on other commands. The Examples paragraph presents sample screen captures of the command and its output.

13-2	59183-01 A

Image 132

Q-Logic 5602 manual Syntax and Keywords, Command

Contents

Firmware Version Document Revision History Table of Contents Section Port Configuration Section Zoning Configuration Connection Security Configuration Section Device Security ConfigurationRadius Server Configuration Add Members to an Alias Remove Members from an Alias Event Log Configuration Simple Network Management Protocol ConfigurationCommand Reference Section 59183-01 a Index List of Tables Introduction Switch Models and Examples Intended AudienceRelated Materials New in This Release Technical Support AvailabilityTraining Contact Information Support Headquarters Introduction Technical Support 59183-01 a Command Line Interface Usage This section describes the following tasks Logging In to the Switch To log off, enter the Exit command Opening and Closing an Admin Session Entering CommandsCommand-Line Completion Setting Page Breaks Getting Help Creating a Support File Local directory now /itasca/conf/images bin Ftp Downloading and Uploading Files Userimages password images User Account Configuration Factory User Accounts Displaying User Account Information Creating User Accounts Modifying User Accounts and Passwords Following example deletes the user account named user3 Network and Fabric Configuration Displaying Name Server Information Displaying the Ethernet Network Configuration WWN Configuring the Ethernet Port Verifying a Switch in the Network Verifying and Tracing Fibre Channel ConnectionsFollowing is an example of a connection failure Port Displaying Switch Information Switch configuration consists of the following tasks Switch Operational Information System Process Information PID Ppid CPU Time Elapsed Time Between Resets Configuration Information Switch Configuration Parameters Zoning Configuration Parameters Security Configuration Parameters Hardware Information Heartbeat LED Activity Firmware Information Managing Switch Services Please Note Managing Switch Configurations Display a List of Switch ConfigurationsActivate a Switch Configuration Copy a Switch Configuration Delete a Switch ConfigurationModify a Switch Configuration Decimal value, 100-100000 msec Back Up and Restore a Switch Configuration Creating the Backup File Downloading the Configuration File Restoring the Configuration File Ftp ipaddress user images password images ftp bin Paging a Switch Setting the Date and Time Switch Configuration Setting the Date and Time List Resetting a Switch Installing FirmwareSwitch Reset Methods One-Step Firmware Installation Nondisruptive Activation Enter the password for your account name FTP only Custom Firmware Installation Wait for the unpack to complete Managing Switch Feature Upgrades Display Feature Licenses Install a Feature License Key Page Displaying Port Information This section describes the following topicsYou can display the following port information Port Configuration Parameters Arbff Port Operational Information PL-XPL-VC-SG3-22 Port Threshold Alarm Configuration Parameters Port Performance Transceiver Information FTRJ8524P2BNL Modifying Port Operating Characteristics Set config port Port Binding Resetting a Port SANbox admin-config # set config security port Configuring Port Threshold Alarms SANbox admin-config # set config threshold Testing a Port Online Tests for Ports Offline Tests for Ports Cancel a Port Test Display Port Test Results Extending Port Transmission Distance Current value SANbox # show donor Port Config Zoning Configuration Configured Zone Set Information Displaying Zoning Database Information SANbox # zoning list Active ZoneSet Information Active Zone Set Information Zone Set Membership Information Zone Membership Information Alias and Alias Membership Information Zoning Modification History Zoning Database Limits E2JBOD2 Configuring the Zoning Database SANbox # admin start SANbox admin # config edit Modifying the Zoning Database Resetting the Zoning Database Removing Inactive Zone Sets, Zones, and Aliases Managing Zone Sets Create a Zone SetDelete a Zone Set Managing Zone Sets consists of the following tasks Rename a Zone Set Copy a Zone SetAdd Zones to a Zone Set Remove Zones from a Zone Set Deactivate a Zone Set Managing ZonesCreate a Zone Delete a Zone Rename a Zone Copy a ZoneAdd Members to a Zone Remove Members from a Zone Managing Aliases Create an AliasDelete an Alias Rename an Alias Copy an Alias Add Members to an AliasRemove Members from an Alias Connection Security Configuration Managing SSL and SSH Services TelnetEnabled True / False SSHEnabled Displaying SSL and SSH Services Creating an SSL Security CertificatePage Device Security Configuration Configured Security Set Information Displaying Security Database Information MD5 Active Security Set Information Security Set Membership Information Group Membership Information Security Database Modification History Security Database Limits Configuring the Security Database Set Config Security command Before Reaching the end of the list Resetting the Security Database Modifying the Security Database Managing Security Sets Create a Security SetDelete a Security Set Rename a Security Set Add Groups to a Security Set Remove Groups from a Security SetActivate a Security Set Deactivate a Security Set Managing Groups Create a GroupDelete a Group Rename a Group Copy a Group Add Members to a Group Modify a Group Member Remove Members from a Group Radius Server Configuration Displaying Radius Server Information Configuring a Radius Server on the Switch Page Event Log Configuration Starting and Stopping Event Logging Displaying the Event Log Filtering the Event Log Display Controlling Messages in the Output Stream Managing the Event Log Configuration Configure the Event Log Display the Event Log Configuration Restore the Event Log ConfigurationClearing the Event Log Logging to a Remote Host Creating and Downloading a Log File Page Managing the Snmp Service You control the Snmp service SNMPEnabled parameters through 12-2 59183-01 a Displaying Snmp Information Modifying the Snmp Configuration Resetting the Snmp Configuration SANbox admin # reset snmpPage Command Reference Access Authority Command Syntax and Keywords Command Listing Commands are listed in alphabetical order as follows Admin AuthoritySyntax Keywords Alias Syntax aliasKeywords add alias memberlist Copy aliassource aliasdestination Delete alias ListMembers alias Remove alias memberlist Config Syntax configKeywords activate configname Edit configname RestoreSave configname 59183-01 a 13-9 Create Keywords certificateSupport 59183-01 a 13-11 Following is an example of the Create Certificate command SANbox admin # create support Date Syntax dateKeywords MMDDhhmmCCYY Exit Authority None Syntax exitCloses the Telnet session Fcping Authority NoneKeywords address Fctrace PortdestinationHopcount Examples The following is an example of the Fctrace command Feature Syntax featureAdd licensekey log Keywords add licensekey Following is an example of the Feature Log command Firmware Install Syntax firmware install 59183-01 a 13-21 Group Syntax group Keywords add group ISL Group Member Attributes Port Group Member Attributes Configures security for attachments to other switches MS Group Member AttributesCopy groupsource groupdestination Create group type Edit group member Group Member Attributes Members group Remove group memberlistRename groupold groupnew Securitysets group Following is an example of the Group Edit command Following is an example of the Group List command Following is an example of the Group Members command Hardreset Syntax hardreset Help command keyword CommandHelp Keyword Re-execute selected commands Following is an example of the History commandHistory History Hotreset Hotreset Keywords cleanup ImageSyntax image Unpack file 13-36 59183-01 a Following is an example of the Lip command LipReinitializes the specified loop port Lip portnumber Logout Authority None Syntax logout Passwd Syntax passwd accountname Keywords accountname Ping Ping ipaddressIpaddress Examples The following is an example of the Ps command Authority None Syntax psDisplays current system process information Quit Authority None Syntax quit Reset Syntax resetKeywords config configname Services FactoryPort portlist Radius Switch Workstation could lose communication with the switchSystem Zoning Switch Configuration Defaults Values Port Configuration Defaults Parameter 4-Gbps Port Defaults Port Threshold Alarm Configuration Defaults Zoning Configuration Defaults Snmp Configuration Defaults 10. Radius Configuration Defaults 11. Services Configuration Defaults 12. System Configuration Defaults 13. Security Configuration Defaults Security Keywords activeClear Edit LimitsSave Following is an example of the Security History command Following is an example of the Security Limits command Following is an example of the Security List command Securityset Syntax securitysetKeywords activate securityset Active Copy securitysetsource securitysetdestination Create securitysetDeactivate Delete securityset Following is an example of the Securityset Groups command Following is an example of the Securityset List command Set Alarm Syntax set alarm optionKeywords option Option can be one of the following Set Beacon Set beacon stateState Set Config Port 14. Port Configuration ParametersKeywords port portnumber Ports portnumber Send Arbff True instead of IDLEs False on the loop 14. Port Configuration Parameters 14. Port Configuration Parameters 59183-01 a 13-65 13-66 59183-01 a Set Config Security Syntax set config security15. Security Configuration Parameters 13-68 59183-01 a Set Config Security Portbinding 16. Port Binding Configuration Parameters Set Config Switch Syntax set config switch17. Switch Configuration Parameters Resource Allocation Timeout Value. The number of millisec Set Config Threshold Syntax set config threshold18. Port Alarm Threshold Parameters Error rate has fallen below the falling trigger Following is an example of the Set Config Threshold command Set Config Zoning Syntax set config zoning19. Zoning Configuration Parameters 59183-01 a 13-75 Set Log Set logArchive Component filterlist Display filter Disables monitoring on all ports Level filterMonitors none of the severity levels Specifies all ports Alarms are always logged and always displayed on the screen StartStop Stops logging of events Set Pagebreak Keywords stateSyntax pagebreak state 59183-01 a 13-81 Enable Set PortSet port clear Set port portnumber Speed transmissionspeed State state Set Setup Radius Configures Radius servers on the switchSet setup radius Configuration fields 20. Radius Service Settings 13-86 59183-01 a Set Setup Services Configures services on the switchSyntax set setup services 21. Switch Services Settings 21. Switch Services Settings 59183-01 a 13-89 Set Setup Snmp Configures Snmp on the switchSyntax set setup snmp 22. Snmp Configuration Settings 22. Snmp Configuration Settings 13-92 59183-01 a Set Setup System Syntax set setup system23. System Configuration Settings 13-94 59183-01 a Set Switch State Admin sessionSet switch state state State can be one of the following Set Timezone Set timezone Show About Authority None SyntaxShow about Show Alarm Show alarmSettings Following is an example of the Show Alarm command Show Broadcast Syntax show broadcast Displays chassis component status and temperature Show ChassisShow chassis Show Config Port Displays configuration parameters for one or more portsShow config port portnumber Portnumber 13-102 59183-01 a Show Config Security Displays the security database configuration parametersSyntax show config security Show Config Security Portbinding Show config security portbinding portnumber Show Config Switch Displays the switch configuration parametersSyntax show config switch Show Config Threshold Displays alarm threshold parameters for the switchSyntax show config threshold Show Config Zoning Displays zoning configuration parameters for the switchSyntax show config zoning Show Domains Syntax show domains Show Donor Show donor Show Fabric Show fabric Show Fdmi Show fdmi portwwnPortwwn Question marks ? Following is an example of the Show Fdmi WWN command Show Interface Displays the status of the active network interfacesSyntax show interface Show Log Show logNumberofevents Component Level Options Settings Following is an example of the Show Log Level commandFollowing is an example of the Show Log Options command Port Show Lsdb Displays Link State database informationShow lsdb Installed Show MediaShow media Portlist 25. Transceiver Information 13-120 59183-01 a 59183-01 a 13-121 Following is an example of the Show Mem command Show MemDisplays information about memory activity Show mem count Show NS Show ns optionOption Following is an example of the Show NS portID command Displays the current pagebreak setting Show PagebreakSyntax show pagebreak Show Perf Syntax show perf portlistKeywords portlist Byte portlist Errors portlist Outbyte portlistFrame portlist Inframe portlist Following is an example of the Show Perf Byte command Show Port Show port26. Show Port Parameters Lipalpdalps LIPF7F7 26. Show Port Parameters 59183-01 a 13-133 Show Post Log Syntax show post log Show Setup Mfg Displays manufacturing information about the switchSyntax show setup mfg Show Setup Radius Syntax show setup radiusDisplays Radius server information Show Setup Services Displays switch service status informationSyntax show setup services Show Setup Snmp Displays the current Snmp settingsSyntax show setup snmp Following is an example of the Show Setup Snmp command Show Setup System Displays the current system settingsSyntax show setup system Show Steering Show steering domainidDomainid Show Switch Displays switch operational informationShow switch 27. Switch Operational Parameters 13-142 59183-01 a Displays the current time zone setting Show TimezoneSyntax show timezone Show Topology Displays all connected devicesSyntax show topology 59183-01 a 13-145 Show Users Show users Show Version Shutdown Syntax shutdown Test Cancel Test cancelPort portnumber Test Port Syntax test port portnumberOffline loopbacktype Online 28. Port Test Parameters 13-152 59183-01 a Test Status Test status Examples The following is an example of the Uptime command UptimeAuthority None Syntax uptime User Syntax userKeywords accounts Add Following is an example of the User Add command Following is an example of the User Edit command Following is an example of the User Delete command Following is an example of the User List command Examples The following is an example of the Whoami command WhoamiAuthority None Syntax whoami Zone Syntax zoneKeywords add zone memberlist Copy zonesource zonedestination Delete zone Members zoneRemove zone memberlist Rename zoneold zonenew Following is an example of the Zone Members command Following is an example of the Zone Zonesets command Zoneset Syntax zoneset Delete zoneset Remove zoneset zonelistRename zonesetold zonesetnew Zones zoneset Following is an example of the Zoneset List command Following is an example of the Zoneset Zones command Zoning Syntax zoningDelete orphans Opens a Zoning Edit session 29. Zoning Database Limits 13-168 59183-01 a Following is an example of the Zoning Limits command Following is an example of the Zoning List command Index Index-2 59183-01 a Example FTP See File Transfer Protocol Index-4 59183-01 a 59183-01 a Index-5 Index-6 59183-01 a Set Config Security Port command Show Config Security Port command 59183-01 a Index-9 Index-10 59183-01 a 59183-01 a Index-11