Open-Xchange™ OX6
		Next

Open-Xchange™ OX6

Provisioning

Copyright © 2006-2012 OPEN-XCHANGE Inc. , This document is the intellectual property of Open-Xchange Inc., Tarrytown, NY, USA , The document may be copied in whole or in part, provided that each copy contains this copyright notice. The information contained in this book was compiled with the utmost care. Nevertheless, erroneous statements cannot be excluded altogether. Open‑Xchange Inc., the authors and the translators are not liable for possible errors and their consequences. The names of software and hardware used in this book may be registered trademarks; they are used without guarantee of free usability. Open-Xchange Inc. generally follows the spelling conventions of the manufacturers. The reproduction of brand names, trade names, logos etc. in this book (even without special marking) does not justify the assumption that such names can be considered free (for the purposes of trademark and brand name regulations)Please direct any recommendations or comments to documentation@open-xchange.com

Tuesday, 19 June 2012 v6.20.5

Table of Contents

Open-Xchange™ Server 6 - Command Line Tools

1 Command line Tools (CLTs)
2 Environment variables

1 Context management

1.1 createcontext

1.1.1 Parameters
1.1.2 Extra parameters when authentication is enabled
1.1.3 Return value
1.1.4 Mandatory parameters
1.1.5 Command output
1.1.6 Example

1.2 deletecontext

1.2.1 Parameters
1.2.2 Extra parameters when authentication is enabled
1.2.3 Return value
1.2.4 Mandatory parameters
1.2.5 Command output
1.2.6 Example

1.3 listcontext

1.3.1 Parameters
1.3.2 Extra parameters when authentication is enabled
1.3.3 Return value
1.3.4 Mandatory parameters
1.3.5 Command output
1.3.6 Example

1.4 disablecontext

1.4.1 Parameters
1.4.2 Extra parameters when authentication is enabled
1.4.3 Return value
1.4.4 Mandatory parameters
1.4.5 Command output
1.4.6 Example

1.5 disableallcontexts

1.5.1 Parameters
1.5.2 Extra parameters when authentication is enabled
1.5.3 Return value
1.5.4 Mandatory parameters
1.5.5 Command output
1.5.6 Example

1.6 enablecontext

1.6.1 Parameters
1.6.2 Extra parameters when authentication is enabled
1.6.3 Return value
1.6.4 Mandatory parameters
1.6.5 Command output
1.6.6 Example

1.7 enableallcontexts

1.7.1 Parameters
1.7.2 Extra parameters when authentication is enabled
1.7.3 Return value
1.7.4 Mandatory parameters
1.7.5 Command output
1.7.6 Example

1.8 changecontext

1.8.1 Parameters
1.8.2 Extra parameters when authentication is enabled
1.8.3 Return value
1.8.4 Mandatory parameters
1.8.5 Command output
1.8.6 Example

1.9 getAdminId

1.10 existscontext

1.10.1 Parameters
1.10.2 Return value
1.10.3 Mandatory parameters
1.10.4 Command output
1.10.5 Example

2 User management

2.1 createuser

2.1.1 Parameters
2.1.2 Extended options
2.1.3 Open-Xchange module access
2.1.4 Extra parameters when authentication is enabled
2.1.5 Return value
2.1.6 Mandatory parameters
2.1.7 Command output
2.1.8 Example

2.2 deleteuser

2.2.1 Parameters
2.2.2 Extra parameters when authentication is enabled
2.2.3 Return value
2.2.4 Mandatory parameters
2.2.5 Command output
2.2.6 Example

2.3 listuser

2.3.1 Parameters
2.3.2 Extra parameters when authentication is enabled
2.3.3 Return value
2.3.4 Mandatory parameters
2.3.5 Command output
2.3.6 Example

2.4 changeuser

2.4.1 Parameters
2.4.2 Extended options
2.4.3 Access changes for existing users
2.4.4 Extra parameters when authentication is enabled
2.4.5 Return value
2.4.6 Mandatory parameters
2.4.7 Command output
2.4.8 Example

2.5 existsuser

2.5.1 Parameters
2.5.2 Return value
2.5.3 Mandatory parameters
2.5.4 Command output
2.5.5 Example

2.6 changeaccessglobal

2.6.1 Mandatory parameters
2.6.2 Optional parameters
2.6.3 Options
2.6.4 Example
2.6.5 RMI/SOAP calls

2.7 usercopy

2.7.1 Mandatory parameters
2.7.2 Example

3 Group management

3.1 creategroup

3.1.1 Parameters
3.1.2 Extra parameters when authentication is enabled
3.1.3 Return value
3.1.4 Mandatory parameters
3.1.5 Command output
3.1.6 Example

3.2 deletegroup

3.2.1 Parameters
3.2.2 Extra parameters when authentication is enabled
3.2.3 Return value
3.2.4 Mandatory parameters
3.2.5 Command output
3.2.6 Example

3.3 listgroup

3.3.1 Parameters
3.3.2 Extra parameters when authentication is enabled
3.3.3 Return value
3.3.4 Mandatory parameters
3.3.5 Command output
3.3.6 Example

3.4 changegroup

3.4.1 Parameters
3.4.2 Extra parameters when authentication is enabled
3.4.3 Return value
3.4.4 Mandatory parameters
3.4.5 Command output
3.4.6 Example

4 Resource Management

4.1 createresource

4.1.1 Parameters
4.1.2 Extra parameters when authentication is enabled
4.1.3 Return value
4.1.4 Mandatory parameters
4.1.5 Command output
4.1.6 Example

4.2 deleteresource

4.2.1 Parameters
4.2.2 Extra parameters when authentication is enabled
4.2.3 Return value
4.2.4 Mandatory parameters
4.2.5 Command output
4.2.6 Example

4.3 listresource

4.3.1 Parameters
4.3.2 Extra parameters when authentication is enabled
4.3.3 Return value
4.3.4 Mandatory parameters
4.3.5 Command output
4.3.6 Example

4.4 changeresource

4.4.1 Parameters
4.4.2 Extra parameters when authentication is enabled
4.4.3 Return value
4.4.4 Mandatory parameters
4.4.5 Command output
4.4.6 Example

5 Data management

5.1 deleteinvisible

5.1.1 Parameters
5.1.2 Extra parameters
5.1.3 Return value
5.1.4 Mandatory parameters
5.1.5 Command output
5.1.6 Example

Software License Agreement

		Next
		Open-Xchange™ Server 6 - Command Line Tools