SRM-LS

BeStMan Copyright (c) 2007,2008,2009, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy).� All rights reserved.

If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Technology Transfer Department at [email protected] �and [email protected].

NOTICE.� This software was developed under partial funding from the U.S. Department of Energy.� As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, prepare derivative works, and perform publicly and display publicly.� Beginning five (5) years after the date permission to assert copyright is obtained from the U.S. Department of Energy, and subject to any subsequent five (5) year renewals, the U.S. Government is granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so.

For the end user license agreement file for BeStMan for non-commercial research use, go to http://datagrid.lbl.gov/bestman/license-nc.html.

For the end user license agreement file for BeStMan for commercial research use, go to http://datagrid.lbl.gov/bestman/license-c.html.

1 Introduction

SRM client tools are full implementations of SRM v2.2 as generic SRM v2.2 clients, developed by Lawrence Berkeley National Laboratory. They have been tested for all current SRM v2.2 implementations such as BeStMan, CASTOR, dCache, DPM, SRM/iRODS-SRB and StoRM. They are continuously being tested for compatibility and interoperability.

It�s a java implementation that would run on any OS platforms, and currently supports gsiftp, http, https and ftp as its file transfer protocols.

It requires the minimal administrative efforts on the deployment and maintenance.

SRM v2.2 specification can be found on http://sdm.lbl.gov/srm-wg/doc/SRM.v2.2.html.
SRM client downloads and instructions can be found on http://datagrid.lbl.gov/bestman.

2 Requirements

� SUN Java 1.5.0_12 or IBM Java 1.5 or higher versions such as 1.6.0_07.

� Valid user grid proxy

3 Installation

� Refer to SRM Client User�s Guide.

4 Configuration, configuration options, configuration file and notes

� Refer to SRM Client User�s Guide.

5 SRM-LS

srm-ls handles directory or file browsing and retrieves information.

5.1 Usage

� srm-ls� <source_url> �[command line options]

� srm-ls �-f <input_file> [command line options]

5.2 Options

� Command line options take priority from the options from conf file.

� Options in the following table are in alphabetical order

-authid <string>	� Authorization� ID to be used in SRM for the request
-conf <path>	� Path to the configuration file. � Command line options will override the options from conf file
-connectiontimeout <int>	� Specifies time in seconds to wait for soap or gsi connection before timing out. � Default=1800
-count <int>	� Specifies count in case there are too many listing � Default=0
-debug	� Specifies debugging output � Default=false
-delegation <true\|false>	� Force proxy delegation. � When not provided, srm-ls automatically handles proxy delegation based on the source URLs. � When -delegation is provided, it overrides the automatic handling and forces the user choice.
-f <path>	� Path to the xml input file containing the source url, target url information for requests with more than one file � Refer to the format and an example in 6.3
-filestoragetype <p \| d \| v>	� Indicates file storage type � p - Permanent, d - Durable, v - Volatile � Default=null
-fulldetailed	� Specify to request detailed information on the source url � Default=false
-help	� Show the help message
-log <path>	� Specifies path to log file � Default=./srmclient-event-date-random.log
-numlevels <int>	� Specifies the number of levels of recursiveness � Default=1
-offset <int>	� Specifies offset in case there are too many listing � Default=0
-proxyfile <path>	� Path to user grid proxy
-quiet	� Suppress output in the console. � This option writes the output to the log file.
-recursive	� Specifies recursive listing with -ls option � Default=false
-renewproxy	� Enables automatic proxy renewal upon expiration � Works only when -usercert and -userkey are provided � Default=false
-report <path>	� Specifies path to full report output.
-s <source_url>	� Source URL for file or directory
-serviceurl <ws_endpoint>	� Full web service endpoint � Required when source url or target url does not contain web service endpoint information
-statusmaxtime <int>	� Max time before status checks get timed out, in seconds � Default=600
-statuswaittime <int>	� Wait time delay between status check, in seconds � Default=30
-storageinfo	� extra storage access information � Default=false � For BeStMan supporting MSS, a formatted input separated by comma is used with following keywords when necessary: for:<source\|target\|sourcetarget>,login:<string>,passwd:<string>, projectid:<string>,readpasswd:<string>,writepasswd<string>
-submitonly	� Enables request submission only. � Default=false � When provided, srm-ls exits after the request submission. Otherwise, it continues checking status until it is timed out or gets return status.
-usercert <path>	� Path to user grid certificate
-userkey <path>	� Path to user grid certificate key
-xmlreport <path>	� Specifies path to short output report in XML format.

5.3 Notes

� srm client makes no proxy delegation by default, and automatically handles proxy delegation based on the source urls. A user can override the automatic handling by providing an option �-delegation� (or �-delegation true�) to force the delegation, and �-delegation false� to force no delegation. �-debug� option would show how the delegation is done on the output.

5.4 Input file format

<?xml version="1.0" encoding="UTF-8"?>

� <file>

�� <sourceurl>Source_URL</sourceurl>

� </file>

</request>

� Example 1 : LS operation

<?xml version="1.0" encoding="UTF-8"?>

� <file>

�� <sourceurl>srm://bestman.lbl.gov:8443/srm/v2/server?SFN=/mydir/mypath/myfile</sourceurl>

� </file>

</request>

5.5 Examples

5.5.1 Browse a file in SRM server

1. srm-ls srm://host:port/wsept\?SFN=/source_filepath
This command retrieves the file info from SRM or from the file system that SRM can access to. Click here for the sample output.

1.1. srm-ls srm://bestman.lbl.gov:8443/srm/v2/server\?SFN=/srmcache/guest/test.data

5.5.2 Browsing a directory in SRM server

1. srm-ls� srm://host:port /wsept\?SFN=/source_dirpath

This command retrieves the directory info from SRM or from the file system that SRM can access to. Click here for the sample output.

1.1. srm-ls� srm://bestman.lbl.gov:8443/srm/v2/server\?SFN=/srmcache/guest/dir�

2. srm-ls� srm://host:port /wsept\?SFN=/source_dirpath -recursive

This command retrieves the directory info recursively from SRM or from the file system that SRM can access to. Click here for the sample output.

2.1. srm-ls� srm://bestman.lbl.gov:8443/srm/v2/server\?SFN=/srmcache/guest/dir� \
�� -recursive

5.5.3 Browsing a file in gridftp server

1. srm-ls� gsiftp://host:port//target_filepath

This command retrieves the file information from the gridftp server. Click here for the sample output.

1.1. srm-ls �gsiftp://gridftphost.lbl.gov//data/path/test.data

5.5.4 Browsing a directory in gridftp server

1. srm-ls� gsiftp://host:port//source_dirpath�

This command retrieves the directory info from the gridftp server. Click here for the sample output.

1.1. srm-ls� gsiftp://gridftphost.lbl.gov//data/path/source.dir

2. srm-ls� gsiftp://host:port//source_dirpath� -recursive

This command retrieves the directory info recursively from the gridftp server. Click here for the sample output.

2.1. srm-ls �gsiftp://gridftphost.lbl.gov//data/path/source.dir� -recursive

5.5.5 Browsing a local file

1. srm-ls� file:////target_filepath

This command retrieves the file information from the local file system. Click here for the sample output.

1.2. srm-ls� file:////data/path/test.data

5.5.6 Browsing a local directory

1. srm-ls� file:////source_dirpath�

This command retrieves the directory info from the local file system. Click here for the sample output.

1.2. srm-ls� file:////data/path/source.dir

2. srm-ls� file:////source_dirpath� -recursive

This command retrieves the directory info recursively from the local file system. Click here for the sample output.

2.1. srm-ls� file:////data/path/source.dir� -recursive

6 Exit codes

When SRM client commands exit, they have exit codes as following:

0	SRM_SUCCESS
51	SRM_FAILURE
52	SRM_AUTHENTICATION_FAILURE
53	SRM_AUTHORIZATION_FAILURE
54	SRM_INVALID_REQUEST
55	SRM_INVALID_PATH
56	SRM_FILE_LIFETIME_EXPIRED
57	SRM_SPACE_LIFETIME_EXPIRED
58	SRM_EXCEED_ALLOCATION
59	SRM_NO_USER_SPACE
60	SRM_NO_FREE_SPACE
61	SRM_DUPLICATION_ERROR
62	SRM_NON_EMPTY_DIRECTORY
63	SRM_TOO_MANY_RESULTS
64	SRM_INTERNAL_ERROR
65	SRM_FATAL_INTERNAL_ERROR
66	SRM_NOT_SUPPORTED
67	SRM_REQUEST_QUEUED
68	SRM_REQUEST_INPROGRESS
69	SRM_REQUEST_SUSPENDED
70	SRM_ABORTED
71	SRM_RELEASED
72	SRM_FILE_PINNED
73	SRM_FILE_IN_CACHE
74	SRM_SPACE_AVAILABLE
75	SRM_LOWER_SPACE_GRANTED
76	SRM_DONE
77	SRM_PARTIAL_SUCCESS
78	SRM_REQUEST_TIMED_OUT
79	SRM_LAST_COPY
80	SRM_FILE_BUSY
81	SRM_FILE_LOST
82	SRM_FILE_UNAVAILABLE
83	SRM_UNKNOWN_ERROR
90	Connection refused
91	GSI mapping not found
92	General unpredictable exception
93	Input error
94	Other error, not reached SRM yet
100	SRM returned no status, but it is a failure

7 Troubleshooting

� When a large LS request is submitted or expected, the srm-ls may not fill all request or status information into the memory. It is mostlikely because the memory size of the java virtual machine.� In such case, you can increase the size of the virtual machine in srm-ls by -Xmx###M, where # is the amount of memory which you want to allocate in megabytes. E.g. java �Xmx512M

� For memory conscious jobs, �-lite� option is provided to use less memory to handle the user request. The option the passes -Xms32M to the virtual machine.

8 See Also

srm-ls-status, srm-dir