fscadmin.sh/.bat

Monitors and controls File Management System FSC servers. This can be used to check the status of a server, perform a shutdown, modify logging levels, query performance counters, or to clear or inspect caches. Syntax $FMS_HOME/fscadmin.sh [-h] [-k keyfile] [-s serveraddr] [-f tickets-file] [command] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -h Displays help for this utility. -k Specifies a file containing the encryption key required by this system. A key file is a text file containing an ASCII-HEX encryption key. This is generally the same key file referenced in the fmsmaster.xml file for this system. This argument is optional. Example: fscadmin -k site123keyfile.txt ./status Default: -s Specifies the protocol server for the FSC and the port you wish to communicate with. Example: fscadmin -s http://myserver:4445 ./status Default: http://127.0.0.1:4444 -f Specifies the name of the tickets file. command Command is a formatted string with the following fields: FSCID/FUNCTION[/SUBFUNCTION/…] FSCID The FSC with the given ID, as defined in the primary configuration, for which this command is intended. A period (.) can be used to indicate the local (current) FSC you are connecting to, as indicated by the -s parameter. FUNCTION [/SUBFUNCTION/…] The functions and subfunctions are enumerated in Function[/Subfunction/…] Details, later in this section. Example: fscadmin -s http://myserver:4445 ./status Example: fscadmin -s http://myserver:4445 ./log Default: ./status. Example: fscadmin -s http://myserver:4444 fsc123/log Environment The FSC_HOME variable must be set to a valid FMS server directory. The JAVA_HOME variable must be set to a valid Java SDK directory. Files fscadmin.properties (Optional) A property file used to configure proxy and SSL options if required by the fscadmin utility. fscadmin.properties.template A template of the available properties that can be set for the fscadmin utility. Restrictions You can route fscadmin commands to remote FSCs without having to specify that FSCs address on the command line. Input and output through the fscadmin utility is not localized. Commands are subject to change without notice. Function[/Subfunction/…] Details FUNCTION[/SUBFUNCTION] Description cachesummary Summary of the read and write caches (number of files, bytes, hits, misses). cachesummary/read Summary of the read cache. cachesummary/write Summary of the write cache. cachesummary/whole Summary of the whole file cache. cachedetail Summary and detail of the read and write caches (GUIDS, filesizes). cachedetail/read Summary and detail of the read cache. cachedetail/write Summary and detail of the write cache. cachedetail/whole Summary and detail of the whole file cache. clearcache Clears (empties) both read and write caches. clearcache/read Clears the read cache. clearcache/write Clears the write cache. clearcache/whole Clears the whole file cache. config Dumps the configuration for this FSC. config/hash Displays the MD5 hash for the current primary configuration file. config/reload Reloads the latest configuration from the usual configuration sources, either from disk or via download from another FSC. config/reload/all Performs a coordinated configuration reload first reloading all FSC configuration primaries, then reloading all FSC configuration secondaries. Returns final configuration hash results in a comma-separated list. config/reload/slaves Performs a coordinated configuration reload of all FSC configuration secondaries. Returns final configuration hash results in a comma-separated list. config/report Queries the configuration hashes from all FSCs and returns results in a comma-separated list. filestoresummary Summary of all filestores (volumeid, root path, files, dirs, bytes). filestoresummary/xxx Summary of a filestore specified by xxx. filestoredetail Summary and detail of all filestores (file name, length, last modified, last accessed). filestoredetail/xxx Summary and detail of a filestore specified by xxx. loadfsccache/status Displays the simple Load FSC Cache status. This includes the number of tickets received, valid, invalid, expired, etc. It also includes the number of files that have been downloaded, failed to download, and are waiting to be downloaded. loadfsccache/status/reset Resets the Load FSC Cache statistics. loadfsccache/queue Displays the tickets remaining in the Load FSC Cache queue. loadfsccache/queue/clear Removes all remaining tickets in the Load FSC Cache queue. loadfsccache/filelist Uses -f option to upload a file of tickets that should be populated into the specified FSC. loadfsccache/stat Returns the number of transactions processed by the Load FSC Cache context. loadfsccache/stat/valid Returns the number of valid tickets processed. loadfsccache/stat/invalid Returns the number of invalid tickets processed. loadfsccache/stat/expired Returns the number of expired tickets processed. loadfsccache/stat/total Returns the total number of tickets processed. loadfsccache/stat/ok Returns the number of files successfully populated. loadfsccache/stat/failed Returns the number of files which failed to populate. loadfsccache/stat/waiting Returns the number of tickets remaining to be populated loadfsccache/stat/processing Returns 1 if population is occurring, otherwise 0. loadfsccache/stat/localfiles Returns the number of local files on which population was attempted, but was not required. loglevel/show Shows the current logging level of all loggers. loglevel/[fatal|error|warn |info|debug] Sets the log level for all loggers starting with com to xxx. loglevel/logger/[fatal|error|warn |info|debug] Sets error log level on the logger and all children. logger is in the form of the name of the class.package of which you wish to change the log level. com.teamcenter.fms.servercache is all of the server com.teamcenter.fms.servercache. FileHandleCacheManager sets only the loglevel on that class. log Dumps the current logfile contents. migratecache Migrates the whole files from segment cache to whole file cache. migratecache/status Prints the status of migratecache command. purgecache Purges the caches, reclaiming disk space. purgecache/read Purges the read cache. purgecache/write Purges the write cache. purgecache/whole Purges the whole file cache. purgeguid/xxx Removes the GUID (file) specified by xxx from the cache. perfcounters Reports the value of system performance counters. perfcounters/reset Resets the performance counters. shutdown Stops the FSC when it becomes idle (when all current file transfers are complete). The FSC will reject all new incoming file requests. shutdown/maxwait/xxx Stops the FSC when it becomes idle (when all current file transfers are complete) or when a maximum number of seconds have been exceeded. The FSC will reject all new incoming file requests. If the server does not become idle, xxx is the number of seconds to wait before forcing the shutdown. shutdown/now Stops the FSC. status Displays simple status about the FSC (FSCID, site, running time) and also prints the number of concurrent admin and file-based connections. This also shows the remaining time before a forced shutdown, if one is pending. stop Stops the FSC. useragents Prints a tally of all the useragents (clients) that have connected. version Prints the versions of the FSC JAR files. Examples To see general statistics of the server, enter the following command: Copy ./fscadmin.sh -s http://myserver:4445 ./status Example output: Copy FSC id: myfsc, site:fms.teamcenter.com running for 3 days, 17 hours, 3 min, 46 sec Current number of file connections: 0 Current number of admin connections: 1 To see general statistics of the caches, enter the following command: Copy ./fscadmin.sh -s http://myserver:4445 ./cachesummary Example output: Copy Cache summary: myfsc-FSCReadMap Files: 0, Bytes: 0, Hits: 0, Misses: 0 Cache summary: myfsc-FSCWriteMap Files: 0, Bytes: 0, Hits: 0, Misses: 0 To see version information for the server, enter the following command: Copy ./fscadmin.sh -s http://myserver:4445 ./version Example output: Copy FMSServerCache version: 1.1, build date: 20050729 FMSUtil version: 1.1, build date: 20050729 FSCJavaClientProxy version: 1.1, build date: 20050729 To set the FSC loglevel to WARN, enter the following command on a single line: Copy ./fscadmin.sh -s http://myserver:4445 ./loglevel/warn Example output: Copy loglevel done. To cause an idle shutdown, waiting no more than 1 hour, enter the following command on a single line: Copy ./fscadmin.sh -s http://myserver:4445 ./shutdown/maxwait/3600 Example output: Copy FSC will shutdown when idle, or in 3600 seconds... The following command prepopulates FSC using the loadfsccache/filelist command: Copy fscadmin -s http://server:port -f ticketsfile ./loadfsccache/filelist