CSA: サービスおよび管理のコマンドライン ユーティリティ

ccppmop1561
Clarity PPM
システム管理(CSA)を使用せずに、サービスを開始、停止、または管理するには、コマンドライン ユーティリティを使用します。 スクリプトでコマンドライン ユーティリテイを使用して、さまざまなシステム管理タスクを自動化することができます。
3
service コマンド
コマンド ラインからサービスを管理するには、service コマンドを使用します。 このコマンドの形式は次のとおりです。
service start|stop|status|add|clone|remove|deploy|destroy {all|service name} [-info] [-verbose] [-help]
start
すべてまたは特定のサービスを開始します。
例:
service start nsa service start nsa bg
stop
すべてまたは特定のサービスを停止します。 start オプションと共にこのオプションを使用すると、1 つ以上のサービスを停止して、その後、再起動することができます。
例:
service stop beacon service stop start beacon service stop app bg nsa beacon
status
すべてまたは特定のサービスのステータスを表示します。
service status all
add
ローカル サーバ上のすべてまたは特定のサービスをアクティブ化します。
clone
オリジナルと同じサーバ上で app サービスまたは bg サービスのコピーを作成します。 ポート、サービス名、およびその他のサービス プロパティは、競合を回避するためにインクリメントされることがあります。
service clone app
remove
ローカル サーバ上のすべてまたは特定のサービスを非アクティブ化します。
service remove app bg nsa beacon
deploy
クラスタ内のサーバに設定を展開します。
destroy
以前作成されたサービスのクローンを削除して破棄します。 オリジナルのサービスは破棄できません。
{all | service name}
タスクをすべてのサービスで実行するか、以下のいずれかのサービスで実行するかを指定します。
  • app
  • beacon
  • nsa
  • db
  • bg
  • reports (
    Clarity PPM
    リリース 14.4 以降では使用できません)
-info
情報メッセージを表示します。
-verbose
詳細なメッセージを表示します。
-help
すべてまたは指定されたオプションのコマンド ヘルプを表示します。
service -help service stop -help
コマンドを組み合わせることができます。 たとえば、以下の組み合わせを使用すると、app サービスと bg サービスを再起動することができます。
service stop start app bg
以下のコマンドは、現在の単一サーバまたはクラスタ化サーバ上のすべてのサービスを停止して削除します。
service stop remove all
admin コマンド
以下のようなデータベース、索引、およびシステム タスクを実行するには、
admin
コマンドライン ユーティリティを使用します。
  • アップグレード前後のシステムの準備
  • データベースの分析、エクスポート、インポート
  • XDM メタデータの読み取り、および新しいファイルとリソースの生成
  • CA PPM システム管理アーカイブ ファイルのパッケージ化
  • 検索索引の作成および再作成
  • ファイル システムからデータベースへのドキュメントの移行
このコマンドの形式は次のとおりです。
admin xdm|search|package|[-info] [-verbose] [-help]
xdm オプション
Clarity PPM
の XDM を処理します。 このコマンドは、アップグレード前に XDM を使用していたシステムのアップグレード後に、それらのシステムでのみ利用できます。 利用可能な XDM オプションを以下に示します。
  • install
    設定の変更を適用します。
  • validate
    XDM の設定を検証します。
  • gen-glossary
    グロッサリ ファイルを生成します。
  • apply-glossary
    グロッサリの変更を適用します。
  • force
    エラーが発生した場合でも処理を完遂します。 このオプションを指定しない場合、エラーにより処理が停止します。
  • all
    XDM 定義の変更を適用します。
search オプション
インデックスを管理します。 以下のオプションを使用できます。
  • migrate
    ファイル システムからデータベースにドキュメントを移行します。
  • recreate-index-files
    ファイルストア内にファイルを再作成します。
  • recreate-index-data
    cscoll コレクション内のすべての関係データの索引を再作成します。
  • index
    ファイルとキュー内のすべての関係データを直ちに索引付けします。
package {app | bg}
CA PPM アプリケーション(app)または CA PPM バックグラウンド(bg)サービスをアーカイブ ファイルにパッケージ化します。 作成されたパッケージには、
app.ear
または
bg.ear
という名前が付けられます。
db オプション
アプリケーション サーバ上のデータベース オブジェクトを管理します。 利用可能なオプションを以下に示します。
  • compile
    有効なデータベース オブジェクトをすべてコンパイルします(Oracle のみ)。
  • analyze
    データベース スキーマを分析します(Oracle のみ)。
  • upgrade
    データベース スキーマをバージョン 13.0 以降から現在のリリースにアップグレードします。
  • compare -Dreport.file= report file path
    データベースを指定された XML スキーマと比較します(Oracle のみ)。 既定のファイルは、「installdir/logs/compare-report.txt」です。
  • compare-any params
    データベースを別の XML スキーマと比較します。 必要なパラメータの詳細については、コマンドライン ヘルプを表示してください(admin db compare-any -help)。
  • post-install
    データベースのポストインストール手順を実行します。
backup
入力を求められたら、バックアップ ファイルのターゲット ディレクトリを指定します。
general
オプション
設定ファイルとファイル所有権を管理します。 利用可能なオプションを以下に示します。
  • view-config
    データベース内にある設定ファイルのバージョンを表示します。
  • upload-all-config
    必要な設定ファイルをすべてデータベースにアップロードします。 これらのファイルには、properties.xml、tenants.xml、hosts.xml、logger.xml、および components.xml が含まれます。
  • upload-config
    データベースに properties.xml ファイルをアップロードします。
  • upload-config -Dfile=<config filename>
    データベースに設定ファイルをアップロードします。 たとえば、logger.xml などです。
  • download-config
    データベースから properties.xml ファイルをダウンロードします。
  • download-config -Dfile=<config filename>
    データベースから設定ファイルをダウンロードします。 たとえば、hosts.xml などです。
  • apply-ownership
    指定されたディレクトリ内のすべてのファイルに適切なユーザとグループ所有者を適用します(UNIX のみ)。
system-options
オプション
以下のコマンド オプションは、15.3.0.5、15.4.1.1、および 15.5 以降のリリースで利用可能で、システム オプションおよび値を追加または削除できます。
admin system-options -add <option code> <option value>
-add
新しいシステム オプションのエントリと値を追加します。
-multi
は、複数のオプション値を 1 つの新しいシステム オプション エントリに追加します。
-force
オプションのエントリと値を削除し、再作成します。 -force フラグは -multi と同時に使用できません。
-list
オプション値をリスト表示します。
-delete
以下の構文を使用してシステム オプションのエントリと値を削除します。
-delete <オプション コード> <オプション値>
例 1
: 以下のコマンドで、
cmn_option_values
テーブル内の
CONTENT_SECURITY_DOMAINS
設定に新しい
ca.com
オプション値を追加します。
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
例 2
: 最初のコマンドで、現在のドメインとシード データがすべて削除されます。残りの行で、指定したすべてのドメインが追加されます。
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
例 3
: 以下のコマンドで、
cmn_option_values
テーブル内の
CONTENT_SECURITY_DOMAINS
設定に新しい オプション値を追加します。
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
例 4
: 以下のコマンドで、
cmn_option_values
テーブル内の
CONTENT_SECURITY_DOMAINS
設定のオプション値を一覧表示します。
admin system-options -list CONTENT_SECURITY_DOMAINS
これらのコマンドを発行した後、特に systemOptions および securityDomains のすべてのキャッシュをリフレッシュまたはフラッシュします。
CORS での system-option コマンドの有効化
以下の情報は、15.3.0.5、15.4.1.1、15.5、または 15.5.1 にのみ適用されます。 Clarity PPM 15.6 以降を使用している場合、CORS がサポートされているため、このセクションは適用されません。 英語版のドキュメントで「Reference (リファレンス)」の「REST API」を参照してください。
admin system-options コマンドは CORS に REST API(未サポート、CA サービス統合に対してのみ利用可能)を許可します。 その他のアプリケーションは、CA PPM に直接 API コールを実行できます。 たとえば、CA Agile Central では CA PPM のプロジェクト データを読み取ることができます。
これらのオプションは既定では有効になりません。
  • 新しいブループリント チャネル機能を使用する場合、CA PPM には、チャネルでホワイトリストを定義した後にドメインをそのリストに追加する機能が組み込まれています。 ホワイトリストを使用すると、他のアプリケーションに組み込みの CORS 制限がない場合、CA PPM で PPM フレームワーク内に外部アプリケーションを表示できます。これは CA PPM では外部のセキュリティ ポリシーを上書きできないからです。
  • 他のドメインを指す既存のコンテンツがある場合、代わりに 1 つ以上のチャネルを実装できました。 引き続き HTML ポートレットおよびサードパーティ製アプリケーションへのその他のリンクを使用し、新ユーザ エクスペリエンスでチャネルを使用しない場合は、システム オプションの以下のデータベースの更新コマンドで CORS を有効にします。
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
;