Data Quality user documentation | Command line management utility

The Pro API Command Line Management Utility is a tool for Windows and UNIX administrators which enables you to display query results on the command line that can otherwise only be displayed using the Administrator Console. Arguments are passed in on the command line and the results are output on one or more lines. The 64-bit version of the Command Line Management Utility is called wvmgmtdg.exe.

Synopsis

wvmgmtd [-ini:<config file>] <command> [<argument1>] ...

Arguments

Use the -ini:<config file> option to specify an alternate configuration file from which settings can be read. By default, qaworld.ini is used.

The <commands> are listed in detail below.

For <arguments>, you can specify particular servers, clients or data files for the command to process; the default behaviour is that all are processed. The <Server> can be any of the following:

Server number (index of server in server list, starting from zero)
Server name:port
Server IP address:port

Output

Each <command> has different output. The command summaries describe the output in more detail.

Common output elements include:

<EOL> is equivalent to LF or CR/LF depending on the platform.

The <Errorcode> value returned has the following format:

-errorcode<TAB>Error description

For example: -1010<TAB>File not found

Return Vvalue

If an error occurs, wvmgmtd returns an exit status of 255, otherwise the exit status is 0.

Command summaries

This command lists the known servers and tests their status.

Command:

wvmgmtd srvlist

Output:

<+Count(n) of configured servers or -Errorcode><EOL>
<Svr name / IP (1)><TAB><Port><TAB><Desc> <TAB><Status><EOL>
<Svr name / IP (2)><TAB><Port><TAB><Desc> <TAB><Status><EOL>
...
<Svr name / IP (n)><TAB><Port><TAB><Desc> <TAB><Status><EOL>

This command instructs the specified server to shut down remotely.

Command:

wvmgmtd shutdown <Server>

<Server> not specified

If <Server> is not specified, this command will attempt to shut down all active servers.

Output:

<Errorcode>

This command reads the description of the specified server.

Command:

wvmgmtd descread <Server>

Output:

<Errorcode><Description>

This command sets the description of the specified server.

Command:

wvmgmtd descwrite <Server> <Description to set>

Spaces or special characters

If the description to set has spaces or special characters, it must be enclosed in double quotes.

Output:

<Errorcode>

This command reads the maximum number of clients configured for a specified server.

Command:

wvmgmtd maxcliread <Server>

Output:

<+Max client count or -Errorcode>

This command sets the maximum number of clients configured for the specified server.

Command:

wvmgmtd maxcliwrite <New max client count> <Server>

<Server> not specified

If <Server> is not specified, this command will attempt to shut down all active servers.

Output:

<Errorcode>

This command reads the maximum number of threads configured for the specified server.

Command:

wvmgmtd maxthread <Server>

Output:

<+Max thread count or -Errorcode>

This command sets the maximum number of threads configured for the specified server.

Command:

wvmgmtd maxthwrite <New max thread count> <Server>

<Server> not specified

If <Server> is not specified, this command will attempt to shut down all active servers.

Output:

<Errorcode>

This command counts the current number of clients attached to the specified server.

Command:

wvmgmtd clientcountread <Server>

<Server> not specified

If <Server> is not specified, this command will attempt to shut down all active servers.

Output:

<+Number of clients attached or -Errorcode>

This command returns a list of the clients using the specified server.

Command:

wvmgmtd clientlistread all <Server>

<Server> not specified

If <Server> is not specified, this command will attempt to shut down all active servers.

Output:

<+Count(n) of current clients or -Errorcode><EOL>
<Client name / IP (1)><TAB><Port><EOL>
<Client name / IP (2)><TAB><Port><EOL>
...
<Client name / IP (n)><TAB><Port><EOL>

This command disconnects a specified client from the specified server.

Command:

wvmgmtd clientdisconnect <Client name/IP> <Port> <Server>

Server not specified

If the <Server> is not specified, this command will attempt to disconnect the client from all active servers. The entries for Client name/IP and Port must exactly match the string returned by clientlistread. Wildcards are accepted for both Client name/IP and Port.

Output:

<Errorcode>

This command shows what datasets are available on the server.

Command:

wvmgmtd datalistread current <Server>

Output:

<+Count (n) of datasets currently in use -Errorcode><EOL>
<Name(1)><TAB><Release><TAB><Exp><TAB><Location><EOL>
<Name(2)><TAB><Release><TAB><Exp><TAB><Location><EOL>
...
<Name(n)><TAB><Release><TAB><Exp><TAB><Location><EOL>

Where:

<Name(n)> is the dataset name
<Release> is the release details
<Exp> is the days to expiry
<Location> is the full path to the data files

This command shows which datasets can be updated.

Command:

wvmgmtd datalistread toupdate <Server>

Output:

<+Count (n) of datasets currently in use -Errorcode><EOL>
<Name(1)><TAB><Release><TAB><Exp><TAB><Location><EOL>
<Name(2)><TAB><Release><TAB><Exp><TAB><Location><EOL>
...
<Name(n)><TAB><Release><TAB><Exp><TAB><Location><EOL>

This command updates the server to use newly installed data.

Command:

wvmgmtd dataunused update <Server>

Output:

<"OK" or Errorcode>

This command lists licenses for the specified server.

Command:

wvmgmtd licenselistread <Server>

Output:

<Count (n) of licenses><EOL>
<license 1><TAB><Customer Ref><TAB><Data ID><TAB><Licence
Type><TAB><Expiry date><EOL>

This command adds a specified license to the specified server.

Command:

wvmgmtd licenseadd "<Licence Number>" <Server>

Output:

<Errorcode><TAB><Error Description><EOL>

This command removes a specified license to the specified server.

Command:

wvmgmtd licenseremove "<Licence Number>" <Server>

Output:

<Errorcode><TAB><Error Description><EOL>

This command synchronizes the specified server with its license file. This is useful if the license file has been modified externally to Pro API.

Command:

wvmgmtd licenserefresh <Server>

Output:

<Errorcode><TAB><Error Description><EOL>

This command retrieves the information necessary for counter administration.

Command:

wvmgmtd counterinforead <Server>

Output:

<number of fields> or <Errorcode><field name><TAB><field value>

This command lists the meters, their values, and their expiry.

first run datalistread

Before you run meterslistread, you should run datalistread. This creates meters if they do not already exist and ensures that active meters will show up when you run meterslistread.

Command:

wvmgmtd meterslistread <Server>

Output:

<number of fields> or <Errorcode><meter name><TAB><meter value><TAB><*><meter expiry>

Where <*> is the active flag. This reports whether data has been used, and if so, whether there is a respective license for that counter.

This command applies an update code to the counter(s). This code is supplied by Experian.

Command:

wvmgmtd counterupdate <Server> <update code>

Output:

<Errorcode>

This command transfers clicks between servers. It is possible to transfer both expiry and non-expiry clicks.

Transfer clicks

You may not be able to transfer clicks between certain versions of Pro API.

Command:

wvmgmtd meterstransfer <source server> <destination server> <meter name1>:<clicks to transfer> [<meter name 2>:<clicks to transfer> ...]

<metername>

When transferring expiry clicks, the <metername> input must also contain the valid to and valid from dates for the click expiry, in the format YYYYMMDD. For example, <metername>.20210607.20220607 shows that the valid from date is the 7th of June 2022, and the valid to date is the 7th of June 2022.

Output:

<Errorcode>

Was this helpful?

Previous: Administrator console

Pro API

Configuration tools

Next topic:
Format of configuration file
Previous topic:
Use cases