AppSuite:Resource management

Revision as of 17:58, 16 December 2012 by Tierlieb (talk | contribs)

The createresource tool allows to create a new resource within a given context.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <string>The id of the context
-n,--name <string>The resource name
-d,--displayname <string>The resource display name
-a,--available <true/false>Toggle resource availability
-D,--description <string>Description of this resource
-e,--email <string>E-Mail of this resource

Extra parameters when authentication is enabled

-A,--adminuser <string>Context Admin user name
-P,--adminpass <string>Context Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

contextid {adminuser adminpass} name displayname email

Command output

On success:

resource <resourceid> in context <contextid> created

On failure:

resource in context <contextid> could not be created: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/createresource -c 123 -n "laptop" -d "Super laptop" -D "laptop for rent" -e "laptop@example.com"

resource 6 in context 123 created


deleteresource

The deleteresource tool allows to delete a resource within a given context.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the context
-i,--resourceid <integer>Id of this resource
-n,--name <string>The resource name

Extra parameters when authentication is enabled

-A,--adminuser <string>Context Admin user name
-P,--adminpass <string>Context Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

contextid {adminuser adminpass} (name or resourceid)

Command output

On success:

resource <resourceid> in context <contextid> deleted

On failure:

resource <resourceid> in context <contextid> could not be deleted: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/deleteresource -c 123 -i 6

resource 6 in context 123 deleted


listresource

The listresource tool allows to list and search for resources within a given context.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the context
--csvFormat output as csv
-s,--searchpattern <string>The search pattern which is used for listing

Extra parameters when authentication is enabled

<colgroup><col><col></colgroup>
-A,--adminuser <string>Context Admin user name
-P,--adminpass <string>Context Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

contextid {adminuser adminpass}

Command output

Standard output:

idnamedisplaynamedescriptionemailavailable
6laptop"Super Laptop""laptop for rent"laptop@example.comtrue

csv output:

id,name,displayname,email,available

Example

root@oxhe~# /opt/open-xchange/sbin/listresource -c 123

idnamedisplaynamedescriptionemailavailable 
6laptop"Super Laptop""laptop for rent"laptop@example.comtrue 


changeresource

The changeresource tool allows to change a resource within a given context.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the context
-i,--resourceid <integer>Id of this resource
-n,--name <string>The resource name
-d,--displayname <string>The resource display name
-a,--available <true/false>Toggle resource availability
-D,--description <string>Description of this resource
-e,--email <string>Email of this resource

Extra parameters when authentication is enabled

-A,--adminuser <string>Context Admin user name
-P,--adminpass <string>Context Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

contextid {adminuser adminpass} (resourceid or name ) and at least one attribute to change

Command output

On success:

resource <resourceid> in context <contextid> changed

On failure:

resource <resourceid> in context <contextid> could not be changed: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/changeresource -c 123 -i 6 -D "old Laptop"

resource 6 in context 123 changed