Full List of Commands and Options

Commands

Option

Options

Object

Function

Create

New

Add

 

Creates a new object

-r

-p

-f

-q

 

 

system

domain

account

remoteaccount

tables

backup

<name>

[<variable1>=<value1>

<variable2>=<value2>

<parameterN>=<valueN>]

service connectionstring

filename

Modify

Set

 

Change the properties of an object

-r

-p

-f

-q

 

system

domain

account

remoteaccount

storage

<name>

[<variable1>=<value1>

<variable2>=<value2>

<parameterN>=<valueN>]

1 (Convert to database Storage)

Delete

 

Delete an object

-r

-p

-f

-q

 

system

domain

account

remoteaccount

tables

<name>

 

 

 

service connectionstring

Display

Get

List

 

Display the selected properties of an object

 

 

 

-r

-p

-f

-q

 

 

 

 

 

system

domain

account

remoteaccount

service

 

 

userstatistics

 

 

<name>

[<variable1>

<variable2>

<parameterN>]

or

<mask> (e.g. * to display all properties and values)

fromdate

todate

filterstring

Check

Validate

 

Check the validity of a user account in accordance with the password policy

-r

-p

-f

-q

 

 

account

 

 

 

 

 

passpolicy

 

 

 

 

 

Search

 

Search the API for a string

 

 

string

 

 

 

Upgrade

 

Upgrade IceWarp Server's database to the latest version

 

 

<old version>

 

 

 

Export

Import

 

Export or Import data to a file

-r

-p

-f

-q

 

domain

account

remoteaccount

 

backup

<name>

[<variable1>

<variable2>

<parameterN>]

Filename

Options

Option

Function

-m (--template=) name

Applies an object template.

-m MyTemplate

-r (--remote=) info

Connects to a remote server.

-r=user,userpw,www.RemoteServer:32001[,"ssl"]

-p (--path=) dir

Path to the server directory.

-f (--filter=) value

Filter for objects.

--f="((U_Name like ''John%'')

OR (U_Name like ''George%''))

AND (U_AccountDisabled <> ''0'')"

-q (--quiet)

Runs in quiet mode.

-h (--help / -?)

Displays help.

-t (--tutorial)

Displays a short tutorial.

-v (--version)

Displays tool.exe version.