New feature to Command line clients

This message was edited 13 times. Last update was at 25/09/2009 13:32:20

The Command Line client can be scripted.
This is be useful for those wanting to manage their RAID configurations through scripts or their favorite automation tools.

----------------------------------------------------------------------
Quick tutorial (full tutorial will be posted on the main site when I get a chance to)

To run the command line client in:
- Interactive mode: FlexRAIDClient [Host] [Port] [Timeout]
- Non-Interactive mode: FlexRAIDClient Host Port Timeout Command

The Host/Port/Timeout parameters are optional in interactive mode, but required in non-interactive mode.

To use the default values for the Port and Timeout parameter, use a '-' as value.
Ex: FlexRAIDClient localhost - - run C:\cmds\create.txt

For the non-interactive mode, the "Command" parameter represents the command you would normally type in interactive mode.
In the previous example, the bolded text is the command.

In non-interactive mode, the client will return an exit-code that you can make use of in your script.

Exit-Codes:

SUCCESS = 0

STATE_PROCESSING = 100
STATE_RESUMING = 101
STATE_PAUSING = 102
STATE_RESUMING_TO_ABORT = 103
STATE_ABORTING = 104
STATE_PAUSED = 105
STATE_ABORTED = 106

MISSING_COMMAND_FILE_TO_RUN = -100
MISSING_COMMAND_FILE_TO_UPLOAD = -101

COMMAND_NOT_SUPPORTED_IN_INTERACTIVE_MODE_PREFIX = -200
COMMAND_NOT_SUPPORTED_IN_INTERACTIVE_MODE_POSTFIX = -201
COMMAND_NOT_SUPPORTED_IN_INTERACTIVE_MODE_CONNECT = -202

VALIDATE_ALERT_HAS_CORRUPTED_CHANGED_DELETED = -300
VALIDATE_ALERT_HAS_CORRUPTED_CHANGED = -301
VALIDATE_ALERT_HAS_CORRUPTED_DELETED = -302
VALIDATE_ALERT_HAS_CHANGED_DELETED = -303
VALIDATE_ALERT_HAS_CORRUPTED = -304
VALIDATE_ALERT_HAS_CHANGED = -305
VALIDATE_ALERT_HAS_DELETED = -306

NO_RESPONSE_RECEIVED = -400

ERROR_AN_ERROR_HAS_OCCURRED = -500
ERROR_AN_EXCEPTION_HAS_OCCURRED = -501
ERROR_INVALID_TASK = -510
ERROR_INVALID_COMMAND = -520
ERROR_INVALID_PARAMETERS = -530
ERROR_INVALID_PARAMETERS_FOR_UPLOAD_COMMAND = -531
ERROR_INVALID_PARAMETERS_FOR_RUN_COMMAND = -532
ERROR_INVALID_PARAMETERS_FOR_MAX_COMMAND = -533
ERROR_NOT_YET_IMPLEMENTED = -540
ERROR_NOT_YET_SUPPORTED = -550
ERROR_NON_EXISTENT_ELEMENT = -560
ERROR_NO_SUCH_PROCESS_ID = -561
ERROR_NO_COMMAND_SPECIFIED = -570
ERROR_CONCURRENT_PROCESS_NOT_ALLOWED_ON_THE_SAME_CONFIG = -580
ERROR_VALIDATION_ERROR = -590

Sample script 1:

Sample script 2:

rem Here we start the host
cd "C:\Program Files\OpenEgg.org\FlexRAID Basic Host Service 1.0"
C:
start /min FlexRAID

rem This here is to wait for the host to finish starting - waiting 3 seconds
@ping 127.0.0.1 -n 3 -w 1000> nul

rem Now we switch to the command-line client
cd "C:\Program Files\OpenEgg.org\FlexRAID Basic CMD Client 1.0"
C:

set myhost=localhost
rem '-' means use the default value (9595)
set myPort=-
rem '-' means use the default value (2000 - [in milliseconds])
set myTimeOut=-
set configFile=C:\cmds\config.txt
set create=%configFile% create
set update=%configFile% rsynch
set validate=%configFile% validate
set quick-validate=%configFile% quick-validate
set verify=%configFile% verify
set cmdStart=FlexRAIDClient %myhost% %myPort% %myTimeOut%
set logFile=C:\logs\myLog.txt

%cmdStart% run %update% >> %logFile%
IF %ERRORLEVEL% GTR 0 goto report

rem This will block until the task has completed
%cmdStart% monitor >> %logFile%

:report
rem IF %ERRORLEVEL% GTR 0 (
rem call sendEmail "me@email.com" "my ERROR message" %ERRORLEVEL%
rem goto done 
rem )

rem IF %ERRORLEVEL% EQU 0 (
rem call sendEmail "me@email.com" "my SUCCESS message"
rem )

:done
%cmdStart% shutdown-server >> %logFile%

Where config.txt would contain something like (see command templates package for more info):

Are you referring to 009?

And is this something to be used on schedulers, right?

This message was edited 5 times. Last update was at 06/01/2009 07:58:05

gorman wrote:Are you referring to 009?

And is this something to be used on schedulers, right?

This will be on the command line clients.
There multiple parts to FlexRAID:

- A Host service: currently at RC 3 build 008 (009 released to select users)
- A Web UI client: currently at build 3
- A DOS/Shell client: currently at RC2 build 001

The next release of the DOS/Shell client will have the stated feature.
Currently, you can only use the DOS/Shell client in interactive mode (you cannot script against it).

The non-interactive mode will be useful for those not wanting to use the Web UI but wanting to automate/manage FlexRAID through a script and their own scheduler/tool of choice.

The Web UI has a lot of features including a very good scheduler and e-mail alerts.
However, some users might prefer a more "lightweight" client configuration.

For instance, you will able to create a simple script (DOS script in this example) as follow:

Of course, there will be full documentation of how to use the DOS/Shell clients in non-interactive mode along with the full list of error and status codes.

Another thing to add is that, you could have a file monitoring tool kick off the parity update script.

Some users have expressed the idea of kicking off the parity update task (rsynch) when data changes are detected.
Those users could use a tool like FileMon for Windows to detect data changes and kick off the script.

On that note, is there a .NET developer here willing to go through this article(http://articles.techrepublic.com.com/5100-10878_11-6165137.html) and create a nice disk/folder monitoring tool for us?

I'd just like to add that for anyone that wants to get an email everytime your rsynch or whatnot failed, use the script below:

Put the above code, edited of course, in a .vbs file and call it within the script Brahim posted at the top of this thread. Now, every time the exit code is greater than 0 (error), I get an email so I can investigate further.

Cool stuff.

Nice and very clean.

This message was edited 1 time. Last update was at 21/03/2010 14:34:11

I'm having hard time getting my script to work.

What is the correct extension I should be using? .bat .cmd?

I've created the below script:

cd "C:\Program Files(x86)\OpenEgg.org\FlexRAID Basic CMD Client 1.0"
c:
set myhost=localhost
rem '-' means use the default value (9595)
set myPort=-
rem '-' means use the default value (2000 - [in milliseconds])
set myTimeOut=-
set cmdStart=FlexRAIDClient %myhost% %myPort% %myTimeOut%
set logFile=C:\logs\myLog.txt
%cmdStart% run C:\cmd\quick-validate.txt >> %logFile%

If I type all of the above lines in a cmd window, it works without a problem and I'll get an entry in the log file.

But when I try to run the .bat or .cmd nothing happens.

Did you check that the host did not receive the command?

If you run the script by just double clicking, then you might need to pause it to see the output.
Otherwise, it will run quickly and close the window.

You are not monitoring the task.
So, your script essentially just sends the command and exists.

I ended up trying the webclient again (I couldn't get it to work previously) and it worked. It could have been that I changed from FlexRAID 1.2 to 1.3 or that I re-downloaded the webclient package.

All I had to do was import my .meta file and then setup a schedule and it's working without a hitch. Even have the email functionality working. The webclient is definitely a nice feature.