CLIX COMMAND LINE INTERFACE

As described in this reference guide, the MDM software is typically

controlled using the Windows-based MDM Console, which provides

functional capabilities within an interactive point-and-click environment.

By contrast, CLIX makes most operational MDM Console commands

accessible via a command line interface and from within batch files,

making it useful for scheduling and automating routine maintenance.

In addition, CLIX provides an added measure of security and

consistency, since automated batch operation eliminates the potentially

unrestricted access and the types of errors that may be introduced

through a manual GUI interface.

CLIX runs on all platforms for which MDM has been released, including

Windows, Linux and Solaris (contrasting with MDM Console, which is

exclusively a Windows-based application). CLIX highlights include:

• Broad command support. Most of the day-to-day operations

required for routine repository maintenance are available via CLIX,

including commands for mounting, unmounting, starting and stopping

MDM, and loading, unloading, and repairing MDM repositories.

NOTE ►► Commands for repository design (e.g. Create Repository,

Add Table, Add Field, and Reorder Fields) and security (assignment of

privileges, user roles, and so on) are not currently supported by CLIX.

• Batch support. CLIX commands can be combined and organized

into sophisticated batch commands or shell scripts. Combined with

Windows or Unix scheduling programs, you can automate the

schedule and execution of a series of maintenance commands.

NOTE ►► For example, a script might include commands to perform

the following tasks at 2 AM: (1) verify and repair the master MDM

repository; (2) create a backup of today’s work by archiving the existing

master repository; and (3) synchronize the master repository with all

the production slave repositories.

• Error handling. CLIX returns an error code if a command cannot

execute so that the appropriate action can be taken, including an

optional notification to the system or MDM administrator.

NOTE ►► All commands send normal output to the “standard output

device” and error messages to the “standard error device” so that

results may be easily redirected or piped to files or other programs.

• Reports. System activity reports, including rolling logs, assert files

and initialization files can be retrieved via the command line and

written to a text file for analysis by the customer or SAP engineers.

MDM Console

 

The fundamental differences between MDM Console and CLIX are

 

Differences Between MDM Console and CLIX

NOTE ►► Batch or shell scripts that combine a sequence of CLIX

commands can in turn be used with cron, at, or other scheduling

programs.

NOTE ►► Each command returns a code that can be tested in a

batch or shell script: (1) Zero (0) means success; (2) other non-zero

codes are most often accompanied by an explanation. See Table 112

at the end of this section for a list of errors that you may encounter.

This section assumes that you understand the basic MDM Console

commands that CLIX can execute. For further information, please refer

to more complete explanations elsewhere in this guide.

MDM Console

Unit MDM Console CLIX Supported Platforms Windows only All platforms on which the MDM Server has been released. Interface GUI interface Text-based input and output using a command-line interface. Command Set Complete Most operations-oriented commands, but not design-oriented commands. Command Execution Click at a time Can be combined and organized into sophisticated batch or shell scripts. Error Handling GUI messages Error code returned to calling script, which can test and use them to control script flow.

 

CLIX Command Syntax

The basic syntax of a CLIX command is:

CLIX command_name [arguments] [option flags]