Back to BeStMan Client Tools User's Guide
BeStMan SRM-Client Tools User's Guide: Configuration and Notes
Configuration
- Change directory to the installed bestman-client/setup, and run configure with options.
- Minimum options is --enable-clientonly when other options use default values. configure --help to see options with default values.
- Upon successful running of configure, bestman-client/bin would be created with all necessary client commands.
Sample Configuration options
These below examples with the same configuration may not work for your environment. For each option, choose the value that fits your environment.
- Typical case where default values are used,
% configure --enable-clientonly
- From the above value example,
% configure \
--enable-clientonly \
--with-globus-tcp-port-range=62001,62999
- When CA certificate directory is not in usual place (/etc/grid-security/certificates),
% configure \
--enable-clientonly \
--with-cacert-path=/opt/osg/security/certificates \
--with-globus-tcp-port-range=62001,62999
- An example with an external globus location when available,
% configure \
--enable-clientonly \
--with-globus-tcp-port-range=62001,62999 \
--with-globus-location=/software/globus-4.2.1
Configure options
Upon successful configuration, bestman srm client tools would be created in bestman-client/bin.
Required options
| ---enable-clientonly |
Installation for SRM clients only (default=no). |
Other options
| --enable-backup |
Enable backup before running a new configuration if there is a previous configuration (default=no) |
| --enable-verbose |
Print output to the standard output during the configuration |
| --with-cacert-path=<PATH> |
Specify the Grid CA Certificate directory path (default=/etc/grid-security/certificates) |
| --with-java-home=<PATH> |
Specify the JAVA_HOME directory |
| --with-globus-location=<PATH> |
Specify the GLOBUS_LOCATION path |
| --with-globus-tcp-port-range=<VALUES> |
Specify the GLOBUS_TCP_PORT_RANGE when firewall is enabled. E.g. 62001,62999 |
| --with-max-java-heap=<INT> |
Specify the max java heap size in MB (default=1024) |
| --with-srm-home=<PATH> |
Installation path for BeStMan SRM-Client Tools. If not given, it will be guessed based on the current working directory. |
Configuration file
- BeStMan SRM client tools may use client configuration file to define default values for some command line options when the client configuration file is manually created.
- Client configuration file is from bestman-client/conf/srmclient.conf or from a desginated path as an option -conf to srm client commands.
- When a parameter is defined in the client configuration file, the corresponding values may not be provided in the command line. This is particularly useful when repeated commands are used.
- e.g. If SRM service port number and service handle is defined in the client configuration file as
ServicePortNumber=8443
ServiceHandle=/srm/v2/server
- Then, SURL can be srm://bestman.lbl.gov//mydir/myfile
- When the same parameter is provided in the command line with a different value, the command line value takes priority than one in the client configuration file.
- A sample client configuration file is in bestman-client/conf directory.
- Each entry in the configuration file has the following meaning.
Related to the SRM server connection control
| ServicePortNumber |
- Defines the default SRM service port number
|
| ^ |
e.g. ServicePortNumber=8443 |
| ServiceHandle |
- Defines the default SRM service handle
|
| ^ |
e.g. ServiceHandle=/srm/v2/server |
| ServiceURL |
- Defines the default SRM service endpoint
|
| ^ |
e.g. ServiceURL=srm://bestman.lbl.gov:8443/srm/v2/server |
- e.g. When the full SURL is srm://bestman.lbl.gov:8443/srm/v2/server?SFN=/mydir/mypath/myfile, it becomes srm://bestman.lbl.gov//mydir/mypath/myfile when ServicePortNumber and ServuceHandle are defined.
- e.g. A client command “srm-ls srm://bestman.lbl.gov:8443/srm/v2/server?SFN=/mydir/mypath/myfile” can be “srm-ls srm://bestman.lbl.gov//mydir/mypath/myfile” when ServicePortNumber and ServiceHandle are defined.
- e.g. A client command “srm-ping srm://bestman.lbl.gov:8443/srm/v2/server” can be “srm-ping” when ServiceURL is defined.
Related to the client file transfers
| BufferSize |
- Defines the default GridFTP buffer size
- Default=1048576
|
| ^ |
e.g. BufferSize=1048576 |
| Parallelism |
- Defines the default number parallel streams for GridFTP transfers
- Default=1
|
| ^ |
e.g. Parallelism=2 |
| dcau |
- Defines the default DCAU setting
- Default=true
|
| ^ |
e.g. dcau=false |
| NumRetry |
- Defines the default number of retries of file transfers when failed
|
| ^ |
e.g. NumRetry=5 |
| RetryDelay |
- Defines the default number of seconds to sleep aftger a file transfer failure before next file transfer try
|
| ^ |
e.g. RetryDelay=120 |
- Equivalent command line options are -buffersize, -parallelism, -dcau, -numretry and –retrydelay respectively.
Related to the request status check
| StatusWaitTime |
- Defines the default waiting time in seconds between checking status of a request
|
| ^ |
e.g. StatusWaitTime=120 |
| StatusMaxTime |
- Defines the default timeout in seconds for checking status of a request
|
| ^ |
e.g. StatusMaxTime=600 |
- Equivalent command line options are -statuswaittime and -statusmaxtime respectively.
Related to the space token
| SpaceToken |
- Defines the default space token to be used for all file requests
|
| ^ |
e.g. SpaceToken=ATLASUSERDISK1 |
Related to the user GSI settings
| ProxyFile |
- Defines the default user proxy path
|
| ^ |
e.g. ProxyFile=/tmp/x509up_u1234 |
| UserCert |
- Defines the default user certificate path
|
| ^ |
e.g. UserCert=/home/users/mylogin/.globus/usercert.pem |
| UserKey |
- Defines the default user certificate key path
|
| ^ |
e.g. UserKey=/home/users/mylogin/.globus/userkey.pem |
- When UserCert and UserKey are defined, user grid passphrase will be prompted on each request.
- When ProxyFile and UserCert/UserKey are defined, ProxyFile takes priority.
- Equivalent command line options are -proxyfile, -usercert and -userkey respectively.
