本ヘルプセンターは英語版を翻訳したものです。また、一部には翻訳ソフトウエアにより機械的に翻訳した内容が含まれます。翻訳については順次対応しておりますが、最新の情報になっていない場合があります。最新の情報は英語版のページでご確認ください。表示言語は、画面右上の言語名をクリックして切り替えられます。

本ヘルプセンターの一部の記事には外部リンクが含まれています。リンク切れなどお気づきの点がございましたら、トレンドマイクロサポート窓口までご連絡ください。

コマンドラインの基本

ローカルのコマンドラインインタフェース (CLI) から、Deep Security AgentとDeep Security Managerに対して数々の処理を実行するように指示できます。CLIではいくつかの設定を行い、システムリソースの使用量を表示することもできます。

次にコマンドの構文と例を示します。

Deep Security Agent

Windowsでセルフプロテクションが有効になっている場合、ローカルユーザはAgentの管理、たとえばアンインストール、アップデート、停止などを行うことができません。また、CLIコマンドの実行時には、認証パスワードが必要となります。

dsa_controlを使用して、いくつかのAgentの設定を行い、不正プログラム検索、ベースライン再構築などの処理を手動で開始できます。

Dsa_controlは英語の文字列のみをサポートします。Unicodeはサポートされていません。

Windowsの場合:

  • 管理者権限でコマンドプロンプトを開きます。
  • cd C:\Program Files\Trend Micro\Deep Security Agent\
  • dsa_control -m "AntiMalwareManualScan:true"

Linuxの場合:

  • /opt/ds_agent/dsa_control -m "AntiMalwareManualScan:true"

使用方法

dsa_control [-a <str>] [-b] [-c <str>] [-d] [-g <str>] [-s <num>] [-m] [-p <str>] [-r] [-R <str>] [-t <num>] [-u <str>:<str>] [-w <str>:<str>] [-x dsm_proxy://<str>] [-y relay_proxy://<str>] [--buildBaseline] [--scanForChanges] [Additional keyword:value data to send to Manager during activation or heartbeat...]

  • -a <str>, --activate=<str> 指定されたURLでManagerを使用してエージェントをアクティベートします。URLは次の形式で指定する必要があります。

    dsm://<host or IP>:<port>/

    ポートはManagerの検出およびハートビートのポート番号です。

  • -b, --bundle: アップデートバンドルを作成します。
  • -c <str>, --cert=<str>: 証明書ファイルを特定します。
  • -d, --diag: Agentの診断パッケージを生成します。
  • -g <str>, --agent=<str>: AgentのURLです。初期設定:

    https://localhost:<ポート>/

    ポートはManagerの待機ポート番号です。

  • -m, --heartbeat: Managerに今すぐ接続するようにAgentに指示します。
  • -p <str> または --passwd=<str> 以前にDeep Security Managerで設定した認証パスワード。詳細については、Deep Security Managerを介してセルフプロテクションを設定するを参照してください。設定されている場合は、dsa_control -adsa_control -x、およびdsa_control -yを除くdsa_controlコマンドすべてにパスワードを含める必要があります。

    例: dsa_control -m -p MyPa$$w0rd

    パスワードは、コマンドラインに直接入力した場合、画面上に表示されます。入力中のパスワードをアスタリスク (*) にして非表示にする場合は、対話形式のコマンド-p *を入力します。この場合、パスワードの入力を求めるプロンプトが表示されます。

    例:

    dsa_control -m -p *

  • -r, --reset エージェントの設定をリセットします。
  • -R <str>, --restore=<str> 隔離されたファイルを復元します。Windows版では、駆除したファイルや削除したファイルも復元できます。
  • -s <num>, --selfprotect=<num> エージェントの自己保護を有効にする(1:有効化、0:無効化).)セルフプロテクションにより、ローカルのエンドユーザはAgentに対してアンインストールや停止などの制御ができなくなります。詳細については、Agentセルフプロテクションの有効化または無効化を参照してください。この機能はWindows版でのみ使用できます。

    セルフプロテクションはdsa_controlコマンドで有効化できますが、関連付けられた認証パスワードの設定にはDeep Security Managerを使用する必要があります。詳細については、Deep Security Managerを介してセルフプロテクションを設定するを参照してください。パスワードは、設定後は-pまたは--passwd=オプションを使用してコマンドラインに入力する必要があります。

    Deep Security 9.0以前では、このオプションは、-H <num>, --harden=<num>でした。
  • -t <num>, --retries=<num>: このパラメータは、Agentサービスに接続してdsa_controlコマンドの指示を実行できない場合に、dsa_controlを再試行する回数 (<num>) を設定します。再試行は、1秒おきに実行されます。
  • -u <user>:<password> -x オプションと組み合わせて使用して、プロキシで認証が必要な場合に、プロキシのユーザ名とパスワードを指定します。 usernameとpasswordはコロン区切りで区切ってください。 (:)。たとえば、 # ./dsa_control -x dsm_proxy://<str> -u <new username>:<new password>と入力します。

    ユーザ名とパスワードを削除するには、空の文字列( "")を入力します。例: # ./dsa_control -x dsm_proxy://<str> -u <existing username>:""

    プロキシのユーザ名のみを変更せずにプロキシのパスワードのみをアップデートする場合は、 -xなしで -u オプションを使用できます。たとえば、 # ./dsa_control -u <existing username>:<new password>と入力します。

    基本認証のみ。ダイジェストおよびNTLMはサポートされていません。

  • -w <user>:<password> -y オプションと組み合わせて使用して、プロキシで認証が必要な場合に、プロキシのユーザ名とパスワードを指定します。 usernameとpasswordはコロン区切りで区切ってください。 (:)。たとえば、 # ./dsa_control -y dsm_proxy://<str> -w <new username>:<new password>と入力します。

    ユーザ名とパスワードを削除するには、空の文字列( "")を入力します。例: # ./dsa_control -y dsm_proxy://<str> -w <existing username>:""

    プロキシのユーザ名のみを変更せずにプロキシのパスワードのみをアップデートする場合は、 -yなしで -w オプションを使用できます。たとえば、 # ./dsa_control -w <existing username>:<new password>と入力します。

  • -x dsm_proxy://<str>:<num> Agentがプロキシ経由でManagerに接続に接続する場合は、プロキシのIPアドレスまたはFQDNとポート番号をコロン (:) で区切って入力します。
  • -y relay_proxy://<str>:<num> Agentがセキュリティアップデートやソフトウェアを実行する際にプロキシ経由でRelayに接続する場合は、プロキシのIPアドレスまたはFQDNとポート番号をコロン (:) で区切って入力します。
  • --buildBaseline: 変更監視のベースラインを構築します。
  • --scanForChanges: 変更監視の変更を検索します。
  • --max-dsm-retries 有効化を再試行する最大回数。0から100までの値を入力してください。初期設定値は30です。
  • --dsm-retry-interval 有効化を再試行する間隔 (秒)。1から3600までの値を入力してください初期設定値は300です。
Agentからのリモート有効化 (「dsa_control -a」)

Managerがコンピュータを保護するためのルールとポリシーを割り当てられるようにするには、そのコンピュータにインストールされているAgentを有効化する必要があります。有効化プロセスでは、AgentとManager間で一意のフィンガープリントが交換されます。これにより、1つのManager (またはいずれか1つのManagerノード) だけがAgentへの指示や通信をできるようにします。

Managerから手動でAgentを有効化するには、[コンピュータ] 画面でコンピュータを右クリックして、[処理]→[有効化/再有効化] の順に選択します。

Agentでは、ローカルで実行するコマンドラインツールを使用して有効化プロセスを開始できます。インストール環境に多数のコンピュータを追加する際、有効化プロセスを自動化するスクリプトを記述する必要がある場合には、この方法が便利です。Agentからのリモート有効化を有効にするには、[管理]→[システム設定]→[Agent] に進み、[Agentからのリモート有効化を許可] を選択します。

有効化の命令には、少なくとも有効化コマンドとManagerのURL (ポート番号を含む) を含めます。

dsa_control -a dsm://<ホスト>:<ポート>/

指定する項目は次のとおりです。

  • -aはAgentを有効化するコマンドです。
  • dsm://<host>:<port>/のパラメータにより、Agentに接続先のManagerを指示します (<ホスト> はManagerの完全修飾ドメイン名 (FQDN)、IPv4アドレス、またはIPv6アドレスとなり、<ポート>はAgentからManagerへの通信ポート番号です)。次に例を示します。

    dsa_control -a dsm://fe80::ad4a:af37:17cf:8937:4120

ホスト名は唯一の必須パラメータです。追加のパラメータを使用することもできます (以下の使用可能なパラメータの表を参照してください)。パラメータはキー:値のペアとして入力する必要があります (セパレータにはコロンを使用します)。入力可能なキー:値のペアの数に制限はありませんが、キー:値のそれぞれのペアを空白文字で区切る必要があります。次に例を示します。

dsa_control -a dsm://dsm-example-com:4120/ hostname:www12 "description:Long Description With Spaces"

(引用符が必要なのは、空白文字または特殊文字が値に含まれる場合のみです)

プロキシ経由のプライベートネットワーク上でのAgentからのリモート有効化

プライベートネットワーク上のAgentは、Agent側から開始するManagerとの通信をプロキシサーバ経由で実行できます。

  1. Deep Security Managerで、[管理]→[システム設定]→[Agent] に移動します。
  2. [Agentからのリモート有効化] エリアで次の手順を実行します。
    • [Agentからのリモート有効化を許可] を選択します。
    • [Agentによるホスト名指定を許可] を選択します。
    • [同じ名前のコンピュータがすでに存在する場合] のリストから、[同じ名前で新規コンピュータを有効化] を選択します。
  3. [保存] をクリックします。

次のコマンドラインオプションを使用して、Agentがプロキシサーバ経由でManagerと通信するように設定できます。

構文 備考

dsa_control -x "dsm_proxy://<host or IP>/"

AgentがManagerとの通信に使用するプロキシサーバのアドレスを設定します。

dsa_control -x ""

プロキシサーバのアドレスをクリアします。

dsa_control -u "<username:password>"

プロキシのユーザ名とパスワードを設定します。

dsa_control -u ""

プロキシのユーザ名とパスワードをクリアします。

dsa_control -x "dsm_proxy://172.21.3.184:808/"

プロキシのIPv4アドレスです。

dsa_control -x "dsm_proxy://squid:808/"

プロキシのホスト名です。

dsa_control -x "dsm_proxy://[fe80::340a:7671:64e7:14cc]:808/"

プロキシのIPv6アドレスです。

dsa_control -u "root:Passw0rd!"

プロキシの認証に、「root」とパスワード「Passw0rd!」を使用します (基本認証のみ。Digest認証とNTLM認証はサポートされていません)。

Agentからのリモート有効化を行うには、最初にプロキシ設定コマンドを発行し、次にAgentからのリモート有効化のコマンドを発行する必要があります。以下は、プロキシサーバのアドレスと認証情報の設定、Agentの有効化までの一連のコマンドの例となります。

dsa_control -x "dsm_proxy://172.21.3.184:808/"
dsa_control -u "root:Passw0rd!"
dsa_control -a "dsm://dsm.example.com:4120/"
Deep Security Managerで必要な設定

Agentからのハートビート有効化コマンド (「dsa_control -m」)

Agentからのハートビートコマンドは、Managerに対するハートビート処理をただちに実行するようにAgentに指示します。ハートビートコマンドは、上記の有効化コマンドと同様これだけでも便利ですが、このコマンドを使用してManagerにさまざまなパラメータセットを渡すこともできます。

次の表は、有効化コマンドとハートビートコマンドで使用できるパラメータを一覧表示しています。有効化中にしか使用できないパラメータや、有効化後のハートビート中にしか使用できないパラメータもあります。

パラメータ 説明 有効化中の使用 ハートビート中の使用
AntiMalwareCancelManualScan

ブール。

コンピュータで現在実行されている手動または予約検索の検索をキャンセルします。詳細については、不正プログラム検索の設定を参照してください。

"AntiMalwareCancelManualScan:true" 不可
AntiMalwareManualScan

ブール。

コンピュータで手動または予約された不正プログラム対策検索を開始します。詳細については、不正プログラム検索の設定を参照してください。

"AntiMalwareManualScan:true" 不可
description

文字列。

description」の値を設定します。最大2000文字。

"description:Extra information about the host"
displayname

文字列。

displayname」の値を設定します。(ホスト名の横にカッコで囲んで表示されます)。最大2000文字。

"displayname:the_name"
externalid

整数。

externalid値を設定します。この値を使用して、Agentを一意に識別できます。この値には、SOAP WebサービスAPIを使用してアクセスできます。

"externalid:123"
group

文字列。

コンピュータの属する [コンピュータ] 画面の Group を設定します。1つの階層レベルの1つのグループ名につき最大254文字。

スラッシュ (「/」) はグループの階層を示します。groupパラメータはグループの階層を読み取ったり、作成したりできます。
このパラメータは、メインの「コンピュータ」ルートブランチの下位にある標準のグループにコンピュータを追加する場合にのみ使用できます。ディレクトリ (MS Active Directory)、VMware vCenter、またはクラウドプロバイダのアカウントに所属するグループにコンピュータを追加する場合には使用できません。

"group:Zone A web servers"
groupid

整数。

"groupid:33"
hostname

文字列。

最大254文字。

hostnameには、Managerの [コンピュータ] リストに含まれるコンピュータへの接続に最も適したIPアドレス、ホスト名、またはFQDNを指定します。

"hostname:www1" 不可
IntegrityScan

ブール。

コンピュータで変更の検索を開始します。

"IntegrityScan:true" 不可
policy

文字列。

最大254文字。

ポリシー名とポリシーリストの大文字と小文字は区別しません。ポリシーが見つからない場合、ポリシーは割り当てられません。

イベントベースタスクによって割り当てられるポリシーは、Agentからのリモート有効化中に割り当てられるポリシーをオーバーライドします。

"policy:Policy Name"
policyid

整数。

"policyid:12"
relaygroup

文字列。

コンピュータを特定のRelayグループにリンクします。最大254文字。

Relayグループ名と既存のRelayグループ名の大文字と小文字は区別しません。Relayグループが見つからない場合は、初期設定のRelayグループが使用されます。

これは、イベントベースタスクの際に割り当てられるRelayグループには影響を与えません。このオプションまたはイベントベースタスクのどちらかを使用してください。

"relaygroup:Custom Relay Group"
relaygroupid

整数。

"relaygroupid:123"
relayid

整数。

"relayid:123"
tenantIDtoken

文字列。

Agentからのリモート有効化をテナントとして使用する場合は、tenantIDtokenの両方が必要です。tenantIDtokenはインストールスクリプト生成ツールから取得できます。

"tenantID:12651ADC-D4D5"

and

"token:8601626D-56EE"
RecommendationScan

ブール。

コンピュータで推奨設定の検索を開始します。

"RecommendationScan:true" 不可
UpdateComponent

ブール。

セキュリティアップデートの実行をManagerに指示します。

"UpdateComponent:true" 不可
RebuildBaseline

ブール。

コンピュータに変更監視ベースラインを再構築します。

"RebuildBaseline:true" 不可
UpdateConfiguration

ブール。

「ポリシーの送信」処理を実行するようにDeep Security Managerに指示します。

"UpdateConfiguration:true" 不可

Agentを有効化する

Agentをコマンドラインから有効化するには、テナントIDとパスワードが必要です。これらの情報はインストールスクリプトで確認できます。

  1. Deep Security Managerの画面右上で、[サポート情報]→[インストールスクリプト] の順にクリックします。
  2. プラットフォームを選択します。
  3. [インストール後にAgentを自動的に有効化] を選択します。
  4. インストールスクリプトで、tenantIDtokenの文字列を探します。

Windows

PowerShellの場合:

& $Env:ProgramFiles"\Trend Micro\Deep Security Agent\dsa_control" -a <manager URL> <tenant ID> <token>

cmd.exeの場合:

C:\Windows\system32>"\Program Files\Trend Micro\Deep Security Agent\dsa_control" -a <manager URL> <tenant ID> <token>

Linux

/opt/ds_agent/dsa_control -a <manager URL> <tenant ID> <token>

不正プログラム対策およびルールアップデート用にプロキシを設定する

Agentをプロキシ経由でRelayに接続する必要がある場合は、プロキシ接続を設定する必要があります。

Windows
  1. 管理者権限でコマンドプロンプト (cmd.exe) を開きます。
  2. 次のコマンドを入力します。

    cd C:\Program Files\Trend Micro\Deep Security Agent\

    dsa_control -w myUserName:MTPassw0rd

    dsa_control -y relay_proxy://squid.example.com:443

Linux

/opt/ds_agent/dsa_control -w myUserName:MTPassw0rd

/opt/ds_agent/dsa_control -y relay_proxy://squid.example.com:443

Managerへの接続用にプロキシを設定する

Agentをプロキシ経由でManagerに接続する必要がある場合は、プロキシ接続を設定する必要があります。

Windows
  1. 管理者権限でコマンドプロンプト (cmd.exe) を開きます。
  2. 次のコマンドを入力します。

    cd C:\Program Files\Trend Micro\Deep Security Agent\

    dsa_control -u myUserName:MTPassw0rd

    dsa_control -x dsm_proxy://squid.example.com:443

Linux

/opt/ds_agent/dsa_control -u myUserName:MTPassw0rd

/opt/ds_agent/dsa_control -x dsm_proxy://squid.example.com:443

Agentからのハートビート有効化コマンド

Windows

PowerShellの場合:

& "\Program Files\Trend Micro\Deep Security Agent\dsa_control" -m

cmd.exeの場合:

C:\Windows\system32>"\Program Files\Trend Micro\Deep Security Agent\dsa_control" -m

Linux

/opt/ds_agent/dsa_control -m

不正プログラムの手動検索を開始する

Windows
  1. 管理者権限でコマンドプロンプト (cmd.exe) を開きます。
  2. 次のコマンドを入力します。

    cd C:\Program Files\Trend Micro\Deep Security Agent\

    dsa_control -m "AntiMalwareManualScan:true"

Linux

/opt/ds_agent/dsa_control -m "AntiMalwareManualScan:true"

診断パッケージを作成する

Deep Security のテクニカルサポートチームから、トラブルシューティングのために診断パッケージの作成を求められる場合があります。診断パッケージはzipファイルとして作成され、動作中のエンドポイントにローカルにダウンロードされます。このファイルをテクニカルサポートに送信できます。詳細な手順については、診断パッケージとログの作成を参照してください。

Deep Security Agentコンピュータの診断パッケージはDeep Security Managerから作成できますが、AgentコンピュータがAgent/Applianceによって開始される通信を使用するよう設定されている場合は、Managerは必要なログの一部を収集できません。そのため、テクニカルサポートから診断パッケージを要求された場合は、該当するAgentコンピュータで直接コマンドを実行する必要があります。

Windows

PowerShellの場合:

& "\Program Files\Trend Micro\Deep Security Agent\dsa_control" -d

cmd.exeの場合:

C:\Windows\system32>"\Program Files\Trend Micro\Deep Security Agent\dsa_control" -d

Linux

/opt/ds_agent/dsa_control -d

Agentをリセットする

このコマンドにより、ターゲットのAgentから有効化情報が削除され、無効化されます。

Windows

PowerShellの場合:

& "\Program Files\Trend Micro\Deep Security Agent\dsa_control" -r

cmd.exeの場合:

C:\Windows\system32>"\Program Files\Trend Micro\Deep Security Agent\dsa_control" -r

Linux

/opt/ds_agent/dsa_control -r

dsa_query

エージェント情報を表示するには、 dsa_query コマンドを使用できます。

使用方法

dsa_query [-c <str>] [-p <str>] [-r <str]

  • -p,--passwd <string>:認証パスワードです。Agentのセルフプロテクションが有効な場合は必須です。
    一部のクエリコマンドでは認証を直接バイパスできます。このような場合、パスワードは必要ありません。
  • -c,--cmd <string>:Agentに対してクエリコマンドを実行します。次のコマンドがサポートされます。次のコマンドがサポートされます。
    • "GetHostInfo":ハートビート中にどのIDがManagerに返されるかを照会する
    • "GetAgentStatus":どの保護モジュールが有効になっているかを検索します. 不正プログラム対策 および 変更監視 検索のステータス、その他のその他の情報を照会します。
    • "GetComponentInfo": 不正プログラム対策のパターンおよびエンジンのバージョン情報を照会します。
  • -r,--raw <string>:"-c"と同じクエリコマンドの情報を返しますが、サードパーティのソフトウェアで解釈できるようにrawデータ形式で出力します。

pattern: 結果をフィルタするためのワイルドカードのパターンです (オプション)。

例:
dsa_query -c "GetComponentInfo" -r "au" "AM*"

CPU使用率とRAM使用量を確認する

Windows

タスクマネージャーまたはprocmonを使用します。

Linux

top

ds_agentプロセスまたはサービスが実行されていることを確認する

Windows

タスクマネージャーまたはprocmonを使用します。

Linux

ps -ef|grep ds_agent

LinuxでAgentを再起動する

service ds_agent restart

または

/etc/init.d/ds_agent restart

or

systemctl restart ds_agent

Deep Security Manager

dsm_cコマンドを使用して、Managerでいくつかの設定を行い、ユーザアカウントをロック解除できます。

一部のコマンドではDeep Security Managerが再起動することがあります。コマンドが実行されたら、Deep Security Managerが再起動したことを確認します。

使用方法

dsm_c -action actionname

コマンドのヘルプを表示するには、-hオプションを使用します。dsm_c -h

次の表のカッコで囲まれたパラメータは、すべて必須パラメータです。

一部の処理には-tenantnameパラメータまたは-tenantidパラメータのいずれかが必要です。テナント名を使用すると実行エラーが発生する場合は、関連付けられたテナントIDを使用してコマンドを再度実行します。
処理名Description使用方法
addcert信頼された証明書を追加します

dsm_c -action addcert -purpose PURPOSE -cert CERT

PURPOSE refers to the type of connections the certificate will be used for.

addregionプライベートクラウドプロバイダのリージョンを追加しますdsm_c -action addregion -region REGION -display DISPLAY -endpoint ENDPOINT
changesetting設定を変更しますdsm_c -action changesetting -name NAME [-value VALUE | -valuefile FILENAME] [-computerid COMPUTERID] [-computername COMPUTERNAME] [-policyid POLICYID] [-policyname POLICYNAME] [-tenantname TENANTNAME | -tenantid TENANTID]
createinsertstatements別のデータベースへのエクスポートに使用するinsert文を作成しますdsm_c -action createinsertstatements [-file FILEPATH] [-generateDDL] [-databaseType sqlserver|oracle] [-maxresultfromdb count] [-tenantname TENANTNAME | -tenantid TENANTID]
diagnostic

システム用の診断パッケージを作成します。

必要に応じて、詳細な診断パッケージのプロセスメモリを増やすことができます。

dsm_c -action diagnostic [-verbose 0|1] [-tenantname TENANTNAME | -tenantid TENANTID]
fullaccess管理者にFull Accessの役割を与えますdsm_c -action fullaccess -username USERNAME [-tenantname TENANTNAME | -tenantid TENANTID]
listcerts信頼された証明書を一覧表示します

dsm_c -action listcerts [-purpose PURPOSE]

PURPOSE refers to the type of connections the certificate will be used for.

listregionsプライベートクラウドプロバイダのリージョンを一覧表示しますdsm_c -action listregions
removecert信頼された証明書を削除しますdsm_c -action removecert -id ID
removeregionプライベートクラウドプロバイダのリージョンを削除しますdsm_c -action removeregion -region REGION
resetcountersカウンタテーブルをリセットします (空の状態に戻します)dsm_c -action resetcounters [-tenantname TENANTNAME | -tenantid TENANTID]
scriptdsm_cコマンドのバッチ処理を実行しますdsm_c -action script -scriptfile <path_to_text_file_containing_commands> [-tenantname TENANTNAME | -tenantid TENANTID]
setportsDeep Security Managerのポートを設定するdsm_c -action setports [-managerPort port] [-heartbeatPort port]
settlsprotocol Deep Security Managerおよびリレープロトコルの設定

dsm_c -action settlsprotocol -MinimumTLSProtocol MINIMUMTLSPROTOCOL | ShowValue

where MINIMUMTLSPROTOCOLis replaced with either TLSv1 or TLSv1.2. See Deep SecurityでのTLS 1.2の使用 for details.

trustdirectorycertディレクトリの証明書を信頼しますdsm_c -action trustdirectorycert -directoryaddress DIRECTORYADDRESS -directoryport DIRECTORYPORT [-username USERNAME] [-password PASSWORD] [-tenantname TENANTNAME | -tenantid TENANTID]
unlockoutユーザアカウントのロックを解除しますdsm_c -action unlockout -username USERNAME [-newpassword NEWPASSWORD] [-disablemfa][-tenantname TENANTNAME | -tenantid TENANTID]
upgradetasksインサービスアップグレードの一環として必要になる場合があるアップグレードタスク処理を実行します

dsm_c -action upgradetasks [-listtasksets] [-listtasks -taskset UPGRADE_TASK_SET [-force]] [-tenantlist] [-tenantsummary] [-run -taskset UPGRADE_TASK_SET [-force] [-filter REGULAR_EXPRESSION]] [-showrollbackinfo -task TASKNAME] [-purgehistory [-task TASKNAME]] [-showhistory [-task TASKNAME]] [-tenantname TENANTNAME | -tenantid TENANTID]

  • [-listtasksets]:システム全体またはテナント (-tenantnameで指定) 用の一連のタスクを一覧表示します。
  • [-listtasks -taskset UPGRADE_TASK_SET [-force]]:実行する変更内容を一覧表示します。すべてのタスクを表示するには、-forceを指定します。
  • [-tenantlist]:指定したテナントの未解決アップグレード処理のバージョンを表示します。
  • [-tenantsummary]:最新ではないテナントの概要を表示します。
  • [-run -taskset UPGRADE_TASK_SET [-force] [-filter REGX]]:各テナントにアップグレード処理を実行します。実行済みであっても、すべてのタスクを実行する場合は、-forceを含めます。正規表現で処理を制限する場合は、-filterを含めます。
  • [-showrollbackinfo -task TASKNAME]:指定したタスクのロールバック情報を表示します。1つのテナントまたはすべてのテナントを表示できます。
  • [-purgehistory [-task TASKNAME]]:指定したテナントやタスクの履歴を削除します。テナントやタスクを指定しないと、すべての項目が対象になります。
  • [-showhistory [-task TASKNAME]]:指定したテナントやタスクの履歴を表示します。テナントやタスクを指定しないと、すべての項目が対象になります。
versionget現在のソフトウェアバージョン、データベーススキーマバージョン、またはその両方に関する情報を表示しますdsm_c -action versionget [-software] [-dbschema]
viewsetting設定値を表示しますdsm_c -action viewsetting -name NAME [-computerid COMPUTERID] [-computername COMPUTERNAME] [-policyid POLICYID] [-policyname POLICYNAME] [-tenantname TENANTNAME | -tenantid TENANTID]

リターンコード

dsm_cコマンドは、コマンドの実行に成功したかどうかを示す整数値を返します。返される値は以下のとおりです。

  • 0: 実行に成功
  • -1: ソフトウェアのインストールの破損など、原因不明の失敗
  • 1: データベースにアクセスできなかったなど、実行中の失敗
  • 2: 指定されている引数が無効