User Guide

User Guide
omconfig rac: Managing the Remote Access Controller: Dell OpenManage Server Administrator Version 2.2 Command Line Interface User's Guide

Back to Contents Page

omconfig rac: Managing the Remote Access Controller

Dell OpenManage™ Server Administrator Version 2.2 Command Line Interface User's Guide

Conventions for Parameter Tables omconfig rac snmptraps
omconfig rac Command Summary omconfig rac remote
Help With the omconfig rac Command omconfig rac rmdialinuser
omconfig rac authentication omconfig rac rmdialoutuser
omconfig rac dialinusers omconfig rac rmsnmptrap
omconfig rac dialoutusers omconfig rac rmuser
omconfig rac generatecert omconfig rac reset
omconfig rac modem omconfig rac uploadcert
omconfig rac network omconfig rac users

The omconfig rac command enables you to configure the operational components of the Remote Access Service (RAS). The CLI command omconfig rac uses the remote access controller (RAC) software interface to configure these operational components.

NOTE: Some features documented may not be available on your system's RAC. For example, dial-up modem use is supported only on DRAC III.
NOTE: The commands are available only on systems with DRAC III, DRAC III/XT, ERA, and ERA/O (not for systems with DRAC 4).

For information on how to use Server Administrator to configure other system and main system chassis components, see "omconfig: Managing Components Using the Instrumentation Service." For information on how to use the omconfig system command to view and to manage cost of ownership information (assetinfo), see "omconfig system assetinfo: Editing Cost of Ownership Values."

Often you must use omreport rac commands to get information you need to execute an omconfig rac command. For information about the omreport rac command, see "omconfig rac: Managing the Remote Access Controller."


Conventions for Parameter Tables

Parameter tables list input parameters for a command in the order in which you must configure them instead of the order in which they appear in the command line interface.

The symbol |, often called pipe, is the logical exclusive or operator. For example, enable | disable means that you can enable or disable the component or feature, but you cannot simultaneously enable and disable the component or feature.


omconfig rac Command Summary

NOTE: You must reset the remote access controller after execution of each omconfig rac command. After resetting the remote access controller, you must also wait approximately one minute before executing a subsequent omconfig rac command.
NOTE: Although this section lists all possible omconfig rac commands, the commands available on your system depend on your system configuration. If you try to get help or execute a command for a component that is not installed on your system, Server Administrator issues a message that the component or feature is not found on this system.

Table 9-1 is a high-level summary of the omconfig rac command. The column titled "Command level 3" lists the major arguments that can be used with omconfig rac. "User privilege required" refers to the type of privilege you need to execute the command, where U=User, P=Power User, and A=Administrator. "Use" is a very general statement about the actions that can be performed using omconfig rac. More details about syntax and use of the command appear later in this section.

Table 9-1. Command Level 1, Command Level 2, and Command Level 3 Options for omconfig rac 

Command level 1

Command level 2

Command
level 3

User privilege required

Use

omconfig

 

 

 

 

 

rac

 

 

 

 

 

authentication

A

Sets authentication properties.

 

 

dialinusers

A

Sets dial-in user properties.

 

 

dialoutusers

A

Sets dial-out user properties.

 

 

generatecert

A

Generates an certificate signing request (CSR).

 

 

modem

A

Configures modem properties.

 

 

network

A

Configures network properties.

 

 

snmptraps

A

Sets SNMP trap properties.

 

 

remote

A

Configures remote features properties.

 

 

rmdialinuser

A

Removes the dial-in user.

 

 

rmdialoutuser

A

Removes the dial-out user.

 

 

rmsnmptrap

A

Removes the SNMP trap.

 

 

rmuser

A

Removes the user.

 

 

reset

A

Resets the RAC.

 

 

uploadcert

A

Uploads a server or CA certificate.

 

 

users

A

Sets user properties.


Help With the omconfig rac Command

Use the omconfig rac -? command to get a list of the available commands for omconfig rac.

Use omconfig rac <command level 3> -? to see a list of name=value pairs that you may need to use with dialinusers, dialoutusers, modem, network, remote, and so on.

Type:

omconfig rac dialinusers -?

The following is an excerpt of the Server Administrator response:

dialinusers Set dial-in user properties.

Valid parameters are:

username=<text:Reqd>

index=<number:0-15>

password=<text>

callbacknumber=<number>

callbacktype=<text>


omconfig rac authentication

Use the omconfig rac authentication command to specify whether you want to enable local operating system authentication of a system that is seeking to use the remote access interface. To enable local operating system authentication, type:

omconfig rac authentication localauthenable=true

To disable local operating system authentication, type:

omconfig rac authentication localauthenable=false

Local Operating System Authentication

Use the omconfig rac authentication command to determine whether local operating system authentication of users is enabled or disabled for the remote access controller.

The RAC has two methods of authenticating user access: RAC authentication and local operating system authentication. RAC authentication is always enabled. Administrators can set up specific user accounts and passwords that allow access to the RAC.

Operating systems also require administrators to define different levels of users and user accounts; each user level has different privileges. Local operating system authentication on the RAC is an option for administrators who do not want to define one set of privileges for users in the operating system and a separate set of users and accounts for the RAC. If you enable local operating system authentication for the RAC, you enable any user with Administrator status on the operating system to log into the RAC.

Example Command for omconfig rac authentication

When you type:

omconfig rac authentication localauthenable=true

you have configured the RAC to allow access to any user who has Administrator privileges on the operating system.

When you type:

omconfig rac authentication localauthenable=false

you have configured the RAC to allow access only to users with user names and passwords that are defined by the RAC administrator.


omconfig rac dialinusers

NOTE: Some features documented may not be available on your system's RAC. For example, dial-up modem use is supported only on DRAC III.

Use the omconfig rac dialinusers command to specify requirements for each user who is to have dial-in privileges. The administrator can specify values for a user name, password, and other properties for each user. Table 9-2 shows the valid parameters for the command.

Table 9-2. omconfig rac dialinusers 

name=value pair

Description

username=<text>

Sets the user name for the point-to-point protocol (PPP) user.

index=<number:0–15>

Sets the dial-in user index to populate with user name, password, and so on. The index specifies one of the 16 user "positions" on the RAC.

If an index is not specified for an omconfig rac command, the entry is added to the next available position on the RAC.

If an index is specified for an omconfig rac command and another entry exists for that position, the key field parameter is used to decide if the command should be executed. If the key field supplied by the user matches the key field of the entry on that specific position of the RAC, the RAC entry is edited. Otherwise, the command fails.

password=<text>

Sets the password for this PPP user.

callbacknumber=<n>

Sets the callback number.

callbacktype=none | preset | usr-specified

Sets the type of call back.

Example Commands

The following example sets one name=value pair. Type:

omconfig rac dialinusers username=jdoe

The next example supplies values for all command parameters that you can use with the omconfig rac dialinusers command. Type:

omconfig rac dialinusers username=jdoe index=0 password= steven70 callbacknumber=4441022 callbacktype=preset

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac dialoutusers

Use the omconfig rac dialoutusers command to specify requirements for each user who is to have dial-out privileges. The administrator can specify values for a surname, password, IP address, and other properties for each dial-out user. Table 9-3 shows the valid parameters for the command.

Table 9-3. omconfig rac dialoutusers 

name=value pair

Description

ipaddr=<text>

Sets the IP address, which must be specified in dotted-decimal notation.

index=<number:0–15>

Sets the dial-out user index to populate with user name, password, and so on.The index specifies one of the 16 user "positions" on the RAC.

If an index is not specified for an omconfig rac command, the entry is added to the next available position on the RAC.

If an index is specified for an omconfig rac command and another entry exists for that position, the key field parameter is used to decide if the command should be executed. If the key field supplied by the user matches the key field of the entry on that specific position of the RAC, the RAC entry is edited. Otherwise, the command fails.

username=<text>

Sets the user name for the point-to-point protocol (PPP) dial-out user.

password=<text>

Sets the password for this PPP user.

phonenumber=<n>

Sets the number where you can reach the PPP user.

authtype=any | encrypted

Sets the type of authentication required for this user.

Example Commands

The following example sets one name=value pair. Type:

omconfig rac dialoutusers ipaddr=14.16.53.18

The following message appears:

Command Successful. Please reset RAC card!

The next example supplies values for all command parameters that you can use with the omconfig rac dialoutusers command. Type:

omconfig rac dialoutusers ipaddr=14.16.53.18 index=1
username=sustein password=74chaunu phonenumber=4021027
authtype=any

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac generatecert

Use the omconfig rac generatecert command to generate the certificate signing request (CSR) that you send to a certificate authority (CA). A certificate authority is a business entity that is recognized in the IT industry for meeting high standards of reliable screening, identification, and other important security criteria. Examples of CAs include Thawte and VeriSign. After the CA receives your CSR, they review and verify the information the CSR contains. If the applicant meets the CA's security standards, the CA issues a certificate to the applicant that uniquely identifies that applicant for transactions over networks and on the Internet.

For the purposes of the RAC, you can use the omconfig rac generatecert command to generate a CSR. Then you send the CSR in your application to the CA; the CA approves the CSR and sends you a certificate. Then use the omconfig rac uploadcert command to upload the certificate to the RAC. Uploading your new certificate replaces the default RAC certificate that you received with your RAC.

NOTE: Whenever you have a fully qualified pathname or filename that contains spaces, you must place double quotation marks around the string. For example, if your update package is located at c:\security files\certificates\sslcert.cer, you must place the fully qualified path in double quotations because there is a space between "security" and "files." The following is an example command using the fully qualified path and filename enclosed in quotation marks.

omconfig rac generatecert file="c:\security files\certificates\sslcert.cer"

NOTE: Except for the two-letter country code, all other parameter values are strings. Parameters are required only if indicated (required).
NOTE: This command makes use of the FTP protocol to communicate with the RAC firmware. The command may fail if firewall software is installed in the system.

Table 9-4 shows required and optional parameters that are used to generate your CSR.

Table 9-4. omconfig rac generatecert 

name=value pair

Description

commonname=<text>

Enter a unique text string that distinguishes your system from others for which you may be requesting certificates (required).

countrycode=<text>

Two-letter code representing the country where your system is located. See ISO Standard 3166 (required).

emailaddress=<text>

The e-mail address of your system.

file=<text>

The absolute pathname or filename (with extension) of the CSR to be generated (required). If you provide only a filename, the CSR file is placed in your current working directory.

locality=<text>

City name or other location name where your system is located.

orgname=<text>

Name of your organization (required).

orgunit=<text>

Name of the sub-unit or department in your organization that is applying for the certificate (required).

state=<text>

Name of your state or province.

Once you have generated the CSR, you can upload the certificate to the RAC using the omconfig rac uploadcert command.


omconfig rac modem

Use the omconfig rac modem command to configure properties for your RAC's modem, if present. Table 9-5 shows the valid parameters for the command.

Table 9-5. omconfig rac modem

name=value pair

Description

baudrate=<n>

The modem speed in bits per second. The default baud rate is 38400.

initstring=<text>

The required initialization string for your RAC.

dialtype=tone | pulse

Specifies whether the dial type for your modem is tone or pulse.

countrycode=<two-letter country code>

Specifies the code for the country where your system is located.

Use the omconfig rac modem command with the countrycode parameter to specify the code for the country where your system is located, for example:

omconfig rac modem countrycode=US

Table 9-6 shows the country codes that you must use to set this parameter.

Table 9-6. Country Codes for countrycode Parameter of omconfig rac modem

Country

Country Code

Country

Country Code

Australia

AU

Japan

JA

Austria

AS

Korea

KO

Belgium

BE

Luxembourg

LU

Bulgaria

BU

Mexico

ME

Canada

CA

Netherlands

NE

China

CH

New Zealand

NW

Czech and Slovak Republic

CZ

Norway

NO

Denmark

DE

Philippines

PH

Finland

FI

Poland

PO

France

FR

Portugal

PR

Germany

GE

Russia

RU

Greece

GR

Singapore

SI

Hong Kong

HO

Spain

SP

Hungary

HU

Sweden

SW

India

IN

Switzerland

SZ

Ireland

IR

Taiwan

TA

Israel

IS

United Kingdom

UK

Italy

IT

United States

US


omconfig rac network

Use the omconfig rac network command to specify network parameter values. Table 9-7 shows the valid parameters for the command.

Table 9-7. omconfig rac network 

name=value pair

Description

ipaddr=<text>

Sets the IP address, which must be specified in dotted-decimal notation.

subnetmask=<text>

Sets the subnet mask, which must be specified in dotted-decimal notation.

gateway=<text>

Sets the gateway, which must be specified in dotted-decimal notation.

nicenable=true | false

true: Enables the NIC.

false: Disables the NIC.

dhcpenable=true | false

true: Enables the DHCP.

false: Disables the DHCP.

smtpaddr=<text>

Sets the SMTP address, which must be specified in dotted-decimal notation.

smtpenable=true | false

true: Enables the SMTP.

false: Disables the SMTP.

dialinenable=true | false

true: Enables the dial-in communications.

false: Disables the dial-in communications.

dialindhcpenable=true | false

true: Enables the dial-in dynamic host configuration protocol (DHCP).

false: Disables the dial-in dynamic host configuration protocol (DHCP).

dialinpaddr=<text>

Sets the base IP address, which must be specified in dotted-decimal notation.

dialinauthtype=any | encrypted

Sets the type of authentication required.

Example Command

The following example sets one name=value pair. Type:

omconfig rac network ippaddr=123.169.555.216

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac snmptraps

Use the omconfig rac snmptraps command to specify the SNMP trap property values. Table 9-8 shows the valid parameters for the command.

Table 9-8. omconfig rac snmptraps 

name=value pair

Description

ipaddr=<text>

Sets the IP address, which must be specified in dotted-decimal notation.

index=<number:0–15>

Sets the SNMP trap index. The index specifies one of the 16 trap "positions" on the RAC.

If an index is not specified for an omconfig rac command, the entry is added to the next available position on the RAC.

If an index is specified for an omconfig rac command and another entry exists for that position, the key field parameter is used to decide if the command should be executed. If the key field supplied by the user matches the key field of the entry on that specific position of the RAC, the RAC entry is edited. Otherwise, the command fails.

trapsenable=true | false

true: Enables SNMP traps.

false: Disables SNMP traps.

community=<text>

Sets the community.

Example Commands

The following example sets one name=value pair. Type:

omconfig rac snmptraps ipaddr=123.166.555.216 index=1 community=dell

The following message appears:

Command Successful. Please reset RAC card!

The next example supplies values for all command parameters that you can use with the omconfig rac snmptraps command. Type:

omconfig rac snmptraps ipaddr=123.166.555.216 index=0 trapsenable=true community=dell

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac remote

Use the omconfig rac remote command to specify the remote features property values. Table 9-9 shows the valid parameters for the command.

Table 9-9. omconfig rac remote

name=value pair

Description

floppytftpenable=true | false

true: Enables remote boot.

false: Disables remote boot.

floppytftpipaddr=<text>

Sets the floppy TFTP address.

floppytftppath=<text>

Sets the floppy TFTP path.

fwupdatetftpipaddr=<text>

Sets the firmware TFTP address.

fwupdatetftppath=<text>

Sets the directory path on the TFTP server where the firmware update images reside.

Example Command

The following example sets one name=value pair. Type:

omconfig rac remote floppytftpenable=true

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac rmdialinuser

Use the omconfig rac rmdialinuser command to remove a dial-in user. Table 9-10 shows the valid parameters for the command.

Table 9-10. omconfig rac rmdialinuser

name=value pair

Description

username=<text>

Specifies the user name of entry which is to be deleted. If no user name is specified, an index must be specified.

index=<n>

Specifies the index of the entry which is to be deleted. If no index is specified, a user name must be specified.

Example Command

The following example sets one name=value pair. Type:

omconfig rac rmdialinuser username=jdoe

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac rmdialoutuser

Use the omconfig rac rmdialoutuser command to remove a dial-out user. Table 9-11 shows the valid parameters for the command.

Table 9-11. omconfig rac rmdialoutuser

name=value pair

Description

username=<text>

Specifies the user name of entry which is to be deleted. If no user name is specified, an index must be specified.

index=<n>

Specifies the index of the entry which is to be deleted. If no index is specified, a user name must be specified.

Example Command

The following example sets one name=value pair. Type:

omconfig rac rmdialoutuser username=jdoe

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac rmsnmptrap

Use the omconfig rac rmsnmptrap command to remove an SNMP trap. Table 9-12 shows the valid parameters for the command.

Table 9-12. omconfig rac rmsnmptrap 

name=value pair

Description

ipaddr=<text>

Specifies the IP address of entry which is to be deleted. This value must be specified in dotted-decimal notation. If no IP address is specified, an index must be specified.

index=<n>

Specifies the index of the entry which is to be deleted. If no index is specified, an IP address must be specified.

Example Command

The following example sets one name=value pair. Type:

omconfig rac rmsnmptrap ipaddr=123.199.152.216

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac rmuser

Use the omconfig rac rmuser command to remove a user. Table 9-13 shows the valid parameters for the command.

Table 9-13. omconfig rac rmuser

name=value pair

Description

username=<text>

Specifies the user name of entry which is to be deleted. If no user name is specified, an index must be specified.

index=<n>

Specifies the index of the entry which is to be deleted. If no index is specified, a user name must be specified.

Example Command

The following example sets one name=value pair. Type:

omconfig rac rmuser username=jdoe

The following message appears:

Command Successful. Please reset RAC card!


omconfig rac reset

Use the omconfig rac reset command to reset the RAC.


omconfig rac uploadcert

Use the omconfig rac uploadcert command to upload the server or CA certificate to the RAC. You must enter the fully qualified pathname of the certificate and select the type of certificate to upload. The two types of certificate that you can upload are a server certificate, or a certificate that you can obtain from a certificate authority (CA). Examples of certificate authorities are Thawte Server CA or VeriSign, Inc.

NOTE: This command makes use of the FTP protocol to communicate with the RAC firmware. The command may fail if firewall software is installed in the system.

Table 9-14 shows the valid parameters for the command.

Table 9-14. omconfig rac uploadcert

name=value pair

Description

file=<text>

The absolute pathname (including filename and extension) of the certificate to be uploaded to the RAC (required).

type=server | ca

Indicates whether the certificate you are uploading is a server certificate or a CA certificate.


omconfig rac users

Use the omconfig rac users command to specify user property values. Table 9-15 shows the valid parameters for the command.

Table 9-15. omconfig rac users 

name=value pair

Description

username=<text>

Sets the user name.

index=<number:0–15>

Specifies the index of the entry. The index specifies one of the 16 user "positions" on the RAC.

If an index is not specified for an omconfig rac command, the entry is added to the next available position on the RAC.

If an index is specified for an omconfig rac command and another entry exists for that position, the key field parameter is used to decide if the command should be executed. If the key field supplied by the user matches the key field of the entry on that specific position of the RAC, the RAC entry is edited. Otherwise, the command fails.

userpassword=<text>

Sets the password.

numericpagingenable=true | false

true: Enables numeric paging.

false: Disables numeric paging.

numericpagernumber=<n>

Sets the numeric pager number.

numericpagermsg=<text>

Sets the numeric pager message.

emailpagingenable=true | false

true: Enables e-mail paging.

false: Disables e-mail paging.

emailaddress=<text>

Sets the e-mail address.

emailmsg=<text>

Set the e-mail message.

alphapagingenable=true | false

true: Enables the alpha paging.

false: Disables the alpha paging.

alphanumber=<n>

Sets the alpha number.

alphaprotocol=8N1 | 7E0

Sets the alpha protocol.

alphabaudrate=<n>

Sets the alpha baud rate.

alphapagerid=<n>

Sets the alpha pager ID.

apphacustommsg=<text>

Sets the alpha custom message.

alphapagerpassword=<text>

Sets the alpha pager password.

Example Command

The following example sets one name=value pair. Type:

omconfig rac users username=jdoe

The following message appears:

Command Successful. Please reset RAC card!


Back to Contents Page

 

© 2012 Dell | Terms of Sale | Unresolved Issues | Privacy | Site Map | Feedback

snWEB2