Signiant Support

dds_browse usage notes and return codes Print


Summary

The dds_browse command is available on Signiant Managers in the Signiant 'bin' directory.  It is a command line utility that can be used to retrieve directory listings from Signiant Agents.  By default, this is located at /usr/signiant/dds/bin/dds_browse for Linux Managers and C:\Program Files\Signiant\Mobilize\bin\dds_browse.exe for Windows Managers.

Discussion

This article covers the basic features of the dds_browse command.  For more advanced options, run dds_browse -? from the command line.

The most common usage for dds_browse is to connect to a particular Signiant Agent and retrieve the directory listing for a specific directory, as follows:

dds_browse -node SigniantAgent -user GrantedUserId DirectoryName

The dds_browse command uses the Signiant protocol to retrieve this data.  As such, the Signiant Agent must grant access to the Manager to run jobs as the specified user.  Also, the manager will only be able to browse directories for which the granted user has access.  Finally, if the agent has a grant that limits the connection to a particular directory, only the contents of that directory (and its subdirectories) may be browsed.

The default behaviour is to list the full path to the files in the output.  To retrieve the names only, use the -basenames option as follows:

dds_browse -node SigniantAgent -user %dds_default_user% -basenames DirectoryName

Another common use of dds_browse is to retrieve a list of "root directories" on the agent.  This is particularly useful for Windows agents, where a list of available drive letters will be returned.  This is done with the following command:

dds_browse -node SigniantAgent -user GrantedUserId -showroot

The dds_browse command will send its output to the manager's standard output (most often the screen).  To redirect the output to a file, use the -out option:

dds_browse -node SigniantAgent -user %dds_default_user% -out agent.out DirectoryName

The output will contain the following information, with spaces between each item.  A line will be output for each entity found in the directory.  Each line will contain the following fields:
 
File Mask

A string of 6 numbers.  The first three numbers determine the type of entry, with the most common being 010 (file) and 004 (directory).  The remaining three numbers represent the permissions set for the file, in UNIX format (with an approximation of the Windows permissions for Windows remote agents).

 

File Size

The size of the file, in bytes

Last Modified Date

The last modified date, in YYYY/MM/DD format.

Last Modified Time

The last modified time, in hh:mm:ss format

File Name

The name of the file, including the path if the -

When using dds_browse from the command line, the following return codes are produced:
 
2 Scanning Error

One or more problems were encountered while scanning entries in the specified remote directory 

10

Parameter Error

An invalid option was specified on the command line.

11

Initialization Error

An unexpected error occured during initialization.  Using the -trace option may provide details on the failure.

12

Memory Allocation Error

The dds_browse command or the remote browsing process was unable to allocate enough memory for the operation.

13

OS Error
The operating system reports an unexpected error.

16

Prompt Error

An unexpected error occurred.  Using the -trace option may provide details on the failure.

19

Configuration File Error

The configuration file specified using the -O option is not correctly formatted

21

Abort Requested

The browse process received an abort request before operations were completed.

22

Internal Error

An unexpected error occurred.  Using the -trace option may provide details on the failure.

23

Process Start Error

An unexpected error occurred.  Using the -trace option may provide details on the failure.

30

Session Dead Error

An unexpected error occurred.  Using the -trace option may provide details on the failure.

33

Authorization Error

The agent does not accept connections from the manager OR the agent does not have a grant for the manager to operate as the specified user.

40

Version Mismatch

The manager and agent versions of the Signiant software are not compatible.

Additional Information

When running on a Linux manager and browsing a Windows agent, you should either use two backslash characters (\\) or a single forward slash (/) as your directory separator.  For example:

dds_browse -node SigniantAgent -user GrantedUserId c:\\data
dds_browse -node SigniantAgent -user GrantedUserId c:/data


The following shows sample output from the examples given in the Discussion section.

dds_browse -user %dds_default_user% -node sigagent1  c:/data
0040777 0 2010/10/01 15:14:27 c:\data
0100666 3880 2010/10/01 13:37:08 c:\data\file1.dat
0100666 2103 2010/10/01 13:37:08 c:\data\file2.dat
0100666 5358 2010/09/28 14:15:36 c:\data\file3.dat

dds_browse -user %dds_default_user% -node sigagent1 -basenames c:/data
0100666 3880 2010/10/01 13:37:08 file1.dat
0100666 2103 2010/10/01 13:37:08 file2.dat
0100666 5358 2010/09/28 14:15:36 file3.dat

dds_browse -user %dds_default_user% -node ottwsdmaki.ott.signiant.com -showroot
0040777 0 2010/10/01 15:17:45 c:\
0040777 0 2010/10/01 15:17:45 i:\