Example Help Commands | Dell Command Line Interface guide

omhelp: Getting Help With CLI Commands

The omhelp command and its equivalent, <command> -?, accesses the CLI's detailed help text interface. You can get help at several levels of detail.

Each fully qualified CLI command may have a variable number of distinct parts: the command (command level 1), one or more subcommands (command level 2 and command level 3, if present), and one or more name=value pair(s).

By appending -?(space-dash-question mark) to any command, you can get help on the command.

Example Help Commands

When you type omconfig -?, you get general help about the omconfig command. The help at this level lists the available subcommands for omconfig:

•about

•preferences

•chassis

•system

When you type omconfig system -?, CLI help lists all of the subcommands that are available for omconfig system:

•alertaction

•alertlog

•assetinfo

•cmdlog

•esmlog

•events

•recovery

•shutdown

•thrmshutdown

•webserver

Figure 2-1 shows the levels of help for a command.

omhelp: Getting Help With CLI Commands

19

Image 19

Dell Command Line Interface manual Example Help Commands, About Preferences Chassis System

Contents

W . d e l l . c o m s u p p o r t . d e l l . c o m Command Line Interface Users Guide December Contents Omreport chassis temps Omreport chassis volts Omreport chassis fru Omreport chassis infoOmreport chassis leds Omreport chassis nics Omreport chassis ports User Level Required for Adding Asset Information 101 101 Example Command for Adding Outsource Information 107 Example Commands for Adding Depreciation Information 103Example Command for Adding Lease Information 105 Example Command for Adding Maintenance Information 106 123 117119 121 135 131132 133 148 Omconfig Reset Controller Configuration 149Omconfig Set Check Consistency Rate 155 Omconfig Reconfiguring Virtual Disks 166 168 Omconfig Prepare to Remove Physical Disk 170Omconfig Unassign Global Hot Spare 173 Omconfig Cancel Rebuild Physical Disk 174 187 Selecting a Format for Your CLI Command Output 189 Contents Introduction Whats New for Version Primary CLI Commands Using CLI Commands from Windows Command PromptsOmconfig Omhelp Omreport Success Messages CLI Error Checking and Error MessagesWorking With CLI Command Results Glossary Instrumentation Service Controller Components Failure Messages Scripting and Comparing With the CLI Command Syntax Overview An example of nine name=value pairs About Preferences Chassis System Example Help Commands Optional Parameters Info Value Different Levels of Help for a Command Conventions for Parameter Tables Omreport Command Summary Date last updated Omreport Command Level 1, Level 2, and LevelCommand User Level Privilege Required Omreport About Server Administrator program Pwrsupplies Shows properties of power supplies Remoteaccess Command User Level Privilege Required FrontpanelSystem, are enabled or disabled Connector type, and maximum speed Alertlog Command User Level Privilege Required AlertactionRecovery Failure state Omreport about Help With the omreport Command Omreport chassis acswitch Omreport chassis CommandsOmreport chassis Omreport chassis biossetup Omreport chassis biosOmreport chassis batteries Or disabled Bios Setup Parameters Description BezelReboot is enabled or disabled Console Redirection After Boot RAID device or a Scsi device Bios Setup Parameters Description RAID Channel aRAID mode, or is disabled Omreport chassis bmc Omreport chassis fans Omreport chassis currentsOmreport chassis fancontrol Omreport chassis info Omreport chassis firmwareOmreport chassis frontpanel Omreport chassis fru 8RLNB1S Omreport chassis intrusion Omreport chassis memory Omreport chassis leds Omreport chassis ports Omreport chassis nics Capabilities and Cache Properties for a Specific Processor Omreport chassis processors Fields Reported for Each Cache on a Particular Processor Omreport chassis pwrsupplies Omreport chassis remoteaccess Omreport chassis temps Omreport chassis slotsNetwork LAN connection Omreport system Omreport system CommandsCommands for Viewing Logs Omreport chassis volts ESM Log Overall Health Status Omreport system alertactionComponents and Events for Which You Can View Alert Actions Omreport system events Omreport system assetinfoPage Destination Example Command for Event TypeOmreport system operatingsystem Omreport system pedestinations Omreport system summary Omreport system recoveryOmreport system platformevents Omreport system shutdown Example Command Output Processor Name Product ID Name Version Network Interface CardMemory Array Omreport system version Omreport system thrmshutdownPage Page Omconfig Command Summary Reported in custom delimited format cdv Administrator or notDepreciation, lease, maintenance, service Cdvformat Default or by value Enables and disables platform events filterOptions when shutting down the system By default or by value Help With the omconfig Command Omconfig about Omconfig chassis biossetup Omconfig chassis Rad Maps external serial connector to remote Onpxenic1 PXE is enabled on NICOnpxenic2 PXE is enabled on NIC Attribute=extserial Setting=com1 com2 rad Attribute=nic2 Setting=enabled disabled Attribute=intrusion Setting=enable disableBoot. If the system also has bezel intrusion Disable Disables the intrusion check during Raid Sets the onboard Sata controller to RAID On Enable this deviceOff Disable this device Scsi device On Enables the user-accessible USB ports Enabledwithbios disabled Boot, without Bios support Omconfig chassis bmcFor configuring the USB ports Attribute=usbb Setting=enabled Charsendthreshold=number InstalledConfiguration protocol 5 millisecond intervals Be accepted on a LAN channel to User AdministratorOption to share the BMC management traffic Between them Per second Supported on PowerEdge x9xx systemsSystems that have a Drac 5 installed 115200 Second Omconfig chassis bmc Name=value pair Systems Channel, to AdministratorTo Operator Lineediting=enabled disabled Ready to accept another commandCharacter sequence that indicates when its Command Port channel Serial Port channelChannel Guest testalert custom none Config= Config=user Id=user id Valid Parameters for Current Warning Thresholds Omconfig chassis currentsAccessconsoleredir= true false Accessvirtualmedia= true false Specify a Value for Minimum and Maximum Warning Thresholds Omconfig chassis fansDefault Minimum and Maximum Warning Thresholds Valid Parameters for Fan Warning Thresholds Omconfig chassis frontpanel Omconfig chassis fancontrol Cannot exceed 10 characters Omconfig chassis infoOmconfig chassis info Name=value pair Description Index=n Tag=text When a critical event occurs Omconfig chassis ledsOmconfig chassis memorymode Led=fault Severity=warning critical Main system chassis Omconfig chassis remoteaccess From the baseboard serial controller into Packet that contains this numberCharacters as soon as this number Characters or greater has been accepted Subnet=Subnet Subnet Sets a subnet mask if you have To AdministratorStatic Static if the IP address of the BMC That can be accepted on a LAN channel 115200 Per second Sets connection speed to 9600 bitsTo send Modem 12. omconfig chassis remoteaccess Name=value pairTo User That can be accepted on a serial over LAN 115200Channel, to Operator Input buffer is ready to accept Enabled Directs the BMC to output aAnother command When the BMC writes a new line to Not have access privileges for Access privileges of a User forFor the Serial Port channel For the LAN channel Access privileges of an Operator forLanaccesslevel=user User with an ID has Dracusergroup=none Does not enable Accessconsoleredir= true Omconfig chassis tempsValid Parameters for Temperature Warning Thresholds Configuration of users Specify a Value for Minimum and Maximum Warning Thresholds Omconfig chassis voltsValid Parameters for Voltage Warning Thresholds Omconfig preferences cdvformat Omconfig preferencesOmconfig preferences dirservice Server Administrator, it is omsa Omconfig preferences snmpPresent, you can only login to the local machine accounts Omconfig preferences useraccess Administrators Omconfig systemOmconfig system alertaction Syntax for Setting Alert Actions Components and Events for Which You Can Set Alert Actions Available Alert Actions Example Set Alert Action Commands Has been set Commands for Clearing LogsOmconfig system pedestinations False Disables an individual platform event filter Omconfig system platformevents Event=powerfail Event=powerwarnEvent=powerabsent That the power supply is absent Type=battery Configures events for battery Type=all Omconfig system eventsSource Type Severity Index Omconfig system webserver Omconfig system shutdown Omconfig system recoveryExample Recovery Commands Example Shutdown Commands Omconfig system thrmshutdown Omconfig system thrmshutdown severity=disabled Example Thermal Shutdown Commands 100 User Level Required for Adding Asset Information Omconfig System Asset Info OverviewOmconfig system assetinfo info=acquisition Adding Acquisition Information 102 Example Commands for Adding Acquisition Information Adding Depreciation Information Example Commands for Adding Depreciation Information103 Extended warranty service Adding Extended Warranty InformationExample Command for Adding Extended Warranty Information Omconfig system assetinfo info=extwarranty Adding Lease Information Example Command for Adding Lease Information105 106 Adding Maintenance InformationExample Command for Adding Maintenance Information Omconfig system assetinfo info=maintenance Adding Outsource Information Example Command for Adding Outsource Information107 Adding Owner Information Example Command for Adding Owner Information108 Example Command for Adding Service Information Adding Service Contract Information109 Adding Support Information Example Command for Adding Support Information110 Adding System Information Example Command for Adding System Information10. omconfig system assetinfo info=system Command Command Name=value name=value pair Example Command for Adding Warranty Information Adding Warranty Information112 113 Omreport rac Command Summary Omreport rac authentication Help With the omreport rac Command114 115 Example Command for omreport rac authenticationOmreport rac dialinusers Omreport rac dialoutusers Omreport rac snmptraps Omreport rac networkOmreport rac modem Omreport rac remote 117 Omreport rac viewcertificate 118 119 Omconfig rac Command Summary 120 Omconfig rac Managing the Remote Access Controller 121 Help With the omconfig rac CommandOmconfig rac authentication Local Operating System Authentication Example Command for omconfig rac authentication Omconfig rac dialinusers122 Example Commands Omconfig rac dialoutusers123 124 Omconfig rac generatecert 125 Omconfig rac modem 126 Example Command Omconfig rac network127 128 Omconfig rac snmptraps User name is specified, an index must be specified Omconfig rac remoteOmconfig rac rmdialinuser 129 130 Omconfig rac rmdialoutuser Specified, an index must be specified Omconfig rac rmsnmptrapOmconfig rac rmuser 131 132 Omconfig rac resetOmconfig rac uploadcert Omconfig rac users 133 134 135 CLI Command Syntax 136 Omreport Command User Privileges for omreport storage and omconfig storage137 Omreport Controller Status Omreport Storage Help138 139 Omreport Battery StatusOmreport Connector Status Omreport Global Information Smart Thermal Shutdown Status Omreport Enclosure Status Omreport Temperature Probe Status140 141 Omreport Fan Status Omreport EMM Status Omreport Power Supply Status142 143 13. omreport Physical Disk CommandsPdisk=connectorID targetID ConnectorID enclosureID slotID Omreport Physical Disk Status Complete Syntax Omconfig Global CommandsOmconfig Global Enable Smart Thermal Shutdown Omreport Virtual Disk Status 145 Omconfig Global Disable Smart Thermal ShutdownOmconfig Global Rescan Controller Example Syntax 146 Omconfig Controller Commands 147 Omconfig Rescan Controller 148 Omconfig Enable Controller AlarmOmconfig Disable Controller Alarm Omconfig Quiet Controller Alarm Omconfig Reset Controller Configuration Omconfig Test Controller Alarm149 Pdisk=connectortargetID Omconfig Create Virtual Disk150 151 Controller=id Parameter RequiredRaid=c r0 r1 r1c r5 r10 r50 Parameter Required Size=number max min Parameter Required 152 PDISKID=connectorenclosureIDportID connectortargetIDCachepolicy=d c Parameter Optional Readpolicy=ra nra ara rc nrc Parameter Optional 153 Writepolicy=wb wt wc nwc Parameter OptionalName=string Parameter Optional Spanlength=n Parameter Required for RAID 154 Omconfig Set Controller Rebuild RateOmconfig Set Background Initialization Rate Read-ahead Write-through caching Cache I/O 155 Omconfig Set Reconstruct RateOmconfig Set Check Consistency Rate Omconfig Export the Controller Log Omconfig Import/Recover Foreign Configuration Omconfig Import Foreign Configuration156 157 Omconfig Clear Foreign ConfigurationOmconfig Set Patrol Read Mode Omconfig Start Patrol Read Omconfig Stop Patrol Read Omconfig Virtual Disk Commands158 Omconfig Unblink Virtual Disk Omconfig Blink Virtual Disk159 160 Omconfig Initialize Virtual DiskOmconfig Cancel Initialize Virtual Disk Omconfig Fast Initialize Virtual Disk Omconfig Cancel Background Initialize Omconfig Slow Initialize Virtualize Disk161 162 Omconfig Restore Dead SegmentsOmconfig Split Mirror Omconfig Unmirror Example for SAS Controllers Omconfig Assign Dedicated Hot Spare163 Example for SCSI, SATA, and ATA Controllers Omconfig Check Consistency Omconfig Unassign Dedicated Hot Spare164 165 Omconfig Cancel Check ConsistencyOmconfig Pause Check Consistency Omconfig Resume Check Consistency 166 Omconfig Delete Virtual DiskOmconfig Format Virtual Disk Omconfig Reconfiguring Virtual Disks Omconfig Rename Virtual Disk Omconfig Change Virtual Disk Policy167 Omconfig Blink Physical Disk Omconfig Physical Disk Commands168 169 Omconfig Unblink Physical Disk Omconfig Initialize Physical Disk Omconfig Prepare to Remove Physical Disk170 171 Omconfig Offline Physical Disk Omconfig Assign Global Hot Spare Omconfig Online Physical Disk172 173 Omconfig Unassign Global Hot Spare Omconfig Cancel Rebuild Physical Disk Omconfig Rebuild Physical Disk174 Omconfig Clear Physical Disk Omconfig Remove Dead Segments175 176 Omconfig Cancel Clear Physical Disk 177 Omconfig Battery CommandsOmconfig Recondition Battery Omconfig Start Battery Learn Cycle 178 Omconfig Connector CommandsOmconfig Delay Battery Learn Cycle Omconfig Rescan Connector 179 Omconfig Enclosure Commands Omconfig Disable Enclosure Alarm Omconfig Enable Enclosure Alarm180 Omconfig Set Enclosure Asset Name Omconfig Enable Smart Thermal ShutdownOmconfig Disable Smart Thermal Shutdown Omconfig Set Enclosure Asset Tag 182 Omconfig Set Temperature Probe Thresholds Omconfig Set All Temperature Probe Thresholds Omconfig Reset Temperature Probe Thresholds183 Omconfig Blink Omconfig Reset All Temperature Probe Thresholds184 185 186 Working With CLI Command Results Output Options for Command ResultsControlling Command Output Display Writing Command Output to a File 188 Save Command Results to a File That Can Be Overwritten Append Command Results to an Existing File Selecting a Format for Your CLI Command Output189 190 List lst 191 Example output displays as follows 192 Asic ADBAGP Ascii BTU BiosBGA BMC Cimom CdramCD-ROM CIM CSR COOCPU CRC DIP DhcpDimm DIN EDO DTEECC ECP Fpbga FATFCC Feprom Hpfs GUIHIP HMA IRQ IHVIpmi IPX LIF LANLCC Ldap Midi MBRMCA MIB NIS NdisNIC NIF PGA PCIPcmcia Perc RAID PXEQFP RAC ROM RFIRGB Rimm Simd SmbiosSEC Sgram Svga UDP TqfpTSR Uart Vcci UTPUuid VAC VRM VlsiVlvesa Vram ZIP XMMXMS ZIF 214 Index 215 216 CLI 217 218 219 220 221 222 223 224 225 226