CSA: Service and Admin Command-Line Utilities

ccppmop1561
To start, stop, or manage services outside 
Clarity PPM
 System Administration (CSA), use the command-line utilities. You can use the command-line utilities in scripts to automate various system administration tasks.
 
 
3
 
 
Service Command
Use the service command to manage services from the command line. This command has the following format:
service start|stop|status|add|clone|remove|deploy|destroy {all|service name} [-info] [-verbose] [-help]
 
start
 
Starts all or specified services.
 
Examples:
 
service start nsa service start nsa bg
 
stop
 
Stops all or specified services. You can use this option with the start option to stop and then restart one or more services.
Examples:
 
service stop beacon service stop start beacon service stop app bg nsa beacon
status
Displays the status of all or specified services.
 
Example
:
service status all
add
Activates all or specified services on a local server.
 
clone
 
Creates a copy of the app or bg service on the same server as the original. Ports, service names, and other properties of the service can be incremented to avoid a collision.
Example
:
service clone app
remove
Deactivates all or specified services on a local server.
 
Example
:
service remove app bg nsa beacon
deploy
Disperses the settings to servers in the cluster.
destroy
Removes and destroys a previously cloned service. The original service cannot be destroyed.
{all | service name}
Indicates if the task is performed on all services or on one of the following services:
  • app
  • beacon
  • nsa
  • db
  • bg
  • reports (not available in 
    Clarity PPM
     14.4 and higher releases)
-info
Displays informational messages.
-verbose
Displays detailed messages.
-help
Displays command Help for all or a specified option.
 
Example
:
service -help service stop -help
 You can combine commands. For example, the following combination can be used to restart the app and bg services:
service stop start app bg
The following commands stop and remove all services on the current single or clustered server:
service stop remove all
Admin Command
Use the 
admin
 command-line utilities to perform the following database, index, and system tasks:
  • Prepare the system before and after an upgrade.
  • Analyze, export, and import databases.
  • Read the XDM metadata and generate new files and resources.
  • Package CA PPM System Administration archive files.
  • Create and recreate the search index.
  • Migrate the documents from the file system to the database.
This command has the following format:
admin xdm|search|package|[-info] [-verbose] [-help]
 
xdm 
option
 
 
Processes the 
Clarity PPM
 XDM. This command is available only on upgraded systems that use the XDM before upgrading. Here are the available XDM options:
  •  
    install
    Applies configuration changes.
  •  
    validate
    Validates the XDM configuration.
  •  
    gen-glossary
    Generates the glossary file.
  •  
    apply-glossary
    Applies glossary changes.
  •  
    force
    Completes processing even if errors are encountered. If this option is not specified, an error stops the processing.
  •  
    all
    Applies XDM definition changes.
 
search 
option
 
 
Manages the index. The following options are available:
  •  
    migrate
    Migrates the documents from the file system to the database.
  •  
    recreate-index-files
    Recreates the files in the filestore.
  •  
    recreate-index-data
    Recreates the index for all relational data in the cscoll collection.
  •  
    index
    Immediately indexes files and all relational data in the queues.
 
package {app | bg}
 
Packages the CA PPM Application (app) or CA PPM Background (bg) service in an archive file. The resulting package is named 
app.ear
 or 
bg.ear
.
 
db 
option
 
 
Manages database objects on the application server. Here are the available options:
  •  
    compile
    Compiles all valid database objects (Oracle only).
  •  
    analyze
    Analyzes the database scheme (Oracle only).
  •  
    upgrade
    Upgrades the database schema from version 13.0 or higher to the current release.
  •  
    compare -Dreport.file= report file path
    Compares the database against the specified XML schema (Oracle only). The default file is installdir/logs/compare-report.txt.
  •  
    compare-any params
    Compares the database against another XML schema. For detailed information about the required parameters, display the command-line Help (admin db compare-any -help).
  •  
    post-install
    Performs the database post-install procedures.
 
backup
 
When prompted, provide the target directory for the backup file.
general 
option
 
Manages configuration files and the file ownership. Here are the available options:
  •  
    view-config
    Displays the configuration file version that is in the database.
  •  
    upload-all-config
    Uploads all the needed configuration files to the database. The files include properties.xml, tenants.xml, hosts.xml, logger.xml, and components.xml.
  •  
    upload-config
    Uploads the properties.xml file to the database.
  •  
    upload-config -Dfile=<config filename>
    Uploads the configuration file to the database. For example, logger.xml.
  •  
    download-config
    Downloads the properties.xml file from the database.
  •  
    download-config -Dfile=<config filename>
    Downloads the configuration file from the database. For example, hosts.xml.
  •  
    apply-ownership
    Applies the correct user and group owner to all files in the specified directory (Unix only).
system-options 
 
option
 
 
The following command options, available in 15.3.0.5, 15.4.1.1, 15.5, and newer releases, let you add or delete system options and values:
admin system-options -add <option code> <option value>
 
-add
Adds a new system option entry and value.
 
-multi
Adds multiple option values for a single new system option entry.
 
 
-force
Deletes and re-creates the option entry and value. The -force flag does not work with -multi.
-list
 
Lists the option values. 
 
-delete
Deletes a system option entry and value using the following syntax: 
 
-delete <option code> <option value>
 
 
Example 1
: The following command adds a new 
ca.com
 option value for the 
CONTENT_SECURITY_DOMAINS
 setting in the 
cmn_option_values
 table:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
 
 
 
Example 2
: The first command deletes all current domains and seed data, and then the remaining lines add all the given domains:
admin system-options -delete CONTENT_SECURITY_DOMAINS
admin system-options -add CONTENT_SECURITY_DOMAINS "'self'" -multi admin system-options -add CONTENT_SECURITY_DOMAINS cppmxxxx.ca.com -multi admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi admin system-options -add CONTENT_SECURITY_DOMAINS docops.ca.com -multi admin system-options -add CONTENT_SECURITY_DOMAINS fonts.googleapis.com -multi
 
Example 3
: The following command adds a new 
 ca.com 
 option value for the 
CONTENT_SECURITY_DOMAINS
 setting in the 
cmn_option_values
 table:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
Example 4
: The following command lists option values for the 
CONTENT_SECURITY_DOMAINS
 setting in the 
cmn_option_values
 table:
admin system-options -list CONTENT_SECURITY_DOMAINS
 
 After issuing the commands, refresh or flush all caches especially systemOptions and securityDomains.
Enable the System-Option Commands for CORS
The following information applies only to 15.3.0.5, 15.4.1.1, 15.5, or 15.5.1. If you have Clarity PPM 15.6 or higher, CORS is supported and this section no longer applies. See REST API in the Reference section of the English edition of the documentation.
The admin system-options command allows CORS for the REST API (not yet supported, available exclusively for CA Services integrations). Other applications can then make direct API calls into CA PPM. For example, CA Agile Central can read CA PPM project data. 
These options are not enabled by default.
  • If you plan to use the new blueprint channel feature, CA PPM has a built-in ability to whitelist a domain after you define it in the channel. Whitelisting allows CA PPM to display external applications in the PPM framework, provided the other application does not have CORS restrictions built-in since CA PPM cannot overwrite an external security policy.
  • If you have existing content pointing to other domains, you could implement one or more channels as a replacement. If you want to continue using HTML portlets and other links to third-party applications, and do not use channels in the Modern UX, enable CORS with the following database update command for system options:
DECLARE
option_exists
INTEGER
; FEATURE_EXISTS
INTEGER
;
BEGIN
cmn_feature_delete_sp('CORS_ENABLEMENT_F18624'); cmn_feature_ins_sp('CORS_ENABLEMENT_F18624', 'CORS Enablement', 'This is the toggle for the CORS Enablement feature for rest api', 1);
END
;