* ==================================================================== * Tivoli Storage Manager * Storage Agent * Version 5, Release 2 * 5698-ISE (C) Copyright IBM Corporation, 2001, 2003 All Rights Reserved. * ==================================================================== * Storage Agent Options File (dsmsta.opt.smp) * Platform: Sun Solaris * * This file contains descriptions of all the options you can set * in the server options file. * Use this file as a quick reference or to customize your options files. * You can copy sample options from this file to your server options file. * * Understanding the Syntax for Entering Options * --------------------------------------------- * Options consist of keywords and their values. * * If the option is supported in an options file, an example is * shown with the following syntax: * * OPTION Parameter * * Keywords name the option. You can enter the entire keyword or * the abbreviation, which is identified by uppercase characters. * To enter an option in an options file, enter the option name * followed by one or more blank spaces, followed by option * parameters. When editing an options file, follow these guidelines: * * - Options can begin in any column of the input line. * - Only one option can be on each line, and the option cannot * span more than one line. * - Keywords can be in uppercase or lowercase characters. The * minimum abbreviation is shown in uppercase characters. * - One or more blank spaces are allowed between keywords and values. * - Blank lines are allowed in the file and are interpreted * as comment lines. * - Lines beginning with an asterisk (*) are interpreted as * comment lines. * - File names must be correctly specified, as required by * your operating system. * * Verification of Selected Options * --------------------------------------------- * At server initialization, the server reads the server options file. * If you make any changes to the server options file, you must stop * and then start the server to have the server read the updated * options file. * * During server initialization, the server will process the server * options file and will display a warning message for any unknown * option that is encountered. No warning messages will be displayed * when the server recognizes all options in the server options file. * * After the server is running, you can issue the command: * * query option * * to see a list of all of the options that are in effect. * * ==================================================================== * Choosing Communication Method(s) * * To bring up the storage agent with no communicatons method, specify * * COMMmethod NONE * * Otherwise, for each communication method to be used, specify * COMMmethod TCPIP COMMmethod SHAREDMEM * * Note that the option file can include a set of communication * method options. If COMMmethod NONE is included in the set * it will override all other communication options. * * Example - To use both TCPIP and SHAREDMEM, specify * COMMmethod TCPIP * COMMmethod SHAREDMEM * * ==================================================================== * Setting Communication Method Options * * Use the following options to set communication options: * * ===================================================================== * * TCPIP * * ******************************************************************** * TCPport * * Specifies the TCP/IP port address of an ADSM storage agent. * * Syntax * +------------------+----------------------------------------------+ * | TCPport | port_addr | * +------------------+----------------------------------------------+ * * Parameters * port_addr Specifies the port address. The default is 1500. * You can specify a value from 1024 to 32767. * Contact your system administrator for this value. * * Examples TCPPort 1502 * * Note: TCPADMINPort also defaults to 1500; If both TCPADMINPort and * TCPport default to or are set to the same value, a single thread * handles communications with both client and server sessions. * If they differ, the port set with the TCPADMINPort option is * is restricted to administrative ( and server-server ) communications. * In this case, administrative ( and server-server ) communications * are still allowed to use the port set with the TCPport option, * but non-administrative client sesssions may not use the port * specified with the TCPADMINPort option. * Administrative client sessions, i.e., client session for which * a node-administrator userid is used, may use the port specified * with the TCPADMINPort option. * * ===================================================================== * * ******************************************************************** * TCPADMINPort * * Specifies a TCP/IP port restricted to administrative-type sessions * * Syntax * +------------------+----------------------------------------------+ * | TCPADMINPort | port_addr | * +------------------+----------------------------------------------+ * * Parameters * port_addr Specifies the port address. The default is 1500. * You can specify a value from 1024 to 32767. * Contact your system administrator for this value. * * Examples * TCPADMINPort 1500 * * Note: TCPport also defaults to 1500; If both TCPADMINPort and * TCPport default to or are set to the same value, a single thread * handles communications with both client and server sessions. * If they differ, the port set with the TCPADMINPort option is * is restricted to administrative ( and server-server ) communications. * In this case, administrative ( and server-server ) communications * are still allowed to use the port set with the TCPport option, * but non-administrative client sesssions may not use the port * specified with the TCPADMINPort option. * Administrative client sessions, i.e., client session for which * a node-administrator userid is used, may use the port specified * with the TCPADMINPort option. * * * ********************************************************************** * * TCPWindowsize * * Specifies the amount of data to send or receive * before TCP/IP exchanges acknowledgements with the client node. * This actual window size that is used in a session will be the * minimum size of the storage agent and client window sizes. * Larger window sizes may improve performance * at the expense of memory usage. * * * Syntax * +------------------+----------------------------------------------+ * | TCPWindowsize | window_size | * +------------------+----------------------------------------------+ * * Parameters * window_size Specifies the TCP/IP windowsize in kilobytes. * You can specify a value from 0 to 2048. * 0 indicates that the default window size set * for AIX should be used. Values from 1 to 2048 * indicate that the window size is in the * range of 1K to 2M. * The default window size is 0 which indicates * that ADSM should accept the AIX default window * size. * * * Examples * TCPWindowsize 16 * * ******************************************************************** * TCPNODELAY * * * Specifies whether the storage agent should send small amounts * of data or allow TCP/IP to buffer the data. * Disallowing buffering may improve throughput at the expense * of more packets being sent over the network. . * * * Syntax * +------------------+----------------------------------------------+ * | TCPNODELAY | YES | NO | * +------------------+----------------------------------------------+ * * Parameters * YES Specifies that TCP/IP should not buffer small * ADSM messages. * * NO Specifies that TCP/IP should buffer small * ADSM messages * * The default value is YES. * * Examples * TCPNODELAY YES * * * ===================================================================== * SHAREDMEM * * ******************************************************************** * SHMPort * * Specifies the TCP/IP port address on which this ADSM storage agent will * accept shared memory communications connections. * * Syntax * +------------------+----------------------------------------------+ * | SHMPort | port_addr | * +------------------+----------------------------------------------+ * * Parameters * port_addr Specifies the port address. The default is 1510. * You can specify a value from 1024 to 32767. * Contact your system administrator for this value. * * Examples * SHMPort 1510 * * * ===================================================================== * Section II -- Options common to all ADSM storage agents * ==================================================================== * * * MAXSESSIONS * * ******************************************************************** * MAXSessions * * Specifies the number of simultaneous client sessions. * * Syntax * +------------------+----------------------------------------------+ * | MAXSessions | value | * +------------------+----------------------------------------------+ * * Parameters * value Specifies the number of simultaneous client * sessions. The minimum value is 2 and the * default value is 25. * * Examples * MAXSessions 25 * * ===================================================================== * DEVCONFIG * * Specifies the name of a file that should contain device * configuration information when it is changed by the storage agent. * Device configuration information is used by the * storage agent processes during storage agent database recovery or load and * DSMSERV DUMPDB processing. * * More than one of these parameters may be specified to record * device configuration information to multiple files. * * Syntax * +------------------+----------------------------------------------+ * | DEVCONFig | filename | * +------------------+----------------------------------------------+ * * Parameters * filename - a fully-qualified file name * to which the storage agent is to automatically * record device configuration * information when it changes. * ===================================================================== * * EVENTSTORAGE AGENT * * Specifies whether, at startup, the storage agent should try to contact the event * storage agent. * * Syntax * +-------------------+-----+----+ * | EVENTStorage Agent | YES | NO | * +-------------------+-----+----+ * * Parameters: * Yes Specifies that, at startup, the server tries to * contact the event server. Contact occurs only if * a DEFINE EVENTSERVER command has already been * issued. * No Specifies that, at startup, the server does not * try to contact the event server. * * The default value is YES. * * Examples * EVENTSERVer YES * *============================================================================== * * TXNGROUPMAX * * Specifies the maximum number of files transferred as a group between * the client and storage agent. * * Syntax * +------------------+----------------------------------------------+ * | TXNGroupmax | value | * +------------------+----------------------------------------------+ * * Parameters * value Specifies the maximum number of files that are * transferred as a group between the client and * storage agent. The minimum value is 4 and the maximum * value is 256. The default value is 40. * * Examples * TXNGroupmax 40 * * ===================================================================== * * STAMaxpooledsessions * * Specifies the number of open sessions that the storage agent will * keep open with the server. The default is 25 sessions. If the * value is set to 0, sessions are not pooled. Maximum value is 50. * Sessions opened by the storage agent to the server are closed when * operations are completed. * * Syntax * +----------------------+-----------------------------------------+ * | STAMaxpooledsessions | number | * +----------------------+-----------------------------------------+ * * Parameters * number - The number of sessions which * are to be kept open between the * storage agent and server for * use as the need arises. * devconfig devconfig SERVERNAME TSMDEV SERVERNAME TSMPROD SERVERNAME TSMPROD