How To Use The dsgetprop Command

Dsgetprop

Syntax: dsgetprop [options] [server | handle] property-spec

dslistprop [options] [server | handle]

dssetprop [options] [server | handle] property value

The three DocuShare property commands allow the administrator to inspect any DocuShare DSClass,

object, and object property value.

· The dsgetprop command returns the current value of the named property. Password related properties are excluded.

· The dslistprop command looks up the handle in the DocuShare database and returns a list of names for all readable properties associated with that handle. Use dslistprop to list classname properties.

· The dssetprop command replaces the current value of the named property with the value provided. Password related properties are excluded. These commands require a DocuShare handle, such as Collection-10 or User-23, as the first argument. If the handle or property cannot be found in the DocuShare database, the command will display a message stating that the handle or property cannot be found and then exits the command with a -1 status.

Options for dsgetprop

-h Help. Display command help text.

-l Level. Write the specified level (debug, trace, info, warn, error, fatal) message to the log file.

-q Quiet. Run the command in quiet mode. Suppresses all informational messages with user yes/no prompts. Assume Yes to all prompts and proceed at your own risk.

-u User. For dsgetprop and dssetprop only. Run the command as the specified user. Requires a user handle as an argument. By default, all commands run as the admin user, which gives them unrestricted rights and makes admin the author of any edit operations performed by the command. For example, specifying -u User-12 causes the command to run as User-12 instead of

admin.

Examples using dsgetprop

Note: If there is more than one property in the argument, the -q option is suppressed.

To display the document summary and the document owner:

dsgetprop -q Document-11 summary owner

To display the email address of the site server admin account:

dsgetprop Server adminEmail

To display the site server properties and associated values:

dsgetprop Server