MDM SERVER COMMANDS

CLIX mdsAssertSetting MDMHostSpec [-D]

Reports the current setting of the MDM Server’s Assert option. Return

values are “ON” or “OFF”.

CLIX mdsDiskSpaceFree MDMHostSpec [-D]

Display the disk space free in the Report, Archive, and Accelerator

directories.

CLIX mdsGetReportFile MDMHostSpec filename [-D]

Display contents of a file provided by the filename argument from the

MDM Server report directory. May be restricted by mds.ini settings.

Cannot be used and returns an error when the MDM Server is running

on a non-Windows platform.

CLIX mdsMonitor MDMHostSpec [-D] [-W] [-T seconds]

Displays information about the current and queued activities on the

MDM Server.

CLIX mdsNewPassword MDMHostSpec newPassword [-D]

Replace the existing MDM Server password. To remove an existing

password, that is to have no password, use “” (quoted empty

password) for the newPassword argument.

CLIX mdsAssertOff MDMHostSpec [-D]

Stop writing errors to the MDM Server’s Assertion log. Does not

overwrite the setting of the UseAssert mds.ini parameter.

MDM Console
379

Part 14: CLIX Command Line Interface

CLIX mdsAssertOn MDMHostSpec [-D]

Write errors to the MDM Server’s Assertion log. Does not overwrite the

setting of the UseAssert mds.ini parameter.

CLIX mdsParameters MDMHostSpec [-D]

Display the contents of the MDM Server mds.ini file. May be restricted

by mds.ini settings.

CLIX mdsReportFiles MDMHostSpec Credentials [-D]

Return a list of the files in the MDM Server report directory for which the

given credentials are permitted access. May be restricted by mds.ini

settings. Cannot be used and returns an error when the MDM Server is

running on a non-Windows platform.

CLIX mdsRollingLog MDMHostSpec [-E] [-D]

Display the contents of a file from the current Server*.xml file. With –E

flag, other log files are also included. Cannot be used and returns an

error when the MDM Server is running on a non-Windows platform.

CLIX mdsSetParameter MDMHostSpec settingName=value [-D]

Insert or modify a line from the top section of the MDM Server mds.ini

file. The settingName=value should appear exactly as it would in the

mds.ini file and requires quotes to escape any blanks or punctuation.

May be restricted by mds.ini settings.

CLIX mdsStart MDMHostSpec [-D]

Start the MDM Server if it is not running. Not supported on Unix/Linux.

CLIX mdsStatus MDMHostSpec [-T seconds] Credentials [-D] [-B]

Show information about repositories mounted on the MDM Server for

which the given credentials are permitted access.

CLIX mdsStop MDMHostSpec [-D]

Stop the MDM Server if it is running.

CLIX mdsStatus MDMHostSpec [-T seconds] Credentials [-D] [-B]

Show information about repositories mounted on the MDM Server for

which the given credentials are permitted access.

CLIX mdsVersion MDMHostSpec [-D]

Display the version number and interface information for CLIX.

CLIX Commands

The CLIX commands are summarized in Table 110.

Table 110. Command Summary

Command Code Description   MDM Server Commands mdsHelp M Display help on MDM Server commands   MM Report state of Assert setting (on/off) of MDM Server   MD Return MDM Server disk space info mdsGetReportFile MF List a file from the Report Directory   MM Displays a list of monitored activities currently occurring on the MDM Server mdsNewPassword MN Replace the MDM Server password   MT Turn off Assert setting of MDM Server   MO Turn on Assert setting of MDM Server   MP List the mds.ini file mdsReportFiles MR List the filenames in the Report Directory   ML List the current Server*.xml file   MS Set an mds.ini parameter mdsStart MG Start an MDM Server mdsStatus MI List status of mounted repositories mdsStop MH Stop an MDM Server mdsVersion MV Return MDM Server version info Repository Control Commands* repHelp R Display help on Repository Control commands   RA Cancel a pending Unload Repository command repCheck RC Verify-check an MDM repository repCreate RN Create a new (empty) repository repDelete RE Delete (erase) an MDM repository   RX Make load exclusive to a single MDM Server   RF Refreshes all calculated fields on a repository   RV Reports the repository’s change counter Counter RIM For a slave repository, reports its master’s change counter repGetMasterInfo RIS For a slave repository, displays the specification of its master repository and the name of the master’s MDS Server   RIA Return whether or not MDM Server is busy with the specified commands

♣ mdsAssertSetting

♣ mdsDiskSpaceFree

♣ mdsMonitor

♣ mdsOffAsserts

♣ mdsOnAsserts

♣ mdsParameters

♣ mdsRollingLog

♣ mdsSetParameter

♣ repCancelUnload

♣ repExclusive

♣ repFieldsRecalc

♣ repGetChangeCounter

♣ repGetMasterChange

♣ repIsAvailable

MDM Console

♣ repMonitor

♣ repPreload

♣ repShare

♣ repSwap

♣ repTruncateMCL

♣ cpyInfo

♣ = Command not available in MDM Console.

* = Repository Control commands operate only on mounted MDM repositories.

TIP ►► To see a complete list of synonyms and abbreviations for

CLIX commands, enter “CLIX a”.

NOTE ►► The mdsGetReportFile, mdsReportFiles, and

mdsRollingLog commands cannot be used to retrieve files and

return an error when the MDM Server is on a non-Windows platform.

378
MDM Console

repLoad RG Load a stopped/unloaded repository   RMO Display repository activities currently occurring on MDM Server repMount RM Mount an MDM repository repNormalize RZ Make a normal repository from master or slave   RB Preload repository data without opening ports repRepair RR Verify-repair an MDM repository   RD Allow repository loading on multiple MDM Servers   RW Swap a loaded repository with a preloaded one repSynchronize RS Synchronize a slave repository to its master   RQ Truncates the Master Change Log repUnload RH Unload a loaded/running repository repUnlock RL Appropriate a remotely running MDM repository repUnmount RU Unmount an MDM repository repUpdate RP Update the schema of an MDM repository Repository Copying Commands cpyHelp C Display help on Repository Copying commands cpyArchive CA Create an .a2a archive from a mounted repository cpyDuplicate CD Duplicate a mounted repository   CI Display analysis report of available .a2a files cpyListArchives CL List available .a2a files cpySlave CS Create a slave repository cpyUnarchive CU Create MDM repository from an .a2a archive file DBMS Control Commands dbHelp D Display help on DBMS Control commands dbGetDBMSSetting DG List the MDM Server DBMS settings dbInitialize DI Initialize MDM Server’s use of DBMS dbList DL List the MDM repositories on a DBMS dbPassChange DP Change the DBMS password dbSetDBMSSetting DS Alter one of the MDM Server DBMS settings

CLIX Commands

NOTE ►► Some of the MDM Server commands may be restricted if

mds.ini has one or more of the following parameters set to False:

(1) Allow Console to Retrieve Files

(2) Allow Console to Retrieve SysInfo

(3) Allow Modification of mds.ini

NOTE ►► Some CLIX commands require a Credentials argument

in the form of repositoryUserName:password for the MDM

repository named in the MDMRepSpec or for the MDM repository

targeted in the MDM Server command.

Each of the CLIX commands is described in the following sections.

COMMAND NAMES

Each command_name begins with a prefix representing one of the four

groups to which it belongs (and the command short name begins with

the corresponding letter), as shown in Table 108.

Table 108. CLIX Command Groups

NOTE ►► CLIX with no command displays a general help message;

a command prefix/letter with no arguments displays help on that group.

ARGUMENTS

Except for help commands, the first argument is always an

MDMHostSpec, comprised of the machine hostname or IP address on

which the MDM Server runs, optionally followed by a colon and a

password (e.g. myMDMHostName:MDMPassword)

Several commands also take a DBMSHostSpec, comprised of a DBMS

instance name, type, username and password, all separated by colons

or semi-colons, where type is either ‘S’ (SQL Server), ‘O’ (Oracle), ‘M’

(MaxDB), ‘D’ (DB2), ‘I’ (DB2 on i5/OS), or ‘Z’ (DB2 on z/OS) as in the

following examples:

OraSvr1:o:ellisonsys:larry

[left off empty password]

Several commands also require a RepositorySpec, comprised of the

repository name followed by a colon and the DBMSHostSpec, as in the

following examples:

Tools0704:OraSvr1:o:ellisonsystem:larry

"Consumer Appliances:BILLYGATESBOX:s:sa"

TIP ►► If the MDM repository name has spaces, place the entire

RepositorySpec in quotes.

Command Group Command Prefix Command Letter MDM Server Control mds m Repository Control rep r Repository Copying cpy c DBMS Control db d

Part 14: CLIX Command Line Interface

OPTION FLAGS

The CLIX command option flags are summarized in Table 109.

Table 109. CLIX Command Option Flags

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]