system_tools command options

You can use any of the following options with the system_tools command. You must always supply the -password option.

-cancelshutdown serverId
Cancels the planned shutdown of the server specified by serverId.
-cancelupdatestats
Cancels the process that is updating database statistics if running. Use with -server url to stop the process on the identified server.
Use the following option to verify the process state:
  • -getupdatestatsstate
-checkdbconsistency
Checks the consistency of data in the database. The -checkdbconsistency option runs consistency checks as an asynchronous batch process. PolicyCenter provides this option so that you can schedule consistency checks to run during a time period of low activity on the database server.

The -checkdbconsistency option has two optional arguments:

  • tblSelection
  • checkTypeSelection

Specify the tblSelection argument as one of the following:

  • all – Run consistency checks on all tables.
  • tableName – The name of a single table on which to run checks.
  • tg.tableGroupName – The name of a table group. Use the <database> element in database-config.xml to define table groups.
  • @fileName – The name of a file that contains one or more valid table names or table group names entered in comma-separated values (CSV) format. Prefix table group names with tg., such as tg.MyTableGroup. You can combine table groups and individual table names in the same file.

Specify the checkTypeSelection argument as one of the following:

  • all – Run all consistency checks on the specified tables.
  • checkName – The typecode of a single consistency check to run.
  • @fileName – The name of a file with one or more valid consistency check names entered in comma-separated values (CSV) format.

If you specify one optional argument, you must specify both.

To run consistency checks from PolicyCenter, use the Server Tools Consistency Checks > Info Page screen.

-completefailedfailover type componentId
Manually completes component failover for a failed component. You must supply the component type (type) and component ID (componentId).
-components

Provides information about the components that exist on each PolicyCenter server in the cluster. The report contains the following information for each component:

  • Component type
  • Component code
  • Component state
  • Component start date and time
  • Server ID of the server instance on which the component exists
  • Component ID
The report information is similar, but not identical, to the cluster information available from the Server Tools Cluster Members and Cluster Components screens.
-daemons
Sets the server to the daemons run level. For information about the various run levels, see Server run levels.
-dbcatstats
Used with no arguments, the option returns a ZIP file of database catalog statistics info for all the tables in the database.

The -dbcatstats option takes the following optional arguments:

  • regularTables
  • stagingTables
  • typelistTables

This option, used with three arguments, returns a ZIP file of database catalog statistics info for the specified tables.

Specify each of the arguments as one of the following:

  • all/none – Select all or none of the tables of this type
  • <tableName> – The name of a single table of this type
  • @<fileName> – The name of a file with one or more valid table names of this type entered in comma-separated values (CSV) format.
For example, -dbcatstats none none all returns database catalog statistics information for all the typelist tables. You must specify either no arguments or all three arguments if you use this command option.
You can specify the target destination for the database catalog statistics ZIP file by adding the –filepath filepath option. If you do not provide a path, PolicyCenter uses the current directory.
This process can take a long time, and it is possible for the connection to time out. If the connection times out while running this command option, try reducing the number of tables on which to gather statistics by using the arguments listed previously.
-evenifincluster [-filepath filepath]
Consider the cluster member as failed even if it is still in the cluster. Use only with the -nodefailed option.
The -filepath parameter sets the location (filepath) for an optional report.
Important: This command option overrides an important safety check on the server. Use this command option in certain defined circumstances only. See -nodefailed for details.
-getdbccstate
Returns the status of any currently executing database consistency checks, Processing or Completed, for example.
-getdbstatisticsstatements
Retrieves the list of SQL statements to update database statistics and prints the list to the console.
-getincrementaldbstatisticsstatements
Retrieves the list of SQL statements to update database statistics for tables exceeding the change threshold. Prints the list to the console.
The incrementalupdatethresholdpercent attribute of the <databasestatistics> element in database-config.xml defines the change threshold.
-getPerfReport reportID
Downloads the performance report with the specified ID to a local directory. You can retrieve a list of available performance report IDs by running the -listPerfReports command option.
To download the report file to a directory other than the default directory, add the -filepath option to the -getPerfReport command option.
-getupdatestatsstate
Returns the state of the process running the statistics update.
-listPerfReports numReports

Lists IDs and other information for available database performance reports. You can specify an optional integer (numReports) to specify the number of available downloads to list, ordered starting with the most recent. If unspecified or 0, this command lists all available downloads.

The list shows the ID of the report and the status, indicating if the performance report batch job succeeded, failed, or is still running. The list also includes the start and end times of the batch job and the description of the batch run.
You can use the ID of the performance report to download the report with the -getPerfReport ID command option.
-loggercats
Displays the available logging categories.
-maintenance
Sets the server to the maintenance run level. For information about the various run levels, see Server run levels.
-mssqlPerfRpt n1 n2 collectStatistics
Generate a SQL Server performance report defined by the option parameters, which have the following meaning:
  • n1, n2 - One, or two, interval IDs that define the time interval of the report. A single ID indicates a report for that time period only. Two IDs indicate a time range. If you do not supply at least one interval ID, PolicyCenter does not generate Query Store statistics.
  • collectStatistics - A Boolean value that determines whether PolicyCenter includes database statistics (true) in the output report.These statistics are the same that you see in the Server Tools Database Statistics screen.
After PolicyCenter generates the report, the SQL Server Performance Report screen shows the time interval used for the report in the report description.
If you do not know the interval IDs to use, run the -sqlListIntervals command option first.
-multiuser
Sets the server to the multiuser run level. For information about the various run levels, see Server run levels.
-nodefailed serverId
Releases any tasks owned by the PolicyCenter server specified by serverId. Only use this command option if the server referenced by serverId has already been stopped or otherwise shutdown.
See also the -evenifincluster option.
Important: You must ensure that the server referenced by serverId is actually stopped if using the -evenifincluster option. PolicyCenter does not prevent you from using this option if the server is still running. However, this option overrides an important safety check on the server. It can produce unexpected and possibly negative results if the server is running.

Use the -evenifincluster option only if both of the following are true:

  • The server in question is no longer running.
  • The standard operation of the -nodefailed command failed due to the server retaining its cluster membership.
-nodes

Provides information about each PolicyCenter server in the cluster. The report contains the following information on each cluster member:

  • ID of this cluster server
  • Whether the server instance is actively in the cluster
  • Server run level
  • Time the server instance started
  • Time at which PolicyCenter last updated the server instance
  • Number of user sessions active on the server instance
  • Whether a planned shutdown is in progress
  • Time of the planned shutdown
  • Whether background tasks are still active on the server
The report information is similar, but not identical, to the cluster information available from the Server Tools Cluster Members screen.
-oraListSnaps numSnaps
Lists numSnaps number of available Oracle AWR snapshot IDs, starting with the most recent snapshot. You can generate performance reports using the -oraPerfReport option with these available beginning and ending snapshot IDs.
-oraPerfReport beginSnapshotID endSnapshotID probeVDollarTables

Generates a Guidewire AWR performance report using the OraAWRReport batch process. This command option has the following arguments:

  • beginSnapshotID
  • endSnapshotID
  • probeVDollarTables
Specify the beginning and ending snapshot IDs and whether to probe VDollar tables. The two snapshots must share the same Oracle instance startup time.
The third argument can also specify a file by prefixing the file name with an @ sign, for example, @filename.properties.

Optionally, you can prefix the file name with the path to the file, if the file is not in the current directory. This file is a standard properties file with the following property names (default value in parenthesis):

  • probleVDollarTables (false)
  • capturePeekedBindVariables (false)
  • searchQueriesMultipleHistoricPlans (false)
  • searchQueriesBeginSnapOnly (true)
  • searchQueriesEndSnapOnly (true)
  • includeInstrumentationMetadata (false)
  • outputRawData (false)
  • includeDatabaseStatistics (true)
  • probeSqlMonitor (true)
  • capturePeakedBindVariablesFromAWR (false)
  • genCallsToAshScripts (false)

You must spell and capitalize each property as shown or PolicyCenter ignores the property. If you specify a property, you must set value of that property to either true or false. If you do not specify a property, PolicyCenter uses the default value for that property.

The -oraPerfReport option reports the process ID of the process generating the performance report. You can check on the status of this process using the following command:
  • maintenance_tools -processstatus processID
-password password
Password (password) to use to connect to the server. PolicyCenter requires the password.
-ping

Pings the server to check if its active. The returned message indicates the server run level. The possible responses are:

  • MULTIUSER
  • DAEMONS
  • MAINTENANCE
  • STARTING
-recalcchecksums
Recalculates file checksums that PolicyCenter uses for clustered configuration verification.
-reloadloggingconfig
Directs the server to reload the logging configuration file.
-requestcomponenttransfer type componentId targetOwner
Requests transfer of ownership of a component of the specified type (type) and ID (componentId) to the specified PolicyCenter server (targetOwner).
Use the -components command option to determine the component information to enter.
The -requestcomponenttransfer command option fails if the component cannot be successfully stopped or the current owning server is unable to process the request.
-scheduleshutdown serverId [-terminatebatchprocesses -shutdowndelay minutes]
Schedules the planned shutdown of the server specified by serverId. Use with the following optional options:
  • -terminatebatchprocesses – Determines how the shutdown process handles the batch processes (including work queue writers) currently running on the server. See About planned server shutdowns for information on this command option.
  • -shutdowndelay minutes – Server shuts down in the number of minutes specified by minutes.
It is also possible to schedule a server shutdown in the following ways:
  • From the Server Tools Cluster Members screen.
  • Through the SystemToolsAPI web service.
-shutdowndelay minutes
Server shuts down in the number of minutes specified by minutes. Use with the -scheduleshutdown option only.
-server url
Specifies the PolicyCenter host server URL. Include the port number and web application name, for example:
  • http://serverName:8180/pc
-sessioninfo
Returns the session information of the server.
-sqlListIntervals numIntervals
Lists the numIntervals number of most recent Query Store runtime statistics intervals, including its ID. Each interval ID specifies a unique time interval.
-startfullupgrade

Starts the process of full application upgrade for the entire cluster of server members. You must shut down all cluster members and deploy a new WAR/EAR file to each one before attempting the upgrade.

See the PolicyCenter upgrade documentation for details of the PolicyCenter application upgrade process.
-terminatebatchprocesses
Immediately terminates all running batch processes on the specified server. Use with the -scheduleshutdown option only.
-updatelogginglevel logger level
Sets the logging level of logger with the given name. For the root logger, specify RootLogger for the logger name.
-updatestatistics description update
Launches the Update Statistics batch process to update database statistics.
It is possible to specify an optional text description (description) for this batch process execution. PolicyCenter shows the text of the description on the Execution History tab of the Database Statistics info page.
Specify one of the following values for update:
  • true – (Default) Update database statistics for tables exceeding the change threshold only. Guidewire defines this change threshold through the incrementalupdatethresholdpercent attribute of the <databasestatistics> element in database-config.xml.
  • false – Generate full database statistics.
Important: Updating database statistics can take a long time on a large database. Only collect statistics if there are significant changes to data, such as after a major upgrade, after using the zone_import command, or if there are performance issues.
-user user
User (user) to use to run this process.
-verifyconfig filepath
Compares the local server configuration with the configuration of the remote cluster. The filepath parameter defines the path to the local WAR/EAR file that contains the PolicyCenter application, pc.war, for example.
The command provides an on-screen report that contains information about the feasibility of a configuration upgrade for the server instances in the cluster. For example, the tool provides the following types of information:
  • Configurations are different – Requires a full PolicyCenter server upgrade.
  • Configurations are identical – No upgrade is necessary.
  • Configurations are compatible – Guidewire permits a rolling upgrade.
If a rolling update is not possible, the command lists the incompatible or missing files.
If a rolling update is in progress, there are two possible configurations active in the cluster. Each individual server instance is using either the source configuration or the target configuration.
The -verifyconfig command option checks for both configurations on the server instances on which you run the command and reports which of the configurations is active on this cluster member. If neither configuration is active, the command reports that a rolling update is in progress and that it is not possible to verify the configuration at this time.
See PolicyCenter system tools for information on how the -verifyconfig option works with the substitution of placeholders in the local configuration files. See also Command prompt example for an example of how to use this command option.
-verifydbschema
Initiates a process that compares the logical and physical data model to determine if they match. The command prompt window displays the results of the comparison.
-version
Returns the running server version, the database schema version, and configuration version.