HSI Command Line

The HSI command line has the following format:


  hsi [options] [command [;command [;...]]]


If the optional command-string is specified, HSI is said to be running in one-liner mode.  In this mode, HSI will execute the command-string (which may consist of multiple semicolon-separated commands), and then terminate.


Command line options are as follows:


 -help ..................... Displays a built-in synopsis of HSI usage.  If used as the only command line option, HSI exits instead of entering interactive mode.


 -? ........................ Same as -help


 -a accountID | accountName.. Specifies the account ID or account name to be used for creating new files and directories. 


 -A auth_mechanism .......... Specifies the authentication mechanism to be used when HSI starts up.  Only authentication mechanisms that are available on both the client and HSI Gateway Server can be used successfully.  Valid mechanisms are:
      
combo - user name and password will be used.  If the site uses RSA SecurID one-time passwords, the password is the current OTP setting. Note:  the deprecated "dce" authentication mechanism is still recognized as an alias for the "combo" mechanism, but its use should be discontinued, as it will be removed in a future release.


        kerberos - specifies that MIT kerberos will be used for authentication


        keytab - specifies that a Unix or Kerberos-style keytab will be used for authentication.


        gsi - specifies that the Globus GSI certificate protocol will be used.



        local - (AIX only) - this protocol is used for sites that allow users to authenticate using their AIX (or LDAP) passwords on the HSI Gateway Server machines.


 -c cred_file............... Specifies the credentials cache file to be used if kerberos authentication is used.


 -d debug_level ............ Specifies debugging level to enable when HSI starts up.  debug_level is an integer value between 0 and 4.  Level 0 (the default) specifies no debugging, levels 1-4 specify successively higher debug levels.  In general, the HSI debugging output is useful only to the developers for troubleshooting problems.


 -e ........................ "Echo" flag. If enabled on the command line, or by the "echo" command, HSI will display command lines that are read from IN files


 -E editor-style  ........... Specifies the editing style to be used when editing command lines. editing-style is either vi or emacs.  The default, if not specified in the .editrc file, is "-E vi".  Note that this option is effective only if HSI was built with line-editing enabled.


 -G globus_grid_proxy_path .. If Globus GSI authentication is used for authentication, (for example, if -A gsi is specified), this option can be used to specify an alternative path to the proxy created by the grid-proxy-init command.


 -g GID | groupName.. Specifies the group ID or group name to be used after login has completed.  [hsi 3.5.4 or later]


 -h hostname .......... Directs HSI to attempt to connect to hostname,  which can be either a name or an IP address. 


 -k keytab_path ............. If keytab authentication is used for authentication, the path to the keytab file can be specified by this option.  [Note:  the keytab file will not be used by HSI if it has other than <owner> permissions.]


 -l login_name .............. This option can be used to specify the user's login name.  The normal default is to use the local login name for the client host on which HSI is being run.  The default login name can also be specified in the user's .hsirc file, or as a pattern in the global hsirc file for the client host.


 -O pathname ................ This option is intended for use by applications  that run HSI via the "system" or "popen" calls.  It causes HSI to:


1. Force one-liner mode (no input will be read interactively via stdin)

2. write all output that would normally be written to the TTY or stderr to the file specified by pathname.  


The option takes effect immediately, so it should normally be the first option on the command line if it is used, in order to capture any messages related to parsing the command line.  It also causes the "quiet" flag to be set (disabling extraneous messages from being displayed, such as the message-of-the-day), and the "verbose" command response flag to be disabled.  In addition, it causes all interactive file-transfer progress messages to be disabled.


 -o ......................... overrides the <no-login>  flag, if set by the HPSS administrator.  This option can only be used by root.  It is deprecated, and will be removed in a future release.

 -P .........................- popen command mode. This option is similar to the -O option, but causes all output to be directed to stdout, which is normally redirected to a process that starts HSI with the popen(3) system call.  It also results in setting "quiet" (no extraneous messages) mode, disabling verbose response message, and disabling interactive file transfer messages.


 -p port .................... Specifies the port number to be used when connecting to the HSI Gateway Server.  This option is only effective if the -h hostname parameter is also specified.


 -q ......................... Enables "quiet" mode.  In this mode, extraneous messages such as the interactive file transfer progress messages, as well as the startup "Message of the Day" are not displayed.


 -s site_name ............... Specifies the global or private hsirc stanza name to be used. site_name must match the name of one of the stanzas in either the global hsirc file, or the user's private $HOME/.hsirc file.


 -V ......................... Prints HSI version information without requiring a connection to the HSI Gateway Server.  If used as the only command line option, HSI exits instead of entering interactive mode.


 -v ......................... Enables verbose mode for command output.  Verbose mode is used for printing markers to the listable output file when performing operations such as recursive puts or gets.