Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Redirect
visiblefalse
locationAIPCORE:CMS - Using the Command Line Interface (CLI)


Panel

In this section:

Table of Contents
maxLevel2

Target audience:

  • CAST administrators

...

Analyzing source code and generating snapshots with CAST AIP is achieved using the GUI based application CAST Management Studio (CMS) - you can find out more details about this in Automating CAST Management Studio tasks 472711311.

If you need to automate source code analysis and/or snapshot generation with CAST AIP, then you can do so by using the CLI (Command Line Interface) provided with the CMS. This document explains how.

...

(tick)An installation of CAST AIP is required - either a Full Installation or a All Application Intelligence Platform Applications installation (see Automating CAST Management Studio tasks 472711311), which must be located on the machine you wish to run the CLI from.

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application of the Version you want to accept.
version<string>Specifies the name of the Version you want to accept.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the Application.
measureService<string>Specifies the name of the Measurement Service schema you want to activate.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application of the Version you want to copy.
version<string>Specifies the name of the new Version you want to create.
[fromVersion<string>]Specifies the name of the existing Version you want to copy. Note that this is optional: if you omit it, then the last Version (i.e. the most recent) will always be used.
[discoverers <string>]

This optional setting is available in CAST AIP ≥ 8.3.5. Specifies the discoverers you would like to enable in the existing packages that will be copied into the new Version. You can select:

DiscovererDescription
HTML5 project

This discoverer is provided in the Web Files Discoverer, which is shipped and installed by default with CAST AIP as part of the upgrade and with new AIP schemas. When enabled, Web File Discoverer (i.e. HTML5 projects) projects will be identified and corresponding Analysis Units will be generated. All files "captured" in these "HTML5 project" Analysis Units will be analyzed (predominately HTML and JavaScript files).

XML scannerThis discoverer is provided in the DMT Framework Scanner, which is shipped and installed by default with CAST AIP as part of the upgrade and with new AIP schemas. When enabled, the information generated by the DMT Framework Scanner extension can be seen in the CAST Delivery Manager Delivery Report for existing packages that have been upgraded.

Both discoverers can be enabled (separate them with a semi-colon - ;), just one, or none at all. For example:

Code Block
languagetext
-discoverers "HTML5 project;XML scanner"
-discoverers "HTML5 project"
-discoverers "XML scanner"


Info

Note that:

  • This option is only of use if the Web Files Discoverer and DMT Framework Scanner options were not ticked in the CAST Delivery Manager Tool in the existing package. This may be the case if the Application and Version/Packages have been upgraded from a previous release of CAST AIP where these discoverers were not installed.
  • After enabling the option, when consulting the CAST Delivery Manager Tool, the two corresponding options will be ticked:


[copySources[<boolean>]]Use this option ONLY when copying the "Migrated Version" version that is produced following an upgrade. Do not use at any other time.
[date<date>]Specifies the new Date for the new Version. If omitted, the current date is used.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application for the Analysis Units you want to clean up.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]

Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application whose generated snapshots you want to upload to the Measurement Service schema associated to the Management Service schema specified in the connection profile.
[snapshot <string>]Specifies the specific snapshot (by name) that you want to upload. If omitted, all snapshots will be uploaded to the Measurement Service schema associated to the Management Service schema specified in the connection profile.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]

Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
licenseKey<string>Enter the license key provided to you by CAST.
[sourceDeliveryFolder<string>]Enter the location for the Source Code Delivery Folder and Source Code Deployment Folder.

Please see Preferences - Platform Settings for more information about the path syntax that can be used.

[sourceDeploymentFolder<string>]
[storageWorkingPath<string>]

Enter the location for the LISA (Large Intermediate Storage Area). A LISA sub folder will be created in the chosen location.

Please see Preferences - Platform Settings for more information.

[temporaryWorkingPath<string>]Enter the location for the LTSA (Large Temporary Storage Area). A LTSA sub folder will be created in the chosen location.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Enter the location for the Logs folder. An absolute path is required. You can use either back or forward slashes. By default all log files generated by the CAST Management Studio will be date stamped.

Please see Preferences - Platform Settings for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application of the Version you want to delete.
version<string>Specifies the name of the Version you want to delete.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

This option is used to delete a comma separated list of existing snapshots.

 


Info

Note that:

  • using this option will delete the selected snapshots from the Dashboard Service and the Measurement Service (if the snapshots exist in the Measurement Service).
  • any reconsolidated snapshots (i.e. those snapshots remaining at the end of the delete procedure) will be reuploaded to the Measurement Service if it has been configured.
  • if you remove an older snapshot (i.e. not the most recent) then the next snapshot will be updated:

    • delta and AEP/EFP metrics are recalculated, and the post process procedures that update schema tables required for dashboards are relaunched.
    • new data is also pushed to the associated Measurement Service schema (if one is associated to the Management Service schema for the Application).

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application for the Snapshot(s) you want to delete.
dashboardService<string>Specifies the parent Dashboard Service for the Snapshot(s) you want to delete.
-snapshots<yyyyMMdd>[,<yyyyMMddHHmm>]

Specifies a comma separated list of snapshots to be deleted, based on their capture date. Note that seconds are not permitted in the capture date.

[databaseServer<string>]Specifies the database server on which the snapshot is located - may be required if it is not possible to distinguish two snapshots because all their attributes are identical, including the name of their Dashboard Service.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.-
appli<string>Specifies the parent Application for the Snapshot you want to delete.-
dashboardService<string>Specifies the parent Dashboard Service for the Snapshot you want to delete.-
[beginDate<YYYYMMDD>]

Specifies the start date of the Snapshots to be deleted. Any snapshots created on this date will be included in the range to be deleted.

The beginDate and endDate parameters are optional, however, at least one of the two MUST be present:

  • If you omit the beginDate parameter, then all the snapshots up to the specified endDate (including all those created on the specified endDate) will be deleted
  • If you omit the endDate parameter, then all the snapshots from the specified beginDate (including all those created on the specified beginDate) will be deleted
[endDate<YYYYMMDD>]Specifies the end date of the Snapshots to be deleted. Any snapshots created on this date will be included in the range to be deleted.
[preserveFirst<boolean>]

To aid reconsolidation, the very first snapshot that has ever been generated is NEVER deleted in any circumstance even if it is part of the specified date range. This option specifies (when set to false) that the very first Snapshot ever generated should be deleted. By default and when the option is not specified, it is set to True (i.e. the very first snapshot is never deleted).

-
[preserveLast<boolean>]To aid reconsolidation, the very last snapshot that has ever been generated is NEVER deleted in any circumstance even if it is part of the specified date range. This option specifies (false) that the very last Snapshot ever generated should be deleted. By default and when the option is not specified, it is set to True (i.e. the very last snapshot is never deleted).-
[databaseServer<string>]Specifies the database server on which the snapshot is located - may be required if it is not possible to distinguish two snapshots because all their attributes are identical, including the name of their Dashboard Service.-
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

-
[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

-
[logRootPath<string>]Specifies the log root path.

Please see Preferences - Platform Settings for more information.

-
[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

-
[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

-
[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

-
[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

-
[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

-
[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt-

...

filePath<string>Specifies the name of the PMX file to export to.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt
[connectionProfile<string>]Specifies the name of connection profile to use to connect to the CAST Management Service.

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
captureDate<yyyyMMdd>[,<yyyyMMddHHmm>]Specifies the Snapshot Capture Date to identify the snapshot you want to generate a report for. Note that seconds are not permitted in the capture date.
appli<string>Specifies the parent Application for the Snapshot you want to generate a report for.
dashboardService<string>Specifies the parent Dashboard Service for the Snapshot you want to generate a report for.
hsqFile<string>Specifies the HSQ template you want to use for the report. A selection can be found in the "hsq" folder at the root of your CAST installation.
htmlFile<string>Specifies the output HTML file that will contain the report.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

Info

Please note that CAST supports concurrent snapshot generation on the same workstation (whether through GUI/CLI) with the following conditions:

Expand
  • only one active execution for a given application/triplet should be run at any one time
  • you should ensure that you configure application/triplet specific values for the following CAST locations:
    • TEMP (User's temporary path)
    • LTSA
    • LISA
    • LOG

This can be achieved by:

  • defining an application/triplet specific Windows environment variable (for example %APPLICATION%)
  • using this Windows variable in the CastGlobalSettings.ini file (ensuring you uncomment the variable in the CastGlobalSettings.ini file)
  • changing the Windows variable path each time you generate a snapshot for a specific application/triplet

For example, set the following in the CastGlobalSettings.ini file:

Code Block
languagetext
; Set current user's temporary path
CAST_CURRENT_USER_TEMP_PATH=%APPLICATION%\CAST_TMP

; Set root path of all CAST logs
CAST_LOG_ROOT_PATH=%APPLICATION%\CAST_LOG
 
; Set the default LISA location
CAST_DEFAULT_LISA_DIR=%APPLICATION%\CAST_STORAGE
 
; Set the default LTSA location
CAST_DEFAULT_LTSA_DIR=%APPLICATION%\CAST_STORAGE



...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
snapshot<string>Specifies the Name of the Snapshot to generate. It must be unique for a given Application in a given Dashboard Service.
[captureDate<yyyyMMdd>[,<yyyyMMddHHmm>]]Specifies the Snapshot Capture Date. When triggering Snapshots for each Application, the same Capture Date is used. It must be unique for a given Application in a given Dashboard Service. Note that seconds are not permitted in the capture date.
[version<string>]Defines a source code version name for your snapshot and is displayed only in the CAST Engineering Dashboard. The snapshot will always be triggered on the current version defined in the CAST Management Studio. When triggering Snapshots for each Application in one go, the same source code version name is used for all snapshots. The default is set to: N\A
[appli<string>]Specifies the Application to generate a Snapshot for. Must be omitted when triggering Snapshots for a given Dashboard Service (see -dashboardService below).
[dashboardService<string>]Specifies the Dashboard Service in which to generate the Snapshot. This will generate a Snapshot for all Applications associated to the chosen Dashboard Service. Not required if you are using the -appli option.
[ignoreEmptyModule[<boolean>]]If you set this option to true, empty modules will not cause the snapshot generation to halt. The default is set to: FALSE.
[skipAnalysisJob[<boolean>]]This option enables you to force the CAST Management Studio NOT to run the analysis of the source code (e.g. if you have already run it). This can save time during the process. The default is set to: FALSE.
[consolidateMeasures[<boolean>]]

If you set this option, the snapshot results will be consolidated in the Measurement Service schema. If you include this option, please ensure that a Measurement Service schema is installed and activated for this Management Service. The default is set to: TRUE.

Info
Note that you may need to reload the Health Dashboard so that your new results are displayed correctly. Please consult Reload the cache for more information.


[databaseServer<string>]Specifies the database server on which the snapshot is located - may be required if it is not possible to distinguish two snapshots because all their attributes are identical, including the name of their Dashboard Service.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

filePath<string>Specifies the name of the PMX file to import.
action<string>

Three options are available:

  • create : Creates target objects from the source objects.
  • merge : Additionally changes the target objects from the source objects.
  • replace : Replaces the target objects with the source objects.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25) Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt
[connectionProfile<string>]Specifies the name of connection profile to use to connect to the CAST Management Service schema..

...

connectionProfile <string>Specifies the name of connection profile to use to connect to the CAST Management Service to which you want to import the Application.
-file

Specifies the full path to the Assessment Model file. Note that the file can use any name. On import:

  • All Dashboard Service schemas visible in the Services view will be assigned the imported Assessment Model.
  • The imported Assessment Model will take the name of the Assessment Model PMX file in the Assessment Models view. For example importing AssessmentModel.pmx will result in an Assessment Model called "AssessmentModel".
[appli<string>]

This optional parameter enables you to specify an Application when the Management Service schema associated with the chosen connection profile contains multiple Applications:

  • If there is only one Application in the Management Service schema this parameter is optional, and should match with the existing target Application if it is provided
  • If there are multiple Applications, this parameter is mandatory and should match with an existing Application in the Management Service schema in order to synchronise the imported assessment model with the associated Dashboard Service schemas
Info

Note that this option is only available in CAST AIP ≥ 8.3.12.


[sourceServerRootPath<string>]

Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]

Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]

Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]

Mail server port (default is 25) Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath <string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile <string>Specifies the name of connection profile to use to connect to the CAST Management Service to which you want to import the Application.
appli <string>Specifies the Application you want to start managing.
[sourceServerRootPath<string>]

Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]

Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]

Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]

Mail server port (default is 25) Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath <string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application for the Snapshot you want to prepare.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

Info

Note that this command should ONLY be used in the scope of an upgrade "with extensions", as described in Automating CAST Management Studio tasks 472711311.

Examples

Upgrade ALL Assessment Models with "progressive" option, attached to an Application/Dashboard Service schema in ALL CAST Management Services schemas declared in the connection profile

...

connectionProfile <string>Specifies the name of connection profile to use to connect to the CAST Management Service.

migrateAssessment <option>

Enables you to choose the upgrade option:

CLI optionDescriptionEquivalent GUI Option
progressive

These two options will preserve the current Assessment Model assigned to your CAST Dashboard Service schemas and merge in any new rules delivered with the new CAST AIP Assessment Model - depending on your option choice, these new rules will either be activated (provides the benefits of the new release with all options actived) or disabled (therefore making post upgrade results more stable and in-line with the previous release of CAST AIP but not benefiting from updates in the new release). Please see Automating CAST Management Studio tasks 472711311 for more information about new Quality Rules that may have been added in this release of CAST AIP.

If you have chosen either of these options, the following Assessment Model values will be retained:

  • the status of active/inactive Quality Rules
  • thresholds
  • weights
  • critical contributions
  • parameter values
  • custom indicators
  • custom Quality Rules

However, the Assessment Model will still be subject to an upgrade process to modify some values to make them compatible with CAST AIP 8.2.x, for example:

  • SQL and property implements
  • applicable technologies
  • associate values
  • documentation
Preserve Assessment Model customizations, activate new rules from AIP <release>
conservative Preserve Assessment Model customizations, leave new rules disabled 
true

If you have chosen this option, the new Assessment Model from the new release of CAST AIP will be assigned to the CAST Dashboard Service schemas selected for update, therefore replacing any existing Assessment Models.

Use default Assessment Model from CAST AIP <release>


[sourceServerRootPath <string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath <string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath <string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath <string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath <string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host <string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port <integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from <string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath <string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application of the Version you want to purge.
version<string>Specifies the name of the Version you want to purge.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application of the Version you want to reject.
version<string>Specifies the name of the Version you want to reject.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

This option is used to invoke a code analysis, without generating a snapshot. It is equivalent to the Run analysis only option available in the GUI - it runs all Analysis Units in an Application (if the Analyze Analysis Unit option is selected).

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
[appli<string>]Specifies the Application to generate a Snapshot for. Must be omitted when triggering Snapshots for a given Dashboard Service (see -dashboardService below).
[noSave[<boolean>]]Allows you to specify whether the analysis results will be saved to the Analysis Service or not - this is useful if you are simply testing the analysis runs without error. The default is set to: FALSE.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the Application to which the target Version belongs.
version<string>Specifies the name of Version you want to set as "current".
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile <string>

Mandatory.

Specifies the name of connection profile to use to connect to the CAST Management Service from which you want to removed the Application.

appli <string>

Mandatory.

Specifies the Application you want to remove.

[-deleteCentralData=true/false]

Optional. Defaults to false when omitted.

Set this option to true if you want to completely remove all snapshots associated to the specified Application from the Dashboard Service schema when you stop managing the Application. All relevant snapshot data will no longer be visible in the CAST Application Engineering / CAST Engineering dashboards.

Set this option to false (or omit it) if you would like to stop managing the Application but need to view the historic snapshot data in the CAST dashboards or you need to restore the Application at a later date.

[-deleteAnalyticsData=true/false]

Optional. Defaults to false when omitted.

Set this option to true if you have an active Measurement Service schema and have chosen to upload snapshot data to the Measurement Service schema when you generate a Snapshot and you want to completely remove all snapshots associated to the specified Application from the Measurement Service schema when you stop managing the Application. All relevant snapshot data will no longer be visible in the Health Dashboard.

Set this option to false (or omit it) if you have an active Measurement Service schema and have chosen to upload snapshot data to the Measurement Service schema when you generate a Snapshot and you would like to stop managing the Application but need to view the historic snapshot data in the Health Dashboard or you need to restore the Application at a later date.

[-deleteLocalData=true/false]

Optional. Defaults to false when omitted.

Set this option to true if you want to completely remove all analysis results data associated to the specified Application from the Analysis Service schema when you stop managing the Application. All relevant analysis results data will no longer be visible in the CAST Discovery Portal.

Set this option to false (or omit it) if you would like to remove the Application but need to view the analysis results data in the CAST Discovery Portal or you need to restore the Application at a later date.

[-deleteDelivery=true/false]

Optional. Defaults to false when omitted.

This option will clean up any references to the specified Application when you stop managing the Application. These references correspond to items in the Delivery Folder (see Preferences - Platform Settings).

Set this option to true if you want to completely remove any references to the specified Application from the Delivery folder when you stop managing the Application.

Set this option to false (or omit it) if you want to retain the references to the Application in the Delivery Folder for whatever reason.

[-deleteDeployment=true/false]

Optional. Defaults to false when omitted.

This option will remove any deployed source code associated to the specified Application when you stop managing the Application. This source code corresponds to the current Version in the Application and have been deployed to the CAST Source Code Deployment Folder (see Preferences - Platform Settings). If you remove the deployed source code you will no longer be able to analyze that Version of the source code.

Set this option to true if you want to completely remove all deployed source code associated to the current Application from the Deployment Folder when you stop managing the Application.

Set this option to false (or omit it) if you want to retain the deployed source code for whatever reason.

[sourceServerRootPath<string>]

Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]

Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]

Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]

Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]

Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]

Mail server port (default is 25) Default: 25

Please see Preferences - Mail for more information.

[from<string>]

Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath <string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
appli<string>Specifies the parent Application for the Snapshot you want to delete.
dashboardService<string>Specifies the parent Dashboard Service for the Snapshot you want to delete.
thresholdDate<yyyyMMdd>[,<yyyyMMddHHmm>]Specifies the ending Capture Date of the Snapshots to be deleted. Note that seconds are not permitted in the capture date.
[databaseServer<string>]Specifies the database server on which the snapshot is located - may be required if it is not possible to distinguish two snapshots because all their attributes are identical, including the name of their Dashboard Service.
[preserveInitialSnapshot<boolean>]Specifies whether the oldest Snapshot should be retained or not. By default, if this option is not present, the option is set to TRUE.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile<string>Specifies the name of connection profile to use to connect to the CAST Management Service.
captureDate<yyyyMMdd>[,<yyyyMMddHHmm>]Specifies the Snapshot Capture Date to identify the snapshot to delete. Note that seconds are not permitted in the capture date.
appli<string>Specifies the parent Application for the Snapshot you want to delete.
dashboardService<string>Specifies the parent Dashboard Service for the Snapshot you want to delete.
[databaseServer<string>]Specifies the database server on which the snapshot is located - may be required if it is not possible to distinguish two snapshots because all their attributes are identical, including the name of their Dashboard Service.
[sourceServerRootPath<string>]Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[codeResourceBasePath<string>]Source Code Deployment Folder - a location used exclusively by the CAST Management Studio to store the most recent version of the applications' source code for analysis in uncompressed format.

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]Mail server port (default is 25)Default: 25

Please see Preferences - Mail for more information.

[from<string>]Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath<string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...

connectionProfile <string>

Mandatory.

Specifies the name of connection profile to use to connect to the CAST Management Service from which you want to removed the Application.

appli <string>

Mandatory.

Specifies the Application you want to remove.

[-deleteCentralData=true/false]

Optional. Defaults to false when omitted.

Set this option to true if you want to completely remove all snapshots associated to the specified Application from the Dashboard Service schema when you stop managing the Application. All relevant snapshot data will no longer be visible in the CAST Application Engineering / CAST Engineering dashboards.

Set this option to false (or omit it) if you would like to stop managing the Application but need to view the historic snapshot data in the CAST dashboards or you need to restore the Application at a later date.

[-deleteAnalyticsData=true/false]

Optional. Defaults to false when omitted.

Set this option to true if you have an active Measurement Service schema and have chosen to upload snapshot data to the Measurement Service schema when you generate a Snapshot and you want to completely remove all snapshots associated to the specified Application from the Measurement Service schema when you stop managing the Application. All relevant snapshot data will no longer be visible in the Health Dashboard.

Set this option to false (or omit it) if you have an active Measurement Service schema and have chosen to upload snapshot data to the Measurement Service schema when you generate a Snapshot and you would like to stop managing the Application but need to view the historic snapshot data in the Health Dashboard or you need to restore the Application at a later date.

[-deleteLocalData=true/false]

Optional. Defaults to false when omitted.

Set this option to true if you want to completely remove all analysis results data associated to the specified Application from the Analysis Service schema when you stop managing the Application. All relevant analysis results data will no longer be visible in the CAST Discovery Portal.

Set this option to false (or omit it) if you would like to remove the Application but need to view the analysis results data in the CAST Discovery Portal or you need to restore the Application at a later date.

[-deleteDelivery=true/false]

Optional. Defaults to false when omitted.

This option will clean up any references to the specified Application when you stop managing the Application. These references correspond to items in the Delivery Folder (see Preferences - Platform Settings).

Set this option to true if you want to completely remove any references to the specified Application from the Delivery folder when you stop managing the Application.

Set this option to false (or omit it) if you want to retain the references to the Application in the Delivery Folder for whatever reason.

[-deleteDeployment=true/false]

Optional. Defaults to false when omitted.

This option will remove any deployed source code associated to the specified Application when you stop managing the Application. This source code corresponds to the current Version in the Application and have been deployed to the CAST Source Code Deployment Folder (see Preferences - Platform Settings). If you remove the deployed source code you will no longer be able to analyze that Version of the source code.

Set this option to true if you want to completely remove all deployed source code associated to the current Application from the Deployment Folder when you stop managing the Application.

Set this option to false (or omit it) if you want to retain the deployed source code for whatever reason.

[sourceServerRootPath<string>]

Source Code Delivery Folder - a central location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Please see Preferences - Platform Settings for more information.

[logRootPath<string>]

Specifies the log root path folder. An absolute path is required. You can use either back or forward slashes.

Please see Preferences - Platform Settings for more information.

[workingPath<string>]

Refers to the LISA (Large Intermediate Storage Area).

Please see Preferences - Platform Settings for more information.

[temporaryPath<string>]

Refers to the LTSA (Large Temporary Storage Area).

Please see Preferences - Platform Settings for more information.

[host<string>]

Mail server IP, name or address.

Please see Preferences - Mail for more information.

[port<integer>]

Mail server port (default is 25) Default: 25

Please see Preferences - Mail for more information.

[from<string>]

Optional sender (may be required by Mail server for SPAM filtering)

Please see Preferences - Mail for more information.

[logFilePath <string>]Log file path. Default value is $TEMP$PRODUCTNAME$INCREMENT.log.txt

...