User Guide

User Guide
Using the CLI: Dell OpenManage Client Connector Version 2.1 User's Guide

Back to Contents Page

Using the CLI

Dell OpenManage™ Client Connector Version 2.1 User's Guide

  Using the Windows Command Line

  Using IT Assistant


The Dell OpenManage™ Client Connector (OMCC) can be used as both a graphical user interface (GUI) and a command line interface (CLI). Use the CLI to perform actions on multiple client systems simultaneously.


Using the Windows Command Line

To enable OMCC's command-line capabilities from within a Windows® command prompt, set the OMACS_KEY_OMA environment variable using the set command.

  1. Open a command prompt window.

  2. Type:

set OMACS_KEY_OMA=SOFTWARE\Dell Computer Corporation\Dell OpenManage OMCC\Dell OMA

NOTE: You have set the environment variable for only this active command prompt window. If you close it and open another, you will need to set the environment variable for the new window. This note applies only to the Windows command prompt and not to IT Assistant. Do not set the environment variable globally for any user or for the system. IT Assistant uses the same environment variable but requires a different value. If the variable is set globally to the OMCC value, then IT Assistant will not work properly.

Table 6-1 shows four actions that you can perform from the command line.

Table 6-1. Command-Line Actions 

Actions

Sample Command Line

Client configuration (setting of BIOS parameters)

omconfig system cim action=setcim ipaddress= <client IP address> username=<domain>\<admin username> password=<domain admin password> authenticationlevel=packet classpropertyvalue= dell_configuration::hddpercentagethreshold:20

Updating the client BIOS firmware

omconfig system cim action=flashbios ipaddress=<client IP address> username=<domain>\<admin username> password=<domain admin password> authenticationlevel=packet biosfile=C:\biosimages\<bios image header file>

Restarting the client

omconfig system cim action=restart ipaddress=<client IP address> username=<domain>\<admin username> password=<domain admin password> authenticationlevel=packet

Shutting down the client

omconfig system cim action=shutdown ipaddress=<client IP address> username=<domain>\<admin username> password=<domain admin password> authenticationlevel=packet


Using IT Assistant

Use the IT Assistant's Manage Tasks option to create CLI commands.

  1. From IT Assistant, select Manage Tasks.

  2. Right-click Command Line and click New Task to display the Task Creation Wizard.

You can use the Task Creation Wizard to create a new task. Click Help for more information.

    1. In the Task Creation window, select Remote Client Instrumentation, which allows you to execute OMCC CLI commands remotely. See "Remote Client Instrumentation — Configuring Your Task" for more information.

NOTE: The Remote Client Instrumentation command-line options may not be available if IT Assistant does not detect that the OMCI 7.1 or later components are installed on the IT Assistant Services Tier on the client system.

You must also specify a task name and, optionally, a brief description of your task in the Task Creation window.

    1. Use the Task Executable Specification window to configure the application that you want to launch.

      • Executable — Specifies the fully qualified pathname and filename of the executable file that launches the application program.

NOTE: The pathname references the IT Assistant Services Tier from which the task is run; it is not the path from the user interface.
      • Arguments — Specifies the supporting CLI arguments for the launching of the application. These arguments are case-sensitive.

NOTE: If the Select Devices window does not appear in the wizard, the task will run the command only once.
      • Application requires interaction with desktop — Specifies that the executable to be run is a Microsoft® Windows application that may require additional user interaction. Enabling this option allows you to interact with the application from the IT Assistant Services console. This option is disabled by default.

NOTE: This option is not recommended for scheduled processes because the task's execution will stop until the required user input has been entered.
      • Log — Writes the details of your task's execution to a log file.

Remote Client Instrumentation — Configuring Your Task

Use the Task Creation window to execute OMCC CLI commands remotely. Use the remote client instrumentation CLI for clients running Client Instrumentation 7.1 or later to perform remote Common Information Model (CIM) operations. Table 6-2 shows sample arguments that you could specify in the Arguments field.

Table 6-2. Sample Arguments for Remote Client Instrumentation 

Task

Argument

Remote BIOS Flash

system cim action=flashbios ipaddress=$IP username=$USERNAME password=$PASSWORD authenticationlevel=packet biosfile= ftp://myftpsite/GX260A06.hdr

The BIOS image file must be accessible from the remote client system, which means that the biosfile argument must be presented as the full path to the image file as seen from the client. The user who runs the BIOS update must have read privileges to the location where the image is stored.

For example, if you specify the following definition for the biosfile, the client system searches for the .hdr file in the temp directory of its own C drive:

biosfile=C:\temp\GX260A06.hdr

IT Assistant will not upload the .hdr file; it is the responsibility of the user to place the file in the location specified by the biosfile tag. When the update is executed, the client system will download the BIOS file from the specified location.

Remote CIM set

system cim action=setcim ipaddress=$IP username=$USERNAME password=$PASSWORD authenticationlevel=packet classpropertyvalue= dell_configuration::HDDPercentageThreshold:20

Remote Shutdown

system cim action=shutdown ipaddress=$IP username=$USERNAME password=$PASSWORD authenticationlevel=packet

Remote Restart

system cim action=restart ipaddress=$IP username=$USERNAME password=$PASSWORD authenticationlevel=packet

NOTE: Do not insert a space while entering the password. The password will not be authenticated.

In the previous examples, the $IP is a placeholder for the IP address of the remote client device that you specify in the Device Selection pane. The $USERNAME and $PASSWORD are placeholders for the user name and password for the client device. These tokens are replaced when you enter the credentials in the Authentication window. The credentials that you enter correspond to the Windows operating system credentials.


Back to Contents Page

 

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

snWEB1